/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: Andrew Bennetts
  • Date: 2011-06-09 07:38:32 UTC
  • mto: This revision was merged to the branch mainline in revision 5964.
  • Revision ID: andrew.bennetts@canonical.com-20110609073832-dt6oww033iexli4l
Fix thinko in wording regarding stacking invariants and revisions with multiple parents.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
17
18
# The newly committed revision is going to have a shape corresponding
18
19
# to that of the working tree.  Files that are not in the
19
20
# working tree and that were in the predecessor are reported as
48
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
49
50
# the rest of the code; add a deprecation of the old name.
50
51
 
51
 
from . import (
 
52
from bzrlib import (
52
53
    debug,
53
54
    errors,
 
55
    revision,
54
56
    trace,
 
57
    tree,
55
58
    ui,
56
59
    )
57
 
from .branch import Branch
58
 
from contextlib import ExitStack
59
 
import breezy.config
60
 
from .errors import (BzrError,
61
 
                     ConflictsInTree,
62
 
                     StrictCommitFailed
63
 
                     )
64
 
from .osutils import (get_user_encoding,
65
 
                      has_symlinks,
66
 
                      is_inside_any,
67
 
                      minimum_path_selection,
68
 
                      )
69
 
from .trace import mutter, note, is_quiet
70
 
from .tree import TreeChange
71
 
from .urlutils import unescape_for_display
72
 
from .i18n import gettext
73
 
 
74
 
 
75
 
class PointlessCommit(BzrError):
76
 
 
77
 
    _fmt = "No changes to commit"
78
 
 
79
 
 
80
 
class CannotCommitSelectedFileMerge(BzrError):
81
 
 
82
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
83
 
        ' files %(files_str)s'
84
 
 
85
 
    def __init__(self, files):
86
 
        files_str = ', '.join(files)
87
 
        BzrError.__init__(self, files=files, files_str=files_str)
88
 
 
89
 
 
90
 
def filter_excluded(iter_changes, exclude):
91
 
    """Filter exclude filenames.
92
 
 
93
 
    :param iter_changes: iter_changes function
94
 
    :param exclude: List of paths to exclude
95
 
    :return: iter_changes function
96
 
    """
97
 
    for change in iter_changes:
98
 
        new_excluded = (change.path[1] is not None and
99
 
                        is_inside_any(exclude, change.path[1]))
100
 
 
101
 
        old_excluded = (change.path[0] is not None and
102
 
                        is_inside_any(exclude, change.path[0]))
103
 
 
104
 
        if old_excluded and new_excluded:
105
 
            continue
106
 
 
107
 
        if old_excluded or new_excluded:
108
 
            # TODO(jelmer): Perhaps raise an error here instead?
109
 
            continue
110
 
 
111
 
        yield change
 
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
 
62
import bzrlib.config
 
63
from bzrlib.errors import (BzrError, PointlessCommit,
 
64
                           ConflictsInTree,
 
65
                           StrictCommitFailed
 
66
                           )
 
67
from bzrlib.osutils import (get_user_encoding,
 
68
                            is_inside_any,
 
69
                            minimum_path_selection,
 
70
                            splitpath,
 
71
                            )
 
72
from bzrlib.trace import mutter, note, is_quiet
 
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib import symbol_versioning
 
75
from bzrlib.urlutils import unescape_for_display
112
76
 
113
77
 
114
78
class NullCommitReporter(object):
115
79
    """I report on progress of a commit."""
116
80
 
117
 
    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)
118
86
        pass
119
87
 
120
88
    def snapshot_change(self, change, path):
146
114
        note(format, *args)
147
115
 
148
116
    def snapshot_change(self, change, path):
149
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
117
        if path == '' and change in ('added', 'modified'):
150
118
            return
151
119
        self._note("%s %s", change, path)
152
120
 
153
 
    def started(self, revno, rev_id, location):
154
 
        self._note(
155
 
            gettext('Committing to: %s'),
156
 
            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)
157
132
 
158
133
    def completed(self, revno, rev_id):
159
 
        if revno is not None:
160
 
            self._note(gettext('Committed revision %d.'), revno)
161
 
            # self._note goes to the console too; so while we want to log the
162
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
163
 
            # term we should rearrange the reporting structure, but for now
164
 
            # we just mutter seperately. We mutter the revid and revno together
165
 
            # so that concurrent bzr invocations won't lead to confusion.
166
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
167
 
        else:
168
 
            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)
169
141
 
170
142
    def deleted(self, path):
171
 
        self._note(gettext('deleted %s'), path)
 
143
        self._note('deleted %s', path)
172
144
 
173
145
    def missing(self, path):
174
 
        self._note(gettext('missing %s'), path)
 
146
        self._note('missing %s', path)
175
147
 
176
148
    def renamed(self, change, old_path, new_path):
177
149
        self._note('%s %s => %s', change, old_path, new_path)
192
164
            the working directory; these should be removed from the
193
165
            working inventory.
194
166
    """
195
 
 
196
167
    def __init__(self,
197
168
                 reporter=None,
198
 
                 config_stack=None):
 
169
                 config=None):
199
170
        """Create a Commit object.
200
171
 
201
172
        :param reporter: the default reporter to use or None to decide later
