~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Mark Hammond
  • Date: 2009-01-12 01:55:34 UTC
  • mto: (3995.8.2 prepare-1.12)
  • mto: This revision was merged to the branch mainline in revision 4007.
  • Revision ID: mhammond@skippinet.com.au-20090112015534-yfxg50p7mpds9j4v
Include all .html files from the tortoise doc directory.

Show diffs side-by-side

added added

removed removed

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