~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

Merge the 0.17 fixes back into bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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., 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
19
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
57
57
from cStringIO import StringIO
58
58
 
59
59
from bzrlib import (
60
 
    debug,
61
60
    errors,
62
 
    revision,
63
 
    trace,
 
61
    inventory,
64
62
    tree,
65
 
    xml_serializer,
66
63
    )
67
64
from bzrlib.branch import Branch
68
 
from bzrlib.cleanup import OperationWithCleanups
69
65
import bzrlib.config
70
66
from bzrlib.errors import (BzrError, PointlessCommit,
71
67
                           ConflictsInTree,
72
68
                           StrictCommitFailed
73
69
                           )
74
 
from bzrlib.osutils import (get_user_encoding,
75
 
                            kind_marker, isdir,isfile, is_inside_any,
 
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
76
71
                            is_inside_or_parent_of_any,
77
 
                            minimum_path_selection,
78
 
                            quotefn, sha_file, split_lines,
79
 
                            splitpath,
80
 
                            )
 
72
                            quotefn, sha_file, split_lines)
81
73
from bzrlib.testament import Testament
82
 
from bzrlib.trace import mutter, note, warning, is_quiet
83
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib.trace import mutter, note, warning
 
75
from bzrlib.xml5 import serializer_v5
 
76
from bzrlib.inventory import Inventory, InventoryEntry
84
77
from bzrlib import symbol_versioning
85
78
from bzrlib.symbol_versioning import (deprecated_passed,
86
79
        deprecated_function,
87
80
        DEPRECATED_PARAMETER)
88
81
from bzrlib.workingtree import WorkingTree
89
 
from bzrlib.urlutils import unescape_for_display
90
82
import bzrlib.ui
91
83
 
92
84
 
93
85
class NullCommitReporter(object):
94
86
    """I report on progress of a commit."""
95
87
 
96
 
    def started(self, revno, revid, location=None):
97
 
        if location is None:
98
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
99
 
                                   "to started.", DeprecationWarning,
100
 
                                   stacklevel=2)
101
 
        pass
102
 
 
103
88
    def snapshot_change(self, change, path):
104
89
        pass
105
90
 
106
91
    def completed(self, revno, rev_id):
107
92
        pass
108
93
 
109
 
    def deleted(self, path):
 
94
    def deleted(self, file_id):
 
95
        pass
 
96
 
 
97
    def escaped(self, escape_count, message):
110
98
        pass
111
99
 
112
100
    def missing(self, path):
115
103
    def renamed(self, change, old_path, new_path):
116
104
        pass
117
105
 
118
 
    def is_verbose(self):
119
 
        return False
120
 
 
121
106
 
122
107
class ReportCommitToLog(NullCommitReporter):
123
108
 
129
114
        note(format, *args)
130
115
 
131
116
    def snapshot_change(self, change, path):
132
 
        if path == '' and change in ('added', 'modified'):
 
117
        if change == 'unchanged':
 
118
            return
 
119
        if change == 'added' and path == '':
133
120
            return
134
121
        self._note("%s %s", change, path)
135
122
 
136
 
    def started(self, revno, rev_id, location=None):
137
 
        if location is not None:
138
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
139
 
        else:
140
 
            # When started was added, location was only made optional by
141
 
            # accident.  Matt Nordhoff 20071129
142
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
143
 
                                   "to started.", DeprecationWarning,
144
 
                                   stacklevel=2)
145
 
            location = ''
146
 
        self._note('Committing%s', location)
147
 
 
148
123
    def completed(self, revno, rev_id):
149
124
        self._note('Committed revision %d.', revno)
 
125
    
 
126
    def deleted(self, file_id):
 
127
        self._note('deleted %s', file_id)
150
128
 
151
 
    def deleted(self, path):
152
 
        self._note('deleted %s', path)
 
129
    def escaped(self, escape_count, message):
 
130
        self._note("replaced %d control characters in message", escape_count)
153
131
 
154
132
    def missing(self, path):
155
133
        self._note('missing %s', path)
157
135
    def renamed(self, change, old_path, new_path):
158
136
        self._note('%s %s => %s', change, old_path, new_path)
159
137
 
160
 
    def is_verbose(self):
161
 
        return True
162
 
 
163
138
 
164
139
class Commit(object):
165
140
    """Task of committing a new revision.
176
151
    def __init__(self,
177
152
                 reporter=None,
178
153
                 config=None):
179
 
        """Create a Commit object.
180
 
 
181
 
        :param reporter: the default reporter to use or None to decide later