202
173
        """
203
174
        self.reporter = reporter
204
 
        self.config_stack = config_stack
 
175
        self.config = config
205
176
 
206
177
    @staticmethod
207
 
    def update_revprops(revprops, branch, authors=None,
 
178
    def update_revprops(revprops, branch, authors=None, author=None,
208
179
                        local=False, possible_master_transports=None):
209
180
        if revprops is None:
210
181
            revprops = {}
211
182
        if possible_master_transports is None:
212
183
            possible_master_transports = []
213
 
        if (u'branch-nick' not in revprops and
214
 
                branch.repository._format.supports_storing_branch_nick):
215
 
            revprops[u'branch-nick'] = branch._get_nick(
 
184
        if not 'branch-nick' in revprops:
 
185
            revprops['branch-nick'] = branch._get_nick(
216
186
                local,
217
187
                possible_master_transports)
218
188
        if authors is not None:
219
 
            if u'author' in revprops or u'authors' in revprops:
 
189
            if author is not None:
 
190
                raise AssertionError('Specifying both author and authors '
 
191
                        'is not allowed. Specify just authors instead')
 
192
            if 'author' in revprops or 'authors' in revprops:
220
193
                # XXX: maybe we should just accept one of them?
221
194
                raise AssertionError('author property given twice')
222
195
            if authors:
223
196
                for individual in authors:
224
197
                    if '\n' in individual:
225
198
                        raise AssertionError('\\n is not a valid character '
226
 
                                             'in an author identity')
227
 
                revprops[u'authors'] = '\n'.join(authors)
 
199
                                'in an author identity')
 
200
                revprops['authors'] = '\n'.join(authors)
 
201
        if author is not None:
 
202
            symbol_versioning.warn('The parameter author was deprecated'
 
203
                   ' in version 1.13. Use authors instead',
 
204
                   DeprecationWarning)
 
205
            if 'author' in revprops or 'authors' in revprops:
 
206
                # XXX: maybe we should just accept one of them?
 
207
                raise AssertionError('author property given twice')
 
208
            if '\n' in author:
 
209
                raise AssertionError('\\n is not a valid character '
 
210
                        'in an author identity')
 
211
            revprops['authors'] = author
228
212
        return revprops
229
213
 
230
214
    def commit(self,
250
234
        """Commit working copy as a new revision.
251
235
 
252
236
        :param message: the commit message (it or message_callback is required)
253
 
        :param message_callback: A callback: message =
254
 
            message_callback(cmt_obj)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
238
 
256
239
        :param timestamp: if not None, seconds-since-epoch for a
257
240
            postdated/predated commit.
283
266
        :param lossy: When committing to a foreign VCS, ignore any
284
267
            data that can not be natively represented.
285
268
        """
286
 
        with ExitStack() as stack:
287
 
            self.revprops = revprops or {}
288
 
            # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
            self.config_stack = config or self.config_stack
290
 
            mutter('preparing to commit')
291
 
 
292
 
            if working_tree is None:
293
 
                raise BzrError("working_tree must be passed into commit().")
294
 
            else:
295
 
                self.work_tree = working_tree
296
 
                self.branch = self.work_tree.branch
297
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
298
 
                    if not self.branch.repository.supports_rich_root():
299
 
                        raise errors.RootNotRich()
300
 
            if message_callback is None:
301
 
                if message is not None:
302
 
                    if isinstance(message, bytes):
303
 
                        message = message.decode(get_user_encoding())
304
 
 
305
 
                    def message_callback(x):
306
 
                        return message
307
 
                else:
308
 
                    raise BzrError("The message or message_callback keyword"
309
 
                                   " parameter is required for commit().")
310
 
 
311
 
            self.bound_branch = None
312
 
            self.any_entries_deleted = False
313
 
            if exclude is not None:
314
 
                self.exclude = sorted(
315
 
                    minimum_path_selection(exclude))
316
 
            else:
317
 
                self.exclude = []
318
 
            self.local = local
319
 
            self.master_branch = None
320
 
            self.recursive = recursive
321
 
            self.rev_id = None
322
 
            # self.specific_files is None to indicate no filter, or any iterable to
323
 
            # indicate a filter - [] means no files at all, as per iter_changes.
324
 
            if specific_files is not None:
325
 
                self.specific_files = sorted(
326
 
                    minimum_path_selection(specific_files))
327
 
            else:
328
 
                self.specific_files = None
329
 
 
330
 
            self.allow_pointless = allow_pointless
331
 
            self.message_callback = message_callback
332
 
            self.timestamp = timestamp
333
 
            self.timezone = timezone
334
 
            self.committer = committer
335
 
            self.strict = strict
336
 
            self.verbose = verbose
337
 
 
338
 
            stack.enter_context(self.work_tree.lock_write())
339
 
            self.parents = self.work_tree.get_parent_ids()
340
 
            self.pb = ui.ui_factory.nested_progress_bar()
341
 
            stack.callback(self.pb.finished)
342
 
            self.basis_revid = self.work_tree.last_revision()
343
 
            self.basis_tree = self.work_tree.basis_tree()
344
 
            stack.enter_context(self.basis_tree.lock_read())
345
 
            # Cannot commit with conflicts present.
346
 
            if len(self.work_tree.conflicts()) > 0:
347
 
                raise ConflictsInTree
348
 
 
349
 
            # Setup the bound branch variables as needed.
350
 
            self._check_bound_branch(stack, possible_master_transports)
351
 
            if self.config_stack is None:
352
 
                self.config_stack = self.work_tree.get_config_stack()
353
 
 
354
 
            # Check that the working tree is up to date
355
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
356
 
 
357
 
            # Complete configuration setup
358
 
            if reporter is not None:
359
 
                self.reporter = reporter
360
 
            elif self.reporter is None:
361
 
                self.reporter = self._select_reporter()
362
 
 
363
 
            # Setup the progress bar. As the number of files that need to be
364
 
            # committed in unknown, progress is reported as stages.
365
 
            # We keep track of entries separately though and include that
366
 
            # information in the progress bar during the relevant stages.
367
 
            self.pb_stage_name = ""
368
 
            self.pb_stage_count = 0
369
 
            self.pb_stage_total = 5
370
 
            if self.bound_branch:
371
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
372
 
                # tags to master branch"
373
 
                self.pb_stage_total += 2
374
 
            self.pb.show_pct = False
375
 
            self.pb.show_spinner = False
376
 
            self.pb.show_eta = False
377
 
            self.pb.show_count = True
378
 
            self.pb.show_bar = True
379
 
 
380
 
            # After a merge, a selected file commit is not supported.
381
 
            # See 'bzr help merge' for an explanation as to why.
382
 
            if len(self.parents) > 1 and self.specific_files is not None:
383
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
384
 
            # Excludes are a form of selected file commit.
385
 
            if len(self.parents) > 1 and self.exclude:
386
 
                raise CannotCommitSelectedFileMerge(self.exclude)
387
 
 
388
 
            # Collect the changes
389
 
            self._set_progress_stage("Collecting changes", counter=True)
390
 
            self._lossy = lossy
391
 
            self.builder = self.branch.get_commit_builder(
392
 
                self.parents, self.config_stack, timestamp, timezone, committer,
393
 
                self.revprops, rev_id, lossy=lossy)
394
 
 
395
 
            if self.builder.updates_branch and self.bound_branch:
396
 
                self.builder.abort()
397
 
                raise AssertionError(
398
 
                    "bound branches not supported for commit builders "
399
 
                    "that update the branch")
400
 
 
401
 
            try:
402
 
                # find the location being committed to
403
 
                if self.bound_branch:
404
 
                    master_location = self.master_branch.base
405
 
                else:
406
 
                    master_location = self.branch.base
407
 
 
408
 
                # report the start of the commit
409
 
                self.reporter.started(new_revno, self.rev_id, master_location)
410
 
 
411
 
                self._update_builder_with_changes()
412
 
                self._check_pointless()
413
 
 
414
 
                # TODO: Now the new inventory is known, check for conflicts.
415
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
416
 
                # weave lines, because nothing should be recorded until it is known
417
 
                # that commit will succeed.
418
 
                self._set_progress_stage("Saving data locally")
419
 
                self.builder.finish_inventory()
420
 
 
421
 
                # Prompt the user for a commit message if none provided
422
 
                message = message_callback(self)
423
 
                self.message = message
424
 
 
425
 
                # Add revision data to the local branch
426
 
                self.rev_id = self.builder.commit(self.message)
427
 
 
428
 
            except Exception:
429
 
                mutter("aborting commit write group because of exception:")
430
 
                trace.log_exception_quietly()
431
 
                self.builder.abort()
432
 
                raise
433
 
 
434
 
            self._update_branches(old_revno, old_revid, new_revno)
435
 
 
436
 
            # Make the working tree be up to date with the branch. This
437
 
            # includes automatic changes scheduled to be made to the tree, such
438
 
            # as updating its basis and unversioning paths that were missing.
439
 
            self.work_tree.unversion(self.deleted_paths)
440
 
            self._set_progress_stage("Updating the working tree")
441
 
            self.work_tree.update_basis_by_delta(
442
 
                self.rev_id, self.builder.get_basis_delta())
443
 
            self.reporter.completed(new_revno, self.rev_id)
444
 
            self._process_post_hooks(old_revno, new_revno)
445
 
            return self.rev_id
446
 
 
447
 
    def _update_branches(self, old_revno, old_revid, new_revno):
448
 
        """Update the master and local branch to the new revision.
