/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
52
from bzrlib import (
60
53
    debug,
61
54
    errors,
62
55
    revision,
 
56
    trace,
63
57
    tree,
64
58
    )
65
59
from bzrlib.branch import Branch
 
60
from bzrlib.cleanup import OperationWithCleanups
66
61
import bzrlib.config
67
62
from bzrlib.errors import (BzrError, PointlessCommit,
68
63
                           ConflictsInTree,
69
64
                           StrictCommitFailed
70
65
                           )
71
66
from bzrlib.osutils import (get_user_encoding,
72
 
                            kind_marker, isdir,isfile, is_inside_any,
73
 
                            is_inside_or_parent_of_any,
 
67
                            is_inside_any,
74
68
                            minimum_path_selection,
75
 
                            quotefn, sha_file, split_lines,
76
69
                            splitpath,
77
70
                            )
78
 
from bzrlib.testament import Testament
79
 
from bzrlib.trace import mutter, note, warning, is_quiet
80
 
from bzrlib.inventory import InventoryEntry, make_entry
 
71
from bzrlib.trace import mutter, note, is_quiet
 
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
81
73
from bzrlib import symbol_versioning
82
 
from bzrlib.symbol_versioning import (deprecated_passed,
83
 
        deprecated_function,
84
 
        DEPRECATED_PARAMETER)
85
 
from bzrlib.workingtree import WorkingTree
86
74
from bzrlib.urlutils import unescape_for_display
87
75
import bzrlib.ui
88
76
 
103
91
    def completed(self, revno, rev_id):
104
92
        pass
105
93
 
106
 
    def deleted(self, file_id):
107
 
        pass
108
 
 
109
 
    def escaped(self, escape_count, message):
 
94
    def deleted(self, path):
110
95
        pass
111
96
 
112
97
    def missing(self, path):
129
114
        note(format, *args)
130
115
 
131
116
    def snapshot_change(self, change, path):
132
 
        if change == 'unchanged':
133
 
            return
134
 
        if change == 'added' and path == '':
 
117
        if path == '' and change in ('added', 'modified'):
135
118
            return
136
119
        self._note("%s %s", change, path)
137
120
 
149
132
 
150
133
    def completed(self, revno, rev_id):
151
134
        self._note('Committed revision %d.', revno)
152
 
 
153
 
    def deleted(self, file_id):
154
 
        self._note('deleted %s', file_id)
155
 
 
156
 
    def escaped(self, escape_count, message):
157
 
        self._note("replaced %d control characters in message", escape_count)
 
135
        # self._note goes to the console too; so while we want to log the
 
136
        # rev_id, we can't trivially only log it. (See bug 526425). Long
 
137
        # term we should rearrange the reporting structure, but for now
 
138
        # we just mutter seperately. We mutter the revid and revno together
 
139
        # so that concurrent bzr invocations won't lead to confusion.
 
140
        mutter('Committed revid %s as revno %d.', rev_id, revno)
 
141
 
 
142
    def deleted(self, path):
 
143
        self._note('deleted %s', path)
158
144
 
159
145
    def missing(self, path):
160
146
        self._note('missing %s', path)
210
196
        """Commit working copy as a new revision.
211
197
 
212
198
        :param message: the commit message (it or message_callback is required)
 
199
        :param message_callback: A callback: message = message_callback(cmt_obj)
213
200
 
214
201
        :param timestamp: if not None, seconds-since-epoch for a
215
202
            postdated/predated commit.
216
203
 
217
 
        :param specific_files: If true, commit only those files.
 
204
        :param specific_files: If not None, commit only those files. An empty
 
205
            list means 'commit no files'.
218
206
 
219
207
        :param rev_id: If set, use this as the new revision id.
220
208
            Useful for test or import commands that need to tightly
236
224
            pending changes of any sort during this commit.
237
225
        :param exclude: None or a list of relative paths to exclude from the
238
226
            commit. Pending changes to excluded files will be ignored by the
239
 
            commit. 
 
227
            commit.
240
228
        """
 
229
        operation = OperationWithCleanups(self._commit)
 
230
        self.revprops = revprops or {}
 
231
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
232
        self.config = config or self.config
 
233
        return operation.run(
 
234
               message=message,
 
235
               timestamp=timestamp,
 
236
               timezone=timezone,
 
237
               committer=committer,
 
238
               specific_files=specific_files,
 
239
               rev_id=rev_id,
 
240
               allow_pointless=allow_pointless,
 
241
               strict=strict,
 
242
               verbose=verbose,
 
243
               working_tree=working_tree,
 
244
               local=local,
 
245
               reporter=reporter,
 
246
               message_callback=message_callback,
 
247
               recursive=recursive,
 
248
               exclude=exclude,
 
249
               possible_master_transports=possible_master_transports)
 
