/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: Robert Collins
  • Date: 2007-07-15 15:40:37 UTC
  • mto: (2592.3.33 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070715154037-3ar8g89decddc9su
Make GraphIndex accept nodes as key, value, references, so that the method
signature is closer to what a simple key->value index delivers. Also
change the behaviour when the reference list count is zero to accept
key, value as nodes, and emit key, value to make it identical in that case
to a simple key->value index. This may not be a good idea, but for now it
seems ok.

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 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
                            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
115
84
 
116
85
 
117
86
class NullCommitReporter(object):
118
87
    """I report on progress of a commit."""
119
88
 
120
 
    def started(self, revno, revid, location):
121
 
        pass
122
 
 
123
89
    def snapshot_change(self, change, path):
124
90
        pass
125
91
 
126
92
    def completed(self, revno, rev_id):
127
93
        pass
128
94
 
129
 
    def deleted(self, path):
 
95
    def deleted(self, file_id):
 
96
        pass
 
97
 
 
98
    def escaped(self, escape_count, message):
130
99
        pass
131
100
 
132
101
    def missing(self, path):
135
104
    def renamed(self, change, old_path, new_path):
136
105
        pass
137
106
 
138
 
    def is_verbose(self):
139
 
        return False
140
 
 
141
107
 
142
108
class ReportCommitToLog(NullCommitReporter):
143
109
 
149
115
        note(format, *args)
150
116
 
151
117
    def snapshot_change(self, change, path):
152
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
118
        if change == 'unchanged':
 
119
            return
 
120
        if change == 'added' and path == '':
153
121
            return
154
122
        self._note("%s %s", change, path)
155
123
 
156
 
    def started(self, revno, rev_id, location):
157
 
        self._note(
158
 
            gettext('Committing to: %s'),
159
 
            unescape_for_display(location, 'utf-8'))
160
 
 
161
124
    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)
 
125
        self._note('Committed revision %d.', revno)
 
126
    
 
127
    def deleted(self, file_id):
 
128
        self._note('deleted %s', file_id)
169
129
 
170
 
    def deleted(self, path):
171
 
        self._note(gettext('deleted %s'), path)
 
130
    def escaped(self, escape_count, message):
 
131
        self._note("replaced %d control characters in message", escape_count)
172
132
 
173
133
    def missing(self, path):
174
 
        self._note(gettext('missing %s'), path)
 
134
        self._note('missing %s', path)
175
135
 
176
136
    def renamed(self, change, old_path, new_path):
177
137
        self._note('%s %s => %s', change, old_path, new_path)
178
138
 
179
 
    def is_verbose(self):
180
 
        return True
181
 
 
182
139
 
183
140
class Commit(object):
184
141
    """Task of committing a new revision.
192
149
            the working directory; these should be removed from the
193
150
            working inventory.
194
151
    """
195
 
 
196
152
    def __init__(self,
197
153
                 reporter=None,
198
 
                 config_stack=None):
199
 
        """Create a Commit object.
200
 
 
201
 
        :param reporter: the default reporter to use or None to decide later
202
 
        """
203
 
        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
229
 
 
 
154
                 config=None):
 
155
        if reporter is not None:
 
156
            self.reporter = reporter
 
157
        else:
 
158
            self.reporter = NullCommitReporter()
 
159
        self.config = config
 
160
        
230
161
    def commit(self,
231
162
               message=None,
232
163
               timestamp=None,
243
174
               reporter=None,
244
175
               config=None,
245
176
               message_callback=None,
246
 
               recursive='down',
247
 
               exclude=None,
248
 
               possible_master_transports=None,
249
 
               lossy=False):
 
177
               recursive='down'):
250
178
        """Commit working copy as a new revision.
251
179
 
252
180
        :param message: the commit message (it or message_callback is required)
253
 
        :param message_callback: A callback: message =
254
 
            message_callback(cmt_obj)
255
181
 
256
182
        :param timestamp: if not None, seconds-since-epoch for a
257
183
            postdated/predated commit.
258
184
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
 
185
        :param specific_files: If true, commit only those files.
261
186
 
262
187
        :param rev_id: If set, use this as the new revision id.
263
188
            Useful for test or import commands that need to tightly
273
198
 
274
199
        :param revprops: Properties for new revision
275
200
        :param local: Perform a local only commit.
276
 
        :param reporter: the reporter to use or None for the default
277
 
        :param verbose: if True and the reporter is not None, report everything
278
201
        :param recursive: If set to 'down', commit in any subtrees that have
279
202
            pending changes of any sort during this commit.
280
 
        :param exclude: None or a list of relative paths to exclude from the
281
 
            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.
285
203
        """
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
204
        mutter('preparing to commit')
