/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: Sabin Iacob
  • Date: 2009-03-23 14:59:43 UTC
  • mto: (4189.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4193.
  • Revision ID: iacobs@m0n5t3r.info-20090323145943-3s3p1px5q1rkh2e5
update FSF mailing address

Show diffs side-by-side

added added

removed removed

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