/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: Ian Clatworthy
  • Date: 2007-08-10 05:17:09 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070810051709-0rnxlur94samh192
move most existing topics into the User Guide dir for English

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
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
21
20
# working tree and that were in the predecessor are reported as
22
21
# removed --- this can include files that were either removed from the
23
22
# inventory or deleted in the working tree.  If they were only
26
25
# We then consider the remaining entries, which will be in the new
27
26
# version.  Directory entries are simply copied across.  File entries
28
27
# must be checked to see if a new version of the file should be
29
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
30
29
# version of the file was present.  If the file was present in at
31
30
# least one tree, and if it was the same version in all the trees,
32
31
# then we can just refer to that version.  Otherwise, a new version
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
    inventory,
 
63
    tree,
58
64
    )
59
 
from .branch import Branch
60
 
from .cleanup import ExitStack
61
 
import breezy.config
62
 
from .errors import (BzrError,
63
 
                     ConflictsInTree,
64
 
                     StrictCommitFailed
65
 
                     )
66
 
from .osutils import (get_user_encoding,
67
 
                      has_symlinks,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      )
71
 
from .trace import mutter, note, is_quiet
72
 
from .tree import TreeChange
73
 
from .urlutils import unescape_for_display
74
 
from .i18n import gettext
75
 
 
76
 
 
77
 
class PointlessCommit(BzrError):
78
 
 
79
 
    _fmt = "No changes to commit"
80
 
 
81
 
 
82
 
class CannotCommitSelectedFileMerge(BzrError):
83
 
 
84
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
85
 
        ' files %(files_str)s'
86
 
 
87
 
    def __init__(self, files):
88
 
        files_str = ', '.join(files)
89
 
        BzrError.__init__(self, files=files, files_str=files_str)
90
 
 
91
 
 
92
 
def filter_excluded(iter_changes, exclude):
93
 
    """Filter exclude filenames.
94
 
 
95
 
    :param iter_changes: iter_changes function
96
 
    :param exclude: List of paths to exclude
97
 
    :return: iter_changes function
98
 
    """
99
 
    for change in iter_changes:
100
 
        new_excluded = (change.path[1] is not None and
101
 
                        is_inside_any(exclude, change.path[1]))
102
 
 
103
 
        old_excluded = (change.path[0] is not None and
104
 
                        is_inside_any(exclude, change.path[0]))
105
 
 
106
 
        if old_excluded and new_excluded:
107
 
            continue
108
 
 
109
 
        if old_excluded or new_excluded:
110
 
            # TODO(jelmer): Perhaps raise an error here instead?
111
 
            continue
112
 
 
113
 
        yield change
 
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
                            quotefn, sha_file, split_lines)
 
74
from bzrlib.testament import Testament
 
75
from bzrlib.trace import mutter, note, warning
 
76
from bzrlib.xml5 import serializer_v5
 
77
from bzrlib.inventory import Inventory, InventoryEntry
 
78
from bzrlib import symbol_versioning
 
79
from bzrlib.symbol_versioning import (deprecated_passed,
 
80
        deprecated_function,
 
81
        DEPRECATED_PARAMETER)
 
82
from bzrlib.workingtree import WorkingTree
 
83
import bzrlib.ui
114
84
 
115
85
 
116
86
class NullCommitReporter(object):
117
87
    """I report on progress of a commit."""
118
88
 
119
 
    def started(self, revno, revid, location):
120
 
        pass
121
 
 
122
89
    def snapshot_change(self, change, path):
123
90
        pass
124
91
 
125
92
    def completed(self, revno, rev_id):
126
93
        pass
127
94
 
128
 
    def deleted(self, path):
 
95
    def deleted(self, file_id):
 
96
        pass
 
97
 
 
98
    def escaped(self, escape_count, message):
129
99
        pass
130
100
 
131
101
    def missing(self, path):
134
104
    def renamed(self, change, old_path, new_path):
135
105
        pass
136
106
 
137
 
    def is_verbose(self):
138
 
        return False
139
 
 
140
107
 
141
108
class ReportCommitToLog(NullCommitReporter):
142
109
 
148
115
        note(format, *args)
149
116
 
150
117
    def snapshot_change(self, change, path):
151
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
118
        if change == 'unchanged':
 
119
            return
 
120
        if change == 'added' and path == '':
152
121
            return
153
122
        self._note("%s %s", change, path)
154
123
 
155
 
    def started(self, revno, rev_id, location):
156
 
        self._note(
157
 
            gettext('Committing to: %s'),
158
 
            unescape_for_display(location, 'utf-8'))
159
 
 
160
124
    def completed(self, revno, rev_id):
161
 
        if revno is not None:
162
 
            self._note(gettext('Committed revision %d.'), revno)
163
 
            # self._note goes to the console too; so while we want to log the
164
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
165
 
            # term we should rearrange the reporting structure, but for now
166
 
            # we just mutter seperately. We mutter the revid and revno together
167
 
            # so that concurrent bzr invocations won't lead to confusion.
168
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
169
 
        else:
170
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
125
        self._note('Committed revision %d.', revno)
 
126
    
 
127
    def deleted(self, file_id):
 
128
        self._note('deleted %s', file_id)
171
129
 
172
 
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
130
    def escaped(self, escape_count, message):
 
131
        self._note("replaced %d control characters in message", escape_count)
174
132
 
175
133
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
134
        self._note('missing %s', path)
177
135
 
178
136
    def renamed(self, change, old_path, new_path):
179
137
        self._note('%s %s => %s', change, old_path, new_path)
180
138
 
181
 
    def is_verbose(self):
182
 
        return True
183
 
 
184
139
 
185
140
class Commit(object):
186
141
    """Task of committing a new revision.
194
149
            the working directory; these should be removed from the
195
150
            working inventory.
196
151
    """