449
 
 
450
 
        This will try to make sure that the master branch is updated
451
 
        before the local branch.
452
 
 
453
 
        :param old_revno: Revision number of master branch before the
454
 
            commit
455
 
        :param old_revid: Tip of master branch before the commit
456
 
        :param new_revno: Revision number of the new commit
457
 
        """
458
 
        if not self.builder.updates_branch:
459
 
            self._process_pre_hooks(old_revno, new_revno)
460
 
 
461
 
            # Upload revision data to the master.
462
 
            # this will propagate merged revisions too if needed.
463
 
            if self.bound_branch:
464
 
                self._set_progress_stage("Uploading data to master branch")
465
 
                # 'commit' to the master first so a timeout here causes the
466
 
                # local branch to be out of date
467
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
468
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
469
 
                if self._lossy:
470
 
                    self.branch.fetch(self.master_branch, self.rev_id)
471
 
 
472
 
            # and now do the commit locally.
473
 
            if new_revno is None:
474
 
                # Keep existing behaviour around ghosts
475
 
                new_revno = 1
476
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
477
 
        else:
478
 
            try:
479
 
                self._process_pre_hooks(old_revno, new_revno)
480
 
            except BaseException:
481
 
                # The commit builder will already have updated the branch,
482
 
                # revert it.
483
 
                self.branch.set_last_revision_info(old_revno, old_revid)
484
 
                raise
 
269
        operation = OperationWithCleanups(self._commit)
 
270
        self.revprops = revprops or {}
 
271
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
272
        self.config = config or self.config
 
273
        return operation.run(
 
274
               message=message,
 
275
               timestamp=timestamp,
 
276
               timezone=timezone,
 
277
               committer=committer,
 
278
               specific_files=specific_files,
 
279
               rev_id=rev_id,
 
280
               allow_pointless=allow_pointless,
 
281
               strict=strict,
 
282
               verbose=verbose,
 
283
               working_tree=working_tree,
 
284
               local=local,
 
285
               reporter=reporter,
 
286
               message_callback=message_callback,
 
287
               recursive=recursive,
 
288
               exclude=exclude,
 
289
               possible_master_transports=possible_master_transports,
 
290
               lossy=lossy)
 
291
 
 
292
    def _commit(self, operation, message, timestamp, timezone, committer,
 
293
            specific_files, rev_id, allow_pointless, strict, verbose,
 
294
            working_tree, local, reporter, message_callback, recursive,
 
295
            exclude, possible_master_transports, lossy):
 
296
        mutter('preparing to commit')
 
297
 
 
298
        if working_tree is None:
 
299
            raise BzrError("working_tree must be passed into commit().")
 
300
        else:
 
301
            self.work_tree = working_tree
 
302
            self.branch = self.work_tree.branch
 
303
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
304
                if not self.branch.repository.supports_rich_root():
 
305
                    raise errors.RootNotRich()
 
306
        if message_callback is None:
 
307
            if message is not None:
 
308
                if isinstance(message, str):
 
309
                    message = message.decode(get_user_encoding())
 
310
                message_callback = lambda x: message
 
311
            else:
 
312
                raise BzrError("The message or message_callback keyword"
 
313
                               " parameter is required for commit().")
 
314
 
 
315
        self.bound_branch = None
 
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
 
322
        self.local = local
 
323
        self.master_branch = None
 
324
        self.recursive = recursive
 
325
        self.rev_id = None
 
326
        # self.specific_files is None to indicate no filter, or any iterable to
 
327
        # indicate a filter - [] means no files at all, as per iter_changes.
 
328
        if specific_files is not None:
 
329
            self.specific_files = sorted(
 
330
                minimum_path_selection(specific_files))
 
331
        else:
 
332
            self.specific_files = None
 
333
 
 
334
        self.allow_pointless = allow_pointless
 
335
        self.message_callback = message_callback
 
336
        self.timestamp = timestamp
 
337
        self.timezone = timezone
 
338
        self.committer = committer
 
339
        self.strict = strict
 
340
        self.verbose = verbose
 
341
 
 
342
        self.work_tree.lock_write()
 
343
        operation.add_cleanup(self.work_tree.unlock)
 
344
        self.parents = self.work_tree.get_parent_ids()
 
345
        # We can use record_iter_changes IFF iter_changes is compatible with
 
346
        # the command line parameters, and the repository has fast delta
 
347
        # generation. See bug 347649.
 
348
        self.use_record_iter_changes = (
 
349
            not self.exclude and 
 
350
            not self.branch.repository._format.supports_tree_reference and
 
351
            (self.branch.repository._format.fast_deltas or
 
352
             len(self.parents) < 2))
 
353
        self.pb = ui.ui_factory.nested_progress_bar()
 
354
        operation.add_cleanup(self.pb.finished)
 
355
        self.basis_revid = self.work_tree.last_revision()
 
356
        self.basis_tree = self.work_tree.basis_tree()
 
357
        self.basis_tree.lock_read()
 
358
        operation.add_cleanup(self.basis_tree.unlock)
 
359
        # Cannot commit with conflicts present.
 
360
        if len(self.work_tree.conflicts()) > 0:
 
361
            raise ConflictsInTree
 
362
 
 
363
        # Setup the bound branch variables as needed.
 
364
        self._check_bound_branch(operation, possible_master_transports)
 
365
 
 
366
        # Check that the working tree is up to date
 
367
        old_revno, new_revno = self._check_out_of_date_tree()
 
368
 
 
369
        # Complete configuration setup
 
370
        if reporter is not None:
 
371
            self.reporter = reporter
 
372
        elif self.reporter is None:
 
373
            self.reporter = self._select_reporter()
 
374
        if self.config is None:
 
375
            self.config = self.branch.get_config()
 
376
 
 
377
        self._set_specific_file_ids()
 
378
 
 
379
        # Setup the progress bar. As the number of files that need to be
 
380
        # committed in unknown, progress is reported as stages.
 
381
        # We keep track of entries separately though and include that
 
382
        # information in the progress bar during the relevant stages.
 
383
        self.pb_stage_name = ""
 
384
        self.pb_stage_count = 0
 
385
        self.pb_stage_total = 5
 
386
        if self.bound_branch:
 
387
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
388
            # tags to master branch"
 
389
            self.pb_stage_total += 2
 
390
        self.pb.show_pct = False
 
391
        self.pb.show_spinner = False
 
392
        self.pb.show_eta = False
 
393
        self.pb.show_count = True
 
394
        self.pb.show_bar = True
 
395
 
 
396
        self._gather_parents()
 
397
        # After a merge, a selected file commit is not supported.
 
398
        # See 'bzr help merge' for an explanation as to why.
 
399
        if len(self.parents) > 1 and self.specific_files is not None:
 
400
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
401
        # Excludes are a form of selected file commit.
 
402
        if len(self.parents) > 1 and self.exclude:
 
403
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
404
 
 
405
        # Collect the changes
 
406
        self._set_progress_stage("Collecting changes", counter=True)
 
407
        self._lossy = lossy
 
408
        self.builder = self.branch.get_commit_builder(self.parents,
 
409
            self.config, timestamp, timezone, committer, self.revprops,
 
410
            rev_id, lossy=lossy)
 
411
        if not self.builder.supports_record_entry_contents and self.exclude:
 
412
            self.builder.abort()
 
413
            raise errors.ExcludesUnsupported(self.branch.repository)
 
414
 
 
415
        try:
 
416
            self.builder.will_record_deletes()
 
417
            # find the location being committed to
 
418
            if self.bound_branch:
 
419
                master_location = self.master_branch.base
 
420
            else:
 
421
                master_location = self.branch.base
 
422
 
 
423
            # report the start of the commit
 
424
            self.reporter.started(new_revno, self.rev_id, master_location)
 
425
 
 
426
            self._update_builder_with_changes()
 
427
            self._check_pointless()
 
428
 
 
429
            # TODO: Now the new inventory is known, check for conflicts.
 
430
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
431
            # weave lines, because nothing should be recorded until it is known
 
432
            # that commit will succeed.
 
433
            self._set_progress_stage("Saving data locally")
 
434
            self.builder.finish_inventory()
 
435
 
 
436
            # Prompt the user for a commit message if none provided
 
437
            message = message_callback(self)
 
438
            self.message = message
 
439
 
 
440
            # Add revision data to the local branch
 
441
            self.rev_id = self.builder.commit(self.message)
 
442
 
 
443
        except Exception, e:
 
444
            mutter("aborting commit write group because of exception:")
 
445
            trace.log_exception_quietly()
 
446
            self.builder.abort()
 
447
            raise
 
448
 
 
449
        self._process_pre_hooks(old_revno, new_revno)
 
450
 
 
451
        # Upload revision data to the master.
 
452
        # this will propagate merged revisions too if needed.
 
453
        if self.bound_branch:
 
454
            self._set_progress_stage("Uploading data to master branch")
 
455
            # 'commit' to the master first so a timeout here causes the
 
456
            # local branch to be out of date
 
457
            (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
 
458
                self.branch, new_revno, self.rev_id, lossy=lossy)
 
459
            if lossy:
 
460
                self.branch.fetch(self.master_branch, self.rev_id)
 
461
 
 
462
        # and now do the commit locally.
 
463
        self.branch.set_last_revision_info(new_revno, self.rev_id)
485
464
 
486
465
        # Merge local tags to remote
487
466
        if self.bound_branch:
488
467
            self._set_progress_stage("Merging tags to master branch")
489
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
490
 
                self.master_branch.tags)
 
468
            tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
491
469
            if tag_conflicts:
492
470
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
493
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
494
 
                    "\n".join(warning_lines))))
 
471
                note("Conflicting tags in bound branch:\n" +
 
472
                    "\n".join(warning_lines))
 
473
 
 
474
        # Make the working tree be up to date with the branch. This
 
475
        # includes automatic changes scheduled to be made to the tree, such
 
476
        # as updating its basis and unversioning paths that were missing.
 
477
        self.work_tree.unversion(self.deleted_ids)
 
478
        self._set_progress_stage("Updating the working tree")
 
479
        self.work_tree.update_basis_by_delta(self.rev_id,
 
480
             self.builder.get_basis_delta())
 
481
        self.reporter.completed(new_revno, self.rev_id)
 
482
        self._process_post_hooks(old_revno, new_revno)
 
483
        return self.rev_id
495
484
 
496
485
    def _select_reporter(self):
497
486
        """Select the CommitReporter to use."""
509
498
            return
510
499
        raise PointlessCommit()
511
500
 
512
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
 
501
    def _check_bound_branch(self, operation, possible_master_transports=None):
513
502
        """Check to see if the local branch is bound.
