/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-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
from bzrlib import (
54
53
    debug,
55
54
    errors,
 
55
    revision,
56
56
    trace,
57
 
    ui,
 
57
    tree,
58
58
    )
59
 
from .branch import Branch
60
 
from .cleanup import ExitStack
61
 
import breezy.config
62
 
from .errors import (BzrError,
63
 
                     ConflictsInTree,
64
 
                     StrictCommitFailed
65
 
                     )
66
 
from .osutils import (get_user_encoding,
67
 
                      has_symlinks,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      )
71
 
from .trace import mutter, note, is_quiet
72
 
from .urlutils import unescape_for_display
73
 
from .i18n import gettext
74
 
 
75
 
 
76
 
class PointlessCommit(BzrError):
77
 
 
78
 
    _fmt = "No changes to commit"
79
 
 
80
 
 
81
 
class CannotCommitSelectedFileMerge(BzrError):
82
 
 
83
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
84
 
        ' files %(files_str)s'
85
 
 
86
 
    def __init__(self, files):
87
 
        files_str = ', '.join(files)
88
 
        BzrError.__init__(self, files=files, files_str=files_str)
89
 
 
90
 
 
91
 
def filter_excluded(iter_changes, exclude):
92
 
    """Filter exclude filenames.
93
 
 
94
 
    :param iter_changes: iter_changes function
95
 
    :param exclude: List of paths to exclude
96
 
    :return: iter_changes function
97
 
    """
98
 
    for change in iter_changes:
99
 
        new_excluded = (change.path[1] is not None and
100
 
                        is_inside_any(exclude, change.path[1]))
101
 
 
102
 
        old_excluded = (change.path[0] is not None and
103
 
                        is_inside_any(exclude, change.path[0]))
104
 
 
105
 
        if old_excluded and new_excluded:
106
 
            continue
107
 
 
108
 
        if old_excluded or new_excluded:
109
 
            # TODO(jelmer): Perhaps raise an error here instead?
110
 
            continue
111
 
 
112
 
        yield change
 
59
from bzrlib.branch import Branch
 
60
from bzrlib.cleanup import OperationWithCleanups
 
61
import bzrlib.config
 
62
from bzrlib.errors import (BzrError, PointlessCommit,
 
63
                           ConflictsInTree,
 
64
                           StrictCommitFailed
 
65
                           )
 
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
 
73
from bzrlib import symbol_versioning
 
74
from bzrlib.urlutils import unescape_for_display
 
75
import bzrlib.ui
113
76
 
114
77
 
115
78
class NullCommitReporter(object):
116
79
    """I report on progress of a commit."""
117
80
 
118
 
    def started(self, revno, revid, location):
 
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)
119
86
        pass
120
87
 
121
88
    def snapshot_change(self, change, path):
147
114
        note(format, *args)
148
115
 
149
116
    def snapshot_change(self, change, path):
150
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
117
        if path == '' and change in ('added', 'modified'):
151
118
            return
152
119
        self._note("%s %s", change, path)
153
120
 
154
 
    def started(self, revno, rev_id, location):
155
 
        self._note(
156
 
            gettext('Committing to: %s'),
157
 
            unescape_for_display(location, 'utf-8'))
 
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)
158
132
 
159
133
    def completed(self, revno, rev_id):
160
 
        if revno is not None:
161
 
            self._note(gettext('Committed revision %d.'), revno)
162
 
            # self._note goes to the console too; so while we want to log the
163
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
164
 
            # term we should rearrange the reporting structure, but for now
165
 
            # we just mutter seperately. We mutter the revid and revno together
166
 
            # so that concurrent bzr invocations won't lead to confusion.
167
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
168
 
        else:
169
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
134
        self._note('Committed revision %d.', revno)
 
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)
170
141
 
171
142
    def deleted(self, path):
172
 
        self._note(gettext('deleted %s'), path)
 
143
        self._note('deleted %s', path)
173
144
 
174
145
    def missing(self, path):
175
 
        self._note(gettext('missing %s'), path)
 
146
        self._note('missing %s', path)
176
147
 
177
148
    def renamed(self, change, old_path, new_path):