197
 
 
198
152
    def __init__(self,
199
153
                 reporter=None,
200
 
                 config_stack=None):
201
 
        """Create a Commit object.
202
 
 
203
 
        :param reporter: the default reporter to use or None to decide later
204
 
        """
205
 
        self.reporter = reporter
206
 
        self.config_stack = config_stack
207
 
 
208
 
    @staticmethod
209
 
    def update_revprops(revprops, branch, authors=None,
210
 
                        local=False, possible_master_transports=None):
211
 
        if revprops is None:
212
 
            revprops = {}
213
 
        if possible_master_transports is None:
214
 
            possible_master_transports = []
215
 
        if (u'branch-nick' not in revprops and
216
 
                branch.repository._format.supports_storing_branch_nick):
217
 
            revprops[u'branch-nick'] = branch._get_nick(
218
 
                local,
219
 
                possible_master_transports)
220
 
        if authors is not None:
221
 
            if u'author' in revprops or u'authors' in revprops:
222
 
                # XXX: maybe we should just accept one of them?
223
 
                raise AssertionError('author property given twice')
224
 
            if authors:
225
 
                for individual in authors:
226
 
                    if '\n' in individual:
227
 
                        raise AssertionError('\\n is not a valid character '
228
 
                                             'in an author identity')
229
 
                revprops[u'authors'] = '\n'.join(authors)
230
 
        return revprops
231
 
 
 
154
                 config=None):
 
155
        if reporter is not None:
 
156
            self.reporter = reporter
 
157
        else:
 
158
            self.reporter = NullCommitReporter()
 
159
        self.config = config
 
160
        
232
161
    def commit(self,
233
162
               message=None,
234
163
               timestamp=None,
245
174
               reporter=None,
246
175
               config=None,
247
176
               message_callback=None,
248
 
               recursive='down',
249
 
               exclude=None,
250
 
               possible_master_transports=None,
251
 
               lossy=False):
 
177
               recursive='down'):
252
178
        """Commit working copy as a new revision.
253
179
 
254
180
        :param message: the commit message (it or message_callback is required)
255
 
        :param message_callback: A callback: message =
256
 
            message_callback(cmt_obj)
257
181
 
258
182
        :param timestamp: if not None, seconds-since-epoch for a
259
183
            postdated/predated commit.
260
184
 
261
 
        :param specific_files: If not None, commit only those files. An empty
262
 
            list means 'commit no files'.
 
185
        :param specific_files: If true, commit only those files.
263
186
 
264
187
        :param rev_id: If set, use this as the new revision id.
265
188
            Useful for test or import commands that need to tightly
275
198
 
276
199
        :param revprops: Properties for new revision
277
200
        :param local: Perform a local only commit.
278
 
        :param reporter: the reporter to use or None for the default
279
 
        :param verbose: if True and the reporter is not None, report everything
280
201
        :param recursive: If set to 'down', commit in any subtrees that have
281
202
            pending changes of any sort during this commit.
282
 
        :param exclude: None or a list of relative paths to exclude from the
283
 
            commit. Pending changes to excluded files will be ignored by the
284
 
            commit.
285
 
        :param lossy: When committing to a foreign VCS, ignore any
286
 
            data that can not be natively represented.
287
203
        """
288
 
        with ExitStack() as stack:
289
 
            self.revprops = revprops or {}
290
 
            # XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
 
            self.config_stack = config or self.config_stack
292
 
            mutter('preparing to commit')
293
 
 
294
 
            if working_tree is None:
295
 
                raise BzrError("working_tree must be passed into commit().")
296
 
            else:
297
 
                self.work_tree = working_tree
298
 
                self.branch = self.work_tree.branch
299
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
 
                    if not self.branch.repository.supports_rich_root():
301
 
                        raise errors.RootNotRich()
302
 
            if message_callback is None:
303
 
                if message is not None:
304
 
                    if isinstance(message, bytes):
305
 
                        message = message.decode(get_user_encoding())
306
 
 
307
 
                    def message_callback(x):
308
 
                        return message
309
 
                else:
310
 
                    raise BzrError("The message or message_callback keyword"
311
 
                                   " parameter is required for commit().")
312
 
 
313
 
            self.bound_branch = None
314
 
            self.any_entries_deleted = False
315
 
            if exclude is not None:
316
 
                self.exclude = sorted(
317
 
                    minimum_path_selection(exclude))
318
 
            else:
319
 
                self.exclude = []
320
 
            self.local = local
321
 
            self.master_branch = None
322
 
            self.recursive = recursive
323
 
            self.rev_id = None
324
 
            # self.specific_files is None to indicate no filter, or any iterable to
325
 
            # indicate a filter - [] means no files at all, as per iter_changes.
326
 
            if specific_files is not None:
327
 
                self.specific_files = sorted(
328
 
                    minimum_path_selection(specific_files))
329
 
            else:
330
 
                self.specific_files = None
331
 
 
332
 
            self.allow_pointless = allow_pointless
333
 
            self.message_callback = message_callback
334
 
            self.timestamp = timestamp
335
 
            self.timezone = timezone
336
 
            self.committer = committer
337
 
            self.strict = strict
338
 
            self.verbose = verbose
339
 
 
340
 
            stack.enter_context(self.work_tree.lock_write())
341
 
            self.parents = self.work_tree.get_parent_ids()
342
 
            self.pb = ui.ui_factory.nested_progress_bar()
343
 
            stack.callback(self.pb.finished)
344
 
            self.basis_revid = self.work_tree.last_revision()
345
 
            self.basis_tree = self.work_tree.basis_tree()
346
 
            stack.enter_context(self.basis_tree.lock_read())
 
204
        mutter('preparing to commit')
 
205
 
 
206
        if working_tree is None:
 
207
            raise BzrError("working_tree must be passed into commit().")
 
208
        else:
 
209
            self.work_tree = working_tree
 
210
            self.branch = self.work_tree.branch
 