250
 
 
251
    def _commit(self, operation, message, timestamp, timezone, committer,
 
252
            specific_files, rev_id, allow_pointless, strict, verbose,
 
253
            working_tree, local, reporter, message_callback, recursive,
 
254
            exclude, possible_master_transports):
241
255
        mutter('preparing to commit')
242
256
 
243
257
        if working_tree is None:
258
272
                               " parameter is required for commit().")
259
273
 
260
274
        self.bound_branch = None
261
 
        self.any_entries_changed = False
262
275
        self.any_entries_deleted = False
263
276
        if exclude is not None:
264
277
            self.exclude = sorted(
267
280
            self.exclude = []
268
281
        self.local = local
269
282
        self.master_branch = None
270
 
        self.master_locked = False
271
283
        self.recursive = recursive
272
284
        self.rev_id = None
 
285
        # self.specific_files is None to indicate no filter, or any iterable to
 
286
        # indicate a filter - [] means no files at all, as per iter_changes.
273
287
        if specific_files is not None:
274
288
            self.specific_files = sorted(
275
289
                minimum_path_selection(specific_files))
276
290
        else:
277
291
            self.specific_files = None
278
 
        self.specific_file_ids = None
 
292
            
279
293
        self.allow_pointless = allow_pointless
280
 
        self.revprops = revprops
281
294
        self.message_callback = message_callback
282
295
        self.timestamp = timestamp
283
296
        self.timezone = timezone
284
297
        self.committer = committer
285
298
        self.strict = strict
286
299
        self.verbose = verbose
287
 
        # accumulates an inventory delta to the basis entry, so we can make
288
 
        # just the necessary updates to the workingtree's cached basis.
289
 
        self._basis_delta = []
290
300
 
291
301
        self.work_tree.lock_write()
 
302
        operation.add_cleanup(self.work_tree.unlock)
 
303
        self.parents = self.work_tree.get_parent_ids()
 
304
        # We can use record_iter_changes IFF iter_changes is compatible with
 
305
        # the command line parameters, and the repository has fast delta
 
306
        # generation. See bug 347649.
 
307
        self.use_record_iter_changes = (
 
308
            not self.exclude and 
 
309
            not self.branch.repository._format.supports_tree_reference and
 
310
            (self.branch.repository._format.fast_deltas or
 
311
             len(self.parents) < 2))
292
312
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
313
        operation.add_cleanup(self.pb.finished)
293
314
        self.basis_revid = self.work_tree.last_revision()
294
315
        self.basis_tree = self.work_tree.basis_tree()
295
316
        self.basis_tree.lock_read()
 
317
        operation.add_cleanup(self.basis_tree.unlock)
 
318
        # Cannot commit with conflicts present.
 
319
        if len(self.work_tree.conflicts()) > 0:
 
320
            raise ConflictsInTree
 
321
 
 
322
        # Setup the bound branch variables as needed.
 
323
        self._check_bound_branch(operation, possible_master_transports)
 
324
 
 
325
        # Check that the working tree is up to date
 
326
        old_revno, new_revno = self._check_out_of_date_tree()
 
327
 
 
328
        # Complete configuration setup
 
329
        if reporter is not None:
 
330
            self.reporter = reporter
 
331
        elif self.reporter is None:
 
332
            self.reporter = self._select_reporter()
 
333
        if self.config is None:
 
334
            self.config = self.branch.get_config()
 
335
 
 
336
        self._set_specific_file_ids()
 
337
 
 
338
        # Setup the progress bar. As the number of files that need to be
 
339
        # committed in unknown, progress is reported as stages.
 
340
        # We keep track of entries separately though and include that
 
341
        # information in the progress bar during the relevant stages.
 
342
        self.pb_stage_name = ""
 
343
        self.pb_stage_count = 0
 
344
        self.pb_stage_total = 5
 
345
        if self.bound_branch:
 
346
            self.pb_stage_total += 1
 
347
        self.pb.show_pct = False
 
348
        self.pb.show_spinner = False
 
349
        self.pb.show_eta = False
 
350
        self.pb.show_count = True
 
351
        self.pb.show_bar = True
 
352
 
 
353
        self._gather_parents()
 
354
        # After a merge, a selected file commit is not supported.
 
355
        # See 'bzr help merge' for an explanation as to why.
 
356
        if len(self.parents) > 1 and self.specific_files is not None:
 
357
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
358
        # Excludes are a form of selected file commit.
 
359
        if len(self.parents) > 1 and self.exclude:
 
360
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
361
 
 
362
        # Collect the changes
 
363
        self._set_progress_stage("Collecting changes", counter=True)
 
364
        self.builder = self.branch.get_commit_builder(self.parents,
 
365
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
366
 
296
367
        try:
297
 
            # Cannot commit with conflicts present.
298
 
            if len(self.work_tree.conflicts()) > 0:
299
 
                raise ConflictsInTree
300
 
 
301
 
            # Setup the bound branch variables as needed.
302
 
            self._check_bound_branch(possible_master_transports)
303
 
 
304
 
            # Check that the working tree is up to date
305
 
            old_revno, new_revno = self._check_out_of_date_tree()
306
 
 
307
 
            # Complete configuration setup
308
 
            if reporter is not None:
309
 
                self.reporter = reporter
310
 
            elif self.reporter is None:
311
 
                self.reporter = self._select_reporter()
312
 
            if self.config is None:
313
 
                self.config = self.branch.get_config()
314
 
 
315
 
            # If provided, ensure the specified files are versioned
316
 
            if self.specific_files is not None:
317
 
                # Note: This routine is being called because it raises
318
 
                # PathNotVersionedError as a side effect of finding the IDs. We
319
 
                # later use the ids we found as input to the working tree
320
 
                # inventory iterator, so we only consider those ids rather than
321
 
                # examining the whole tree again.
322
 
                # XXX: Dont we have filter_unversioned to do this more
323
 
                # cheaply?
324
 
                self.specific_file_ids = tree.find_ids_across_trees(
325
 
                    specific_files, [self.basis_tree, self.work_tree])
326
 
 
327
 
            # Setup the progress bar. As the number of files that need to be
328
 
            # committed in unknown, progress is reported as stages.
329
 
            # We keep track of entries separately though and include that
330
 
            # information in the progress bar during the relevant stages.
331
 
            self.pb_stage_name = ""
332
 
            self.pb_stage_count = 0
333
 
            self.pb_stage_total = 5
334
 
            if self.bound_branch:
335
 
                self.pb_stage_total += 1
336
 
            self.pb.show_pct = False
337
 
            self.pb.show_spinner = False
338
 
            self.pb.show_eta = False
339
 
            self.pb.show_count = True
340
 
            self.pb.show_bar = True
341
 
 
342
 
            self.basis_inv = self.basis_tree.inventory
343
 
            self._gather_parents()
344
 
            # After a merge, a selected file commit is not supported.
345
 
            # See 'bzr help merge' for an explanation as to why.
346
 
            if len(self.parents) > 1 and self.specific_files:
347
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
348
 
            # Excludes are a form of selected file commit.
349
 
            if len(self.parents) > 1 and self.exclude:
350
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
351
 
 
352
 
            # Collect the changes
353
 
            self._set_progress_stage("Collecting changes",
354
 
                    entries_title="Directory")
355
 
            self.builder = self.branch.get_commit_builder(self.parents,
356
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
357
 
            
358
 
            try:
359
 
                # find the location being committed to
360
 
                if self.bound_branch:
361
 
                    master_location = self.master_branch.base
362
 
                else:
363
 
                    master_location = self.branch.base
364
 
 
365
 
                # report the start of the commit
366
 
                self.reporter.started(new_revno, self.rev_id, master_location)
367
 
 
368
 
                self._update_builder_with_changes()
369
 
                self._report_and_accumulate_deletes()
370
 
                self._check_pointless()
371
 
 
372
 
                # TODO: Now the new inventory is known, check for conflicts.
373
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
374
 
                # weave lines, because nothing should be recorded until it is known
375
 
                # that commit will succeed.
376
 
                self._set_progress_stage("Saving data locally")
377
 
                self.builder.finish_inventory()
378
 
 
379
 
                # Prompt the user for a commit message if none provided
380
 
                message = message_callback(self)
381
 
                self.message = message
382
 
                self._escape_commit_message()
383
 
 
384
 
                # Add revision data to the local branch
385
 
                self.rev_id = self.builder.commit(self.message)
386
 
 
387
 
            except:
388
 
                self.builder.abort()
389
 
                raise
390
 
 
391
 
            self._process_pre_hooks(old_revno, new_revno)
392
 
 
393
 
            # Upload revision data to the master.
394
 
            # this will propagate merged revisions too if needed.
395
 
            if self.bound_branch:
396
 
                if not self.master_branch.repository.has_same_location(
397
 
                        self.branch.repository):
398
 
                    self._set_progress_stage("Uploading data to master branch")
399
 
                    self.master_branch.repository.fetch(self.branch.repository,
400
 
                        revision_id=self.rev_id)
401
 
                # now the master has the revision data
402
 
                # 'commit' to the master first so a timeout here causes the
403
 
                # local branch to be out of date
404
 
                self.master_branch.set_last_revision_info(new_revno,
405
 
                                                          self.rev_id)
406
 
 
407
 
            # and now do the commit locally.
408
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
409
 
 
410
 
            # Make the working tree up to date with the branch
411
 
            self._set_progress_stage("Updating the working tree")
412
 
            self.work_tree.update_basis_by_delta(self.rev_id,
413
 
                 self._basis_delta)
414
 
            self.reporter.completed(new_revno, self.rev_id)
415
 
            self._process_post_hooks(old_revno, new_revno)
416
 
        finally:
417
 
            self._cleanup()
 
368
            self.builder.will_record_deletes()
 
369
            # find the location being committed to
 
370
            if self.bound_branch:
 
371
                master_location = self.master_branch.base
 
372
            else:
 
373
                master_location = self.branch.base
 
374
 
 
375
            # report the start of the commit
 
376
            self.reporter.started(new_revno, self.rev_id, master_location)
 
377
 
 
378
            self._update_builder_with_changes()
 
379
            self._check_pointless()
 
380
 
 
381
            # TODO: Now the new inventory is known, check for conflicts.
 
382
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
383
            # weave lines, because nothing should be recorded until it is known
 
384
            # that commit will succeed.
 
385
            self._set_progress_stage("Saving data locally")
 
386
            self.builder.finish_inventory()
 
387
 
 
388
            # Prompt the user for a commit message if none provided
 
389
            message = message_callback(self)
 
390
            self.message = message
 
391
 
 
392
            # Add revision data to the local branch
 
393
            self.rev_id = self.builder.commit(self.message)
 
394
 
 
395
        except Exception, e:
 
396
            mutter("aborting commit write group because of exception:")
 
397
            trace.log_exception_quietly()
 
398
            note("aborting commit write group: %r" % (e,))
 
399
            self.builder.abort()
 
400
            raise
 
401
 
 
402
        self._process_pre_hooks(old_revno, new_revno)
 
403
 
 
404
        # Upload revision data to the master.
 
405
        # this will propagate merged revisions too if needed.
 
406
        if self.bound_branch:
 
407
            self._set_progress_stage("Uploading data to master branch")
 
408
            # 'commit' to the master first so a timeout here causes the
 
409
            # local branch to be out of date
 
410
            self.master_branch.import_last_revision_info(
 
411
                self.branch.repository, new_revno, self.rev_id)
 
412
 
 
413
        # and now do the commit locally.
 
414
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
415
 
 
416
        # Make the working tree be up to date with the branch. This
 
417
        # includes automatic changes scheduled to be made to the tree, such
 
418
        # as updating its basis and unversioning paths that were missing.
 
419
        self.work_tree.unversion(self.deleted_ids)
 
420
        self._set_progress_stage("Updating the working tree")
 
421
        self.work_tree.update_basis_by_delta(self.rev_id,
 
422
             self.builder.get_basis_delta())
 
423
        self.reporter.completed(new_revno, self.rev_id)
 
424
        self._process_post_hooks(old_revno, new_revno)
418
425
        return self.rev_id
419
426
 
420
427
    def _select_reporter(self):
429
436
        # A merge with no effect on files
430
437
        if len(self.parents) > 1:
431
438
            return
432
 
        # TODO: we could simplify this by using self._basis_delta.
 
439
        # TODO: we could simplify this by using self.builder.basis_delta.
433
440
 
434
441
        # The initial commit adds a root directory, but this in itself is not
435
442
        # a worthwhile commit.
436
443
        if (self.basis_revid == revision.NULL_REVISION and
437
 
            len(self.builder.new_inventory) == 1):
 
444
            ((self.builder.new_inventory is not None and
 
445
             len(self.builder.new_inventory) == 1) or
 
446
            len(self.builder._basis_delta) == 1)):
438
447
            raise PointlessCommit()
439
 
        # If length == 1, then we only have the root entry. Which means
440
 
        # that there is no real difference (only the root could be different)
441
 
        # unless deletes occured, in which case the length is irrelevant.
442
 
        if (self.any_entries_deleted or 
443
 
            (len(self.builder.new_inventory) != 1 and
444
 
             self.any_entries_changed)):
 
448
        if self.builder.any_changes():
445
449
            return
446
450
        raise PointlessCommit()
447
451
 
448
 
    def _check_bound_branch(self, possible_master_transports=None):
 
452
    def _check_bound_branch(self, operation, possible_master_transports=None):
449
453
        """Check to see if the local branch is bound.
450
454
 
451
455
        If it is bound, then most of the commit will actually be
474
478
        #       commits to the remote branch if they would fit.
475
479
        #       But for now, just require remote to be identical
476
480
        #       to local.
477
 
        
 
481
 
478
482
        # Make sure the local branch is identical to the master
479
483
        master_info = self.master_branch.last_revision_info()
480
484
        local_info = self.branch.last_revision_info()
486
490
        # so grab the lock
487
491
        self.bound_branch = self.branch
488
492
        self.master_branch.lock_write()
489
 
        self.master_locked = True
 
493
        operation.add_cleanup(self.master_branch.unlock)
490
494
 
491
495
    def _check_out_of_date_tree(self):
492
496
        """Check that the working tree is up to date.
537
541
    def _process_hooks(self, hook_name, old_revno, new_revno):
538
542
        if not Branch.hooks[hook_name]:
539
543
            return
540
 
        
 
544
 
541
545
        # new style commit hooks:
542
546
        if not self.bound_branch:
543
547
            hook_master = self.branch
552
556
            old_revid = self.parents[0]
553
557
        else:
554
558
            old_revid = bzrlib.revision.NULL_REVISION
555
 
        
 
559
 
556
560
        if hook_name == "pre_commit":
557
561
            future_tree = self.builder.revision_tree()
558
562
            tree_delta = future_tree.changes_from(self.basis_tree,
559
563
                                             include_root=True)
560
 
        
 
564
 
561
565
        for hook in Branch.hooks[hook_name]:
562
566
            # show the running hook in the progress bar. As hooks may
563
567
            # end up doing nothing (e.g. because they are not configured by
577
581
                     old_revno, old_revid, new_revno, self.rev_id,
578
582
                     tree_delta, future_tree)
579
583
 
580
 
    def _cleanup(self):
581
 
        """Cleanup any open locks, progress bars etc."""
582
 
        cleanups = [self._cleanup_bound_branch,
583
 
                    self.basis_tree.unlock,
584
 
                    self.work_tree.unlock,
585
 
                    self.pb.finished]
586
 
        found_exception = None
587
 
        for cleanup in cleanups:
588
 
            try:
589
 
                cleanup()
590
 
            # we want every cleanup to run no matter what.
591
 
            # so we have a catchall here, but we will raise the
592
 
            # last encountered exception up the stack: and
593
 
            # typically this will be useful enough.
594
 
            except Exception, e:
595
 
                found_exception = e
596
 
        if found_exception is not None: 
597
 
            # don't do a plan raise, because the last exception may have been
598
 
            # trashed, e is our sure-to-work exception even though it loses the
599
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
600
 
            # exc_info and if its the same one do a plain raise otherwise 
601
 
            # 'raise e' as we do now.
602
 
            raise e
603
 
 
604
 
    def _cleanup_bound_branch(self):
605
 
        """Executed at the end of a try/finally to cleanup a bound branch.
606
 
 
607
 
        If the branch wasn't bound, this is a no-op.
608
 
        If it was, it resents self.branch to the local branch, instead
609
 
        of being the master.
610
 
        """
611
 
        if not self.bound_branch:
612
 
            return
613
 
        if self.master_locked:
614
 
            self.master_branch.unlock()
615
 
 
616
 
    def _escape_commit_message(self):
617
 
        """Replace xml-incompatible control characters."""
618
 
        # FIXME: RBC 20060419 this should be done by the revision
619
 
        # serialiser not by commit. Then we can also add an unescaper
620
 
        # in the deserializer and start roundtripping revision messages
621
 
        # precisely. See repository_implementations/test_repository.py
622
 
        
623
 
        # Python strings can include characters that can't be
624
 
        # represented in well-formed XML; escape characters that
625
 
        # aren't listed in the XML specification
626
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
627
 
        self.message, escape_count = re.subn(
628
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
629
 
            lambda match: match.group(0).encode('unicode_escape'),
630
 
            self.message)
631
 
        if escape_count:
632
 
            self.reporter.escaped(escape_count, self.message)
633
 
 
634
584
    def _gather_parents(self):
635
585
        """Record the parents of a merge for merge detection."""
636
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
586
        # TODO: Make sure that this list doesn't contain duplicate
637
587
        # entries and the order is preserved when doing this.
638
 
        self.parents = self.work_tree.get_parent_ids()
 
588
        if self.use_record_iter_changes:
 
589
            return
 
590
        self.basis_inv = self.basis_tree.inventory
639
591
        self.parent_invs = [self.basis_inv]
640
592
        for revision in self.parents[1:]:
641
593
            if self.branch.repository.has_revision(revision):
648
600
    def _update_builder_with_changes(self):
649
601
        """Update the commit builder with the data about what has changed.
650
602
        """
651
 
        # Build the revision inventory.
652
 
        #
653
 
        # This starts by creating a new empty inventory. Depending on
654
 
        # which files are selected for commit, and what is present in the
655
 
        # current tree, the new inventory is populated. inventory entries 
656
 
        # which are candidates for modification have their revision set to
657
 
        # None; inventory entries that are carried over untouched have their
658
 
        # revision set to their prior value.
659
 
        #
660
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
661
 
        # results to create a new inventory at the same time, which results
662
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
663
 
        # ADHB 11-07-2006
664
 
 
665
603
        exclude = self.exclude
666
 
        specific_files = self.specific_files or []
 
604
        specific_files = self.specific_files
667
605
        mutter("Selecting files for commit with filter %s", specific_files)
668
606
 
669
 
        # Build the new inventory
670
 
        self._populate_from_inventory()
671
 
 
 
607
        self._check_strict()
 
608
        if self.use_record_iter_changes:
 
609
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
610
                specific_files=specific_files)
 
