← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 16:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719165716-b4iupzkb17b9l9wx
Avoid branch write lock to preserve VFS call count.

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,
204
227
               reporter=None,
205
228
               config=None,
206
229
               message_callback=None,
207
 
               recursive='down'):
 
230
               recursive='down',
 
231
               exclude=None,
 
232
               possible_master_transports=None,
 
233
               lossy=False):
208
234
        """Commit working copy as a new revision.
209
235
 
210
236
        :param message: the commit message (it or message_callback is required)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
211
238
 
212
239
        :param timestamp: if not None, seconds-since-epoch for a
213
240
            postdated/predated commit.
214
241
 
215
 
        :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'.
216
244
 
217
245
        :param rev_id: If set, use this as the new revision id.
218
246
            Useful for test or import commands that need to tightly
232
260
        :param verbose: if True and the reporter is not None, report everything
233
261
        :param recursive: If set to 'down', commit in any subtrees that have
234
262
            pending changes of any sort during this commit.
 
263
        :param exclude: None or a list of relative paths to exclude from the
 
264
            commit. Pending changes to excluded files will be ignored by the
 
265
            commit.
 
266
        :param lossy: When committing to a foreign VCS, ignore any
 
267
            data that can not be natively represented.
235
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):
236
296
        mutter('preparing to commit')
237
297
 
238
298
        if working_tree is None:
246
306
        if message_callback is None:
247
307
            if message is not None:
248
308
                if isinstance(message, str):
249
 
                    message = message.decode(bzrlib.user_encoding)
 
309
                    message = message.decode(get_user_encoding())
250
310
                message_callback = lambda x: message
251
311
            else:
252
312
                raise BzrError("The message or message_callback keyword"
253
313
                               " parameter is required for commit().")
254
314
 
255
315
        self.bound_branch = None
256
 
        self.any_entries_changed = False
257
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
258
322
        self.local = local
259
323
        self.master_branch = None
260
 
        self.master_locked = False
261
324
        self.recursive = recursive
262
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.
263
328
        if specific_files is not None:
264
329
            self.specific_files = sorted(
265
330
                minimum_path_selection(specific_files))
266
331
        else:
267
332
            self.specific_files = None
268
 
        self.specific_file_ids = None
 
333
 
269
334
        self.allow_pointless = allow_pointless
270
 
        self.revprops = revprops
271
335
        self.message_callback = message_callback
272
336
        self.timestamp = timestamp
273
337
        self.timezone = timezone
274
338
        self.committer = committer
275
339
        self.strict = strict
276
340
        self.verbose = verbose
277
 
        # accumulates an inventory delta to the basis entry, so we can make
278
 
        # just the necessary updates to the workingtree's cached basis.
279
 
        self._basis_delta = []
280
341
 
281
342
        self.work_tree.lock_write()
282
 
        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)
283
355
        self.basis_revid = self.work_tree.last_revision()
284
356
        self.basis_tree = self.work_tree.basis_tree()
285
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
 
286
421
        try:
287
 
            # Cannot commit with conflicts present.
288
 
            if len(self.work_tree.conflicts()) > 0:
289
 
                raise ConflictsInTree
290
 
 
291
 
            # Setup the bound branch variables as needed.
292
 
            self._check_bound_branch()
293
 
 
294
 
            # Check that the working tree is up to date
295
 
            old_revno, new_revno = self._check_out_of_date_tree()
296
 
 
297
 
            # Complete configuration setup
298
 
            if reporter is not None:
299
 
                self.reporter = reporter
300
 
            elif self.reporter is None:
301
 
                self.reporter = self._select_reporter()
302
 
            if self.config is None:
303
 
                self.config = self.branch.get_config()
304
 
 
305
 
            # If provided, ensure the specified files are versioned
306
 
            if self.specific_files is not None:
307
 
                # Note: This routine is being called because it raises
308
 
                # PathNotVersionedError as a side effect of finding the IDs. We
309
 
                # later use the ids we found as input to the working tree
310
 
                # inventory iterator, so we only consider those ids rather than
311
 
                # examining the whole tree again.
312
 
                # XXX: Dont we have filter_unversioned to do this more
313
 
                # cheaply?
314
 
                self.specific_file_ids = tree.find_ids_across_trees(
315
 
                    specific_files, [self.basis_tree, self.work_tree])
316
 
 
317
 
            # Setup the progress bar. As the number of files that need to be
318
 
            # committed in unknown, progress is reported as stages.
319
 
            # We keep track of entries separately though and include that
320
 
            # information in the progress bar during the relevant stages.
321
 
            self.pb_stage_name = ""
322
 
            self.pb_stage_count = 0
323
 
            self.pb_stage_total = 5
 
422
            self.builder.will_record_deletes()
 
423
            # find the location being committed to
324
424
            if self.bound_branch:
325
 
                self.pb_stage_total += 1
326
 
            self.pb.show_pct = False
327
 
            self.pb.show_spinner = False
328
 
            self.pb.show_eta = False
329
 
            self.pb.show_count = True
330
 
            self.pb.show_bar = True
331
 
 
332
 
            # After a merge, a selected file commit is not supported.
333
 
            # See 'bzr help merge' for an explanation as to why.
334
 
            self.basis_inv = self.basis_tree.inventory
335
 
            self._gather_parents()
336
 
            if len(self.parents) > 1 and self.specific_files:
337
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
338
 
 
339
 
            # Collect the changes
340
 
            self._set_progress_stage("Collecting changes",
341
 
                    entries_title="Directory")
342
 
            self.builder = self.branch.get_commit_builder(self.parents,
343
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
344
 
            
345
 
            try:
346
 
                # find the location being committed to
347
 
                if self.bound_branch:
348
 
                    master_location = self.master_branch.base
349
 
                else:
350
 
                    master_location = self.branch.base
351
 
 
352
 
                # report the start of the commit
353
 
                self.reporter.started(new_revno, self.rev_id, master_location)
354
 
 
355
 
                self._update_builder_with_changes()
356
 
                self._report_and_accumulate_deletes()
357
 
                self._check_pointless()
358
 
 
359
 
                # TODO: Now the new inventory is known, check for conflicts.
360
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
 
                # weave lines, because nothing should be recorded until it is known
362
 
                # that commit will succeed.
363
 
                self._set_progress_stage("Saving data locally")
364
 
                self.builder.finish_inventory()
365
 
 
366
 
                # Prompt the user for a commit message if none provided
367
 
                message = message_callback(self)
368
 
                self.message = message
369
 
                self._escape_commit_message()
370
 
 
371
 
                # Add revision data to the local branch
372
 
                self.rev_id = self.builder.commit(self.message)
373
 
 
374
 
            except:
375
 
                self.builder.abort()
376
 
                raise
377
 
 
 
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:
378
480
            self._process_pre_hooks(old_revno, new_revno)
379
481
 
380
482
            # Upload revision data to the master.
381
483
            # this will propagate merged revisions too if needed.
382
484
            if self.bound_branch:
383
 
                if not self.master_branch.repository.has_same_location(
384
 
                        self.branch.repository):
385
 
                    self._set_progress_stage("Uploading data to master branch")
386
 
                    self.master_branch.repository.fetch(self.branch.repository,
387
 
                        revision_id=self.rev_id)
388
 
                # now the master has the revision data
 
485
                self._set_progress_stage("Uploading data to master branch")
389
486
                # 'commit' to the master first so a timeout here causes the
390
487
                # local branch to be out of date
391
 
                self.master_branch.set_last_revision_info(new_revno,
392
 
                                                          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)
393
492
 
394
493
            # and now do the commit locally.
395
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
396
503
 
397
 
            # Make the working tree up to date with the branch
398
 
            self._set_progress_stage("Updating the working tree")
399
 
            self.work_tree.update_basis_by_delta(self.rev_id,
400
 
                 self._basis_delta)
401
 
            self.reporter.completed(new_revno, self.rev_id)
402
 
            self._process_post_hooks(old_revno, new_revno)
403
 
        finally:
404
 
            self._cleanup()
405
 
        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))) )
406
513
 
407
514
    def _select_reporter(self):
408
515
        """Select the CommitReporter to use."""
416
523
        # A merge with no effect on files
417
524
        if len(self.parents) > 1:
418
525
            return
419
 
        # TODO: we could simplify this by using self._basis_delta.
420
 
 
421
 
        # The initial commit adds a root directory, but this in itself is not
422
 
        # a worthwhile commit.
423
 
        if (self.basis_revid == revision.NULL_REVISION and
424
 
            len(self.builder.new_inventory) == 1):
425
 
            raise PointlessCommit()
426
 
        # If length == 1, then we only have the root entry. Which means
427
 
        # that there is no real difference (only the root could be different)
428
 
        # unless deletes occured, in which case the length is irrelevant.
429
 
        if (self.any_entries_deleted or 
430
 
            (len(self.builder.new_inventory) != 1 and
431
 
             self.any_entries_changed)):
 
526
        if self.builder.any_changes():
432
527
            return
433
528
        raise PointlessCommit()
434
529
 
435
 
    def _check_bound_branch(self):
 
530
    def _check_bound_branch(self, operation, possible_master_transports=None):
436
531
        """Check to see if the local branch is bound.