182
 
        """
183
 
        self.reporter = reporter
 
154
        if reporter is not None:
 
155
            self.reporter = reporter
 
156
        else:
 
157
            self.reporter = NullCommitReporter()
184
158
        self.config = config
185
 
 
 
159
        
186
160
    def commit(self,
187
161
               message=None,
188
162
               timestamp=None,
199
173
               reporter=None,
200
174
               config=None,
201
175
               message_callback=None,
202
 
               recursive='down',
203
 
               exclude=None,
204
 
               possible_master_transports=None):
 
176
               recursive='down'):
205
177
        """Commit working copy as a new revision.
206
178
 
207
179
        :param message: the commit message (it or message_callback is required)
208
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
209
180
 
210
181
        :param timestamp: if not None, seconds-since-epoch for a
211
182
            postdated/predated commit.
212
183
 
213
 
        :param specific_files: If not None, commit only those files. An empty
214
 
            list means 'commit no files'.
 
184
        :param specific_files: If true, commit only those files.
215
185
 
216
186
        :param rev_id: If set, use this as the new revision id.
217
187
            Useful for test or import commands that need to tightly
227
197
 
228
198
        :param revprops: Properties for new revision
229
199
        :param local: Perform a local only commit.
230
 
        :param reporter: the reporter to use or None for the default
231
 
        :param verbose: if True and the reporter is not None, report everything
232
200
        :param recursive: If set to 'down', commit in any subtrees that have
233
201
            pending changes of any sort during this commit.
234
 
        :param exclude: None or a list of relative paths to exclude from the
235
 
            commit. Pending changes to excluded files will be ignored by the
236
 
            commit.
237
202
        """
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
203
        mutter('preparing to commit')
264
204
 
265
205
        if working_tree is None:
273
213
        if message_callback is None:
274
214
            if message is not None:
275
215
                if isinstance(message, str):
276
 
                    message = message.decode(get_user_encoding())
 
216
                    message = message.decode(bzrlib.user_encoding)
277
217
                message_callback = lambda x: message
278
218
            else:
279
219
                raise BzrError("The message or message_callback keyword"
280
220
                               " parameter is required for commit().")
281
221
 
282
222
        self.bound_branch = None
283
 
        self.any_entries_deleted = False
284
 
        if exclude is not None:
285
 
            self.exclude = sorted(
286
 
                minimum_path_selection(exclude))
287
 
        else:
288
 
            self.exclude = []
289
223
        self.local = local
290
224
        self.master_branch = None
291
 
        self.recursive = recursive
 
225
        self.master_locked = False
292
226
        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
 
        if specific_files is not None:
296
 
            self.specific_files = sorted(
297
 
                minimum_path_selection(specific_files))
298
 
        else:
299
 
            self.specific_files = None
300
 
            
 
227
        self.specific_files = specific_files
301
228
        self.allow_pointless = allow_pointless
 
229
        self.recursive = recursive
302
230
        self.revprops = revprops
303
231
        self.message_callback = message_callback
304
232
        self.timestamp = timestamp
307
235
        self.strict = strict
308
236
        self.verbose = verbose
309
237
 
 
238
        if reporter is None and self.reporter is None:
 
239
            self.reporter = NullCommitReporter()
 
240
        elif reporter is not None:
 
241
            self.reporter = reporter
 
242
 
310
243
        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
244
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
322
 
        operation.add_cleanup(self.pb.finished)
323
 
        self.basis_revid = self.work_tree.last_revision()
324
245
        self.basis_tree = self.work_tree.basis_tree()
325
246
        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
247
        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()
 
248
            # Cannot commit with conflicts present.
 
249
            if len(self.work_tree.conflicts()) > 0:
 
250
                raise ConflictsInTree
 
251
 
 
252
            # Setup the bound branch variables as needed.
 
253
            self._check_bound_branch()
 
254
 
 
255
            # Check that the working tree is up to date
 
256
            old_revno,new_revno = self._check_out_of_date_tree()
 
257
 
 
258
            if strict:
 
259
                # raise an exception as soon as we find a single unknown.
 
260
                for unknown in self.work_tree.unknowns():
 
261
                    raise StrictCommitFailed()
 
262
                   
 
263
            if self.config is None:
 
264
                self.config = self.branch.get_config()
 
265
 
 
266
            self.work_inv = self.work_tree.inventory
 
267
            self.basis_inv = self.basis_tree.inventory
 
268
            if specific_files is not None:
 
269
                # Ensure specified files are versioned
 
270
                # (We don't actually need the ids here)
 
271
                # XXX: Dont we have filter_unversioned to do this more
 
272
                # cheaply?
 
273
                tree.find_ids_across_trees(specific_files,
 
274
                                           [self.basis_tree, self.work_tree])
 
275
 
 
276
            # Setup the progress bar ...
 
277
            # one to finish, one for rev and inventory, and one for each
 
278
            # inventory entry, and the same for the new inventory.
 
279
            # note that this estimate is too long when we do a partial tree
 
280
            # commit which excludes some new files from being considered.
 
281
            # The estimate is corrected when we populate the new inv.
 
282
            self.pb_total = len(self.work_inv) + 5
 
283
            self.pb_count = 0
 
284
 
 
285
            self._gather_parents()
 
286
            if len(self.parents) > 1 and self.specific_files:
 
287
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
288
            
 
289
            # Build the new inventory
 
290
            self.builder = self.branch.get_commit_builder(self.parents,
 
291
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
292
            self._remove_deleted()
 
293
            self._populate_new_inv()
 
294
            self._report_deletes()
388
295
            self._check_pointless()
 
296
            self._emit_progress_update()
389
297
 
390
 
            # TODO: Now the new inventory is known, check for conflicts.
 
298
            # TODO: Now the new inventory is known, check for conflicts and
 
299
            # prompt the user for a commit message.
391
300
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
392
301
            # weave lines, because nothing should be recorded until it is known
393
302
            # that commit will succeed.
394
 
            self._set_progress_stage("Saving data locally")
395
303
            self.builder.finish_inventory()
396
 
 
397
 
            # Prompt the user for a commit message if none provided
 
304
            self._emit_progress_update()
398
305
            message = message_callback(self)
 
306
            assert isinstance(message, unicode), type(message)
399
307
            self.message = message
 
308
            self._escape_commit_message()
400
309
 
401
310
            # Add revision data to the local branch
402
311
            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)
 
312
            self._emit_progress_update()
 
313
            
 
314
            # upload revision data to the master.
 
315
            # this will propagate merged revisions too if needed.
 
316
            if self.bound_branch:
 
317
                self.master_branch.repository.fetch(self.branch.repository,
 
318
                                                    revision_id=self.rev_id)
 
319
                # now the master has the revision data
 
320
                # 'commit' to the master first so a timeout here causes the
 
321
                # local branch to be out of date
 
322
                self.master_branch.set_last_revision_info(new_revno,
 
323
                                                          self.rev_id)
 
324
 
 
325
            # and now do the commit locally.
 
326
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
327
 
 
328
            # Make the working tree up to date with the branch
 
329
            rev_tree = self.builder.revision_tree()
 
330
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
331
            self.reporter.completed(new_revno, self.rev_id)
 
332
 
 
333
            # Process the post commit hooks, if any
 
334
            self._process_hooks(old_revno, new_revno)
 
335
            self._emit_progress_update()
 
336
        finally:
 
337
            self._cleanup()
434
338
        return self.rev_id
435
339
 
436
 
    def _select_reporter(self):
437
 
        """Select the CommitReporter to use."""
438
 
        if is_quiet():
439
 
            return NullCommitReporter()
440
 
        return ReportCommitToLog()
 
340
    def _any_real_changes(self):
 
341
        """Are there real changes between new_inventory and basis?
 