514
503
 
515
504
        If it is bound, then most of the commit will actually be
531
520
        # If the master branch is bound, we must fail
532
521
        master_bound_location = self.master_branch.get_bound_location()
533
522
        if master_bound_location:
534
 
            raise errors.CommitToDoubleBoundBranch(
535
 
                self.branch, self.master_branch, master_bound_location)
 
523
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
524
                    self.master_branch, master_bound_location)
536
525
 
537
526
        # TODO: jam 20051230 We could automatically push local
538
527
        #       commits to the remote branch if they would fit.
540
529
        #       to local.
541
530
 
542
531
        # Make sure the local branch is identical to the master
543
 
        master_revid = self.master_branch.last_revision()
544
 
        local_revid = self.branch.last_revision()
545
 
        if local_revid != master_revid:
 
532
        master_info = self.master_branch.last_revision_info()
 
533
        local_info = self.branch.last_revision_info()
 
534
        if local_info != master_info:
546
535
            raise errors.BoundBranchOutOfDate(self.branch,
547
 
                                              self.master_branch)
 
536
                    self.master_branch)
548
537
 
549
538
        # Now things are ready to change the master branch
550
539
        # so grab the lock
551
540
        self.bound_branch = self.branch
552
 
        stack.enter_context(self.master_branch.lock_write())
 