437
532
 
438
533
        If it is bound, then most of the commit will actually be
443
538
            raise errors.LocalRequiresBoundBranch()
444
539
 
445
540
        if not self.local:
446
 
            self.master_branch = self.branch.get_master_branch()
 
541
            self.master_branch = self.branch.get_master_branch(
 
542
                possible_master_transports)
447
543
 
448
544
        if not self.master_branch:
449
545
            # make this branch the reference branch for out of date checks.
460
556
        #       commits to the remote branch if they would fit.
461
557
        #       But for now, just require remote to be identical
462
558
        #       to local.
463
 
        
 
559
 
464
560
        # Make sure the local branch is identical to the master
465
561
        master_info = self.master_branch.last_revision_info()
466
562
        local_info = self.branch.last_revision_info()
472
568
        # so grab the lock
473
569
        self.bound_branch = self.branch
474
570
        self.master_branch.lock_write()
475
 
        self.master_locked = True
 
571
        operation.add_cleanup(self.master_branch.unlock)
476
572
 
477
573
    def _check_out_of_date_tree(self):
478
574
        """Check that the working tree is up to date.
479
575
 
480
 
        :return: old_revision_number,new_revision_number tuple
 
576
        :return: old_revision_number, old_revision_id, new_revision_number
 
577
            tuple
481
578
        """