211
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
212
                if not self.branch.repository.supports_rich_root():
 
213
                    raise errors.RootNotRich()
 
214
        if message_callback is None:
 
215
            if message is not None:
 
216
                if isinstance(message, str):
 
217
                    message = message.decode(bzrlib.user_encoding)
 
218
                message_callback = lambda x: message
 
219
            else:
 
220
                raise BzrError("The message or message_callback keyword"
 
221
                               " parameter is required for commit().")
 
222
 
 
223
        self.bound_branch = None
 
224
        self.local = local
 
225
        self.master_branch = None
 
226
        self.master_locked = False
 
227
        self.rev_id = None
 
228
        self.specific_files = specific_files
 
229
        self.allow_pointless = allow_pointless
 
230
        self.recursive = recursive
 
231
        self.revprops = revprops
 
232
        self.message_callback = message_callback
 
233
        self.timestamp = timestamp
 
234
        self.timezone = timezone
 
235
        self.committer = committer
 
236
        self.strict = strict
 
237
        self.verbose = verbose
 
238
 
 
239
        if reporter is None and self.reporter is None:
 
240
            self.reporter = NullCommitReporter()
 
241
        elif reporter is not None:
 
242
            self.reporter = reporter
 
243
 
 
244
        self.work_tree.lock_write()
 
245
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
246
        self.basis_tree = self.work_tree.basis_tree()
 
247
        self.basis_tree.lock_read()
 
248
        try:
347
249
            # Cannot commit with conflicts present.
348
250
            if len(self.work_tree.conflicts()) > 0:
349
251
                raise ConflictsInTree
350
252
 
351
253
            # Setup the bound branch variables as needed.
352
 
            self._check_bound_branch(stack, possible_master_transports)
353
 
            if self.config_stack is None:
354
 
                self.config_stack = self.work_tree.get_config_stack()
 
254
            self._check_bound_branch()
355
255
 
356
256
            # Check that the working tree is up to date
357
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
358
 
 
359
 
            # Complete configuration setup
360
 
            if reporter is not None:
361
 
                self.reporter = reporter
362
 
            elif self.reporter is None:
363
 
                self.reporter = self._select_reporter()
 
257
            old_revno,new_revno = self._check_out_of_date_tree()
 
258
 
 
259
            if self.config is None:
 
260
                self.config = self.branch.get_config()
 
261
 
 
262
            # If provided, ensure the specified files are versioned
 
263
            if specific_files is not None:
 
264
                # Note: We don't actually need the IDs here. This routine
 
265
                # is being called because it raises PathNotVerisonedError
 
266
                # as a side effect of finding the IDs.
 
267
                # XXX: Dont we have filter_unversioned to do this more
 
268
                # cheaply?
 
269
                tree.find_ids_across_trees(specific_files,
 
270
                                           [self.basis_tree, self.work_tree])
364
271
 
365
272
            # Setup the progress bar. As the number of files that need to be
366
273
            # committed in unknown, progress is reported as stages.
368
275
            # information in the progress bar during the relevant stages.
369
276
            self.pb_stage_name = ""
370
277
            self.pb_stage_count = 0
371
 
            self.pb_stage_total = 5
 
278
            self.pb_stage_total = 4
372
279
            if self.bound_branch:
373
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
374
 
                # tags to master branch"
375
 
                self.pb_stage_total += 2
 
280
                self.pb_stage_total += 1
376
281
            self.pb.show_pct = False
377
282
            self.pb.show_spinner = False
378
283
            self.pb.show_eta = False
381
286
 
382
287
            # After a merge, a selected file commit is not supported.
383
288
            # See 'bzr help merge' for an explanation as to why.
384
 
            if len(self.parents) > 1 and self.specific_files is not None:
385
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
386
 
            # Excludes are a form of selected file commit.
387
 
            if len(self.parents) > 1 and self.exclude:
388
 
                raise CannotCommitSelectedFileMerge(self.exclude)
389
 
 
 
289
            self.basis_inv = self.basis_tree.inventory
 
290
            self._gather_parents()
 
291
            if len(self.parents) > 1 and self.specific_files:
 
292
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
293
            
390
294
            # Collect the changes
391
 
            self._set_progress_stage("Collecting changes", counter=True)
392
 
            self._lossy = lossy
393
 
            self.builder = self.branch.get_commit_builder(
394
 
                self.parents, self.config_stack, timestamp, timezone, committer,
395
 
                self.revprops, rev_id, lossy=lossy)
396
 
 
397
 
            if self.builder.updates_branch and self.bound_branch:
398
 
                self.builder.abort()
399
 
                raise AssertionError(
400
 
                    "bound branches not supported for commit builders "
401
 
                    "that update the branch")
402
 
 
 
295
            self._set_progress_stage("Collecting changes",
 
296
                    entries_title="Directory")
 
297
            self.builder = self.branch.get_commit_builder(self.parents,
 
298
                self.config, timestamp, timezone, committer, revprops, rev_id)
403
299
            try:
404
 
                # find the location being committed to
405
 
                if self.bound_branch:
406
 
                    master_location = self.master_branch.base
407
 
                else:
408
 
                    master_location = self.branch.base
409
 
 
410
 
                # report the start of the commit
411
 
                self.reporter.started(new_revno, self.rev_id, master_location)
412
 
 
413
300
                self._update_builder_with_changes()
414
301
                self._check_pointless()
415
302
 
422
309
 
423
310
                # Prompt the user for a commit message if none provided
424
311
                message = message_callback(self)
 
312
                assert isinstance(message, unicode), type(message)
425
313
                self.message = message
 
314
                self._escape_commit_message()
426
315
 
427
316
                # Add revision data to the local branch
428
317
                self.rev_id = self.builder.commit(self.message)
429
 
 
430
 
            except Exception:
431
 
                mutter("aborting commit write group because of exception:")