178
149
        self._note('%s %s => %s', change, old_path, new_path)
193
164
            the working directory; these should be removed from the
194
165
            working inventory.
195
166
    """
196
 
 
197
167
    def __init__(self,
198
168
                 reporter=None,
199
 
                 config_stack=None):
 
169
                 config=None):
200
170
        """Create a Commit object.
201
171
 
202
172
        :param reporter: the default reporter to use or None to decide later
203
173
        """
204
174
        self.reporter = reporter
205
 
        self.config_stack = config_stack
206
 
 
207
 
    @staticmethod
208
 
    def update_revprops(revprops, branch, authors=None,
209
 
                        local=False, possible_master_transports=None):
210
 
        if revprops is None:
211
 
            revprops = {}
212
 
        if possible_master_transports is None:
213
 
            possible_master_transports = []
214
 
        if (u'branch-nick' not in revprops and
215
 
                branch.repository._format.supports_storing_branch_nick):
216
 
            revprops[u'branch-nick'] = branch._get_nick(
217
 
                local,
218
 
                possible_master_transports)
219
 
        if authors is not None:
220
 
            if u'author' in revprops or u'authors' in revprops:
221
 
                # XXX: maybe we should just accept one of them?
222
 
                raise AssertionError('author property given twice')
223
 
            if authors:
224
 
                for individual in authors:
225
 
                    if '\n' in individual:
226
 
                        raise AssertionError('\\n is not a valid character '
227
 
                                             'in an author identity')
228
 
                revprops[u'authors'] = '\n'.join(authors)
229
 
        return revprops
 
175
        self.config = config
230
176
 
231
177
    def commit(self,
232
178
               message=None,
246
192
               message_callback=None,
247
193
               recursive='down',
248
194
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
195
               possible_master_transports=None):
251
196
        """Commit working copy as a new revision.
252
197
 
253
198
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message =
255
 
            message_callback(cmt_obj)
 
199
        :param message_callback: A callback: message = message_callback(cmt_obj)
256
200
 
257
201
        :param timestamp: if not None, seconds-since-epoch for a
258
202
            postdated/predated commit.
281
225
        :param exclude: None or a list of relative paths to exclude from the
282
226
            commit. Pending changes to excluded files will be ignored by the
283
227
            commit.
284
 
        :param lossy: When committing to a foreign VCS, ignore any
285
 
            data that can not be natively represented.