314
205
 
315
206
        if working_tree is None:
322
213
                    raise errors.RootNotRich()
323
214
        if message_callback is None:
324
215
            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
 
216
                if isinstance(message, str):
 
217
                    message = message.decode(bzrlib.user_encoding)
 
218
                message_callback = lambda x: message
330
219
            else:
331
220
                raise BzrError("The message or message_callback keyword"
332
221
                               " parameter is required for commit().")
333
222
 
334
223
        self.bound_branch = None
335
 
        self.any_entries_deleted = False
336
 
        if exclude is not None:
337
 
            self.exclude = sorted(
338
 
                minimum_path_selection(exclude))
339
 
        else:
340
 
            self.exclude = []
341
224
        self.local = local
342
225
        self.master_branch = None
343
 
        self.recursive = recursive
 
226
        self.master_locked = False
344
227
        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
 
        if specific_files is not None:
348
 
            self.specific_files = sorted(
349
 
                minimum_path_selection(specific_files))
350
 
        else:
351
 
            self.specific_files = None
352
 
 
 
228
        self.specific_files = specific_files
353
229
        self.allow_pointless = allow_pointless
 
230
        self.recursive = recursive
 
231
        self.revprops = revprops
354
232
        self.message_callback = message_callback
355
233
        self.timestamp = timestamp
356
234
        self.timezone = timezone
358
236
        self.strict = strict
359
237
        self.verbose = verbose
360
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
 
361
244
        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)
366
 
        self.basis_revid = self.work_tree.last_revision()
 
245
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
367
246
        self.basis_tree = self.work_tree.basis_tree()
368
247
        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
248
        try:
427
 
            # find the location being committed to
 
249
            # Cannot commit with conflicts present.
 
250
            if len(self.work_tree.conflicts()) > 0:
 
251
                raise ConflictsInTree
 
252
 
 
253
            # Setup the bound branch variables as needed.
 
254
            self._check_bound_branch()
 
255
 
 
256
            # Check that the working tree is up to date
 
257
            old_revno,new_revno = self._check_out_of_date_tree()
 
258
 
 
259
            if strict:
 
260
                # raise an exception as soon as we find a single unknown.
 
261
                for unknown in self.work_tree.unknowns():
 
262
                    raise StrictCommitFailed()
 
263
                   
 
264
            if self.config is None:
 
265
                self.config = self.branch.get_config()
 
266
 
 
267
            # If provided, ensure the specified files are versioned
 
268
            if specific_files is not None:
 
269
                # Note: We don't actually need the IDs here. This routine
 
270
                # is being called because it raises PathNotVerisonedError
 
271
                # as a side effect of finding the IDs.
 
272
                # XXX: Dont we have filter_unversioned to do this more
 
273
                # cheaply?
 
274
                tree.find_ids_across_trees(specific_files,
 
275
                                           [self.basis_tree, self.work_tree])
 
276
 
 
277
            # Setup the progress bar. As the number of files that need to be
 
278
            # committed in unknown, progress is reported as stages.
 
279
            # We keep track of entries separately though and include that
 
280
            # information in the progress bar during the relevant stages.
 
281
            self.pb_stage_name = ""
 
282
            self.pb_stage_count = 0
 
283
            self.pb_stage_total = 4
428
284
            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
 
 
 
285
                self.pb_stage_total += 1
 
286
            self.pb.show_pct = False
 
287
            self.pb.show_spinner = False
 
288
            self.pb.show_eta = False
 
289
            self.pb.show_count = True
 
290
            self.pb.show_bar = True
 
291
 
 
292
            # After a merge, a selected file commit is not supported.
 
293
            # See 'bzr help merge' for an explanation as to why.
 
294
            self.basis_inv = self.basis_tree.inventory
 
295
            self._gather_parents()
 
296
            if len(self.parents) > 1 and self.specific_files:
 
297
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
298
            
 
299
            # Collect the changes
 
300
            self._emit_progress_set_stage("Collecting changes", show_entries=True)
 