432
 
                trace.log_exception_quietly()
433
 
                self.builder.abort()
 
318
            except:
 
319
                # perhaps this should be done by the CommitBuilder ?
 
320
                self.work_tree.branch.repository.abort_write_group()
434
321
                raise
435
322
 
436
 
            self._update_branches(old_revno, old_revid, new_revno)
437
 
 
438
 
            # Make the working tree be up to date with the branch. This
439
 
            # includes automatic changes scheduled to be made to the tree, such
440
 
            # as updating its basis and unversioning paths that were missing.
441
 
            self.work_tree.unversion(self.deleted_paths)
442
 
            self._set_progress_stage("Updating the working tree")
443
 
            self.work_tree.update_basis_by_delta(self.rev_id,
444
 
                                                 self.builder.get_basis_delta())
445
 
            self.reporter.completed(new_revno, self.rev_id)
446
 
            self._process_post_hooks(old_revno, new_revno)
447
 
            return self.rev_id
448
 
 
449
 
    def _update_branches(self, old_revno, old_revid, new_revno):
450
 
        """Update the master and local branch to the new revision.
451
 
 
452
 
        This will try to make sure that the master branch is updated
453
 
        before the local branch.
454
 
 
455
 
        :param old_revno: Revision number of master branch before the
456
 
            commit
457
 
        :param old_revid: Tip of master branch before the commit
458
 
        :param new_revno: Revision number of the new commit
459
 
        """
460
 
        if not self.builder.updates_branch:
461
 
            self._process_pre_hooks(old_revno, new_revno)
462
 
 
463
323
            # Upload revision data to the master.
464
324
            # this will propagate merged revisions too if needed.
465
325
            if self.bound_branch:
466
326
                self._set_progress_stage("Uploading data to master branch")
 
327
                self.master_branch.repository.fetch(self.branch.repository,
 
328
                                                    revision_id=self.rev_id)
 
329
                # now the master has the revision data
467
330
                # 'commit' to the master first so a timeout here causes the
468
331
                # local branch to be out of date
469
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
471
 
                if self._lossy:
472
 
                    self.branch.fetch(self.master_branch, self.rev_id)
 
332
                self.master_branch.set_last_revision_info(new_revno,
 
333
                                                          self.rev_id)
473
334
 
474
335
            # and now do the commit locally.
475
 
            if new_revno is None:
476
 
                # Keep existing behaviour around ghosts
477
 
                new_revno = 1
478
336
            self.branch.set_last_revision_info(new_revno, self.rev_id)
479
 
        else:
480
 
            try:
481
 
                self._process_pre_hooks(old_revno, new_revno)
482
 
            except BaseException:
483
 
                # The commit builder will already have updated the branch,
484
 
                # revert it.
485
 
                self.branch.set_last_revision_info(old_revno, old_revid)
486
 
                raise
487
 
 
488
 
        # Merge local tags to remote
489
 
        if self.bound_branch:
490
 
            self._set_progress_stage("Merging tags to master branch")
491
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
 
                self.master_branch.tags)
493
 
            if tag_conflicts:
494
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
495
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
 
                    "\n".join(warning_lines))))
497
 
 
498
 
    def _select_reporter(self):
499
 
        """Select the CommitReporter to use."""
500
 
        if is_quiet():
501
 
            return NullCommitReporter()
502
 
        return ReportCommitToLog()
 
337
 
 
338
            # Make the working tree up to date with the branch
 
339
            self._set_progress_stage("Updating the working tree")
 
340
            rev_tree = self.builder.revision_tree()
 
341
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
342
            self.reporter.completed(new_revno, self.rev_id)
 
343
            self._process_hooks(old_revno, new_revno)
 
344
        finally:
 
345
            self._cleanup()
 
346
        return self.rev_id
 
347
 
 
348
    def _any_real_changes(self):
 
349
        """Are there real changes between new_inventory and basis?
 
350
 
 
351
        For trees without rich roots, inv.root.revision changes every commit.
 
352
        But if that is the only change, we want to treat it as though there
 
353
        are *no* changes.
 
354
        """
 
355
        new_entries = self.builder.new_inventory.iter_entries()
 
356
        basis_entries = self.basis_inv.iter_entries()
 
357
        new_path, new_root_ie = new_entries.next()
 
358
        basis_path, basis_root_ie = basis_entries.next()
 
359
 
 
360
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
361
        def ie_equal_no_revision(this, other):
 
362
            return ((this.file_id == other.file_id)
 
363
                    and (this.name == other.name)
 
364
                    and (this.symlink_target == other.symlink_target)
 
365
                    and (this.text_sha1 == other.text_sha1)
 
366
                    and (this.text_size == other.text_size)
 
367
                    and (this.text_id == other.text_id)
 
368
                    and (this.parent_id == other.parent_id)
 
369
                    and (this.kind == other.kind)
 
370
                    and (this.executable == other.executable)
 
371
                    and (this.reference_revision == other.reference_revision)
 
372
                    )
 
373
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
374
            return True
 
375
 
 
376
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
377
            if new_ie != basis_ie:
 
378
                return True
 
379
 
 
380
        # No actual changes present
 
381
        return False
503
382
 
504
383
    def _check_pointless(self):
505
384
        if self.allow_pointless:
507
386
        # A merge with no effect on files
508
387
        if len(self.parents) > 1:
509
388
            return
510
 
        if self.builder.any_changes():
 
389
        # work around the fact that a newly-initted tree does differ from its
 
390
        # basis
 
391
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
 
392
            raise PointlessCommit()
 
393
        # Shortcut, if the number of entries changes, then we obviously have
 
394
        # a change
 
395
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
396
            return
 
397
        # If length == 1, then we only have the root entry. Which means
 
398
        # that there is no real difference (only the root could be different)
 
399
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
511
400
            return
512
401
        raise PointlessCommit()