611
            iter_changes = self._filter_iter_changes(iter_changes)
 
612
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
613
                self.work_tree, self.basis_revid, iter_changes):
 
614
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
615
        else:
 
616
            # Build the new inventory
 
617
            self._populate_from_inventory()
 
618
            self._record_unselected()
 
619
            self._report_and_accumulate_deletes()
 
620
 
 
621
    def _filter_iter_changes(self, iter_changes):
 
622
        """Process iter_changes.
 
623
 
 
624
        This method reports on the changes in iter_changes to the user, and 
 
625
        converts 'missing' entries in the iter_changes iterator to 'deleted'
 
626
        entries. 'missing' entries have their
 
627
 
 
628
        :param iter_changes: An iter_changes to process.
 
629
        :return: A generator of changes.
 
630
        """
 
631
        reporter = self.reporter
 
632
        report_changes = reporter.is_verbose()
 
633
        deleted_ids = []
 
634
        for change in iter_changes:
 
635
            if report_changes:
 
636
                old_path = change[1][0]
 
637
                new_path = change[1][1]
 
638
                versioned = change[3][1]
 
639
            kind = change[6][1]
 
640
            versioned = change[3][1]
 
641
            if kind is None and versioned:
 
642
                # 'missing' path
 
643
                if report_changes:
 