482
579
        try:
483
580
            first_tree_parent = self.work_tree.get_parent_ids()[0]
496
593
        else:
497
594
            # ghost parents never appear in revision history.
498
595
            new_revno = 1
499
 
        return old_revno,new_revno
 
596
        return old_revno, master_last, new_revno
500
597
 
501
598
    def _process_pre_hooks(self, old_revno, new_revno):
502
599
        """Process any registered pre commit hooks."""
508
605
        # Process the post commit hooks, if any
509
606
        self._set_progress_stage("Running post_commit hooks")
510
607
        # old style commit hooks - should be deprecated ? (obsoleted in
511
 
        # 0.15)
512
 
        if self.config.post_commit() is not None:
513
 
            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(' ')
514
612
            # this would be nicer with twisted.python.reflect.namedAny
515
613
            for hook in hooks:
516
614
                result = eval(hook + '(branch, rev_id)',
523
621
    def _process_hooks(self, hook_name, old_revno, new_revno):
524
622
        if not Branch.hooks[hook_name]:
525
623
            return
526
 
        
 
624
 
527
625
        # new style commit hooks:
528
626
        if not self.bound_branch:
529
627
            hook_master = self.branch
538
636
            old_revid = self.parents[0]
539
637
        else:
540
638
            old_revid = bzrlib.revision.NULL_REVISION
541
 
        
 
639
 
542
640
        if hook_name == "pre_commit":
543
641
            future_tree = self.builder.revision_tree()
544
642
            tree_delta = future_tree.changes_from(self.basis_tree,
545
643
                                             include_root=True)
546
 
        
 
644
 
547
645
        for hook in Branch.hooks[hook_name]:
548
646
            # show the running hook in the progress bar. As hooks may
549
647
            # end up doing nothing (e.g. because they are not configured by
563
661
                     old_revno, old_revid, new_revno, self.rev_id,
564
662
                     tree_delta, future_tree)
565
663
 
566
 
    def _cleanup(self):
567
 
        """Cleanup any open locks, progress bars etc."""
568
 
        cleanups = [self._cleanup_bound_branch,
569
 
                    self.basis_tree.unlock,
570
 
                    self.work_tree.unlock,
571
 
                    self.pb.finished]
572
 
        found_exception = None
573
 
        for cleanup in cleanups:
574
 
            try:
575
 
                cleanup()
576
 
            # we want every cleanup to run no matter what.
