/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: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

Show diffs side-by-side

added added

removed removed

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