286
 
        """
287
 
        with ExitStack() as stack:
288
 
            self.revprops = revprops or {}
289
 
            # XXX: Can be set on __init__ or passed in - this is a bit ugly.
290
 
            self.config_stack = config or self.config_stack
291
 
            mutter('preparing to commit')
292
 
 
293
 
            if working_tree is None:
294
 
                raise BzrError("working_tree must be passed into commit().")
295
 
            else:
296
 
                self.work_tree = working_tree
297
 
                self.branch = self.work_tree.branch
298
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
299
 
                    if not self.branch.repository.supports_rich_root():
300
 
                        raise errors.RootNotRich()
301
 
            if message_callback is None:
302
 
                if message is not None:
303
 
                    if isinstance(message, bytes):
304
 
                        message = message.decode(get_user_encoding())
305
 
 
306
 
                    def message_callback(x):
307
 
                        return message
308
 
                else:
309
 
                    raise BzrError("The message or message_callback keyword"
310
 
                                   " parameter is required for commit().")
311
 
 
312
 
            self.bound_branch = None
313
 
            self.any_entries_deleted = False
314
 
            if exclude is not None:
315
 
                self.exclude = sorted(
316
 
                    minimum_path_selection(exclude))
317
 
            else:
318
 
                self.exclude = []
319
 
            self.local = local
320
 
            self.master_branch = None
321
 
            self.recursive = recursive
322
 
            self.rev_id = None
323
 
            # self.specific_files is None to indicate no filter, or any iterable to
324
 
            # indicate a filter - [] means no files at all, as per iter_changes.
325
 
            if specific_files is not None:
326
 
                self.specific_files = sorted(
327
 
                    minimum_path_selection(specific_files))
328
 
            else:
329
 
                self.specific_files = None
330
 
 
331
 
            self.allow_pointless = allow_pointless
332
 
            self.message_callback = message_callback
333
 
            self.timestamp = timestamp
334
 
            self.timezone = timezone
335
 
            self.committer = committer
336
 
            self.strict = strict
337
 
            self.verbose = verbose
338
 
 
339
 
            stack.enter_context(self.work_tree.lock_write())
340
 
            self.parents = self.work_tree.get_parent_ids()
341
 
            self.pb = ui.ui_factory.nested_progress_bar()
342
 
            stack.callback(self.pb.finished)
343
 
            self.basis_revid = self.work_tree.last_revision()
344
 
            self.basis_tree = self.work_tree.basis_tree()
345
 
            stack.enter_context(self.basis_tree.lock_read())
346
 
            # Cannot commit with conflicts present.
347
 
            if len(self.work_tree.conflicts()) > 0:
348
 
                raise ConflictsInTree
349
 
 
350
 
            # Setup the bound branch variables as needed.
351
 
            self._check_bound_branch(stack, possible_master_transports)
352
 
            if self.config_stack is None:
353
 
                self.config_stack = self.work_tree.get_config_stack()
354
 
 
355
 
            # Check that the working tree is up to date
356
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
357
 
 
358
 
            # Complete configuration setup
359
 
            if reporter is not None:
360
 
                self.reporter = reporter
361
 
            elif self.reporter is None:
362
 
                self.reporter = self._select_reporter()
363
 
 
364
 
            # Setup the progress bar. As the number of files that need to be
365
 
            # committed in unknown, progress is reported as stages.
366
 
            # We keep track of entries separately though and include that
367
 
            # information in the progress bar during the relevant stages.
368
 
            self.pb_stage_name = ""
369
 
            self.pb_stage_count = 0
370
 
            self.pb_stage_total = 5
371
 
            if self.bound_branch:
372
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
373
 
                # tags to master branch"
374
 
                self.pb_stage_total += 2
375
 
            self.pb.show_pct = False
376
 
            self.pb.show_spinner = False
377
 
            self.pb.show_eta = False
378
 
            self.pb.show_count = True
379
 
            self.pb.show_bar = True
380
 
 
381
 
            # After a merge, a selected file commit is not supported.
382
 
            # See 'bzr help merge' for an explanation as to why.
383
 
            if len(self.parents) > 1 and self.specific_files is not None:
384
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
385
 
            # Excludes are a form of selected file commit.
386
 
            if len(self.parents) > 1 and self.exclude:
387
 
                raise CannotCommitSelectedFileMerge(self.exclude)
388
 
 
389
 
            # Collect the changes
390
 
            self._set_progress_stage("Collecting changes", counter=True)
391
 
            self._lossy = lossy
392
 
            self.builder = self.branch.get_commit_builder(
393
 
                self.parents, self.config_stack, timestamp, timezone, committer,
394
 
                self.revprops, rev_id, lossy=lossy)
395
 
 
396
 
            if self.builder.updates_branch and self.bound_branch:
397
 
                self.builder.abort()
398
 
                raise AssertionError(
399
 
                    "bound branches not supported for commit builders "
400
 
                    "that update the branch")
401
 
 
402
 
            try:
403
 
                # find the location being committed to
404
 
                if self.bound_branch:
405
 
                    master_location = self.master_branch.base
406
 
                else:
407
 
                    master_location = self.branch.base
408
 
 
409
 
                # report the start of the commit
410
 
                self.reporter.started(new_revno, self.rev_id, master_location)
411
 
 
412
 
                self._update_builder_with_changes()
413
 
                self._check_pointless()
414
 
 
415
 
                # TODO: Now the new inventory is known, check for conflicts.
416
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
417
 
                # weave lines, because nothing should be recorded until it is known
418
 
                # that commit will succeed.
419
 
                self._set_progress_stage("Saving data locally")
420
 
                self.builder.finish_inventory()
421
 
 
422
 
                # Prompt the user for a commit message if none provided
423
 
                message = message_callback(self)
424
 
                self.message = message
425
 
 
426
 
                # Add revision data to the local branch
427
 
                self.rev_id = self.builder.commit(self.message)
428
 
 
429
 
            except Exception:
430
 
                mutter("aborting commit write group because of exception:")
431
 
                trace.log_exception_quietly()
432
 
                self.builder.abort()
433
 
                raise
434
 
 
435
 
            self._update_branches(old_revno, old_revid, new_revno)
436
 
 
437
 
            # Make the working tree be up to date with the branch. This
438
 
            # includes automatic changes scheduled to be made to the tree, such
439
 
            # as updating its basis and unversioning paths that were missing.
440
 
            self.work_tree.unversion(self.deleted_paths)
441
 
            self._set_progress_stage("Updating the working tree")
442
 
            self.work_tree.update_basis_by_delta(
443
 
                self.rev_id, self.builder.get_basis_delta())
444
 
            self.reporter.completed(new_revno, self.rev_id)
445
 
            self._process_post_hooks(old_revno, new_revno)
446
 
            return self.rev_id
447
 
 
448
 
    def _update_branches(self, old_revno, old_revid, new_revno):
449
 
        """Update the master and local branch to the new revision.