342
 
 
343
        For trees without rich roots, inv.root.revision changes every commit.
 
344
        But if that is the only change, we want to treat it as though there
 
345
        are *no* changes.
 
346
        """
 
347
        new_entries = self.builder.new_inventory.iter_entries()
 
348
        basis_entries = self.basis_inv.iter_entries()
 
349
        new_path, new_root_ie = new_entries.next()
 
350
        basis_path, basis_root_ie = basis_entries.next()
 
351
 
 
352
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
353
        def ie_equal_no_revision(this, other):
 
354
            return ((this.file_id == other.file_id)
 
355
                    and (this.name == other.name)
 
356
                    and (this.symlink_target == other.symlink_target)
 
357
                    and (this.text_sha1 == other.text_sha1)
 
358
                    and (this.text_size == other.text_size)
 
359
                    and (this.text_id == other.text_id)
 
360
                    and (this.parent_id == other.parent_id)
 
361
                    and (this.kind == other.kind)
 
362
                    and (this.executable == other.executable)
 
363
                    and (this.reference_revision == other.reference_revision)
 
364
                    )
 
365
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
366
            return True
 
367
 
 
368
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
369
            if new_ie != basis_ie:
 
370
                return True
 
371
 
 
372
        # No actual changes present
 
373
        return False
441
374
 
442
375
    def _check_pointless(self):
443
376
        if self.allow_pointless:
445
378
        # A merge with no effect on files
446
379
        if len(self.parents) > 1:
447
380
            return
448
 
        # TODO: we could simplify this by using self.builder.basis_delta.
449
 
 
450
 
        # The initial commit adds a root directory, but this in itself is not
451
 
        # a worthwhile commit.
452
 
        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)):
 
381
        # work around the fact that a newly-initted tree does differ from its
 
382
        # basis
 
383
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
456
384
            raise PointlessCommit()
457
 
        if self.builder.any_changes():
 
385
        # Shortcut, if the number of entries changes, then we obviously have
 
386
        # a change
 
387
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
388
            return
 
389
        # If length == 1, then we only have the root entry. Which means
 
390
        # that there is no real difference (only the root could be different)
 
391
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
458
392
            return
459
393
        raise PointlessCommit()
460
394
 
461
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
395
    def _check_bound_branch(self):
462
396
        """Check to see if the local branch is bound.
