~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-08-28 08:23:40 UTC
  • mfrom: (2757.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070828082340-2byilw23kzl3cjx4
(Daniel Watkins) Better explanation of -r in uncommit help

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