450
 
 
451
 
        This will try to make sure that the master branch is updated
452
 
        before the local branch.
453
 
 
454
 
        :param old_revno: Revision number of master branch before the
455
 
            commit
456
 
        :param old_revid: Tip of master branch before the commit
457
 
        :param new_revno: Revision number of the new commit
458
 
        """
459
 
        if not self.builder.updates_branch:
460
 
            self._process_pre_hooks(old_revno, new_revno)
461
 
 
462
 
            # Upload revision data to the master.
463
 
            # this will propagate merged revisions too if needed.
464
 
            if self.bound_branch:
465
 
                self._set_progress_stage("Uploading data to master branch")
466
 
                # 'commit' to the master first so a timeout here causes the
467
 
                # local branch to be out of date
468
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
469
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
470
 
                if self._lossy:
471
 
                    self.branch.fetch(self.master_branch, self.rev_id)
472
 
 
473
 
            # and now do the commit locally.
474
 
            if new_revno is None:
475
 
                # Keep existing behaviour around ghosts
476
 
                new_revno = 1
477
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
478
 
        else:
479
 
            try:
480
 
                self._process_pre_hooks(old_revno, new_revno)
481
 
            except BaseException:
482
 
                # The commit builder will already have updated the branch,
483
 
                # revert it.
484
 
                self.branch.set_last_revision_info(old_revno, old_revid)
485
 
                raise
486
 
 
487
 
        # Merge local tags to remote
488
 
        if self.bound_branch:
489
 
            self._set_progress_stage("Merging tags to master branch")
490
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
491
 
                self.master_branch.tags)
492
 
            if tag_conflicts:
493
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
494
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
495
 
                    "\n".join(warning_lines))))
 
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):
 
255
        mutter('preparing to commit')
 
256
 
 
257
        if working_tree is None:
 
258
            raise BzrError("working_tree must be passed into commit().")
 
259
        else:
 
260
            self.work_tree = working_tree
 
261
            self.branch = self.work_tree.branch
 
262
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
263
                if not self.branch.repository.supports_rich_root():
 
264
                    raise errors.RootNotRich()
 
265
        if message_callback is None:
 
266
            if message is not None:
 
267
                if isinstance(message, str):
 
268
                    message = message.decode(get_user_encoding())
 
269
                message_callback = lambda x: message
 
270
            else:
 
271
                raise BzrError("The message or message_callback keyword"
 
272
                               " parameter is required for commit().")
 
273
 
 
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 = []
 
281
        self.local = local
 
282
        self.master_branch = None
 
283
        self.recursive = recursive
 
284
        self.rev_id = None
 
285
        # self.specific_files is None to indicate no filter, or any iterable to
 
286
        # indicate a filter - [] means no files at all, as per iter_changes.
 
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
            
 
293
        self.allow_pointless = allow_pointless
 
294
        self.message_callback = message_callback
 
295
        self.timestamp = timestamp
 
296
        self.timezone = timezone
 
297
        self.committer = committer
 
298
        self.strict = strict
 
299
        self.verbose = verbose
 
300
 
 
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))
 
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()
 
315
        self.basis_tree = self.work_tree.basis_tree()
 
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
 
 
367
        try:
 
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)
 
425
        return self.rev_id
496
426
 
497
427
    def _select_reporter(self):
498
428
        """Select the CommitReporter to use."""
506
436
        # A merge with no effect on files
507
437
        if len(self.parents) > 1:
508
438
            return
 
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)):
 
447
            raise PointlessCommit()
509
448
        if self.builder.any_changes():
510
449
            return
511
450
        raise PointlessCommit()
512
451
 
513
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
 
452
    def _check_bound_branch(self, operation, possible_master_transports=None):
514
453
        """Check to see if the local branch is bound.