644
                    reporter.missing(new_path)
 
645
                deleted_ids.append(change[0])
 
646
                # Reset the new path (None) and new versioned flag (False)
 
647
                change = (change[0], (change[1][0], None), change[2],
 
648
                    (change[3][0], False)) + change[4:]
 
649
            elif kind == 'tree-reference':
 
650
                if self.recursive == 'down':
 
651
                    self._commit_nested_tree(change[0], change[1][1])
 
652
            if change[3][0] or change[3][1]:
 
653
                yield change
 
654
                if report_changes:
 
655
                    if new_path is None:
 
656
                        reporter.deleted(old_path)
 
657
                    elif old_path is None:
 
658
                        reporter.snapshot_change('added', new_path)
 
659
                    elif old_path != new_path:
 
660
                        reporter.renamed('renamed', old_path, new_path)
 
661
                    else:
 
662
                        if (new_path or 
 
663
                            self.work_tree.branch.repository._format.rich_root_data):
 
664
                            # Don't report on changes to '' in non rich root
 
665
                            # repositories.
 
666
                            reporter.snapshot_change('modified', new_path)
 
667
            self._next_progress_entry()
 
668
        # Unversion IDs that were found to be deleted
 
669
        self.deleted_ids = deleted_ids
 
670
 
 
671
    def _record_unselected(self):