463
397
 
464
398
        If it is bound, then most of the commit will actually be
469
403
            raise errors.LocalRequiresBoundBranch()
470
404
 
471
405
        if not self.local:
472
 
            self.master_branch = self.branch.get_master_branch(
473
 
                possible_master_transports)
 
406
            self.master_branch = self.branch.get_master_branch()
474
407
 
475
408
        if not self.master_branch:
476
409
            # make this branch the reference branch for out of date checks.
487
420
        #       commits to the remote branch if they would fit.
488
421
        #       But for now, just require remote to be identical
489
422
        #       to local.
490
 
 
 
423
        
491
424
        # Make sure the local branch is identical to the master
492
425
        master_info = self.master_branch.last_revision_info()
493
426
        local_info = self.branch.last_revision_info()
499
432
        # so grab the lock
500
433
        self.bound_branch = self.branch
501
434
        self.master_branch.lock_write()
502
 
        operation.add_cleanup(self.master_branch.unlock)
 
435
        self.master_locked = True
503
436
 
504
437
    def _check_out_of_date_tree(self):
505
438
        """Check that the working tree is up to date.
525
458
            new_revno = 1
526
459
        return old_revno,new_revno
527
460
 
528
 
    def _process_pre_hooks(self, old_revno, new_revno):
529
 
        """Process any registered pre commit hooks."""
530
 
        self._set_progress_stage("Running pre_commit hooks")
531
 
        self._process_hooks("pre_commit", old_revno, new_revno)
532
 
 
533
 
    def _process_post_hooks(self, old_revno, new_revno):
534
 
        """Process any registered post commit hooks."""
535
 
        # Process the post commit hooks, if any
536
 
        self._set_progress_stage("Running post_commit hooks")
 
461
    def _process_hooks(self, old_revno, new_revno):
 
462
        """Process any registered commit hooks."""
537
463
        # old style commit hooks - should be deprecated ? (obsoleted in
538
464
        # 0.15)
539
465
        if self.config.post_commit() is not None:
544
470
                              {'branch':self.branch,
545
471
                               'bzrlib':bzrlib,
546
472
                               'rev_id':self.rev_id})
547
 
        # process new style post commit hooks
548
 
        self._process_hooks("post_commit", old_revno, new_revno)
549
 
 
550
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
551
 
        if not Branch.hooks[hook_name]:
552
 
            return
553
 
 
554
473
        # new style commit hooks:
555
474
        if not self.bound_branch:
556
475
            hook_master = self.branch
565
484
            old_revid = self.parents[0]
566
485
        else:
567
486
            old_revid = bzrlib.revision.NULL_REVISION
568
 
 
569
 
        if hook_name == "pre_commit":
570
 
            future_tree = self.builder.revision_tree()
571
 
            tree_delta = future_tree.changes_from(self.basis_tree,
572
 
                                             include_root=True)
573
 
 
574
 
        for hook in Branch.hooks[hook_name]:
575
 
            # show the running hook in the progress bar. As hooks may
576
 
            # end up doing nothing (e.g. because they are not configured by
577
 
            # the user) this is still showing progress, not showing overall
578
 
            # actions - its up to each plugin to show a UI if it want's to
579
 
            # (such as 'Emailing diff to foo@example.com').
580
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
581
 
                (hook_name, Branch.hooks.get_hook_name(hook))
582
 
            self._emit_progress()
583
 
            if 'hooks' in debug.debug_flags:
584
 
                mutter("Invoking commit hook: %r", hook)
585
 
            if hook_name == "post_commit":
586
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
587
 
                     self.rev_id)
588
 
            elif hook_name == "pre_commit":
589
 
                hook(hook_local, hook_master,
590
 
                     old_revno, old_revid, new_revno, self.rev_id,
591
 
                     tree_delta, future_tree)
 
487
        for hook in Branch.hooks['post_commit']:
 
488
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
489
                self.rev_id)
 
490
 
 
491
    def _cleanup(self):
 
492
        """Cleanup any open locks, progress bars etc."""
 
493
        cleanups = [self._cleanup_bound_branch,
 
494
                    self.basis_tree.unlock,
 
495
                    self.work_tree.unlock,
 
496
                    self.pb.finished]
 
497
        found_exception = None
 
498
        for cleanup in cleanups:
 
499
            try:
 
500
                cleanup()
 
501
            # we want every cleanup to run no matter what.
 
502
            # so we have a catchall here, but we will raise the
 
503
            # last encountered exception up the stack: and
 
504
            # typically this will be useful enough.
 
505
            except Exception, e:
 
506
                found_exception = e
 
507
        if found_exception is not None: 
 
508
            # don't do a plan raise, because the last exception may have been
 
509
            # trashed, e is our sure-to-work exception even though it loses the
 
510
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
511
            # exc_info and if its the same one do a plain raise otherwise 
 
512
            # 'raise e' as we do now.
 
513
            raise e
 
514
 
 
515
    def _cleanup_bound_branch(self):
 
516
        """Executed at the end of a try/finally to cleanup a bound branch.
 
