/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: Jelmer Vernooij
  • Date: 2010-04-11 19:40:23 UTC
  • mto: This revision was merged to the branch mainline in revision 5144.
  • Revision ID: jelmer@samba.org-20100411194023-7iidj17toyv1wskc
Add separate tests for BzrDirs with colocated branch support and 
BzrDirs without.

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