672
672
        # If specific files are selected, then all un-selected files must be
673
673
        # recorded in their previous state. For more details, see
674
674
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
675
 
        if specific_files or exclude:
 
675
        if self.specific_files or self.exclude:
 
676
            specific_files = self.specific_files or []
676
677
            for path, old_ie in self.basis_inv.iter_entries():
677
678
                if old_ie.file_id in self.builder.new_inventory:
678
679
                    # already added - skip.
679
680
                    continue
680
681
                if (is_inside_any(specific_files, path)
681
 
                    and not is_inside_any(exclude, path)):
 
682
                    and not is_inside_any(self.exclude, path)):
682
683
                    # was inside the selected path, and not excluded - if not
683
684
                    # present it has been deleted so skip.
684
685
                    continue
685
686
                # From here down it was either not selected, or was excluded:
686
 
                if old_ie.kind == 'directory':
687
 
                    self._next_progress_entry()
688
687
                # We preserve the entry unaltered.
689
688
                ie = old_ie.copy()
690
689
                # Note: specific file commits after a merge are currently
692
691
                # required after that changes.
693
692
                if len(self.parents) > 1:
694
693
                    ie.revision = None
695
 
                delta, version_recorded, _ = self.builder.record_entry_contents(
696
 
                    ie, self.parent_invs, path, self.basis_tree, None)