517
 
 
518
        If the branch wasn't bound, this is a no-op.
 
519
        If it was, it resents self.branch to the local branch, instead
 
520
        of being the master.
 
521
        """
 
522
        if not self.bound_branch:
 
523
            return
 
524
        if self.master_locked:
 
525
            self.master_branch.unlock()
 
526
 
 
527
    def _escape_commit_message(self):
 
528
        """Replace xml-incompatible control characters."""
 
529
        # FIXME: RBC 20060419 this should be done by the revision
 
530
        # serialiser not by commit. Then we can also add an unescaper
 
531
        # in the deserializer and start roundtripping revision messages
 
532
        # precisely. See repository_implementations/test_repository.py
 
533
        
 
534
        # Python strings can include characters that can't be
 
535
        # represented in well-formed XML; escape characters that
 
536
        # aren't listed in the XML specification
 
537
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
538
        self.message, escape_count = re.subn(
 
539
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
540
            lambda match: match.group(0).encode('unicode_escape'),
 
541
            self.message)
 
542
        if escape_count:
 
543
            self.reporter.escaped(escape_count, self.message)
592
544
 
593
545
    def _gather_parents(self):
594
546
        """Record the parents of a merge for merge detection."""
595
 
        # TODO: Make sure that this list doesn't contain duplicate
 
547
        # TODO: Make sure that this list doesn't contain duplicate 
596
548
        # 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
 
549
        self.parents = self.work_tree.get_parent_ids()
600
550
        self.parent_invs = [self.basis_inv]
601
551
        for revision in self.parents[1:]:
602
552
            if self.branch.repository.has_revision(revision):
606
556
            else:
607
557
                mutter('commit parent ghost revision {%s}', revision)
608
558
 
609
 
    def _update_builder_with_changes(self):
610
 
        """Update the commit builder with the data about what has changed.
611
 
        """
612
 
        exclude = self.exclude
613
 
        specific_files = self.specific_files
614
 
        mutter("Selecting files for commit with filter %s", specific_files)
615
 
 
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()
 
559
    def _remove_deleted(self):
 
560
        """Remove deleted files from the working inventories.
 
561
 
 
562
        This is done prior to taking the working inventory as the
 
563
        basis for the new committed inventory.
 
564
 
 
565
        This returns true if any files
 
566
        *that existed in the basis inventory* were deleted.
 
567
        Files that were added and deleted
 
568
        in the working copy don't matter.
 