513
402
 
514
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
 
403
    def _check_bound_branch(self):
515
404
        """Check to see if the local branch is bound.
516
405
 
517
406
        If it is bound, then most of the commit will actually be
522
411
            raise errors.LocalRequiresBoundBranch()
523
412
 
524
413
        if not self.local:
525
 
            self.master_branch = self.branch.get_master_branch(
526
 
                possible_master_transports)
 
414
            self.master_branch = self.branch.get_master_branch()
527
415
 
528
416
        if not self.master_branch:
529
417
            # make this branch the reference branch for out of date checks.
533
421
        # If the master branch is bound, we must fail
534
422
        master_bound_location = self.master_branch.get_bound_location()
535
423
        if master_bound_location:
536
 
            raise errors.CommitToDoubleBoundBranch(
537
 
                self.branch, self.master_branch, master_bound_location)
 
424
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
425
                    self.master_branch, master_bound_location)
538
426
 
539
427
        # TODO: jam 20051230 We could automatically push local
540
428
        #       commits to the remote branch if they would fit.
541
429
        #       But for now, just require remote to be identical
542
430
        #       to local.
543
 
 
 
431
        
544
432
        # Make sure the local branch is identical to the master
545
 
        master_revid = self.master_branch.last_revision()
546
 
        local_revid = self.branch.last_revision()
547
 
        if local_revid != master_revid:
 
433
        master_info = self.master_branch.last_revision_info()
 
434
        local_info = self.branch.last_revision_info()
 
435
        if local_info != master_info:
548
436
            raise errors.BoundBranchOutOfDate(self.branch,
549
 
                                              self.master_branch)
 
437
                    self.master_branch)
550
438
 
551
439
        # Now things are ready to change the master branch
552
440
        # so grab the lock
553
441
        self.bound_branch = self.branch
554
 
        stack.enter_context(self.master_branch.lock_write())
 
442
        self.master_branch.lock_write()
 
443
        self.master_locked = True
555
444
 
556
445
    def _check_out_of_date_tree(self):
557
446
        """Check that the working tree is up to date.
558
447
 
559
 
        :return: old_revision_number, old_revision_id, new_revision_number
560
 
            tuple
 
448
        :return: old_revision_number,new_revision_number tuple
561
449
        """
562
450
        try:
563
451
            first_tree_parent = self.work_tree.get_parent_ids()[0]
566
454
            # this is so that we still consider the master branch
567
455
            # - in a checkout scenario the tree may have no
568
456
            # parents but the branch may do.
569
 
            first_tree_parent = breezy.revision.NULL_REVISION
570
 
        if (self.master_branch._format.stores_revno() or
571
 
                self.config_stack.get('calculate_revnos')):
572
 
            try:
573
 
                old_revno, master_last = self.master_branch.last_revision_info()
574
 
            except errors.UnsupportedOperation:
575
 
                master_last = self.master_branch.last_revision()
576
 
                old_revno = self.branch.revision_id_to_revno(master_last)
577
 
        else:
578
 
            master_last = self.master_branch.last_revision()
579
 
            old_revno = None
 
457
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
458
        old_revno, master_last = self.master_branch.last_revision_info()
580
459
        if master_last != first_tree_parent:
581
 
            if master_last != breezy.revision.NULL_REVISION:
 
460
            if master_last != bzrlib.revision.NULL_REVISION:
582
461
                raise errors.OutOfDateTree(self.work_tree)
583
 
        if (old_revno is not None and
584
 
                self.branch.repository.has_revision(first_tree_parent)):
 
462
        if self.branch.repository.has_revision(first_tree_parent):
585
463
            new_revno = old_revno + 1
586
464
        else:
587
465
            # ghost parents never appear in revision history.
588
 
            new_revno = None
589
 
        return old_revno, master_last, new_revno
590
 
 
591
 
    def _process_pre_hooks(self, old_revno, new_revno):
592
 
        """Process any registered pre commit hooks."""
593
 
        self._set_progress_stage("Running pre_commit hooks")
594
 
        self._process_hooks("pre_commit", old_revno, new_revno)
595
 
 
596
 
    def _process_post_hooks(self, old_revno, new_revno):
597
 
        """Process any registered post commit hooks."""
 
466
            new_revno = 1
 
467
        return old_revno,new_revno
 
468
 
 
469
    def _process_hooks(self, old_revno, new_revno):
 
470
        """Process any registered commit hooks."""
598
471
        # Process the post commit hooks, if any
599
 
        self._set_progress_stage("Running post_commit hooks")
 
472
        self._set_progress_stage("Running post commit hooks")
600
473
        # old style commit hooks - should be deprecated ? (obsoleted in
601
 
        # 0.15^H^H^H^H 2.5.0)
602
 
        post_commit = self.config_stack.get('post_commit')
603
 
        if post_commit is not None:
604
 
            hooks = post_commit.split(' ')
 
474
        # 0.15)
 
475
        if self.config.post_commit() is not None:
 
476
            hooks = self.config.post_commit().split(' ')
605
477
            # this would be nicer with twisted.python.reflect.namedAny
606
478
            for hook in hooks:
607
479
                result = eval(hook + '(branch, rev_id)',
608
 
                              {'branch': self.branch,
609
 
                               'breezy': breezy,
610
 
                               'rev_id': self.rev_id})
611
 
        # process new style post commit hooks
612
 
        self._process_hooks("post_commit", old_revno, new_revno)
613
 
 
614
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
615
 
        if not Branch.hooks[hook_name]:
616
 
            return
617
 
 
 
480
                              {'branch':self.branch,
 
481
                               'bzrlib':bzrlib,
 
482
                               'rev_id':self.rev_id})
618
483
        # new style commit hooks:
619
484
        if not self.bound_branch:
620
485
            hook_master = self.branch
628
493
        if self.parents:
629
494
            old_revid = self.parents[0]
630
495
        else:
631
 
            old_revid = breezy.revision.NULL_REVISION
632
 
 
633
 
        if hook_name == "pre_commit":
634
 
            future_tree = self.builder.revision_tree()
635
 
            tree_delta = future_tree.changes_from(self.basis_tree,
636
 
                                                  include_root=True)
637
 
 
638
 
        for hook in Branch.hooks[hook_name]:
 
496
            old_revid = bzrlib.revision.NULL_REVISION
 
497
        for hook in Branch.hooks['post_commit']:
639
498
            # show the running hook in the progress bar. As hooks may
640
499
            # end up doing nothing (e.g. because they are not configured by
641
500
            # the user) this is still showing progress, not showing overall
642
501
            # actions - its up to each plugin to show a UI if it want's to
643
502
            # (such as 'Emailing diff to foo@example.com').
644
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
645
 
                (hook_name, Branch.hooks.get_hook_name(hook))
 
503
            self.pb_stage_name = "Running post commit hooks [%s]" % \
 
504
                Branch.hooks.get_hook_name(hook)
646
505
            self._emit_progress()
647
506
            if 'hooks' in debug.debug_flags:
648
507
                mutter("Invoking commit hook: %r", hook)
649
 
            if hook_name == "post_commit":
650
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
651
 
                     self.rev_id)
652
 
            elif hook_name == "pre_commit":
653
 
                hook(hook_local, hook_master,
654
 
                     old_revno, old_revid, new_revno, self.rev_id,
655
 
                     tree_delta, future_tree)
 
508
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
509
                self.rev_id)
 
510
 
 
511
    def _cleanup(self):
 
512
        """Cleanup any open locks, progress bars etc."""
 
513
        cleanups = [self._cleanup_bound_branch,
 
514
                    self.basis_tree.unlock,
 
515
                    self.work_tree.unlock,
 
516
                    self.pb.finished]
 
517
        found_exception = None
 
518
        for cleanup in cleanups:
 
519
            try:
 
520
                cleanup()
 
521
            # we want every cleanup to run no matter what.
 
522
            # so we have a catchall here, but we will raise the
 
523
            # last encountered exception up the stack: and
 
524
            # typically this will be useful enough.
 
525
            except Exception, e:
 
526
                found_exception = e
 
527
        if found_exception is not None: 
 
528
            # don't do a plan raise, because the last exception may have been
 
529
            # trashed, e is our sure-to-work exception even though it loses the
 
530
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
531
            # exc_info and if its the same one do a plain raise otherwise 
 
532
            # 'raise e' as we do now.
 
533
            raise e
 
534
 
 
535
    def _cleanup_bound_branch(self):
 
536
        """Executed at the end of a try/finally to cleanup a bound branch.
 