577
 
            # so we have a catchall here, but we will raise the
578
 
            # last encountered exception up the stack: and
579
 
            # typically this will be useful enough.
580
 
            except Exception, e:
581
 
                found_exception = e
582
 
        if found_exception is not None: 
583
 
            # don't do a plan raise, because the last exception may have been
584
 
            # trashed, e is our sure-to-work exception even though it loses the
585
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
586
 
            # exc_info and if its the same one do a plain raise otherwise 
587
 
            # 'raise e' as we do now.
588
 
            raise e
589
 
 
590
 
    def _cleanup_bound_branch(self):
591
 
        """Executed at the end of a try/finally to cleanup a bound branch.
592
 
 
593
 
        If the branch wasn't bound, this is a no-op.
594
 
        If it was, it resents self.branch to the local branch, instead
595
 
        of being the master.
596
 
        """
597
 
        if not self.bound_branch:
598
 
            return
599
 
        if self.master_locked:
600
 
            self.master_branch.unlock()
601
 
 
602
 
    def _escape_commit_message(self):
603
 
        """Replace xml-incompatible control characters."""
604
 
        # FIXME: RBC 20060419 this should be done by the revision
605
 
        # serialiser not by commit. Then we can also add an unescaper
606
 
        # in the deserializer and start roundtripping revision messages
607
 
        # precisely. See repository_implementations/test_repository.py
608
 
        
609
 
        # Python strings can include characters that can't be
610
 
        # represented in well-formed XML; escape characters that
611
 
        # aren't listed in the XML specification
612
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
613
 
        self.message, escape_count = re.subn(
614
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
615
 
            lambda match: match.group(0).encode('unicode_escape'),
616
 
            self.message)
617
 
        if escape_count:
618
 
            self.reporter.escaped(escape_count, self.message)
619
 
 
620
664
    def _gather_parents(self):
621
665
        """Record the parents of a merge for merge detection."""
622
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
666
        # TODO: Make sure that this list doesn't contain duplicate
623
667
        # entries and the order is preserved when doing this.
624
 
        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
625
671
        self.parent_invs = [self.basis_inv]
626
672
        for revision in self.parents[1:]:
627
673
            if self.branch.repository.has_revision(revision):
634
680
    def _update_builder_with_changes(self):
635
681
        """Update the commit builder with the data about what has changed.
636
682
        """
637
 
        # Build the revision inventory.
638
 
        #
639
 
        # This starts by creating a new empty inventory. Depending on
640
 
        # which files are selected for commit, and what is present in the
641
 
        # current tree, the new inventory is populated. inventory entries 
642
 
        # which are candidates for modification have their revision set to
643
 
        # None; inventory entries that are carried over untouched have their
644
 
        # revision set to their prior value.
645
 
        #
646
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
647
 
        # results to create a new inventory at the same time, which results
648
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
649
 
        # ADHB 11-07-2006
650
 
 
 
683
        exclude = self.exclude
651
684
        specific_files = self.specific_files
652
685
        mutter("Selecting files for commit with filter %s", specific_files)
653
686
 
654
 
        # Build the new inventory
655
 
        self._populate_from_inventory(specific_files)
656
 
 
 
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):
657
754
        # If specific files are selected, then all un-selected files must be
658
755
        # recorded in their previous state. For more details, see
659
756
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
660
 
        if specific_files:
 
757
        if self.specific_files or self.exclude:
 
758
            specific_files = self.specific_files or []
661
759
            for path, old_ie in self.basis_inv.iter_entries():
662
 
                if old_ie.file_id in self.builder.new_inventory:
 
760
                if self.builder.new_inventory.has_id(old_ie.file_id):
663
761
                    # already added - skip.
664
762
                    continue
665
 
                if is_inside_any(specific_files, path):
666
 
                    # was inside the selected path, if not present it has been
667
 
                    # deleted so skip.
 
763
                if (is_inside_any(specific_files, path)
 
764
                    and not is_inside_any(self.exclude, path)):
 
765
                    # was inside the selected path, and not excluded - if not
 
766
                    # present it has been deleted so skip.
668
767
                    continue
669
 
                if old_ie.kind == 'directory':
670
 
                    self._next_progress_entry()
671
 
                # not in final inv yet, was not in the selected files, so is an
672
 
                # entry to be preserved unaltered.
 
768
                # From here down it was either not selected, or was excluded:
 
