/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: John Arbash Meinel
  • Date: 2008-08-25 21:50:11 UTC
  • mfrom: (0.11.3 tools)
  • mto: This revision was merged to the branch mainline in revision 3659.
  • Revision ID: john@arbash-meinel.com-20080825215011-de9esmzgkue3e522
Merge in Lukáš's helper scripts.
Update the packaging documents to describe how to do the releases
using bzr-builddeb to package all distro platforms
simultaneously.

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