515
454
 
516
455
        If it is bound, then most of the commit will actually be
532
471
        # If the master branch is bound, we must fail
533
472
        master_bound_location = self.master_branch.get_bound_location()
534
473
        if master_bound_location:
535
 
            raise errors.CommitToDoubleBoundBranch(
536
 
                self.branch, self.master_branch, master_bound_location)
 
474
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
475
                    self.master_branch, master_bound_location)
537
476
 
538
477
        # TODO: jam 20051230 We could automatically push local
539
478
        #       commits to the remote branch if they would fit.
541
480
        #       to local.
542
481
 
543
482
        # Make sure the local branch is identical to the master
544
 
        master_revid = self.master_branch.last_revision()
545
 
        local_revid = self.branch.last_revision()
546
 
        if local_revid != master_revid:
 
483
        master_info = self.master_branch.last_revision_info()
 
484
        local_info = self.branch.last_revision_info()
 
485
        if local_info != master_info:
547
486
            raise errors.BoundBranchOutOfDate(self.branch,
548
 
                                              self.master_branch)
 
487
                    self.master_branch)
549
488
 
550
489
        # Now things are ready to change the master branch
551
490
        # so grab the lock
552
491
        self.bound_branch = self.branch
553
 
        stack.enter_context(self.master_branch.lock_write())
 
492
        self.master_branch.lock_write()
 
493
        operation.add_cleanup(self.master_branch.unlock)
554
494
 
555
495
    def _check_out_of_date_tree(self):
556
496
        """Check that the working tree is up to date.
557
497
 
558
 
        :return: old_revision_number, old_revision_id, new_revision_number
559
 
            tuple
 
498
        :return: old_revision_number,new_revision_number tuple
560
499
        """
561
500
        try:
562
501
            first_tree_parent = self.work_tree.get_parent_ids()[0]
565
504
            # this is so that we still consider the master branch
566
505
            # - in a checkout scenario the tree may have no
567
506
            # parents but the branch may do.
568
 
            first_tree_parent = breezy.revision.NULL_REVISION
569
 
        if (self.master_branch._format.stores_revno() or
570
 
                self.config_stack.get('calculate_revnos')):
571
 
            try:
572
 
                old_revno, master_last = self.master_branch.last_revision_info()
573
 
            except errors.UnsupportedOperation:
574
 
                master_last = self.master_branch.last_revision()
575
 
                old_revno = self.branch.revision_id_to_revno(master_last)
576
 
        else:
577
 
            master_last = self.master_branch.last_revision()
578
 
            old_revno = None
 
507
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
508
        old_revno, master_last = self.master_branch.last_revision_info()
579
509
        if master_last != first_tree_parent:
580
 
            if master_last != breezy.revision.NULL_REVISION:
 
510
            if master_last != bzrlib.revision.NULL_REVISION:
581
511
                raise errors.OutOfDateTree(self.work_tree)
582
 
        if (old_revno is not None and
583
 
                self.branch.repository.has_revision(first_tree_parent)):
 
512
        if self.branch.repository.has_revision(first_tree_parent):
584
513
            new_revno = old_revno + 1
585
514
        else:
586
515
            # ghost parents never appear in revision history.
587
 
            new_revno = None
588
 
        return old_revno, master_last, new_revno
 
516
            new_revno = 1
 
517
        return old_revno,new_revno
589
518
 
590
519
    def _process_pre_hooks(self, old_revno, new_revno):
