/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2007-12-05 19:55:07 UTC
  • mto: This revision was merged to the branch mainline in revision 3082.
  • Revision ID: john@arbash-meinel.com-20071205195507-1ql7vuval5qug5eu
Clean up some vim: lines to make them proper ReST comments.

Show diffs side-by-side

added added

removed removed

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