← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
52
from bzrlib import (
60
53
    debug,
61
54
    errors,
62
55
    revision,
63
56
    trace,
64
57
    tree,
65
 
    xml_serializer,
66
58
    )
67
59
from bzrlib.branch import Branch
 
60
from bzrlib.cleanup import OperationWithCleanups
68
61
import bzrlib.config
69
62
from bzrlib.errors import (BzrError, PointlessCommit,
70
63
                           ConflictsInTree,
71
64
                           StrictCommitFailed
72
65
                           )
73
66
from bzrlib.osutils import (get_user_encoding,
74
 
                            kind_marker, isdir,isfile, is_inside_any,
75
 
                            is_inside_or_parent_of_any,
 
67
                            is_inside_any,
76
68
                            minimum_path_selection,
77
 
                            quotefn, sha_file, split_lines,
78
69
                            splitpath,
79
70
                            )
80
 
from bzrlib.testament import Testament
81
 
from bzrlib.trace import mutter, note, warning, is_quiet
 
71
from bzrlib.trace import mutter, note, is_quiet
82
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
83
73
from bzrlib import symbol_versioning
84
 
from bzrlib.symbol_versioning import (deprecated_passed,
85
 
        deprecated_function,
86
 
        DEPRECATED_PARAMETER)
87
 
from bzrlib.workingtree import WorkingTree
88
74
from bzrlib.urlutils import unescape_for_display
89
75
import bzrlib.ui
90
76
 
146
132
 
147
133
    def completed(self, revno, rev_id):