537
 
 
538
        If the branch wasn't bound, this is a no-op.
 
539
        If it was, it resents self.branch to the local branch, instead
 
540
        of being the master.
 
541
        """
 
542
        if not self.bound_branch:
 
543
            return
 
544
        if self.master_locked:
 
545
            self.master_branch.unlock()
 
546
 
 
547
    def _escape_commit_message(self):
 
548
        """Replace xml-incompatible control characters."""
 
549
        # FIXME: RBC 20060419 this should be done by the revision
 
550
        # serialiser not by commit. Then we can also add an unescaper
 
551
        # in the deserializer and start roundtripping revision messages
 
552
        # precisely. See repository_implementations/test_repository.py
 
553
        
 
554
        # Python strings can include characters that can't be
 
555
        # represented in well-formed XML; escape characters that
 
556
        # aren't listed in the XML specification
 
557
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
558
        self.message, escape_count = re.subn(
 
559
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
560
            lambda match: match.group(0).encode('unicode_escape'),
 
561
            self.message)
 
562
        if escape_count:
 
563
            self.reporter.escaped(escape_count, self.message)
 
564
 
 
565
    def _gather_parents(self):
 
566
        """Record the parents of a merge for merge detection."""
 
567
        # TODO: Make sure that this list doesn't contain duplicate 
 
568
        # entries and the order is preserved when doing this.
 
569
        self.parents = self.work_tree.get_parent_ids()
 
570
        self.parent_invs = [self.basis_inv]
 
571
        for revision in self.parents[1:]:
 
572
            if self.branch.repository.has_revision(revision):
 
573
                mutter('commit parent revision {%s}', revision)
 
574
                inventory = self.branch.repository.get_inventory(revision)
 
575
                self.parent_invs.append(inventory)
 
576
            else:
 
577
                mutter('commit parent ghost revision {%s}', revision)
656
578
 
657
579
    def _update_builder_with_changes(self):
658
580
        """Update the commit builder with the data about what has changed.
659
581
        """
 
582
        # Build the revision inventory.
 
583
        #
 
584
        # This starts by creating a new empty inventory. Depending on
 
585
        # which files are selected for commit, and what is present in the
 
586
        # current tree, the new inventory is populated. inventory entries 
 
587
        # which are candidates for modification have their revision set to
 
588
        # None; inventory entries that are carried over untouched have their
 
589
        # revision set to their prior value.
 
590
        #
 
591
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
592
        # results to create a new inventory at the same time, which results
 
593
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
594
        # ADHB 11-07-2006
 
595
 
660
596
        specific_files = self.specific_files
661
 
        mutter("Selecting files for commit with filter %r", specific_files)
662
 
 
663
 
        self._check_strict()
664
 
        iter_changes = self.work_tree.iter_changes(
665
 
            self.basis_tree, specific_files=specific_files)
666
 
        if self.exclude:
667
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
668
 
        iter_changes = self._filter_iter_changes(iter_changes)
669
 
        for path, fs_hash in self.builder.record_iter_changes(
670
 
                self.work_tree, self.basis_revid, iter_changes):
671
 
            self.work_tree._observed_sha1(path, fs_hash)
672
 
 
673
 
    def _filter_iter_changes(self, iter_changes):
674
 
        """Process iter_changes.