697
 
                if version_recorded:
698
 
                    self.any_entries_changed = True
699
 
                if delta:
700
 
                    self._basis_delta.append(delta)
 
694
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
695
                    self.basis_tree, None)
701
696
 
702
697
    def _report_and_accumulate_deletes(self):
703
 
        # XXX: Could the list of deleted paths and ids be instead taken from
704
 
        # _populate_from_inventory?
705
 
        deleted_ids = set(self.basis_inv._byid.keys()) - \
706
 
            set(self.builder.new_inventory._byid.keys())
 
698
        if (isinstance(self.basis_inv, Inventory)
 
699
            and isinstance(self.builder.new_inventory, Inventory)):
 
700
            # the older Inventory classes provide a _byid dict, and building a
 
701
            # set from the keys of this dict is substantially faster than even
 
702
            # getting a set of ids from the inventory
 
703
            #
 
704
            # <lifeless> set(dict) is roughly the same speed as
 
705
            # set(iter(dict)) and both are significantly slower than
 
706
            # set(dict.keys())
 
707
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
708
               set(self.builder.new_inventory._byid.keys())
 
709
        else:
 
710
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
707
711
        if deleted_ids:
708
712
            self.any_entries_deleted = True
709
713
            deleted = [(self.basis_tree.id2path(file_id), file_id)
711
715
            deleted.sort()
712
716
            # XXX: this is not quite directory-order sorting
713
717
            for path, file_id in deleted:
714
 
                self._basis_delta.append((path, None, file_id, None))
 
718
                self.builder.record_delete(path, file_id)
715
719
                self.reporter.deleted(path)
716
720
 
717
 
    def _populate_from_inventory(self):
718
 
        """Populate the CommitBuilder by walking the working tree inventory."""
 
721
    def _check_strict(self):
 
722
        # XXX: when we use iter_changes this would likely be faster if
 
723
        # iter_changes would check for us (even in the presence of
 
724
        # selected_files).
719
725
        if self.strict:
720
726
            # raise an exception as soon as we find a single unknown.
721
727
            for unknown in self.work_tree.unknowns():
722
728
                raise StrictCommitFailed()
723
 
        
 
729
 
 
730
    def _populate_from_inventory(self):
 
731
        """Populate the CommitBuilder by walking the working tree inventory."""
 
732
        # Build the revision inventory.
 
733
        #
 
734
        # This starts by creating a new empty inventory. Depending on
 
735
        # which files are selected for commit, and what is present in the
 
736
        # current tree, the new inventory is populated. inventory entries
 
737
        # which are candidates for modification have their revision set to
 
738
        # None; inventory entries that are carried over untouched have their
 
739
        # revision set to their prior value.
 
740
        #
 
741
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
742
        # results to create a new inventory at the same time, which results
 
743
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
744
        # ADHB 11-07-2006
 
745
 
724
746
        specific_files = self.specific_files
725
747
        exclude = self.exclude
726
748
        report_changes = self.reporter.is_verbose()
740
762
            name = existing_ie.name
741
763
            parent_id = existing_ie.parent_id
742
764
            kind = existing_ie.kind
743
 
            if kind == 'directory':
744
 
                self._next_progress_entry()
745
765
            # Skip files that have been deleted from the working tree.
746
766
            # The deleted path ids are also recorded so they can be explicitly
747
767
            # unversioned later.
765
785
                # _update_builder_with_changes.
766
786
                continue
767
787
            content_summary = self.work_tree.path_content_summary(path)
 
788
            kind = content_summary[0]
768
789
            # Note that when a filter of specific files is given, we must only
769
790
            # skip/record deleted files matching that filter.
770
791
            if not specific_files or is_inside_any(specific_files, path):
771
 
                if content_summary[0] == 'missing':
 
792
                if kind == 'missing':
772
793
                    if not deleted_paths:
773
794
                        # path won't have been split yet.
774
795
                        path_segments = splitpath(path)
776
797
                    for segment in path_segments:
777
798
                        deleted_dict = deleted_dict.setdefault(segment, {})
778
799
                    self.reporter.missing(path)
 
800
                    self._next_progress_entry()
779
801
                    deleted_ids.append(file_id)
780
802
                    continue
781
803
            # TODO: have the builder do the nested commit just-in-time IF and
782
804
            # only if needed.
783
 
            if content_summary[0] == 'tree-reference':
 
805
            if kind == 'tree-reference':
784
806
                # enforce repository nested tree policy.
785
807
                if (not self.work_tree.supports_tree_reference() or
786
808
                    # repository does not support it either.
787
809
                    not self.branch.repository._format.supports_tree_reference):
788
 
                    content_summary = ('directory',) + content_summary[1:]
789
 
            kind = content_summary[0]
790
 
            # TODO: specific_files filtering before nested tree processing
791
 
            if kind == 'tree-reference':
792
 
                if self.recursive == 'down':
 
810
                    kind = 'directory'
 
811
                    content_summary = (kind, None, None, None)
 
812
                elif self.recursive == 'down':
793
813
                    nested_revision_id = self._commit_nested_tree(
794
814
                        file_id, path)
795
 
                    content_summary = content_summary[:3] + (
796
 
                        nested_revision_id,)
 
815
                    content_summary = (kind, None, None, nested_revision_id)
797
816
                else:
798
 
                    content_summary = content_summary[:3] + (
799
 
                        self.work_tree.get_reference_revision(file_id),)
 
817
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
818
                    content_summary = (kind, None, None, nested_revision_id)
800
819
 
801
820
            # Record an entry for this item
802
821
            # Note: I don't particularly want to have the existing_ie
808
827
                content_summary)