569
        """
 
570
        specific = self.specific_files
642
571
        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):
681
 
        # If specific files are selected, then all un-selected files must be
682
 
        # recorded in their previous state. For more details, see
683
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
684
 
        if self.specific_files or self.exclude:
685
 
            specific_files = self.specific_files or []
686
 
            for path, old_ie in self.basis_inv.iter_entries():
687
 
                if old_ie.file_id in self.builder.new_inventory:
688
 
                    # already added - skip.
689
 
                    continue
690
 
                if (is_inside_any(specific_files, path)
691
 
                    and not is_inside_any(self.exclude, path)):
692
 
                    # was inside the selected path, and not excluded - if not
693
 
                    # present it has been deleted so skip.
694
 
                    continue
695
 
                # From here down it was either not selected, or was excluded:
696
 
                # We preserve the entry unaltered.
697
 
                ie = old_ie.copy()
698
 
                # Note: specific file commits after a merge are currently
699
 
                # prohibited. This test is for sanity/safety in case it's
700
 
                # required after that changes.
701
 
                if len(self.parents) > 1:
702
 
                    ie.revision = None
703
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
704
 
                    self.basis_tree, None)
705
 
 
706
 
    def _report_and_accumulate_deletes(self):
707
 
        if (isinstance(self.basis_inv, Inventory)
708
 
            and isinstance(self.builder.new_inventory, Inventory)):
709
 
            # the older Inventory classes provide a _byid dict, and building a
710
 
            # set from the keys of this dict is substantially faster than even
711
 
            # getting a set of ids from the inventory
712
 
            #
713
 
            # <lifeless> set(dict) is roughly the same speed as
714
 
            # set(iter(dict)) and both are significantly slower than
715
 
            # set(dict.keys())
716
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
717
 
               set(self.builder.new_inventory._byid.keys())
718
 
        else:
719
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
720
 
        if deleted_ids:
721
 
            self.any_entries_deleted = True
722
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
723
 
                for file_id in deleted_ids]
724
 
            deleted.sort()
725
 
            # XXX: this is not quite directory-order sorting
726
 
            for path, file_id in deleted:
727
 
                self.builder.record_delete(path, file_id)
728
 
                self.reporter.deleted(path)
729
 
 
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).
734
 
        if self.strict:
735
 
            # raise an exception as soon as we find a single unknown.
736
 
            for unknown in self.work_tree.unknowns():
737
 
                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
 
        #
 
572
        deleted_paths = set()
 
573
        for path, ie in self.work_inv.iter_entries():
 
574
            if is_inside_any(deleted_paths, path):
 
575
                # The tree will delete the required ids recursively.
 
576
                continue
 
577
            if specific and not is_inside_any(specific, path):
 
578
                continue
 
579
            if not self.work_tree.has_filename(path):
 
580
                deleted_paths.add(path)
 
581
                self.reporter.missing(path)
 
582
                deleted_ids.append(ie.file_id)
 
583
        self.work_tree.unversion(deleted_ids)
 
584
 
 
585
    def _populate_new_inv(self):
 
586
        """Build revision inventory.
 
587
 
 
588
        This creates a new empty inventory. Depending on
 
589
        which files are selected for commit, and what is present in the
 
590
        current tree, the new inventory is populated. inventory entries 
 
591
        which are candidates for modification have their revision set to
 
592
        None; inventory entries that are carried over untouched have their
 
593
        revision set to their prior value.
 