148
134
        self._note('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)
149
141
 
150
142
    def deleted(self, path):
151
143
        self._note('deleted %s', path)
182
174
        self.reporter = reporter
183
175
        self.config = config
184
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
 
213
 
185
214
    def commit(self,
186
215
               message=None,
187
216
               timestamp=None,
209
238
        :param timestamp: if not None, seconds-since-epoch for a
210
239
            postdated/predated commit.
211
240
 
212
 
        :param specific_files: If true, commit only those files.
 
241
        :param specific_files: If not None, commit only those files. An empty
 
242
            list means 'commit no files'.
213
243
 
214
244
        :param rev_id: If set, use this as the new revision id.
215
245
            Useful for test or import commands that need to tightly
233
263
            commit. Pending changes to excluded files will be ignored by the
234
264
            commit.
235
265
        """
 
266
        operation = OperationWithCleanups(self._commit)
 
267
        self.revprops = revprops or {}
 
268
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
269
        self.config = config or self.config
 
270
        return operation.run(
 
271
               message=message,
 
272
               timestamp=timestamp,
 
273
               timezone=timezone,
 
274
               committer=committer,
 
275
               specific_files=specific_files,
 
276
               rev_id=rev_id,
 
277
               allow_pointless=allow_pointless,
 
278
               strict=strict,
 
279
               verbose=verbose,
 
280
               working_tree=working_tree,
 
281
               local=local,
 
282
               reporter=reporter,
 
283
               message_callback=message_callback,
 
284
               recursive=recursive,
 
285
               exclude=exclude,
 
286
               possible_master_transports=possible_master_transports)
 
287
 
 
288
    def _commit(self, operation, message, timestamp, timezone, committer,
 
289
            specific_files, rev_id, allow_pointless, strict, verbose,
 
290
            working_tree, local, reporter, message_callback, recursive,
 
291
            exclude, possible_master_transports):
236
292
        mutter('preparing to commit')
237
293
 
238
294
        if working_tree is None:
261
317
            self.exclude = []
262
318
        self.local = local
263
319
        self.master_branch = None
264
 
        self.master_locked = False
265
320
        self.recursive = recursive
266
321
        self.rev_id = None
 
322
        # self.specific_files is None to indicate no filter, or any iterable to
 
323
        # indicate a filter - [] means no files at all, as per iter_changes.
267
324
        if specific_files is not None:
268
325
            self.specific_files = sorted(
269
326
                minimum_path_selection(specific_files))
271
328
            self.specific_files = None
272
329
            
273
330
        self.allow_pointless = allow_pointless
274
 
        self.revprops = revprops
275
331
        self.message_callback = message_callback
276
332
        self.timestamp = timestamp
277
333
        self.timezone = timezone
280
336
        self.verbose = verbose
281
337
 
282
338
        self.work_tree.lock_write()
 
339
        operation.add_cleanup(self.work_tree.unlock)
283
340
        self.parents = self.work_tree.get_parent_ids()
284
341
        # We can use record_iter_changes IFF iter_changes is compatible with
285
342
        # the command line parameters, and the repository has fast delta
286
343
        # generation. See bug 347649.
287
344
        self.use_record_iter_changes = (
288
 
            not self.specific_files and
289
345
            not self.exclude and 
290
346
            not self.branch.repository._format.supports_tree_reference and
291
347
            (self.branch.repository._format.fast_deltas or
292
348
             len(self.parents) < 2))
293
349
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
350
        operation.add_cleanup(self.pb.finished)
294
351
        self.basis_revid = self.work_tree.last_revision()
295
352
        self.basis_tree = self.work_tree.basis_tree()
296
353
        self.basis_tree.lock_read()
 
354
        operation.add_cleanup(self.basis_tree.unlock)
 
355
        # Cannot commit with conflicts present.
 
356
        if len(self.work_tree.conflicts()) > 0:
 
357
            raise ConflictsInTree
 
358
 
 
359
        # Setup the bound branch variables as needed.
 
360
        self._check_bound_branch(operation, possible_master_transports)
 
361
 
 
362
        # Check that the working tree is up to date
 
363
        old_revno, new_revno = self._check_out_of_date_tree()
 
364
 
 
365
        # Complete configuration setup
 
366
        if reporter is not None:
 
367
            self.reporter = reporter
 
368
        elif self.reporter is None:
 
369
            self.reporter = self._select_reporter()
 
370
        if self.config is None:
 
371
            self.config = self.branch.get_config()
 
372
 
 
373
        self._set_specific_file_ids()
 
374
 
 
375
        # Setup the progress bar. As the number of files that need to be
 
376
        # committed in unknown, progress is reported as stages.
 
377
        # We keep track of entries separately though and include that
 
378
        # information in the progress bar during the relevant stages.
 
379
        self.pb_stage_name = ""
 
380
        self.pb_stage_count = 0
 
381
        self.pb_stage_total = 5
 
382
        if self.bound_branch:
 
383
            self.pb_stage_total += 1
 
384
        self.pb.show_pct = False
 
385
        self.pb.show_spinner = False
 
386
        self.pb.show_eta = False
 
387
        self.pb.show_count = True
 
388
        self.pb.show_bar = True
 
389
 
 
390
        self._gather_parents()
 
391
        # After a merge, a selected file commit is not supported.
 
392
        # See 'bzr help merge' for an explanation as to why.
 
393
        if len(self.parents) > 1 and self.specific_files is not None:
 
394
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
395
        # Excludes are a form of selected file commit.
 
396
        if len(self.parents) > 1 and self.exclude:
 
397
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
398
 
 
399
        # Collect the changes
 
400
        self._set_progress_stage("Collecting changes", counter=True)
 
401
        self.builder = self.branch.get_commit_builder(self.parents,
 
402
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
403
 
297
404
        try:
298
 
            # Cannot commit with conflicts present.
299
 
            if len(self.work_tree.conflicts()) > 0:
300
 
                raise ConflictsInTree
301
 
 
302
 
            # Setup the bound branch variables as needed.
303
 
            self._check_bound_branch(possible_master_transports)
304
 
 
305
 
            # Check that the working tree is up to date
306
 
            old_revno, new_revno = self._check_out_of_date_tree()
307
 
 
308
 
            # Complete configuration setup
309
 
            if reporter is not None:
310
 
                self.reporter = reporter
311
 
            elif self.reporter is None:
312
 
                self.reporter = self._select_reporter()
313
 
            if self.config is None:
314
 
                self.config = self.branch.get_config()
315
 
 
316
 
            self._set_specific_file_ids()
317
 
 
318
 
            # Setup the progress bar. As the number of files that need to be
319
 
            # committed in unknown, progress is reported as stages.
320
 
            # We keep track of entries separately though and include that
321
 
            # information in the progress bar during the relevant stages.
322
 
            self.pb_stage_name = ""
323
 
            self.pb_stage_count = 0
324
 
            self.pb_stage_total = 5
325
 
            if self.bound_branch:
326
 
                self.pb_stage_total += 1
327
 
            self.pb.show_pct = False
328
 
            self.pb.show_spinner = False
329
 
            self.pb.show_eta = False
330
 
            self.pb.show_count = True
331
 
            self.pb.show_bar = True
332
 
 
333
 
            self._gather_parents()
334
 
            # After a merge, a selected file commit is not supported.
335
 
            # See 'bzr help merge' for an explanation as to why.
336
 
            if len(self.parents) > 1 and self.specific_files:
337
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
338
 
            # Excludes are a form of selected file commit.
339
 
            if len(self.parents) > 1 and self.exclude:
340
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
341
 
 
342
 
            # Collect the changes
343
 
            self._set_progress_stage("Collecting changes", counter=True)
344
 
            self.builder = self.branch.get_commit_builder(self.parents,
345
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
346
 
 
347
 
            try:
348
 
                self.builder.will_record_deletes()
349
 
                # find the location being committed to
350
 
                if self.bound_branch:
351
 
                    master_location = self.master_branch.base
352
 
                else:
353
 
                    master_location = self.branch.base
354
 
 
355
 
                # report the start of the commit
356
 
                self.reporter.started(new_revno, self.rev_id, master_location)
357
 
 
358
 
                self._update_builder_with_changes()
359
 
                self._check_pointless()
360
 
 
361
 
                # TODO: Now the new inventory is known, check for conflicts.
362
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
363
 
                # weave lines, because nothing should be recorded until it is known
364
 
                # that commit will succeed.
365
 
                self._set_progress_stage("Saving data locally")
366
 
                self.builder.finish_inventory()
367
 
 
368
 
                # Prompt the user for a commit message if none provided
369
 
                message = message_callback(self)
370
 
                self.message = message
371
 
 
372
 
                # Add revision data to the local branch
373
 
                self.rev_id = self.builder.commit(self.message)
374
 
 
375
 
            except Exception, e:
376
 
                mutter("aborting commit write group because of exception:")
377
 
                trace.log_exception_quietly()
378
 
                note("aborting commit write group: %r" % (e,))
379
 
                self.builder.abort()
380
 
                raise
381
 
 
382
 
            self._process_pre_hooks(old_revno, new_revno)
383
 
 
384
 
            # Upload revision data to the master.
385
 
            # this will propagate merged revisions too if needed.
386
 
            if self.bound_branch:
387
 
                self._set_progress_stage("Uploading data to master branch")
388
 
                # 'commit' to the master first so a timeout here causes the
389
 
                # local branch to be out of date
390
 
                self.master_branch.import_last_revision_info(
391
 
                    self.branch.repository, new_revno, self.rev_id)
392
 
 
393
 
            # and now do the commit locally.
394
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
395
 
 
396
 
            # Make the working tree be up to date with the branch. This
397
 
            # includes automatic changes scheduled to be made to the tree, such
398
 
            # as updating its basis and unversioning paths that were missing.
399
 
            self.work_tree.unversion(self.deleted_ids)
400
 
            self._set_progress_stage("Updating the working tree")
401
 
            self.work_tree.update_basis_by_delta(self.rev_id,
402
 
                 self.builder.get_basis_delta())
403
 
            self.reporter.completed(new_revno, self.rev_id)
404
 
            self._process_post_hooks(old_revno, new_revno)
405
 
        finally:
406
 
            self._cleanup()
 
405
            self.builder.will_record_deletes()
 
406
            # find the location being committed to
 
407
            if self.bound_branch:
 
408
                master_location = self.master_branch.base
 
409
            else:
 
410
                master_location = self.branch.base
 
411
 
 
412
            # report the start of the commit
 
413
            self.reporter.started(new_revno, self.rev_id, master_location)
 
414
 
 
415
            self._update_builder_with_changes()
 
416
            self._check_pointless()
 
417
 
 
418
            # TODO: Now the new inventory is known, check for conflicts.
 
419
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
420
            # weave lines, because nothing should be recorded until it is known
 
421
            # that commit will succeed.
 
422
            self._set_progress_stage("Saving data locally")
 
423
            self.builder.finish_inventory()
 
424
 
 
425
            # Prompt the user for a commit message if none provided
 
426
            message = message_callback(self)
 
427
            self.message = message
 
428
 
 
429
            # Add revision data to the local branch
 
430
            self.rev_id = self.builder.commit(self.message)
 
431
 
 
432
        except Exception, e:
 
433
            mutter("aborting commit write group because of exception:")
 
434
            trace.log_exception_quietly()
 
435
            note("aborting commit write group: %r" % (e,))
 
436
            self.builder.abort()
 
437
            raise
 
438
 
 
439
        self._process_pre_hooks(old_revno, new_revno)
 
440
 
 
441
        # Upload revision data to the master.
 
442
        # this will propagate merged revisions too if needed.
 
443
        if self.bound_branch:
 
444
            self._set_progress_stage("Uploading data to master branch")
 
445
            # 'commit' to the master first so a timeout here causes the
 
446
            # local branch to be out of date
 
447
            self.master_branch.import_last_revision_info(
 
448
                self.branch.repository, new_revno, self.rev_id)
 
449
 
 
450
        # and now do the commit locally.
 
451
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
452
 
 
453
        # Make the working tree be up to date with the branch. This
 
454
        # includes automatic changes scheduled to be made to the tree, such
 
455
        # as updating its basis and unversioning paths that were missing.
 
456
        self.work_tree.unversion(self.deleted_ids)
 
457
        self._set_progress_stage("Updating the working tree")
 
458
        self.work_tree.update_basis_by_delta(self.rev_id,
 
459
             self.builder.get_basis_delta())
 
460
        self.reporter.completed(new_revno, self.rev_id)
 
461
        self._process_post_hooks(old_revno, new_revno)
407
462
        return self.rev_id
408
463
 
409
464
    def _select_reporter(self):
431
486
            return
432
487
        raise PointlessCommit()
433
488
 
434
 
    def _check_bound_branch(self, possible_master_transports=None):
 
489
    def _check_bound_branch(self, operation, possible_master_transports=None):
435
490
        """Check to see if the local branch is bound.
436
491
 
437
492
        If it is bound, then most of the commit will actually be
472
527
        # so grab the lock
473
528
        self.bound_branch = self.branch
474
529
        self.master_branch.lock_write()
475
 
        self.master_locked = True
 
530
        operation.add_cleanup(self.master_branch.unlock)
476
531
 
477
532
    def _check_out_of_date_tree(self):
478
533
        """Check that the working tree is up to date.
563
618
                     old_revno, old_revid, new_revno, self.rev_id,
564
619
                     tree_delta, future_tree)
565
620
 
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
621
    def _gather_parents(self):
603
622
        """Record the parents of a merge for merge detection."""
604
623
        # TODO: Make sure that this list doesn't contain duplicate
619
638
        """Update the commit builder with the data about what has changed.
620
639
        """
621
640
        exclude = self.exclude
622
 
        specific_files = self.specific_files or []
 
641
        specific_files = self.specific_files
623
642
        mutter("Selecting files for commit with filter %s", specific_files)
624
643
 
625
644
        self._check_strict()
626
645
        if self.use_record_iter_changes:
627
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
646
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
647
                specific_files=specific_files)
628
648
            iter_changes = self._filter_iter_changes(iter_changes)
629
649
            for file_id, path, fs_hash in self.builder.record_iter_changes(
630
650
                self.work_tree, self.basis_revid, iter_changes):
802
822
                # _update_builder_with_changes.
803
823
                continue
804
824
            content_summary = self.work_tree.path_content_summary(path)
 
825
            kind = content_summary[0]
805
826
            # Note that when a filter of specific files is given, we must only
806
827
            # skip/record deleted files matching that filter.
807
828
            if not specific_files or is_inside_any(specific_files, path):
808
 
                if content_summary[0] == 'missing':
 
829
                if kind == 'missing':
809
830
                    if not deleted_paths:
810
831
                        # path won't have been split yet.
811
832
                        path_segments = splitpath(path)
818
839
                    continue
819
840
            # TODO: have the builder do the nested commit just-in-time IF and
820
841
            # only if needed.
821
 
            if content_summary[0] == 'tree-reference':
 
842
            if kind == 'tree-reference':
822
843
                # enforce repository nested tree policy.
823
844
                if (not self.work_tree.supports_tree_reference() or
824
845
                    # repository does not support it either.
825
846
                    not self.branch.repository._format.supports_tree_reference):
826
 
                    content_summary = ('directory',) + content_summary[1:]
827
 
            kind = content_summary[0]
828
 
            # TODO: specific_files filtering before nested tree processing
829
 
            if kind == 'tree-reference':
830
 
                if self.recursive == 'down':
 
847
                    kind = 'directory'
 
848
                    content_summary = (kind, None, None, None)
 
849
                elif self.recursive == 'down':
831
850
                    nested_revision_id = self._commit_nested_tree(
832
851
                        file_id, path)
833
 
                    content_summary = content_summary[:3] + (
834
 
                        nested_revision_id,)
 
852
                    content_summary = (kind, None, None, nested_revision_id)
835
853
                else:
836
 
                    content_summary = content_summary[:3] + (
837
 
                        self.work_tree.get_reference_revision(file_id),)
 
854
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
855
                    content_summary = (kind, None, None, nested_revision_id)
838
856
 
839
857
            # Record an entry for this item
840
858
            # Note: I don't particularly want to have the existing_ie