809
828
 
810
829
        # Unversion IDs that were found to be deleted
811
 
        self.work_tree.unversion(deleted_ids)
 
830
        self.deleted_ids = deleted_ids
812
831
 
813
832
    def _commit_nested_tree(self, file_id, path):
814
833
        "Commit a nested tree."
816
835
        # FIXME: be more comprehensive here:
817
836
        # this works when both trees are in --trees repository,
818
837
        # but when both are bound to a different repository,
819
 
        # it fails; a better way of approaching this is to 
 
838
        # it fails; a better way of approaching this is to
820
839
        # finally implement the explicit-caches approach design
821
840
        # a while back - RBC 20070306.
822
841
        if sub_tree.branch.repository.has_same_location(
848
867
            ie.revision = None
849
868
        # For carried over entries we don't care about the fs hash - the repo
850
869
        # isn't generating a sha, so we're not saving computation time.
851
 
        delta, version_recorded, fs_hash = self.builder.record_entry_contents(
 
870
        _, _, fs_hash = self.builder.record_entry_contents(
852
871
            ie, self.parent_invs, path, self.work_tree, content_summary)
853
 
        if delta:
854
 
            self._basis_delta.append(delta)
855
 
        if version_recorded:
856
 
            self.any_entries_changed = True
857
872
        if report_changes:
858
873
            self._report_change(ie, path)
859
874
        if fs_hash:
871
886
        else:
872
887
            basis_ie = None
873
888
        change = ie.describe_change(basis_ie, ie)
874
 
        if change in (InventoryEntry.RENAMED, 
 
889
        if change in (InventoryEntry.RENAMED,
875
890
            InventoryEntry.MODIFIED_AND_RENAMED):
876
891
            old_path = self.basis_inv.id2path(ie.file_id)
877
892
            self.reporter.renamed(change, old_path, path)
 
893
            self._next_progress_entry()
878
894
        else:
 
895
            if change == 'unchanged':
 
896
                return
879
897
            self.reporter.snapshot_change(change, path)
 
898
            self._next_progress_entry()
880
899
 
881
 
    def _set_progress_stage(self, name, entries_title=None):
 
900
    def _set_progress_stage(self, name, counter=False):
882
901
        """Set the progress stage and emit an update to the progress bar."""
883
902
        self.pb_stage_name = name
884
903
        self.pb_stage_count += 1
885
 
        self.pb_entries_title = entries_title
886
 
        if entries_title is not None:
 
904
        if counter:
887
905
            self.pb_entries_count = 0
888
 
            self.pb_entries_total = '?'
 
906
        else:
 
907
            self.pb_entries_count = None
889
908
        self._emit_progress()
890
909
 
891
910
    def _next_progress_entry(self):
894
913
        self._emit_progress()
895
914
 
896
915
    def _emit_progress(self):
897
 
        if self.pb_entries_title:
898
 
            if self.pb_entries_total == '?':
899
 
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
900
 
                    self.pb_entries_title, self.pb_entries_count)
901
 
            else:
902
 
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
903
 
                    self.pb_entries_title, self.pb_entries_count,
904
 
                    str(self.pb_entries_total))
 
916
        if self.pb_entries_count is not None:
 
917
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
918
                self.pb_entries_count)
905
919
        else:
906
 
            text = "%s - Stage" % (self.pb_stage_name)
 
920
            text = "%s - Stage" % (self.pb_stage_name, )
907
921
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
908
922
 
 
923
    def _set_specific_file_ids(self):
 
924
        """populate self.specific_file_ids if we will use it."""
 
925
        if not self.use_record_iter_changes:
 
926
            # If provided, ensure the specified files are versioned
 
927
            if self.specific_files is not None:
 
928
                # Note: This routine is being called because it raises
 
929
                # PathNotVersionedError as a side effect of finding the IDs. We
 
930
                # later use the ids we found as input to the working tree
 
931
                # inventory iterator, so we only consider those ids rather than
 
932
                # examining the whole tree again.
 
933
                # XXX: Dont we have filter_unversioned to do this more
 
934
                # cheaply?
 
935
                self.specific_file_ids = tree.find_ids_across_trees(
 
936
                    self.specific_files, [self.basis_tree, self.work_tree])
 
937
            else:
 
938
                self.specific_file_ids = None