591
520
        """Process any registered pre commit hooks."""
597
526
        # Process the post commit hooks, if any
598
527
        self._set_progress_stage("Running post_commit hooks")
599
528
        # old style commit hooks - should be deprecated ? (obsoleted in
600
 
        # 0.15^H^H^H^H 2.5.0)
601
 
        post_commit = self.config_stack.get('post_commit')
602
 
        if post_commit is not None:
603
 
            hooks = post_commit.split(' ')
 
529
        # 0.15)
 
530
        if self.config.post_commit() is not None:
 
531
            hooks = self.config.post_commit().split(' ')
604
532
            # this would be nicer with twisted.python.reflect.namedAny
605
533
            for hook in hooks:
606
534
                result = eval(hook + '(branch, rev_id)',
607
 
                              {'branch': self.branch,
608
 
                               'breezy': breezy,
609
 
                               'rev_id': self.rev_id})
 
535
                              {'branch':self.branch,
 
536
                               'bzrlib':bzrlib,
 
537
                               'rev_id':self.rev_id})
610
538
        # process new style post commit hooks
611
539
        self._process_hooks("post_commit", old_revno, new_revno)
612
540
 
627
555
        if self.parents:
628
556
            old_revid = self.parents[0]
629
557
        else:
630
 
            old_revid = breezy.revision.NULL_REVISION
 
558
            old_revid = bzrlib.revision.NULL_REVISION
631
559
 
632
560
        if hook_name == "pre_commit":
633
561
            future_tree = self.builder.revision_tree()
634
562
            tree_delta = future_tree.changes_from(self.basis_tree,
635
 
                                                  include_root=True)
 
563
                                             include_root=True)
636
564
 
637
565
        for hook in Branch.hooks[hook_name]:
638
566
            # show the running hook in the progress bar. As hooks may
653
581
                     old_revno, old_revid, new_revno, self.rev_id,
654
582
                     tree_delta, future_tree)
655
583
 
 
584
    def _gather_parents(self):
 
585
        """Record the parents of a merge for merge detection."""
 
586
        # TODO: Make sure that this list doesn't contain duplicate
 
587
        # entries and the order is preserved when doing this.
 
588
        if self.use_record_iter_changes:
 
589
            return
 
590
        self.basis_inv = self.basis_tree.inventory
 
591
        self.parent_invs = [self.basis_inv]
 
592
        for revision in self.parents[1:]:
 
593
            if self.branch.repository.has_revision(revision):
 
594
                mutter('commit parent revision {%s}', revision)
 
595
                inventory = self.branch.repository.get_inventory(revision)
 
596
                self.parent_invs.append(inventory)
 
597
            else:
 
598
                mutter('commit parent ghost revision {%s}', revision)
 
599
 
656
600
    def _update_builder_with_changes(self):
657
601
        """Update the commit builder with the data about what has changed.
658
602
        """
 
603
        exclude = self.exclude
659
604
        specific_files = self.specific_files
660
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
605
        mutter("Selecting files for commit with filter %s", specific_files)
661
606
 
662
607
        self._check_strict()
663
 
        iter_changes = self.work_tree.iter_changes(
664
 
            self.basis_tree, specific_files=specific_files)
665
 
        if self.exclude:
666
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
667
 
        iter_changes = self._filter_iter_changes(iter_changes)
668
 
        for path, fs_hash in self.builder.record_iter_changes(
 
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(
669
613
                self.work_tree, self.basis_revid, iter_changes):
670
 
            self.work_tree._observed_sha1(path, fs_hash)
 
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()
671
620
 
672
621
    def _filter_iter_changes(self, iter_changes):
673
622
        """Process iter_changes.
674
623
 
675
 
        This method reports on the changes in iter_changes to the user, and
 
624
        This method reports on the changes in iter_changes to the user, and 
676
625
        converts 'missing' entries in the iter_changes iterator to 'deleted'
677
626
        entries. 'missing' entries have their
678
627
 
681
630
        """
682
631
        reporter = self.reporter
683
632
        report_changes = reporter.is_verbose()
684
 
        deleted_paths = []
 
633
        deleted_ids = []
685
634
        for change in iter_changes:
686
635
            if report_changes:
687
 
                old_path = change.path[0]
688
 
                new_path = change.path[1]
689
 
                versioned = change.versioned[1]
690
 
            kind = change.kind[1]
691
 
            versioned = change.versioned[1]
 
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]
692
641
            if kind is None and versioned:
693
642
                # 'missing' path
694
643
                if report_changes:
695
644
                    reporter.missing(new_path)
696
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
697
 
                    trace.warning('Ignoring "%s" as symlinks are not '
698
 
                                  'supported on this filesystem.' % (change.path[0],))
699
 
                    continue
700
 
                deleted_paths.append(change.path[1])
 
645
                deleted_ids.append(change[0])
701
646
                # Reset the new path (None) and new versioned flag (False)
702
 
                change = change.discard_new()
703
 
                new_path = change.path[1]
704
 
                versioned = False
 
647
                change = (change[0], (change[1][0], None), change[2],
 
648
                    (change[3][0], False)) + change[4:]
705
649
            elif kind == 'tree-reference':
706
650
                if self.recursive == 'down':
707
 
                    self._commit_nested_tree(change.path[1])
708
 
            if change.versioned[0] or change.versioned[1]:
 
651
                    self._commit_nested_tree(change[0], change[1][1])
 
652
            if change[3][0] or change[3][1]:
709
653
                yield change
710
654
                if report_changes:
711
655
                    if new_path is None:
712
656
                        reporter.deleted(old_path)
713
657
                    elif old_path is None:
714
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
658
                        reporter.snapshot_change('added', new_path)
715
659
                    elif old_path != new_path:
716
 
                        reporter.renamed(gettext('renamed'),
717
 
                                         old_path, new_path)
 
660
                        reporter.renamed('renamed', old_path, new_path)
718
661
                    else:
719
 
                        if (new_path
720
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
662
                        if (new_path or 
 
663
                            self.work_tree.branch.repository._format.rich_root_data):
721
664
                            # Don't report on changes to '' in non rich root
722
665
                            # repositories.
723
 
                            reporter.snapshot_change(
724
 
                                gettext('modified'), new_path)
 
666
                            reporter.snapshot_change('modified', new_path)
725
667
            self._next_progress_entry()
726
 
        # Unversion files that were found to be deleted
727
 
        self.deleted_paths = deleted_paths
 
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)
728
720
 
729
721
    def _check_strict(self):
730
722
        # XXX: when we use iter_changes this would likely be faster if
735
727
            for unknown in self.work_tree.unknowns():
736
728
                raise StrictCommitFailed()
737
729
 
738
 
    def _commit_nested_tree(self, path):
 
730
    def _populate_from_inventory(self):
 
731
        """Populate the CommitBuilder by walking the working tree inventory."""
 
732
        # Build the revision inventory.
 
733
        #
 
734
        # This starts by creating a new empty inventory. Depending on
 
735
        # which files are selected for commit, and what is present in the
 
736
        # current tree, the new inventory is populated. inventory entries
 
737
        # which are candidates for modification have their revision set to
 
738
        # None; inventory entries that are carried over untouched have their
 
739
        # revision set to their prior value.
 
740
        #
 
741
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
742
        # results to create a new inventory at the same time, which results
 
743
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
744
        # ADHB 11-07-2006
 
745
 
 
746
        specific_files = self.specific_files
 
747
        exclude = self.exclude
 
748
        report_changes = self.reporter.is_verbose()
 
749
        deleted_ids = []
 
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.
 
755
        work_inv = self.work_tree.inventory
 
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)
 
760
        for path, existing_ie in entries:
 
761
            file_id = existing_ie.file_id
 
762
            name = existing_ie.name
 
763
            parent_id = existing_ie.parent_id
 
764
            kind = existing_ie.kind
 
765
            # Skip files that have been deleted from the working tree.
 
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.
 
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.
 
791
            if not specific_files or is_inside_any(specific_files, 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, {})
 
799
                    self.reporter.missing(path)
 
800
                    self._next_progress_entry()
 
801
                    deleted_ids.append(file_id)
 
802
                    continue
 
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)
 
819
 
 
820
            # Record an entry for this item
 