541
        self.master_branch.lock_write()
 
542
        operation.add_cleanup(self.master_branch.unlock)
553
543
 
554
544
    def _check_out_of_date_tree(self):
555
545
        """Check that the working tree is up to date.
556
546
 
557
 
        :return: old_revision_number, old_revision_id, new_revision_number
558
 
            tuple
 
547
        :return: old_revision_number,new_revision_number tuple
559
548
        """
560
549
        try:
561
550
            first_tree_parent = self.work_tree.get_parent_ids()[0]
564
553
            # this is so that we still consider the master branch
565
554
            # - in a checkout scenario the tree may have no
566
555
            # parents but the branch may do.
567
 
            first_tree_parent = breezy.revision.NULL_REVISION
568
 
        if (self.master_branch._format.stores_revno() or
569
 
                self.config_stack.get('calculate_revnos')):
570
 
            try:
571
 
                old_revno, master_last = self.master_branch.last_revision_info()
572
 
            except errors.UnsupportedOperation:
573
 
                master_last = self.master_branch.last_revision()
574
 
                old_revno = self.branch.revision_id_to_revno(master_last)
575
 
        else:
576
 
            master_last = self.master_branch.last_revision()
577
 
            old_revno = None
 
556
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
557
        old_revno, master_last = self.master_branch.last_revision_info()
578
558
        if master_last != first_tree_parent:
579
 
            if master_last != breezy.revision.NULL_REVISION:
 
559
            if master_last != bzrlib.revision.NULL_REVISION:
580
560
                raise errors.OutOfDateTree(self.work_tree)
581
 
        if (old_revno is not None and
582
 
                self.branch.repository.has_revision(first_tree_parent)):
 
561
        if self.branch.repository.has_revision(first_tree_parent):
583
562
            new_revno = old_revno + 1
584
563
        else:
585
564
            # ghost parents never appear in revision history.
586
 
            new_revno = None
587
 
        return old_revno, master_last, new_revno
 
565
            new_revno = 1
 
566
        return old_revno,new_revno
588
567
 
589
568
    def _process_pre_hooks(self, old_revno, new_revno):
590
569
        """Process any registered pre commit hooks."""
596
575
        # Process the post commit hooks, if any
597
576
        self._set_progress_stage("Running post_commit hooks")
598
577
        # old style commit hooks - should be deprecated ? (obsoleted in
599
 
        # 0.15^H^H^H^H 2.5.0)
600
 
        post_commit = self.config_stack.get('post_commit')
601
 
        if post_commit is not None:
602
 
            hooks = post_commit.split(' ')
 
578
        # 0.15)
 
579
        if self.config.post_commit() is not None:
 
580
            hooks = self.config.post_commit().split(' ')
603
581
            # this would be nicer with twisted.python.reflect.namedAny
604
582
            for hook in hooks:
605
583
                result = eval(hook + '(branch, rev_id)',
606
 
                              {'branch': self.branch,
607
 
                               'breezy': breezy,
608
 
                               'rev_id': self.rev_id})
 
584
                              {'branch':self.branch,
 
585
                               'bzrlib':bzrlib,
 
586
                               'rev_id':self.rev_id})
609
587
        # process new style post commit hooks
610
588
        self._process_hooks("post_commit", old_revno, new_revno)