769
                # We preserve the entry unaltered.
673
770
                ie = old_ie.copy()
674
771
                # Note: specific file commits after a merge are currently
675
772
                # prohibited. This test is for sanity/safety in case it's
676
773
                # required after that changes.
677
774
                if len(self.parents) > 1:
678
775
                    ie.revision = None
679
 
                delta, version_recorded = self.builder.record_entry_contents(
680
 
                    ie, self.parent_invs, path, self.basis_tree, None)
681
 
                if version_recorded:
682
 
                    self.any_entries_changed = True
683
 
                if delta: self._basis_delta.append(delta)
 
776
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
777
                    self.basis_tree, None)
684
778
 
685
779
    def _report_and_accumulate_deletes(self):
686
 
        # XXX: Could the list of deleted paths and ids be instead taken from
687
 
        # _populate_from_inventory?
688
 
        deleted_ids = set(self.basis_inv._byid.keys()) - \
689
 
            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)
690
793
        if deleted_ids:
691
794
            self.any_entries_deleted = True
692
795
            deleted = [(self.basis_tree.id2path(file_id), file_id)
694
797
            deleted.sort()
695
798
            # XXX: this is not quite directory-order sorting
696
799
            for path, file_id in deleted:
697
 
                self._basis_delta.append((path, None, file_id, None))
 
800
                self.builder.record_delete(path, file_id)
698
801
                self.reporter.deleted(path)
699
802
 
700
 
    def _populate_from_inventory(self, specific_files):
701
 
        """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).
702
807
        if self.strict:
703
808
            # raise an exception as soon as we find a single unknown.
704
809
            for unknown in self.work_tree.unknowns():
705
810
                raise StrictCommitFailed()
706
 
               
 
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
 
 
828
        specific_files = self.specific_files
 
829
        exclude = self.exclude
707
830
        report_changes = self.reporter.is_verbose()
708
831
        deleted_ids = []
709
832
        # A tree of paths that have been deleted. E.g. if foo/bar has been
711
834
        deleted_paths = {}
712
835
        # XXX: Note that entries may have the wrong kind because the entry does
713
836
        # not reflect the status on disk.
714
 
        work_inv = self.work_tree.inventory
715
 
        entries = work_inv.iter_entries_by_dir(
 
837
        # NB: entries will include entries within the excluded ids/paths
 
838
        # because iter_entries_by_dir has no 'exclude' facility today.
 
839
        entries = self.work_tree.iter_entries_by_dir(
716
840
            specific_file_ids=self.specific_file_ids, yield_parents=True)
717
841
        for path, existing_ie in entries:
718
842
            file_id = existing_ie.file_id
719
843
            name = existing_ie.name
720
844
            parent_id = existing_ie.parent_id
721
845
            kind = existing_ie.kind
722
 
            if kind == 'directory':
723
 
                self._next_progress_entry()
724
846
            # Skip files that have been deleted from the working tree.
725
847
            # The deleted path ids are also recorded so they can be explicitly
726
848
            # unversioned later.
739
861
                if deleted_dict is not None:
740
862
                    # the path has a deleted parent, do not add it.
741
863
                    continue
 
864
            if exclude and is_inside_any(exclude, path):
 
865
                # Skip excluded paths. Excluded paths are processed by
 
866
                # _update_builder_with_changes.
 
867
                continue
742
868
            content_summary = self.work_tree.path_content_summary(path)
 
869
            kind = content_summary[0]
743
870
            # Note that when a filter of specific files is given, we must only
744
871
            # skip/record deleted files matching that filter.
745
872
            if not specific_files or is_inside_any(specific_files, path):
746
 
                if content_summary[0] == 'missing':
 
873
                if kind == 'missing':
747
874
                    if not deleted_paths:
748
875
                        # path won't have been split yet.
749
876
                        path_segments = splitpath(path)
751
878
                    for segment in path_segments:
752
879
                        deleted_dict = deleted_dict.setdefault(segment, {})
753
880
                    self.reporter.missing(path)
 
881
                    self._next_progress_entry()
754
882
                    deleted_ids.append(file_id)
755
883
                    continue
756
884
            # TODO: have the builder do the nested commit just-in-time IF and
757
885
            # only if needed.
758
 
            if content_summary[0] == 'tree-reference':
 
886
            if kind == 'tree-reference':
759
887
                # enforce repository nested tree policy.
760
888
                if (not self.work_tree.supports_tree_reference() or
761
889
                    # repository does not support it either.
762
890
                    not self.branch.repository._format.supports_tree_reference):
763
 
                    content_summary = ('directory',) + content_summary[1:]
764
 
            kind = content_summary[0]
765
 
            # TODO: specific_files filtering before nested tree processing
766
 
            if kind == 'tree-reference':
767
 
                if self.recursive == 'down':
 
891
                    kind = 'directory'
 
892
                    content_summary = (kind, None, None, None)
 
893
                elif self.recursive == 'down':
768
894
                    nested_revision_id = self._commit_nested_tree(
769
895
                        file_id, path)
770
 
                    content_summary = content_summary[:3] + (
771
 
                        nested_revision_id,)
 
896
                    content_summary = (kind, None, None, nested_revision_id)
772
897
                else:
773
 
                    content_summary = content_summary[:3] + (
774
 
                        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)
775
900
 
776
901
            # Record an entry for this item
777
902
            # Note: I don't particularly want to have the existing_ie
783
908
                content_summary)
784
909
 
785
910
        # Unversion IDs that were found to be deleted
786
 
        self.work_tree.unversion(deleted_ids)
 
911
        self.deleted_ids = deleted_ids
787
912
 
788
913
    def _commit_nested_tree(self, file_id, path):
789
914
        "Commit a nested tree."
791
916
        # FIXME: be more comprehensive here:
792
917
        # this works when both trees are in --trees repository,
793
918
        # but when both are bound to a different repository,
794
 
        # it fails; a better way of approaching this is to 
 
919
        # it fails; a better way of approaching this is to
795
920
        # finally implement the explicit-caches approach design
796
921
        # a while back - RBC 20070306.
797
922
        if sub_tree.branch.repository.has_same_location(
821
946
        else:
822
947
            ie = existing_ie.copy()
823
948
            ie.revision = None
824
 
        delta, version_recorded = self.builder.record_entry_contents(ie,
825
 
            self.parent_invs, path, self.work_tree, content_summary)
826
 
        if delta:
827
 
            self._basis_delta.append(delta)
828
 
        if version_recorded:
829
 
            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)
830
953
        if report_changes:
831
954
            self._report_change(ie, path)
 
955
        if fs_hash:
 
956
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
832
957
        return ie
833
958
 
834
959
    def _report_change(self, ie, path):
842
967
        else:
843
968
            basis_ie = None
844
969
        change = ie.describe_change(basis_ie, ie)
845
 
        if change in (InventoryEntry.RENAMED, 
 
970
        if change in (InventoryEntry.RENAMED,
846
971
            InventoryEntry.MODIFIED_AND_RENAMED):
847
972
            old_path = self.basis_inv.id2path(ie.file_id)
848
973
            self.reporter.renamed(change, old_path, path)
 
974
            self._next_progress_entry()
849
975
        else:
 
976
            if change == gettext('unchanged'):
 
977
                return
850
978
            self.reporter.snapshot_change(change, path)
 
979
            self._next_progress_entry()
851
980
 
852
 
    def _set_progress_stage(self, name, entries_title=None):
 
981
    def _set_progress_stage(self, name, counter=False):
853
982
        """Set the progress stage and emit an update to the progress bar."""
854
983
        self.pb_stage_name = name
855
984
        self.pb_stage_count += 1
856
 
        self.pb_entries_title = entries_title
857
 
        if entries_title is not None:
 
985
        if counter:
858
986
            self.pb_entries_count = 0
859
 
            self.pb_entries_total = '?'
 
987
        else:
 
988
            self.pb_entries_count = None
860
989
        self._emit_progress()
861
990
 
862
991
    def _next_progress_entry(self):
865
994
        self._emit_progress()
866
995
 
867
996
    def _emit_progress(self):
868
 
        if self.pb_entries_title:
869
 
            if self.pb_entries_total == '?':
870
 
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
871
 
                    self.pb_entries_title, self.pb_entries_count)
872
 
            else:
873
 
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
874
 
                    self.pb_entries_title, self.pb_entries_count,
875
 
                    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)
876
1000
        else:
877
 
            text = "%s - Stage" % (self.pb_stage_name)
 
1001
            text = gettext("%s - Stage") % (self.pb_stage_name, )
878
1002
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
879
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