/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

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

Show diffs side-by-side

added added

removed removed

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