301
            self.builder = self.branch.get_commit_builder(self.parents,
 
302
                self.config, timestamp, timezone, committer, revprops, rev_id)
436
303
            self._update_builder_with_changes()
437
304
            self._check_pointless()
438
305
 
440
307
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
441
308
            # weave lines, because nothing should be recorded until it is known
442
309
            # that commit will succeed.
443
 
            self._set_progress_stage("Saving data locally")
 
310
            self._emit_progress_set_stage("Saving data locally")
444
311
            self.builder.finish_inventory()
445
312
 
446
313
            # Prompt the user for a commit message if none provided
447
314
            message = message_callback(self)
 
315
            assert isinstance(message, unicode), type(message)
448
316
            self.message = message
 
317
            self._escape_commit_message()
449
318
 
450
319
            # Add revision data to the local branch
451
320
            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:
484
 
            self._process_pre_hooks(old_revno, new_revno)
485
 
 
 
321
            
486
322
            # Upload revision data to the master.
487
323
            # this will propagate merged revisions too if needed.
488
324
            if self.bound_branch:
489
 
                self._set_progress_stage("Uploading data to master branch")
 
325
                self._emit_progress_set_stage("Uploading data to master branch")
 
326
                self.master_branch.repository.fetch(self.branch.repository,
 
327
                                                    revision_id=self.rev_id)
 
328
                # now the master has the revision data
490
329
                # 'commit' to the master first so a timeout here causes the
491
330
                # 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)
 
331
                self.master_branch.set_last_revision_info(new_revno,
 
332
                                                          self.rev_id)
496
333
 
497
334
            # and now do the commit locally.
498
335
            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
 
 
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))))
517
 
 
518
 
    def _select_reporter(self):
519
 
        """Select the CommitReporter to use."""
520
 
        if is_quiet():
521
 
            return NullCommitReporter()
522
 
        return ReportCommitToLog()
 
336
 
 
337
            # Make the working tree up to date with the branch
 
338
            self._emit_progress_set_stage("Updating the working tree")
 
339
            rev_tree = self.builder.revision_tree()
 
340
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
341
            self.reporter.completed(new_revno, self.rev_id)
 
342
            self._process_hooks(old_revno, new_revno)
 
343
        finally:
 
344
            self._cleanup()
 
345
        return self.rev_id
 
346
 
 
347
    def _any_real_changes(self):
 
348
        """Are there real changes between new_inventory and basis?
 
349
 
 
350
        For trees without rich roots, inv.root.revision changes every commit.
 
351
        But if that is the only change, we want to treat it as though there
 
352
        are *no* changes.
 
353
        """
 
354
        new_entries = self.builder.new_inventory.iter_entries()
 
355
        basis_entries = self.basis_inv.iter_entries()
 
356
        new_path, new_root_ie = new_entries.next()
 
357
        basis_path, basis_root_ie = basis_entries.next()
 
358
 
 
359
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
360
        def ie_equal_no_revision(this, other):
 
361
            return ((this.file_id == other.file_id)
 
362
                    and (this.name == other.name)
 
363
                    and (this.symlink_target == other.symlink_target)
 
364
                    and (this.text_sha1 == other.text_sha1)
 
365
                    and (this.text_size == other.text_size)
 
366
                    and (this.text_id == other.text_id)
 
367
                    and (this.parent_id == other.parent_id)
 
368
                    and (this.kind == other.kind)
 
369
                    and (this.executable == other.executable)
 
370
                    and (this.reference_revision == other.reference_revision)
 
371
                    )
 
372
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
373
            return True
 
374
 
 
375
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
376
            if new_ie != basis_ie:
 
377
                return True
 
378
 
 
379
        # No actual changes present
 
380
        return False
523
381
 
524
382
    def _check_pointless(self):
525
383
        if self.allow_pointless:
527
385
        # A merge with no effect on files
528
386
        if len(self.parents) > 1:
529
387
            return
530
 
        if self.builder.any_changes():
 
388
        # work around the fact that a newly-initted tree does differ from its
 
389
        # basis
 
390
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
 
391
            raise PointlessCommit()
 
392
        # Shortcut, if the number of entries changes, then we obviously have
 
393
        # a change
 
394
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
395
            return
 
396
        # If length == 1, then we only have the root entry. Which means
 
397
        # that there is no real difference (only the root could be different)
 
398
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
531
399
            return
532
400
        raise PointlessCommit()
533
401
 