675
 
 
676
 
        This method reports on the changes in iter_changes to the user, and
677
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
678
 
        entries. 'missing' entries have their
679
 
 
680
 
        :param iter_changes: An iter_changes to process.
681
 
        :return: A generator of changes.
682
 
        """
683
 
        reporter = self.reporter
684
 
        report_changes = reporter.is_verbose()
685
 
        deleted_paths = []
686
 
        for change in iter_changes:
687
 
            if report_changes:
688
 
                old_path = change.path[0]
689
 
                new_path = change.path[1]
690
 
                versioned = change.versioned[1]
691
 
            kind = change.kind[1]
692
 
            versioned = change.versioned[1]
693
 
            if kind is None and versioned:
694
 
                # 'missing' path
695
 
                if report_changes:
696
 
                    reporter.missing(new_path)
697
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
 
                    trace.warning('Ignoring "%s" as symlinks are not '
699
 
                                  'supported on this filesystem.' % (change.path[0],))
700
 
                    continue
701
 
                deleted_paths.append(change.path[1])
702
 
                # Reset the new path (None) and new versioned flag (False)
703
 
                change = change.discard_new()
704
 
                new_path = change.path[1]
705
 
                versioned = False
706
 
            elif kind == 'tree-reference':
707
 
                if self.recursive == 'down':
708
 
                    self._commit_nested_tree(change.path[1])
709
 
            if change.versioned[0] or change.versioned[1]:
710
 
                yield change
711
 
                if report_changes:
712
 
                    if new_path is None:
713
 
                        reporter.deleted(old_path)
714
 
                    elif old_path is None:
715
 
                        reporter.snapshot_change(gettext('added'), new_path)
716
 
                    elif old_path != new_path:
717
 
                        reporter.renamed(gettext('renamed'),
718
 
                                         old_path, new_path)
719
 
                    else:
720
 
                        if (new_path
721
 
                                or self.work_tree.branch.repository._format.rich_root_data):
722
 
                            # Don't report on changes to '' in non rich root
723
 
                            # repositories.
724
 
                            reporter.snapshot_change(
725
 
                                gettext('modified'), new_path)
726
 
            self._next_progress_entry()
727
 
        # Unversion files that were found to be deleted
728
 
        self.deleted_paths = deleted_paths
729
 
 
730
 
    def _check_strict(self):
731
 
        # XXX: when we use iter_changes this would likely be faster if
732
 
        # iter_changes would check for us (even in the presence of
733
 
        # selected_files).
 
597
        mutter("Selecting files for commit with filter %s", specific_files)
 
598
 
 
599
        # Check and warn about old CommitBuilders
 
600
        if not self.builder.record_root_entry:
 
601
            symbol_versioning.warn('CommitBuilders should support recording'
 
602
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
603
                stacklevel=1)
 
604
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
605
 
 
606
        # Build the new inventory
 
607
        self._populate_from_inventory(specific_files)
 
608
 
 
609
        # If specific files are selected, then all un-selected files must be
 
610
        # recorded in their previous state. For more details, see
 
611
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
612
        if specific_files:
 
613
            for path, new_ie in self.basis_inv.iter_entries():
 
614
                if new_ie.file_id in self.builder.new_inventory:
 
615
                    continue
 
616
                if is_inside_any(specific_files, path):
 
617
                    continue
 
618
                ie = new_ie.copy()
 
619
                ie.revision = None
 
620
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
621
                                                   self.basis_tree)
 
622
 
 
623
        # Report what was deleted. We could skip this when no deletes are
 
624
        # detected to gain a performance win, but it arguably serves as a
 
625
        # 'safety check' by informing the user whenever anything disappears.
 
626
        for path, ie in self.basis_inv.iter_entries():
 
627
            if ie.file_id not in self.builder.new_inventory:
 
628
                self.reporter.deleted(path)
 
629
 
 
630
    def _populate_from_inventory(self, specific_files):
 
631
        """Populate the CommitBuilder by walking the working tree inventory."""
734
632
        if self.strict:
735
633
            # raise an exception as soon as we find a single unknown.
736
634
            for unknown in self.work_tree.unknowns():
737
635
                raise StrictCommitFailed()
738
 
 
739
 
    def _commit_nested_tree(self, path):
 
636
               
 
637
        deleted_ids = []
 
638
        deleted_paths = set()
 
639
        work_inv = self.work_tree.inventory
 
640
        assert work_inv.root is not None
 
641
        entries = work_inv.iter_entries()
 
642
        if not self.builder.record_root_entry:
 
643
            entries.next()
 
644
        for path, existing_ie in entries:
 
645
            file_id = existing_ie.file_id
 
646
            name = existing_ie.name
 
647
            parent_id = existing_ie.parent_id
 
648
            kind = existing_ie.kind
 
649
            if kind == 'directory':
 
650
                self._next_progress_entry()
 
651
 
 
652
            # Skip files that have been deleted from the working tree.
 
653
            # The deleted files/directories are also recorded so they
 
654
            # can be explicitly unversioned later. Note that when a
 
655
            # filter of specific files is given, we must only skip/record
 
656
            # deleted files matching that filter.
 
657
            if is_inside_any(deleted_paths, path):
 
658
                continue
 
659
            if not specific_files or is_inside_any(specific_files, path):
 
660
                if not self.work_tree.has_filename(path):
 
661
                    deleted_paths.add(path)
 
662
                    self.reporter.missing(path)
 
663
                    deleted_ids.append(file_id)
 
664
                    continue
 
665
            try:
 
666
                kind = self.work_tree.kind(file_id)
 
667
                # TODO: specific_files filtering before nested tree processing
 
668
                if kind == 'tree-reference' and self.recursive == 'down':
 
669
                    self._commit_nested_tree(file_id, path)
 
670
            except errors.NoSuchFile:
 
671
                pass
 
672
 
 
673
            # Record an entry for this item
 
674
            # Note: I don't particularly want to have the existing_ie
 
675
            # parameter but the test suite currently (28-Jun-07) breaks
 
676
            # without it thanks to a unicode normalisation issue. :-(
 
677
            definitely_changed = kind != existing_ie.kind 
 
678
            self._record_entry(path, file_id, specific_files, kind, name,
 
679
                parent_id, definitely_changed, existing_ie)
 
680
 
 
681
        # Unversion IDs that were found to be deleted
 
682
        self.work_tree.unversion(deleted_ids)
 
683
 
 
684
    def _commit_nested_tree(self, file_id, path):
740
685
        "Commit a nested tree."
741
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
686
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
742
687
        # FIXME: be more comprehensive here:
743
688
        # this works when both trees are in --trees repository,
744
689
        # but when both are bound to a different repository,
745
 
        # it fails; a better way of approaching this is to
 
690
        # it fails; a better way of approaching this is to 
746
691
        # finally implement the explicit-caches approach design
747
692
        # a while back - RBC 20070306.
748
 
        if sub_tree.branch.repository.has_same_location(
749
 
                self.work_tree.branch.repository):
 
693
        if (sub_tree.branch.repository.bzrdir.root_transport.base
 
694
            ==
 
695
            self.work_tree.branch.repository.bzrdir.root_transport.base):
750
696
            sub_tree.branch.repository = \
751
697
                self.work_tree.branch.repository
752
698
        try:
753
 
            return sub_tree.commit(message=None, revprops=self.revprops,
754
 
                                   recursive=self.recursive,
755
 
                                   message_callback=self.message_callback,
756
 
                                   timestamp=self.timestamp,
757
 
                                   timezone=self.timezone,
758
 
                                   committer=self.committer,
759
 
                                   allow_pointless=self.allow_pointless,
760
 
                                   strict=self.strict, verbose=self.verbose,
761
 
                                   local=self.local, reporter=self.reporter)
762
 
        except PointlessCommit:
763
 
            return self.work_tree.get_reference_revision(path)
764
 
 
765
 
    def _set_progress_stage(self, name, counter=False):
 
699
            sub_tree.commit(message=None, revprops=self.revprops,
 
700
                recursive=self.recursive,
 
701
                message_callback=self.message_callback,
 
702
                timestamp=self.timestamp, timezone=self.timezone,
 
703
                committer=self.committer,
 
704
                allow_pointless=self.allow_pointless,
 
705
                strict=self.strict, verbose=self.verbose,
 
706
                local=self.local, reporter=self.reporter)
 
707
        except errors.PointlessCommit:
 
708
            pass
 
709
 
 
710
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
711
                      parent_id, definitely_changed, existing_ie=None):
 
712
        "Record the new inventory entry for a path if any."
 
713
        # mutter('check %s {%s}', path, file_id)
 
714
        if (not specific_files or 
 
715
            is_inside_or_parent_of_any(specific_files, path)):
 
716
                # mutter('%s selected for commit', path)
 
717
                if definitely_changed or existing_ie is None:
 
718
                    ie = inventory.make_entry(kind, name, parent_id, file_id)
 
719
                else:
 
720
                    ie = existing_ie.copy()
 
721
                    ie.revision = None
 
722
        else:
 
723
            # mutter('%s not selected for commit', path)
 
724
            if self.basis_inv.has_id(file_id):
 
725
                ie = self.basis_inv[file_id].copy()
 
726
            else:
 
727
                # this entry is new and not being committed
 
728
                ie = None
 
729
        if ie is not None:
 
730
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
731
                path, self.work_tree)
 
732
            self._report_change(ie, path)
 
733
        return ie
 
734
 
 
735
    def _report_change(self, ie, path):
 
736
        """Report a change to the user.
 