594
        """
750
595
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
751
596
        # results to create a new inventory at the same time, which results
752
597
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
753
598
        # ADHB 11-07-2006
754
 
 
755
 
        specific_files = self.specific_files
756
 
        exclude = self.exclude
757
 
        report_changes = self.reporter.is_verbose()
758
 
        deleted_ids = []
759
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
760
 
        # deleted, then we have {'foo':{'bar':{}}}
761
 
        deleted_paths = {}
762
 
        # XXX: Note that entries may have the wrong kind because the entry does
763
 
        # not reflect the status on disk.
764
 
        work_inv = self.work_tree.inventory
765
 
        # NB: entries will include entries within the excluded ids/paths
766
 
        # because iter_entries_by_dir has no 'exclude' facility today.
767
 
        entries = work_inv.iter_entries_by_dir(
768
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
769
 
        for path, existing_ie in entries:
770
 
            file_id = existing_ie.file_id
771
 
            name = existing_ie.name
772
 
            parent_id = existing_ie.parent_id
773
 
            kind = existing_ie.kind
774
 
            # Skip files that have been deleted from the working tree.
775
 
            # The deleted path ids are also recorded so they can be explicitly
776
 
            # unversioned later.
777
 
            if deleted_paths:
778
 
                path_segments = splitpath(path)
779
 
                deleted_dict = deleted_paths
780
 
                for segment in path_segments:
781
 
                    deleted_dict = deleted_dict.get(segment, None)
782
 
                    if not deleted_dict:
783
 
                        # We either took a path not present in the dict
784
 
                        # (deleted_dict was None), or we've reached an empty
785
 
                        # child dir in the dict, so are now a sub-path.
786
 
                        break
787
 
                else:
788
 
                    deleted_dict = None
789
 
                if deleted_dict is not None:
790
 
                    # the path has a deleted parent, do not add it.
791
 
                    continue
792
 
            if exclude and is_inside_any(exclude, path):
793
 
                # Skip excluded paths. Excluded paths are processed by
794
 
                # _update_builder_with_changes.
795
 
                continue
796
 
            content_summary = self.work_tree.path_content_summary(path)
797
 
            kind = content_summary[0]
798
 
            # Note that when a filter of specific files is given, we must only
799
 
            # skip/record deleted files matching that filter.
800
 
            if not specific_files or is_inside_any(specific_files, path):
801
 
                if kind == 'missing':
802
 
                    if not deleted_paths:
803
 
                        # path won't have been split yet.
804
 
                        path_segments = splitpath(path)
805
 
                    deleted_dict = deleted_paths
806
 
                    for segment in path_segments:
807
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
808
 
                    self.reporter.missing(path)
809
 
                    self._next_progress_entry()
810
 
                    deleted_ids.append(file_id)
811
 
                    continue
812
 
            # TODO: have the builder do the nested commit just-in-time IF and
813
 
            # only if needed.
814
 
            if kind == 'tree-reference':
815
 
                # enforce repository nested tree policy.
816
 
                if (not self.work_tree.supports_tree_reference() or
817
 
                    # repository does not support it either.
818
 
                    not self.branch.repository._format.supports_tree_reference):
819
 
                    kind = 'directory'
820
 
                    content_summary = (kind, None, None, None)
821
 
                elif self.recursive == 'down':
822
 
                    nested_revision_id = self._commit_nested_tree(
823
 
                        file_id, path)
824
 
                    content_summary = (kind, None, None, nested_revision_id)
825
 
                else:
826
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
827
 
                    content_summary = (kind, None, None, nested_revision_id)
828
 
 
829
 
            # Record an entry for this item
830
 
            # Note: I don't particularly want to have the existing_ie
831
 
            # parameter but the test suite currently (28-Jun-07) breaks
832
 
            # without it thanks to a unicode normalisation issue. :-(
833
 
            definitely_changed = kind != existing_ie.kind
834
 
            self._record_entry(path, file_id, specific_files, kind, name,
835
 
                parent_id, definitely_changed, existing_ie, report_changes,
836
 
                content_summary)
837
 
 
838
 
        # Unversion IDs that were found to be deleted
839
 
        self.deleted_ids = deleted_ids
840
 
 
841
 
    def _commit_nested_tree(self, file_id, path):
842
 
        "Commit a nested tree."
843
 
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
844
 
        # FIXME: be more comprehensive here:
845
 
        # this works when both trees are in --trees repository,
846
 
        # but when both are bound to a different repository,
847
 
        # it fails; a better way of approaching this is to
848
 
        # finally implement the explicit-caches approach design
849
 
        # a while back - RBC 20070306.
850
 
        if sub_tree.branch.repository.has_same_location(
851
 
            self.work_tree.branch.repository):
852
 
            sub_tree.branch.repository = \
853
 
                self.work_tree.branch.repository
854
 
        try:
855
 
            return sub_tree.commit(message=None, revprops=self.revprops,
856
 
                recursive=self.recursive,
857
 
                message_callback=self.message_callback,
858
 
                timestamp=self.timestamp, timezone=self.timezone,
859
 
                committer=self.committer,
860
 
                allow_pointless=self.allow_pointless,
861
 
                strict=self.strict, verbose=self.verbose,
862
 
                local=self.local, reporter=self.reporter)
863
 
        except errors.PointlessCommit:
864
 
            return self.work_tree.get_reference_revision(file_id)
865
 
 
866
 
    def _record_entry(self, path, file_id, specific_files, kind, name,
867
 
        parent_id, definitely_changed, existing_ie, report_changes,
868
 
        content_summary):
869
 
        "Record the new inventory entry for a path if any."
870
 
        # mutter('check %s {%s}', path, file_id)
871
 
        # mutter('%s selected for commit', path)
872
 
        if definitely_changed or existing_ie is None:
873
 
            ie = make_entry(kind, name, parent_id, file_id)
874
 
        else:
875
 
            ie = existing_ie.copy()
 
599
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
600
        assert self.work_inv.root is not None
 
601
        entries = self.work_inv.iter_entries()
 
602
        if not self.builder.record_root_entry:
 
603
            symbol_versioning.warn('CommitBuilders should support recording'
 
604
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
605
                stacklevel=1)
 
606
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
607
            entries.next()
 
608
            self._emit_progress_update()
 
609
        for path, new_ie in entries:
 
610
            self._emit_progress_update()
 
611
            file_id = new_ie.file_id
 
612
            try:
 
613
                kind = self.work_tree.kind(file_id)
 
614
                if kind == 'tree-reference' and self.recursive == 'down':
 
615
                    # nested tree: commit in it
 
616
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
617
                    # FIXME: be more comprehensive here:
 
618
                    # this works when both trees are in --trees repository,
 
619
                    # but when both are bound to a different repository,
 
620
                    # it fails; a better way of approaching this is to 
 
621
                    # finally implement the explicit-caches approach design
 
622
                    # a while back - RBC 20070306.
 
623
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
624
                        ==
 
625
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
626
                        sub_tree.branch.repository = \
 
627
                            self.work_tree.branch.repository
 
628
                    try:
 
629
                        sub_tree.commit(message=None, revprops=self.revprops,
 
630
                            recursive=self.recursive,
 
631
                            message_callback=self.message_callback,
 
632
                            timestamp=self.timestamp, timezone=self.timezone,
 
633
                            committer=self.committer,
 
634
                            allow_pointless=self.allow_pointless,
 
635
                            strict=self.strict, verbose=self.verbose,
 
636
                            local=self.local, reporter=self.reporter)
 
637
                    except errors.PointlessCommit:
 
638
                        pass
 
639
                if kind != new_ie.kind:
 
640
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
641
                                                  new_ie.parent_id, file_id)
 
642
            except errors.NoSuchFile:
 
643
                pass
 
644
            # mutter('check %s {%s}', path, file_id)
 
645
            if (not self.specific_files or 
 
646
                is_inside_or_parent_of_any(self.specific_files, path)):
 
647
                    # mutter('%s selected for commit', path)
 
648
                    ie = new_ie.copy()
 
649
                    ie.revision = None
 
650
            else:
 
651
                # mutter('%s not selected for commit', path)
 
652
                if self.basis_inv.has_id(file_id):
 
653
                    ie = self.basis_inv[file_id].copy()
 
654
                else:
 
655
                    # this entry is new and not being committed
 
656
                    continue
 
657
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
658
                path, self.work_tree)
 
659
            # describe the nature of the change that has occurred relative to
 
660
            # the basis inventory.
 
661
            if (self.basis_inv.has_id(ie.file_id)):
 
662
                basis_ie = self.basis_inv[ie.file_id]
 
663
            else:
 
664
                basis_ie = None
 
665
            change = ie.describe_change(basis_ie, ie)
 
666
            if change in (InventoryEntry.RENAMED, 
 
667
                InventoryEntry.MODIFIED_AND_RENAMED):
 
668
                old_path = self.basis_inv.id2path(ie.file_id)
 
669
                self.reporter.renamed(change, old_path, path)
 
670
            else:
 
671
                self.reporter.snapshot_change(change, path)
 
672
 
 
673
        if not self.specific_files:
 
674
            return
 
675
 
 
676
        # ignore removals that don't match filespec
 
677
        for path, new_ie in self.basis_inv.iter_entries():
 
678
            if new_ie.file_id in self.work_inv:
 
679
                continue
 
680
            if is_inside_any(self.specific_files, path):
 
681
                continue
 
682
            ie = new_ie.copy()
876
683
            ie.revision = None
877
 
        # For carried over entries we don't care about the fs hash - the repo
878
 
        # isn't generating a sha, so we're not saving computation time.
879
 
        _, _, fs_hash = self.builder.record_entry_contents(
880
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
881
 
        if report_changes:
882
 
            self._report_change(ie, path)
883
 
        if fs_hash:
884
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
885
 
        return ie
886
 
 
887
 
    def _report_change(self, ie, path):
888
 
        """Report a change to the user.
