← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2013-05-27 04:36:19 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20130527043619-29pv82clc2f3y4vp
Launchpad automatic translations update.

Show diffs side-by-side

added added

removed removed

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