534
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
402
    def _check_bound_branch(self):
535
403
        """Check to see if the local branch is bound.
536
404
 
537
405
        If it is bound, then most of the commit will actually be
542
410
            raise errors.LocalRequiresBoundBranch()
543
411
 
544
412
        if not self.local:
545
 
            self.master_branch = self.branch.get_master_branch(
546
 
                possible_master_transports)
 
413
            self.master_branch = self.branch.get_master_branch()
547
414
 
548
415
        if not self.master_branch:
549
416
            # make this branch the reference branch for out of date checks.
553
420
        # If the master branch is bound, we must fail
554
421
        master_bound_location = self.master_branch.get_bound_location()
555
422
        if master_bound_location:
556
 
            raise errors.CommitToDoubleBoundBranch(
557
 
                self.branch, self.master_branch, master_bound_location)
 
423
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
424
                    self.master_branch, master_bound_location)
558
425
 
559
426
        # TODO: jam 20051230 We could automatically push local
560
427
        #       commits to the remote branch if they would fit.
561
428
        #       But for now, just require remote to be identical
562
429
        #       to local.
563
 
 
 
430
        
564
431
        # 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:
 
432
        master_info = self.master_branch.last_revision_info()
 
433
        local_info = self.branch.last_revision_info()
 
434
        if local_info != master_info:
568
435
            raise errors.BoundBranchOutOfDate(self.branch,
569
 
                                              self.master_branch)
 
436
                    self.master_branch)
570
437
 
571
438
        # Now things are ready to change the master branch
572
439
        # so grab the lock
573
440
        self.bound_branch = self.branch
574
441
        self.master_branch.lock_write()
575
 
        operation.add_cleanup(self.master_branch.unlock)
 
442
        self.master_locked = True
576
443
 
577
444
    def _check_out_of_date_tree(self):
578
445
        """Check that the working tree is up to date.
579
446
 
580
 
        :return: old_revision_number, old_revision_id, new_revision_number
581
 
            tuple
 
447
        :return: old_revision_number,new_revision_number tuple