821
            # Note: I don't particularly want to have the existing_ie
 
822
            # parameter but the test suite currently (28-Jun-07) breaks
 
823
            # without it thanks to a unicode normalisation issue. :-(
 
824
            definitely_changed = kind != existing_ie.kind
 
825
            self._record_entry(path, file_id, specific_files, kind, name,
 
826
                parent_id, definitely_changed, existing_ie, report_changes,
 
827
                content_summary)
 
828
 
 
829
        # Unversion IDs that were found to be deleted
 
830
        self.deleted_ids = deleted_ids
 
831
 
 
832
    def _commit_nested_tree(self, file_id, path):
739
833
        "Commit a nested tree."
740
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
834
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
741
835
        # FIXME: be more comprehensive here:
742
836
        # this works when both trees are in --trees repository,
743
837
        # but when both are bound to a different repository,
745
839
        # finally implement the explicit-caches approach design
746
840
        # a while back - RBC 20070306.
747
841
        if sub_tree.branch.repository.has_same_location(
748
 
                self.work_tree.branch.repository):
 
842
            self.work_tree.branch.repository):
749
843
            sub_tree.branch.repository = \
750
844
                self.work_tree.branch.repository
751
845
        try:
752
846
            return sub_tree.commit(message=None, revprops=self.revprops,
753
 
                                   recursive=self.recursive,
754
 
                                   message_callback=self.message_callback,
755
 
                                   timestamp=self.timestamp,
756
 
                                   timezone=self.timezone,
757
 
                                   committer=self.committer,
758
 
                                   allow_pointless=self.allow_pointless,
759
 
                                   strict=self.strict, verbose=self.verbose,
760
 
                                   local=self.local, reporter=self.reporter)
761
 
        except PointlessCommit:
762
 
            return self.work_tree.get_reference_revision(path)
 
847
                recursive=self.recursive,
 
848
                message_callback=self.message_callback,
 
849
                timestamp=self.timestamp, timezone=self.timezone,
 
850
                committer=self.committer,
 
851
                allow_pointless=self.allow_pointless,
 
852
                strict=self.strict, verbose=self.verbose,
 
853
                local=self.local, reporter=self.reporter)
 
854
        except errors.PointlessCommit:
 
855
            return self.work_tree.get_reference_revision(file_id)
 
856
 
 
857
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
858
        parent_id, definitely_changed, existing_ie, report_changes,
 
859
        content_summary):
 
860
        "Record the new inventory entry for a path if any."
 
861
        # mutter('check %s {%s}', path, file_id)
 
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)
 
865
        else:
 
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:
 
873
            self._report_change(ie, path)
 
874
        if fs_hash:
 
875
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
876
        return ie
 
877
 
 
878
    def _report_change(self, ie, path):
 
879
        """Report a change to the user.
 
880
 
 
881
        The change that has occurred is described relative to the basis
 
882
        inventory.
 
883
        """
 
884
        if (self.basis_inv.has_id(ie.file_id)):
 
885
            basis_ie = self.basis_inv[ie.file_id]
 
886
        else:
 
887
            basis_ie = None
 
888
        change = ie.describe_change(basis_ie, ie)
 
889
        if change in (InventoryEntry.RENAMED,
 
890
            InventoryEntry.MODIFIED_AND_RENAMED):
 
891
            old_path = self.basis_inv.id2path(ie.file_id)
 
892
            self.reporter.renamed(change, old_path, path)
 
893
            self._next_progress_entry()
 
894
        else:
 
895
            if change == 'unchanged':
 
896
                return
 
897
            self.reporter.snapshot_change(change, path)
 
898
            self._next_progress_entry()
763
899
 
764
900
    def _set_progress_stage(self, name, counter=False):
765
901
        """Set the progress stage and emit an update to the progress bar."""
778
914
 
779
915
    def _emit_progress(self):
780
916
        if self.pb_entries_count is not None:
781
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
782
 
                                                       self.pb_entries_count)
 
917
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
918
                self.pb_entries_count)
783
919
        else:
784
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
920
            text = "%s - Stage" % (self.pb_stage_name, )
785
921
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
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