611
589
 
626
604
        if self.parents:
627
605
            old_revid = self.parents[0]
628
606
        else:
629
 
            old_revid = breezy.revision.NULL_REVISION
 
607
            old_revid = bzrlib.revision.NULL_REVISION
630
608
 
631
609
        if hook_name == "pre_commit":
632
610
            future_tree = self.builder.revision_tree()
633
611
            tree_delta = future_tree.changes_from(self.basis_tree,
634
 
                                                  include_root=True)
 
612
                                             include_root=True)
635
613
 
636
614
        for hook in Branch.hooks[hook_name]:
637
615
            # show the running hook in the progress bar. As hooks may
652
630
                     old_revno, old_revid, new_revno, self.rev_id,
653
631
                     tree_delta, future_tree)
654
632
 
 
633
    def _gather_parents(self):
 
634
        """Record the parents of a merge for merge detection."""
 
635
        # TODO: Make sure that this list doesn't contain duplicate
 
636
        # entries and the order is preserved when doing this.
 
637
        if self.use_record_iter_changes:
 
638
            return
 
639
        self.basis_inv = self.basis_tree.inventory
 
640
        self.parent_invs = [self.basis_inv]
 
641
        for revision in self.parents[1:]:
 
642
            if self.branch.repository.has_revision(revision):
 
643
                mutter('commit parent revision {%s}', revision)
 
644
                inventory = self.branch.repository.get_inventory(revision)
 
645
                self.parent_invs.append(inventory)
 
646
            else:
 
647
                mutter('commit parent ghost revision {%s}', revision)
 
648
 
655
649
    def _update_builder_with_changes(self):
656
650
        """Update the commit builder with the data about what has changed.
657
651
        """
 
652
        exclude = self.exclude
658
653
        specific_files = self.specific_files
659
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
654
        mutter("Selecting files for commit with filter %s", specific_files)
660
655
 
661
656
        self._check_strict()
662
 
        iter_changes = self.work_tree.iter_changes(
663
 
            self.basis_tree, specific_files=specific_files)
664
 
        if self.exclude:
665
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
666
 
        iter_changes = self._filter_iter_changes(iter_changes)
667
 
        for path, fs_hash in self.builder.record_iter_changes(
 
657
        if self.use_record_iter_changes:
 
658
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
659
                specific_files=specific_files)
 
660
            iter_changes = self._filter_iter_changes(iter_changes)
 
661
            for file_id, path, fs_hash in self.builder.record_iter_changes(
668
662
                self.work_tree, self.basis_revid, iter_changes):
669
 
            self.work_tree._observed_sha1(path, fs_hash)
 
663
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
664
        else:
 
665
            # Build the new inventory
 
666
            self._populate_from_inventory()
 
667
            self._record_unselected()
 
668
            self._report_and_accumulate_deletes()
670
669
 
671
670
    def _filter_iter_changes(self, iter_changes):
672
671
        """Process iter_changes.
673
672
 
674
 
        This method reports on the changes in iter_changes to the user, and
 
673
        This method reports on the changes in iter_changes to the user, and 
675
674
        converts 'missing' entries in the iter_changes iterator to 'deleted'
676
675
        entries. 'missing' entries have their
677
676
 
680
679
        """
681
680
        reporter = self.reporter
682
681
        report_changes = reporter.is_verbose()
683
 
        deleted_paths = []
 
682
        deleted_ids = []
684
683
        for change in iter_changes:
685
684
            if report_changes:
686
 
                old_path = change.path[0]
687
 
                new_path = change.path[1]
688
 
                versioned = change.versioned[1]
689
 
            kind = change.kind[1]
690
 
            versioned = change.versioned[1]
 
685
                old_path = change[1][0]
 
686
                new_path = change[1][1]
 
687
                versioned = change[3][1]
 
688
            kind = change[6][1]
 
689
            versioned = change[3][1]
691
690
            if kind is None and versioned:
692
691
                # 'missing' path
693
692
                if report_changes:
694
693
                    reporter.missing(new_path)
695
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
696
 
                    trace.warning('Ignoring "%s" as symlinks are not '
697
 
                                  'supported on this filesystem.' % (change.path[0],))
698
 
                    continue
699
 
                deleted_paths.append(change.path[1])
 
694
                deleted_ids.append(change[0])
700
695
                # Reset the new path (None) and new versioned flag (False)
701
 
                change = change.discard_new()
702
 
                new_path = change.path[1]
703
 
                versioned = False
 
696
                change = (change[0], (change[1][0], None), change[2],
 
697
                    (change[3][0], False)) + change[4:]
704
698
            elif kind == 'tree-reference':
705
699
                if self.recursive == 'down':
706
 
                    self._commit_nested_tree(change.path[1])
707
 
            if change.versioned[0] or change.versioned[1]:
 
700
                    self._commit_nested_tree(change[0], change[1][1])
 
701
            if change[3][0] or change[3][1]:
708
702
                yield change
709
703
                if report_changes:
710
704
                    if new_path is None:
711
705
                        reporter.deleted(old_path)
712
706
                    elif old_path is None:
713
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
707
                        reporter.snapshot_change('added', new_path)
714
708
                    elif old_path != new_path:
715
 
                        reporter.renamed(gettext('renamed'),
716
 
                                         old_path, new_path)
 
709
                        reporter.renamed('renamed', old_path, new_path)
717
710
                    else:
718
 
                        if (new_path
719
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
711
                        if (new_path or 
 
712
                            self.work_tree.branch.repository._format.rich_root_data):
720
713
                            # Don't report on changes to '' in non rich root
721
714
                            # repositories.
722
 
                            reporter.snapshot_change(
723
 
                                gettext('modified'), new_path)
 
715
                            reporter.snapshot_change('modified', new_path)
724
716
            self._next_progress_entry()
725
 
        # Unversion files that were found to be deleted
726
 
        self.deleted_paths = deleted_paths
 
717
        # Unversion IDs that were found to be deleted
 
718
        self.deleted_ids = deleted_ids
 
719
 
 
720
    def _record_unselected(self):
 
721
        # If specific files are selected, then all un-selected files must be
 
722
        # recorded in their previous state. For more details, see
 
723
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
724
        if self.specific_files or self.exclude:
 
725
            specific_files = self.specific_files or []
 
726
            for path, old_ie in self.basis_inv.iter_entries():
 
727
                if old_ie.file_id in self.builder.new_inventory:
 
728
                    # already added - skip.
 
729
                    continue
 
730
                if (is_inside_any(specific_files, path)
 
731
                    and not is_inside_any(self.exclude, path)):
 
732
                    # was inside the selected path, and not excluded - if not
 
733
                    # present it has been deleted so skip.
 
734
                    continue
 
735
                # From here down it was either not selected, or was excluded:
 
736
                # We preserve the entry unaltered.
 
737
                ie = old_ie.copy()
 
738
                # Note: specific file commits after a merge are currently
 
739
                # prohibited. This test is for sanity/safety in case it's
 
740
                # required after that changes.
 
741
                if len(self.parents) > 1:
 
742
                    ie.revision = None
 
743
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
744
                    self.basis_tree, None)
 
745
 
 
746
    def _report_and_accumulate_deletes(self):
 
747
        if (isinstance(self.basis_inv, Inventory)
 
748
            and isinstance(self.builder.new_inventory, Inventory)):
 
749
            # the older Inventory classes provide a _byid dict, and building a
 
750
            # set from the keys of this dict is substantially faster than even
 
751
            # getting a set of ids from the inventory
 
752
            #
 
753
            # <lifeless> set(dict) is roughly the same speed as
 
754
            # set(iter(dict)) and both are significantly slower than
 
755
            # set(dict.keys())
 
756
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
757
               set(self.builder.new_inventory._byid.keys())
 
758
        else:
 
759
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
760
        if deleted_ids:
 
761
            self.any_entries_deleted = True
 
762
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
763
                for file_id in deleted_ids]
 
764
            deleted.sort()
 
765
            # XXX: this is not quite directory-order sorting
 
766
            for path, file_id in deleted:
 
767
                self.builder.record_delete(path, file_id)
 
768
                self.reporter.deleted(path)
727
769
 
728
770
    def _check_strict(self):
729
771
        # XXX: when we use iter_changes this would likely be faster if
734
776
            for unknown in self.work_tree.unknowns():
735
777
                raise StrictCommitFailed()
736
778
 
737
 
    def _commit_nested_tree(self, path):
 
779
    def _populate_from_inventory(self):
 
780
        """Populate the CommitBuilder by walking the working tree inventory."""
 
781
        # Build the revision inventory.
 
782
        #
 
783
        # This starts by creating a new empty inventory. Depending on
 
784
        # which files are selected for commit, and what is present in the
 
785
        # current tree, the new inventory is populated. inventory entries
 
786
        # which are candidates for modification have their revision set to
 
787
        # None; inventory entries that are carried over untouched have their
 
788
        # revision set to their prior value.
 
789
        #
 
790
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
791
        # results to create a new inventory at the same time, which results
 
792
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
793
        # ADHB 11-07-2006
 
794
 
 
795
        specific_files = self.specific_files
 
796
        exclude = self.exclude
 
797
        report_changes = self.reporter.is_verbose()
 
798
        deleted_ids = []
 
799
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
800
        # deleted, then we have {'foo':{'bar':{}}}
 
801
        deleted_paths = {}
 
802
        # XXX: Note that entries may have the wrong kind because the entry does
 
803
        # not reflect the status on disk.
 
804
        work_inv = self.work_tree.inventory
 
805
        # NB: entries will include entries within the excluded ids/paths
 
806
        # because iter_entries_by_dir has no 'exclude' facility today.
 
807
        entries = work_inv.iter_entries_by_dir(
 
808
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
809
        for path, existing_ie in entries:
 
810
            file_id = existing_ie.file_id
 
811
            name = existing_ie.name
 
812
            parent_id = existing_ie.parent_id
 
813
            kind = existing_ie.kind
 
814
            # Skip files that have been deleted from the working tree.
 
815
            # The deleted path ids are also recorded so they can be explicitly
 
816
            # unversioned later.
 
817
            if deleted_paths:
 
818
                path_segments = splitpath(path)
 
819
                deleted_dict = deleted_paths
 
820
                for segment in path_segments:
 
821
                    deleted_dict = deleted_dict.get(segment, None)
 
822
                    if not deleted_dict:
 
823
                        # We either took a path not present in the dict
 
824
                        # (deleted_dict was None), or we've reached an empty
 
825
                        # child dir in the dict, so are now a sub-path.
 
826
                        break
 
827
                else:
 
828
                    deleted_dict = None
 
829
                if deleted_dict is not None:
 
830
                    # the path has a deleted parent, do not add it.
 
831
                    continue
 
832
            if exclude and is_inside_any(exclude, path):
 
833
                # Skip excluded paths. Excluded paths are processed by
 
834
                # _update_builder_with_changes.
 
835
                continue
 
836
            content_summary = self.work_tree.path_content_summary(path)
 
837
            kind = content_summary[0]
 
838
            # Note that when a filter of specific files is given, we must only
 
839
            # skip/record deleted files matching that filter.
 
840
            if not specific_files or is_inside_any(specific_files, path):
 
841
                if kind == 'missing':
 
842
                    if not deleted_paths:
 
843
                        # path won't have been split yet.
 
844
                        path_segments = splitpath(path)
 
845
                    deleted_dict = deleted_paths
 
846
                    for segment in path_segments:
 
847
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
848
                    self.reporter.missing(path)
 
849
                    self._next_progress_entry()
 
850
                    deleted_ids.append(file_id)
 
851
                    continue
 
852
            # TODO: have the builder do the nested commit just-in-time IF and
 
853
            # only if needed.
 
854
            if kind == 'tree-reference':
 
855
                # enforce repository nested tree policy.
 
856
                if (not self.work_tree.supports_tree_reference() or
 
857
                    # repository does not support it either.
 
858
                    not self.branch.repository._format.supports_tree_reference):
 
859
                    kind = 'directory'
 
860
                    content_summary = (kind, None, None, None)
 
861
                elif self.recursive == 'down':
 
862
                    nested_revision_id = self._commit_nested_tree(
 
863
                        file_id, path)
 
864
                    content_summary = (kind, None, None, nested_revision_id)
 
865
                else:
 
866
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
867
                    content_summary = (kind, None, None, nested_revision_id)
 
868
 
 
869
            # Record an entry for this item
 
870
            # Note: I don't particularly want to have the existing_ie
 
871
            # parameter but the test suite currently (28-Jun-07) breaks
 
872
            # without it thanks to a unicode normalisation issue. :-(
 
873
            definitely_changed = kind != existing_ie.kind
 
874
            self._record_entry(path, file_id, specific_files, kind, name,
 
875
                parent_id, definitely_changed, existing_ie, report_changes,
 
876
                content_summary)
 
877
 
 
878
        # Unversion IDs that were found to be deleted
 
879
        self.deleted_ids = deleted_ids
 
880
 
 
881
    def _commit_nested_tree(self, file_id, path):
738
882
        "Commit a nested tree."
739
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
883
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
740
884
        # FIXME: be more comprehensive here:
741
885
        # this works when both trees are in --trees repository,
742
886
        # but when both are bound to a different repository,
744
888
        # finally implement the explicit-caches approach design
745
889
        # a while back - RBC 20070306.
746
890
        if sub_tree.branch.repository.has_same_location(
747
 
                self.work_tree.branch.repository):
 
891
            self.work_tree.branch.repository):