582
448
        """
583
449
        try:
584
450
            first_tree_parent = self.work_tree.get_parent_ids()[0]
587
453
            # this is so that we still consider the master branch
588
454
            # - in a checkout scenario the tree may have no
589
455
            # 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)
 
456
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
457
        old_revno, master_last = self.master_branch.last_revision_info()
596
458
        if master_last != first_tree_parent:
597
 
            if master_last != breezy.revision.NULL_REVISION:
 
459
            if master_last != bzrlib.revision.NULL_REVISION:
598
460
                raise errors.OutOfDateTree(self.work_tree)
599
461
        if self.branch.repository.has_revision(first_tree_parent):
600
462
            new_revno = old_revno + 1
601
463
        else:
602
464
            # ghost parents never appear in revision history.
603
465
            new_revno = 1
604
 
        return old_revno, master_last, new_revno
605
 
 
606
 
    def _process_pre_hooks(self, old_revno, new_revno):
607
 
        """Process any registered pre commit hooks."""
608
 
        self._set_progress_stage("Running pre_commit hooks")
609
 
        self._process_hooks("pre_commit", old_revno, new_revno)
610
 
 
611
 
    def _process_post_hooks(self, old_revno, new_revno):
612
 
        """Process any registered post commit hooks."""
 
466
        return old_revno,new_revno
 
467
 
 
468
    def _process_hooks(self, old_revno, new_revno):
 
469
        """Process any registered commit hooks."""
613
470
        # Process the post commit hooks, if any
614
 
        self._set_progress_stage("Running post_commit hooks")
 
471
        self._emit_progress_set_stage("Running post commit hooks")
615
472
        # 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(' ')
 
473
        # 0.15)
 
474
        if self.config.post_commit() is not None:
 
475
            hooks = self.config.post_commit().split(' ')
620
476
            # this would be nicer with twisted.python.reflect.namedAny
621
477
            for hook in hooks:
622
478
                result = eval(hook + '(branch, rev_id)',
623
 
                              {'branch': self.branch,
624
 
                               'breezy': breezy,
625
 
                               'rev_id': self.rev_id})
626
 
        # process new style post commit hooks
627
 
        self._process_hooks("post_commit", old_revno, new_revno)
628
 
 
629
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
630
 
        if not Branch.hooks[hook_name]:
631
 
            return
632
 
 
 
479
                              {'branch':self.branch,
 
480
                               'bzrlib':bzrlib,
 
481
                               'rev_id':self.rev_id})
633
482
        # new style commit hooks:
634
483
        if not self.bound_branch:
635
484
            hook_master = self.branch
643
492
        if self.parents:
644
493
            old_revid = self.parents[0]
645
494
        else:
646
 
            old_revid = breezy.revision.NULL_REVISION
647
 
 
648
 
        if hook_name == "pre_commit":
649
 
            future_tree = self.builder.revision_tree()
650
 
            tree_delta = future_tree.changes_from(self.basis_tree,
651
 
                                                  include_root=True)
652
 
 
653
 
        for hook in Branch.hooks[hook_name]:
 
495
            old_revid = bzrlib.revision.NULL_REVISION
 
496
        for hook in Branch.hooks['post_commit']:
654
497
            # show the running hook in the progress bar. As hooks may
655
498
            # end up doing nothing (e.g. because they are not configured by
656
499
            # the user) this is still showing progress, not showing overall
657
500
            # actions - its up to each plugin to show a UI if it want's to
658
501
            # (such as 'Emailing diff to foo@example.com').
659
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
660
 
                (hook_name, Branch.hooks.get_hook_name(hook))
 
502
            self.pb_stage_name = "Running post commit hooks [%s]" % \
 
503
                Branch.hooks.get_hook_name(hook)
661
504
            self._emit_progress()
662
505
            if 'hooks' in debug.debug_flags:
663
506
                mutter("Invoking commit hook: %r", hook)
664
 
            if hook_name == "post_commit":
665
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
666
 
                     self.rev_id)
667
 
            elif hook_name == "pre_commit":
668
 
                hook(hook_local, hook_master,
669
 
                     old_revno, old_revid, new_revno, self.rev_id,
670
 
                     tree_delta, future_tree)
 
507
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
508
                self.rev_id)
 
509
 
 
510
    def _cleanup(self):
 
511
        """Cleanup any open locks, progress bars etc."""
 
512
        cleanups = [self._cleanup_bound_branch,
 
513
                    self.basis_tree.unlock,
 
514
                    self.work_tree.unlock,
 
515
                    self.pb.finished]
 
516
        found_exception = None
 
517
        for cleanup in cleanups:
 
518
            try:
 
519
                cleanup()
 
520
            # we want every cleanup to run no matter what.
 
521
            # so we have a catchall here, but we will raise the
 
522
            # last encountered exception up the stack: and
 
523
            # typically this will be useful enough.
 
524
            except Exception, e:
 
525
                found_exception = e
 
526
        if found_exception is not None: 
 
527
            # don't do a plan raise, because the last exception may have been
 
528
            # trashed, e is our sure-to-work exception even though it loses the
 
529
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
530
            # exc_info and if its the same one do a plain raise otherwise 
 
531
            # 'raise e' as we do now.
 
532
            raise e
 
533
 
 
534
    def _cleanup_bound_branch(self):
 
535
        """Executed at the end of a try/finally to cleanup a bound branch.
 
536
 
 
537
        If the branch wasn't bound, this is a no-op.
 
538
        If it was, it resents self.branch to the local branch, instead
 
539
        of being the master.
 
540
        """
 
541
        if not self.bound_branch:
 
542
            return
 
543
        if self.master_locked:
 
544
            self.master_branch.unlock()
 
545
 
 
546
    def _escape_commit_message(self):
 
547
        """Replace xml-incompatible control characters."""
 
548
        # FIXME: RBC 20060419 this should be done by the revision
 
549
        # serialiser not by commit. Then we can also add an unescaper
 
550
        # in the deserializer and start roundtripping revision messages
 
551
        # precisely. See repository_implementations/test_repository.py
 
552
        
 
553
        # Python strings can include characters that can't be
 
554
        # represented in well-formed XML; escape characters that
 
555
        # aren't listed in the XML specification
 
556
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
557
        self.message, escape_count = re.subn(
 
558
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
559
            lambda match: match.group(0).encode('unicode_escape'),
 
560
            self.message)
 
561
        if escape_count:
 
562
            self.reporter.escaped(escape_count, self.message)
 
563
 
 
564
    def _gather_parents(self):
 
565
        """Record the parents of a merge for merge detection."""
 
566
        # TODO: Make sure that this list doesn't contain duplicate 
 
567
        # entries and the order is preserved when doing this.
 
568
        self.parents = self.work_tree.get_parent_ids()
 
569
        self.parent_invs = [self.basis_inv]
 
570
        for revision in self.parents[1:]:
 
571
            if self.branch.repository.has_revision(revision):
 
572
                mutter('commit parent revision {%s}', revision)
 
573
                inventory = self.branch.repository.get_inventory(revision)
 
574
                self.parent_invs.append(inventory)
 
575
            else:
 
576
                mutter('commit parent ghost revision {%s}', revision)
671
577
 
672
578
    def _update_builder_with_changes(self):
673
579
        """Update the commit builder with the data about what has changed.