737
 
 
738
        The change that has occurred is described relative to the basis
 
739
        inventory.
 
740
        """
 
741
        if (self.basis_inv.has_id(ie.file_id)):
 
742
            basis_ie = self.basis_inv[ie.file_id]
 
743
        else:
 
744
            basis_ie = None
 
745
        change = ie.describe_change(basis_ie, ie)
 
746
        if change in (InventoryEntry.RENAMED, 
 
747
            InventoryEntry.MODIFIED_AND_RENAMED):
 
748
            old_path = self.basis_inv.id2path(ie.file_id)
 
749
            self.reporter.renamed(change, old_path, path)
 
750
        else:
 
751
            self.reporter.snapshot_change(change, path)
 
752
 
 
753
    def _set_progress_stage(self, name, entries_title=None):
766
754
        """Set the progress stage and emit an update to the progress bar."""
767
755
        self.pb_stage_name = name
768
756
        self.pb_stage_count += 1
769
 
        if counter:
 
757
        self.pb_entries_title = entries_title
 
758
        if entries_title is not None:
770
759
            self.pb_entries_count = 0
771
 
        else:
772
 
            self.pb_entries_count = None
 
760
            self.pb_entries_total = '?'
773
761
        self._emit_progress()
774
762
 
775
763
    def _next_progress_entry(self):
778
766
        self._emit_progress()
779
767
 
780
768
    def _emit_progress(self):
781
 
        if self.pb_entries_count is not None:
782
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
783
 
                                                       self.pb_entries_count)
 
769
        if self.pb_entries_title:
 
770
            if self.pb_entries_total == '?':
 
771
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
772
                    self.pb_entries_title, self.pb_entries_count)
 
773
            else:
 
774
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
775
                    self.pb_entries_title, self.pb_entries_count,
 
776
                    str(self.pb_entries_total))
784
777
        else:
785
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
778
            text = "%s - Stage" % (self.pb_stage_name)
786
779
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
780