748
892
            sub_tree.branch.repository = \
749
893
                self.work_tree.branch.repository
750
894
        try:
751
895
            return sub_tree.commit(message=None, revprops=self.revprops,
752
 
                                   recursive=self.recursive,
753
 
                                   message_callback=self.message_callback,
754
 
                                   timestamp=self.timestamp,
755
 
                                   timezone=self.timezone,
756
 
                                   committer=self.committer,
757
 
                                   allow_pointless=self.allow_pointless,
758
 
                                   strict=self.strict, verbose=self.verbose,
759
 
                                   local=self.local, reporter=self.reporter)
760
 
        except PointlessCommit:
761
 
            return self.work_tree.get_reference_revision(path)
 
896
                recursive=self.recursive,
 
897
                message_callback=self.message_callback,
 
898
                timestamp=self.timestamp, timezone=self.timezone,
 
899
                committer=self.committer,
 
900
                allow_pointless=self.allow_pointless,
 
901
                strict=self.strict, verbose=self.verbose,
 
902
                local=self.local, reporter=self.reporter)
 
903
        except errors.PointlessCommit:
 
904
            return self.work_tree.get_reference_revision(file_id)
 
905
 
 
906
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
907
        parent_id, definitely_changed, existing_ie, report_changes,
 
908
        content_summary):
 
909
        "Record the new inventory entry for a path if any."
 
910
        # mutter('check %s {%s}', path, file_id)
 
911
        # mutter('%s selected for commit', path)
 
912
        if definitely_changed or existing_ie is None:
 
913
            ie = make_entry(kind, name, parent_id, file_id)
 
914
        else:
 
915
            ie = existing_ie.copy()
 
916
            ie.revision = None
 
917
        # For carried over entries we don't care about the fs hash - the repo
 
918
        # isn't generating a sha, so we're not saving computation time.
 
919
        _, _, fs_hash = self.builder.record_entry_contents(
 
920
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
921
        if report_changes:
 
922
            self._report_change(ie, path)
 
923
        if fs_hash:
 
924
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
925
        return ie
 
926
 
 
927
    def _report_change(self, ie, path):
 
928
        """Report a change to the user.
 
929
 
 
930
        The change that has occurred is described relative to the basis
 
931
        inventory.
 
932
        """
 
933
        if (self.basis_inv.has_id(ie.file_id)):
 
934
            basis_ie = self.basis_inv[ie.file_id]
 
935
        else:
 
936
            basis_ie = None
 
937
        change = ie.describe_change(basis_ie, ie)
 
938
        if change in (InventoryEntry.RENAMED,
 
939
            InventoryEntry.MODIFIED_AND_RENAMED):
 
940
            old_path = self.basis_inv.id2path(ie.file_id)
 
941
            self.reporter.renamed(change, old_path, path)
 
942
            self._next_progress_entry()
 
943
        else:
 
944
            if change == 'unchanged':
 
945
                return
 
946
            self.reporter.snapshot_change(change, path)
 
947
            self._next_progress_entry()
762
948
 
763
949
    def _set_progress_stage(self, name, counter=False):
764
950
        """Set the progress stage and emit an update to the progress bar."""
777
963
 
778
964
    def _emit_progress(self):
779
965
        if self.pb_entries_count is not None:
780
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
781
 
                                                       self.pb_entries_count)
 
966
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
967
                self.pb_entries_count)
782
968
        else:
783
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
969
            text = "%s - Stage" % (self.pb_stage_name, )
784
970
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
971
 
 
972
    def _set_specific_file_ids(self):
 
973
        """populate self.specific_file_ids if we will use it."""
 
974
        if not self.use_record_iter_changes:
 
975
            # If provided, ensure the specified files are versioned
 
976
            if self.specific_files is not None:
 
977
                # Note: This routine is being called because it raises
 
978
                # PathNotVersionedError as a side effect of finding the IDs. We
 
979
                # later use the ids we found as input to the working tree
 
980
                # inventory iterator, so we only consider those ids rather than
 
981
                # examining the whole tree again.
 
982
                # XXX: Dont we have filter_unversioned to do this more
 
983
                # cheaply?
 
984
                self.specific_file_ids = tree.find_ids_across_trees(
 
985
                    self.specific_files, [self.basis_tree, self.work_tree])
 
986
            else:
 
987
                self.specific_file_ids = None