674
580
        """
 
581
        # Build the revision inventory.
 
582
        #
 
583
        # This starts by creating a new empty inventory. Depending on
 
584
        # which files are selected for commit, and what is present in the
 
585
        # current tree, the new inventory is populated. inventory entries 
 
586
        # which are candidates for modification have their revision set to
 
587
        # None; inventory entries that are carried over untouched have their
 
588
        # revision set to their prior value.
 
589
        #
 
590
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
591
        # results to create a new inventory at the same time, which results
 
592
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
593
        # ADHB 11-07-2006
 
594
 
675
595
        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 file_id, 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).
746
 
        if self.strict:
747
 
            # raise an exception as soon as we find a single unknown.
748
 
            for unknown in self.work_tree.unknowns():
749
 
                raise StrictCommitFailed()
750
 
 
751
 
    def _commit_nested_tree(self, path):
752
 
        "Commit a nested tree."
753
 
        sub_tree = self.work_tree.get_nested_tree(path)
754
 
        # FIXME: be more comprehensive here:
755
 
        # this works when both trees are in --trees repository,
756
 
        # but when both are bound to a different repository,
757
 
        # it fails; a better way of approaching this is to
758
 
        # finally implement the explicit-caches approach design
759
 
        # a while back - RBC 20070306.
760
 
        if sub_tree.branch.repository.has_same_location(
761
 
                self.work_tree.branch.repository):
762
 
            sub_tree.branch.repository = \
763
 
                self.work_tree.branch.repository
764
 
        try:
765
 
            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):
 
596
        mutter("Selecting files for commit with filter %s", specific_files)
 
597
        work_inv = self.work_tree.inventory
 
598
        assert work_inv.root is not None
 
599
        self.pb_entries_total = len(work_inv)
 
600
 
 
601
        # Check and warn about old CommitBuilders
 
602
        entries = work_inv.iter_entries()
 
603
        if not self.builder.record_root_entry:
 
604
            symbol_versioning.warn('CommitBuilders should support recording'
 
605
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
606
                stacklevel=1)
 
607
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
608
            entries.next()
 
609
 
 
610
        deleted_ids = []
 
611
        deleted_paths = set()
 
612
        for path, new_ie in entries:
 
613
            self._emit_progress_next_entry()
 
614
            file_id = new_ie.file_id
 
615
 
 
616
            # Skip files that have been deleted from the working tree.
 
617
            # The deleted files/directories are also recorded so they
 
618
            # can be explicitly unversioned later. Note that when a
 
619
            # filter of specific files is given, we must only skip/record
 
620
            # deleted files matching that filter.
 
621
            if is_inside_any(deleted_paths, path):
 
622
                continue
 
623
            if not specific_files or is_inside_any(specific_files, path):
 
624
                if not self.work_tree.has_filename(path):
 
625
                    deleted_paths.add(path)
 
626
                    self.reporter.missing(path)
 
627
                    deleted_ids.append(file_id)
 
628
                    continue
 
629
            try:
 
630
                kind = self.work_tree.kind(file_id)
 
631
                if kind == 'tree-reference' and self.recursive == 'down':
 
632
                    # nested tree: commit in it
 
633
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
634
                    # FIXME: be more comprehensive here:
 
635
                    # this works when both trees are in --trees repository,
 
636
                    # but when both are bound to a different repository,
 
637
                    # it fails; a better way of approaching this is to 
 
638
                    # finally implement the explicit-caches approach design
 
639
                    # a while back - RBC 20070306.
 
640
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
641
                        ==
 
642
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
643
                        sub_tree.branch.repository = \
 
644
                            self.work_tree.branch.repository
 
645
                    try:
 
646
                        sub_tree.commit(message=None, revprops=self.revprops,
 
647
                            recursive=self.recursive,
 
648
                            message_callback=self.message_callback,
 
649
                            timestamp=self.timestamp, timezone=self.timezone,
 
650
                            committer=self.committer,
 
651
                            allow_pointless=self.allow_pointless,
 
652
                            strict=self.strict, verbose=self.verbose,
 
653
                            local=self.local, reporter=self.reporter)
 
654
                    except errors.PointlessCommit:
 
655
                        pass
 
656
                if kind != new_ie.kind:
 
657
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
658
                                                  new_ie.parent_id, file_id)
 
659
            except errors.NoSuchFile:
 
660
                pass
 
661
            # mutter('check %s {%s}', path, file_id)
 
662
            if (not specific_files or 
 
663
                is_inside_or_parent_of_any(specific_files, path)):
 
664
                    # mutter('%s selected for commit', path)
 
665
                    ie = new_ie.copy()
 
666
                    ie.revision = None
 
667
            else:
 
668
                # mutter('%s not selected for commit', path)
 
669
                if self.basis_inv.has_id(file_id):
 
670
                    ie = self.basis_inv[file_id].copy()
 
671
                else:
 
672
                    # this entry is new and not being committed
 
673
                    continue
 
674
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
675
                path, self.work_tree)
 
676
            # describe the nature of the change that has occurred relative to
 
677
            # the basis inventory.
 
678
            if (self.basis_inv.has_id(ie.file_id)):
 
679
                basis_ie = self.basis_inv[ie.file_id]
 
680
            else:
 
681
                basis_ie = None
 
682
            change = ie.describe_change(basis_ie, ie)
 
683
            if change in (InventoryEntry.RENAMED, 
 
684
                InventoryEntry.MODIFIED_AND_RENAMED):
 
685
                old_path = self.basis_inv.id2path(ie.file_id)
 
686
                self.reporter.renamed(change, old_path, path)
 
687
            else:
 
688
                self.reporter.snapshot_change(change, path)
 
689
 
 
690
        # Unversion IDs that were found to be deleted
 
691
        self.work_tree.unversion(deleted_ids)
 
692
 
 
693
        # If specific files/directories were nominated, it is possible
 
694
        # that some data from outside those needs to be preserved from
 
695
        # the basis tree. For example, if a file x is moved from out of
 
696
        # directory foo into directory bar and the user requests
 
697
        # ``commit foo``, then information about bar/x must also be
 
698
        # recorded.
 
699
        if specific_files:
 
700
            for path, new_ie in self.basis_inv.iter_entries():
 
701
                if new_ie.file_id in work_inv:
 
702
                    continue
 
703
                if is_inside_any(specific_files, path):
 
704
                    continue
 
705
                ie = new_ie.copy()
 
706
                ie.revision = None
 
707
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
708
                                                   self.basis_tree)
 
709
 
 
710
        # Report what was deleted. We could skip this when no deletes are
 
711
        # detected to gain a performance win, but it arguably serves as a
 
712
        # 'safety check' by informing the user whenever anything disappears.
 
713
        for path, ie in self.basis_inv.iter_entries():
 
714
            if ie.file_id not in self.builder.new_inventory:
 
715
                self.reporter.deleted(path)
 
716
 
 
717
    def _emit_progress_set_stage(self, name, show_entries=False):
778
718
        """Set the progress stage and emit an update to the progress bar."""
779
719
        self.pb_stage_name = name
780
720
        self.pb_stage_count += 1
781
 
        if counter:
 
721
        self.pb_entries_show = show_entries
 
722
        if show_entries:
782
723
            self.pb_entries_count = 0
783
 
        else:
784
 
            self.pb_entries_count = None
 
724
            self.pb_entries_total = '?'
785
725
        self._emit_progress()
786
726
 
787
 
    def _next_progress_entry(self):
788
 
        """Emit an update to the progress bar and increment the entry count."""
 
727
    def _emit_progress_next_entry(self):
 
728
        """Emit an update to the progress bar and increment the file count."""
789
729
        self.pb_entries_count += 1
790
730
        self._emit_progress()
791
731
 
792
732
    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)
 
733
        if self.pb_entries_show:
 
734
            text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
 
735
                self.pb_entries_count,str(self.pb_entries_total))
796
736
        else:
797
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
737
            text = "%s - Stage" % (self.pb_stage_name)
798
738
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
739