889
 
 
890
 
        The change that has occurred is described relative to the basis
891
 
        inventory.
892
 
        """
893
 
        if (self.basis_inv.has_id(ie.file_id)):
894
 
            basis_ie = self.basis_inv[ie.file_id]
895
 
        else:
896
 
            basis_ie = None
897
 
        change = ie.describe_change(basis_ie, ie)
898
 
        if change in (InventoryEntry.RENAMED,
899
 
            InventoryEntry.MODIFIED_AND_RENAMED):
900
 
            old_path = self.basis_inv.id2path(ie.file_id)
901
 
            self.reporter.renamed(change, old_path, path)
902
 
            self._next_progress_entry()
903
 
        else:
904
 
            if change == 'unchanged':
905
 
                return
906
 
            self.reporter.snapshot_change(change, path)
907
 
            self._next_progress_entry()
908
 
 
909
 
    def _set_progress_stage(self, name, counter=False):
910
 
        """Set the progress stage and emit an update to the progress bar."""
911
 
        self.pb_stage_name = name
912
 
        self.pb_stage_count += 1
913
 
        if counter:
914
 
            self.pb_entries_count = 0
915
 
        else:
916
 
            self.pb_entries_count = None
917
 
        self._emit_progress()
918
 
 
919
 
    def _next_progress_entry(self):
920
 
        """Emit an update to the progress bar and increment the entry count."""
921
 
        self.pb_entries_count += 1
922
 
        self._emit_progress()
923
 
 
924
 
    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)
928
 
        else:
929
 
            text = "%s - Stage" % (self.pb_stage_name, )
930
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
931
 
 
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
 
684
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
685
                                               self.basis_tree)
 
686
 
 
687
    def _emit_progress_update(self):
 
688
        """Emit an update to the progress bar."""
 
689
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
690
        self.pb_count += 1
 
691
 
 
692
    def _report_deletes(self):
 
693
        for path, ie in self.basis_inv.iter_entries():
 
694
            if ie.file_id not in self.builder.new_inventory:
 
695
                self.reporter.deleted(path)
 
696
 
 
697