~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Robert Collins
  • Date: 2009-04-02 05:05:17 UTC
  • mto: This revision was merged to the branch mainline in revision 4234.
  • Revision ID: robertc@robertcollins.net-20090402050517-4m3m3fq2ttfvwoi0
Alter test_config.FakeBranch in accordance with the Branch change to have a _get_config.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
57
64
    tree,
58
65
    )
59
66
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
67
import bzrlib.config
62
68
from bzrlib.errors import (BzrError, PointlessCommit,
63
69
                           ConflictsInTree,
64
70
                           StrictCommitFailed
65
71
                           )
66
72
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
73
                            kind_marker, isdir,isfile, is_inside_any,
 
74
                            is_inside_or_parent_of_any,
68
75
                            minimum_path_selection,
 
76
                            quotefn, sha_file, split_lines,
69
77
                            splitpath,
70
78
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
 
79
from bzrlib.testament import Testament
 
80
from bzrlib.trace import mutter, note, warning, is_quiet
72
81
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
82
from bzrlib import symbol_versioning
 
83
from bzrlib.symbol_versioning import (deprecated_passed,
 
84
        deprecated_function,
 
85
        DEPRECATED_PARAMETER)
 
86
from bzrlib.workingtree import WorkingTree
74
87
from bzrlib.urlutils import unescape_for_display
75
88
import bzrlib.ui
76
89
 
94
107
    def deleted(self, path):
95
108
        pass
96
109
 
 
110
    def escaped(self, escape_count, message):
 
111
        pass
 
112
 
97
113
    def missing(self, path):
98
114
        pass
99
115
 
132
148
 
133
149
    def completed(self, revno, rev_id):
134
150
        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)
141
151
 
142
152
    def deleted(self, path):
143
153
        self._note('deleted %s', path)
144
154
 
 
155
    def escaped(self, escape_count, message):
 
156
        self._note("replaced %d control characters in message", escape_count)
 
157
 
145
158
    def missing(self, path):
146
159
        self._note('missing %s', path)
147
160
 
196
209
        """Commit working copy as a new revision.
197
210
 
198
211
        :param message: the commit message (it or message_callback is required)
199
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
200
212
 
201
213
        :param timestamp: if not None, seconds-since-epoch for a
202
214
            postdated/predated commit.
203
215
 
204
 
        :param specific_files: If not None, commit only those files. An empty
205
 
            list means 'commit no files'.
 
216
        :param specific_files: If true, commit only those files.
206
217
 
207
218
        :param rev_id: If set, use this as the new revision id.
208
219
            Useful for test or import commands that need to tightly
226
237
            commit. Pending changes to excluded files will be ignored by the
227
238
            commit.
228
239
        """
229
 
        operation = OperationWithCleanups(self._commit)
230
 
        self.revprops = revprops or {}
231
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
232
 
        self.config = config or self.config
233
 
        return operation.run(
234
 
               message=message,
235
 
               timestamp=timestamp,
236
 
               timezone=timezone,
237
 
               committer=committer,
238
 
               specific_files=specific_files,
239
 
               rev_id=rev_id,
240
 
               allow_pointless=allow_pointless,
241
 
               strict=strict,
242
 
               verbose=verbose,
243
 
               working_tree=working_tree,
244
 
               local=local,
245
 
               reporter=reporter,
246
 
               message_callback=message_callback,
247
 
               recursive=recursive,
248
 
               exclude=exclude,
249
 
               possible_master_transports=possible_master_transports)
250
 
 
251
 
    def _commit(self, operation, message, timestamp, timezone, committer,
252
 
            specific_files, rev_id, allow_pointless, strict, verbose,
253
 
            working_tree, local, reporter, message_callback, recursive,
254
 
            exclude, possible_master_transports):
255
240
        mutter('preparing to commit')
256
241
 
257
242
        if working_tree is None:
280
265
            self.exclude = []
281
266
        self.local = local
282
267
        self.master_branch = None
 
268
        self.master_locked = False
283
269
        self.recursive = recursive
284
270
        self.rev_id = None
285
 
        # self.specific_files is None to indicate no filter, or any iterable to
286
 
        # indicate a filter - [] means no files at all, as per iter_changes.
287
271
        if specific_files is not None:
288
272
            self.specific_files = sorted(
289
273
                minimum_path_selection(specific_files))
291
275
            self.specific_files = None
292
276
            
293
277
        self.allow_pointless = allow_pointless
 
278
        self.revprops = revprops
294
279
        self.message_callback = message_callback
295
280
        self.timestamp = timestamp
296
281
        self.timezone = timezone
299
284
        self.verbose = verbose
300
285
 
301
286
        self.work_tree.lock_write()
302
 
        operation.add_cleanup(self.work_tree.unlock)
303
287
        self.parents = self.work_tree.get_parent_ids()
304
288
        # We can use record_iter_changes IFF iter_changes is compatible with
305
289
        # the command line parameters, and the repository has fast delta
306
290
        # generation. See bug 347649.
307
291
        self.use_record_iter_changes = (
 
292
            not self.specific_files and
308
293
            not self.exclude and 
309
294
            not self.branch.repository._format.supports_tree_reference and
310
295
            (self.branch.repository._format.fast_deltas or
311
296
             len(self.parents) < 2))
312
297
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
313
 
        operation.add_cleanup(self.pb.finished)
314
298
        self.basis_revid = self.work_tree.last_revision()
315
299
        self.basis_tree = self.work_tree.basis_tree()
316
300
        self.basis_tree.lock_read()
317
 
        operation.add_cleanup(self.basis_tree.unlock)
318
 
        # Cannot commit with conflicts present.
319
 
        if len(self.work_tree.conflicts()) > 0:
320
 
            raise ConflictsInTree
321
 
 
322
 
        # Setup the bound branch variables as needed.
323
 
        self._check_bound_branch(operation, possible_master_transports)
324
 
 
325
 
        # Check that the working tree is up to date
326
 
        old_revno, new_revno = self._check_out_of_date_tree()
327
 
 
328
 
        # Complete configuration setup
329
 
        if reporter is not None:
330
 
            self.reporter = reporter
331
 
        elif self.reporter is None:
332
 
            self.reporter = self._select_reporter()
333
 
        if self.config is None:
334
 
            self.config = self.branch.get_config()
335
 
 
336
 
        self._set_specific_file_ids()
337
 
 
338
 
        # Setup the progress bar. As the number of files that need to be
339
 
        # committed in unknown, progress is reported as stages.
340
 
        # We keep track of entries separately though and include that
341
 
        # information in the progress bar during the relevant stages.
342
 
        self.pb_stage_name = ""
343
 
        self.pb_stage_count = 0
344
 
        self.pb_stage_total = 5
345
 
        if self.bound_branch:
346
 
            self.pb_stage_total += 1
347
 
        self.pb.show_pct = False
348
 
        self.pb.show_spinner = False
349
 
        self.pb.show_eta = False
350
 
        self.pb.show_count = True
351
 
        self.pb.show_bar = True
352
 
 
353
 
        self._gather_parents()
354
 
        # After a merge, a selected file commit is not supported.
355
 
        # See 'bzr help merge' for an explanation as to why.
356
 
        if len(self.parents) > 1 and self.specific_files is not None:
357
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
358
 
        # Excludes are a form of selected file commit.
359
 
        if len(self.parents) > 1 and self.exclude:
360
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
361
 
 
362
 
        # Collect the changes
363
 
        self._set_progress_stage("Collecting changes", counter=True)
364
 
        self.builder = self.branch.get_commit_builder(self.parents,
365
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
366
 
 
367
301
        try:
368
 
            self.builder.will_record_deletes()
369
 
            # find the location being committed to
370
 
            if self.bound_branch:
371
 
                master_location = self.master_branch.base
372
 
            else:
373
 
                master_location = self.branch.base
374
 
 
375
 
            # report the start of the commit
376
 
            self.reporter.started(new_revno, self.rev_id, master_location)
377
 
 
378
 
            self._update_builder_with_changes()
379
 
            self._check_pointless()
380
 
 
381
 
            # TODO: Now the new inventory is known, check for conflicts.
382
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
383
 
            # weave lines, because nothing should be recorded until it is known
384
 
            # that commit will succeed.
385
 
            self._set_progress_stage("Saving data locally")
386
 
            self.builder.finish_inventory()
387
 
 
388
 
            # Prompt the user for a commit message if none provided
389
 
            message = message_callback(self)
390
 
            self.message = message
391
 
 
392
 
            # Add revision data to the local branch
393
 
            self.rev_id = self.builder.commit(self.message)
394
 
 
395
 
        except Exception, e:
396
 
            mutter("aborting commit write group because of exception:")
397
 
            trace.log_exception_quietly()
398
 
            note("aborting commit write group: %r" % (e,))
399
 
            self.builder.abort()
400
 
            raise
401
 
 
402
 
        self._process_pre_hooks(old_revno, new_revno)
403
 
 
404
 
        # Upload revision data to the master.
405
 
        # this will propagate merged revisions too if needed.
406
 
        if self.bound_branch:
407
 
            self._set_progress_stage("Uploading data to master branch")
408
 
            # 'commit' to the master first so a timeout here causes the
409
 
            # local branch to be out of date
410
 
            self.master_branch.import_last_revision_info(
411
 
                self.branch.repository, new_revno, self.rev_id)
412
 
 
413
 
        # and now do the commit locally.
414
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
415
 
 
416
 
        # Make the working tree be up to date with the branch. This
417
 
        # includes automatic changes scheduled to be made to the tree, such
418
 
        # as updating its basis and unversioning paths that were missing.
419
 
        self.work_tree.unversion(self.deleted_ids)
420
 
        self._set_progress_stage("Updating the working tree")
421
 
        self.work_tree.update_basis_by_delta(self.rev_id,
422
 
             self.builder.get_basis_delta())
423
 
        self.reporter.completed(new_revno, self.rev_id)
424
 
        self._process_post_hooks(old_revno, new_revno)
 
302
            # Cannot commit with conflicts present.
 
303
            if len(self.work_tree.conflicts()) > 0:
 
304
                raise ConflictsInTree
 
305
 
 
306
            # Setup the bound branch variables as needed.
 
307
            self._check_bound_branch(possible_master_transports)
 
308
 
 
309
            # Check that the working tree is up to date
 
310
            old_revno, new_revno = self._check_out_of_date_tree()
 
311
 
 
312
            # Complete configuration setup
 
313
            if reporter is not None:
 
314
                self.reporter = reporter
 
315
            elif self.reporter is None:
 
316
                self.reporter = self._select_reporter()
 
317
            if self.config is None:
 
318
                self.config = self.branch.get_config()
 
319
 
 
320
            self._set_specific_file_ids()
 
321
 
 
322
            # Setup the progress bar. As the number of files that need to be
 
323
            # committed in unknown, progress is reported as stages.
 
324
            # We keep track of entries separately though and include that
 
325
            # information in the progress bar during the relevant stages.
 
326
            self.pb_stage_name = ""
 
327
            self.pb_stage_count = 0
 
328
            self.pb_stage_total = 5
 
329
            if self.bound_branch:
 
330
                self.pb_stage_total += 1
 
331
            self.pb.show_pct = False
 
332
            self.pb.show_spinner = False
 
333
            self.pb.show_eta = False
 
334
            self.pb.show_count = True
 
335
            self.pb.show_bar = True
 
336
 
 
337
            self._gather_parents()
 
338
            # After a merge, a selected file commit is not supported.
 
339
            # See 'bzr help merge' for an explanation as to why.
 
340
            if len(self.parents) > 1 and self.specific_files:
 
341
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
342
            # Excludes are a form of selected file commit.
 
343
            if len(self.parents) > 1 and self.exclude:
 
344
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
345
 
 
346
            # Collect the changes
 
347
            self._set_progress_stage("Collecting changes", counter=True)
 
348
            self.builder = self.branch.get_commit_builder(self.parents,
 
349
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
350
 
 
351
            try:
 
352
                self.builder.will_record_deletes()
 
353
                # find the location being committed to
 
354
                if self.bound_branch:
 
355
                    master_location = self.master_branch.base
 
356
                else:
 
357
                    master_location = self.branch.base
 
358
 
 
359
                # report the start of the commit
 
360
                self.reporter.started(new_revno, self.rev_id, master_location)
 
361
 
 
362
                self._update_builder_with_changes()
 
363
                self._check_pointless()
 
364
 
 
365
                # TODO: Now the new inventory is known, check for conflicts.
 
366
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
367
                # weave lines, because nothing should be recorded until it is known
 
368
                # that commit will succeed.
 
369
                self._set_progress_stage("Saving data locally")
 
370
                self.builder.finish_inventory()
 
371
 
 
372
                # Prompt the user for a commit message if none provided
 
373
                message = message_callback(self)
 
374
                self.message = message
 
375
                self._escape_commit_message()
 
376
 
 
377
                # Add revision data to the local branch
 
378
                self.rev_id = self.builder.commit(self.message)
 
379
 
 
380
            except Exception, e:
 
381
                mutter("aborting commit write group because of exception:")
 
382
                trace.log_exception_quietly()
 
383
                note("aborting commit write group: %r" % (e,))
 
384
                self.builder.abort()
 
385
                raise
 
386
 
 
387
            self._process_pre_hooks(old_revno, new_revno)
 
388
 
 
389
            # Upload revision data to the master.
 
390
            # this will propagate merged revisions too if needed.
 
391
            if self.bound_branch:
 
392
                self._set_progress_stage("Uploading data to master branch")
 
393
                # 'commit' to the master first so a timeout here causes the
 
394
                # local branch to be out of date
 
395
                self.master_branch.import_last_revision_info(
 
396
                    self.branch.repository, new_revno, self.rev_id)
 
397
 
 
398
            # and now do the commit locally.
 
399
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
400
 
 
401
            # Make the working tree up to date with the branch
 
402
            self._set_progress_stage("Updating the working tree")
 
403
            self.work_tree.update_basis_by_delta(self.rev_id,
 
404
                 self.builder.get_basis_delta())
 
405
            self.reporter.completed(new_revno, self.rev_id)
 
406
            self._process_post_hooks(old_revno, new_revno)
 
407
        finally:
 
408
            self._cleanup()
425
409
        return self.rev_id
426
410
 
427
411
    def _select_reporter(self):
449
433
            return
450
434
        raise PointlessCommit()
451
435
 
452
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
436
    def _check_bound_branch(self, possible_master_transports=None):
453
437
        """Check to see if the local branch is bound.
454
438
 
455
439
        If it is bound, then most of the commit will actually be
490
474
        # so grab the lock
491
475
        self.bound_branch = self.branch
492
476
        self.master_branch.lock_write()
493
 
        operation.add_cleanup(self.master_branch.unlock)
 
477
        self.master_locked = True
494
478
 
495
479
    def _check_out_of_date_tree(self):
496
480
        """Check that the working tree is up to date.
581
565
                     old_revno, old_revid, new_revno, self.rev_id,
582
566
                     tree_delta, future_tree)
583
567
 
 
568
    def _cleanup(self):
 
569
        """Cleanup any open locks, progress bars etc."""
 
570
        cleanups = [self._cleanup_bound_branch,
 
571
                    self.basis_tree.unlock,
 
572
                    self.work_tree.unlock,
 
573
                    self.pb.finished]
 
574
        found_exception = None
 
575
        for cleanup in cleanups:
 
576
            try:
 
577
                cleanup()
 
578
            # we want every cleanup to run no matter what.
 
579
            # so we have a catchall here, but we will raise the
 
580
            # last encountered exception up the stack: and
 
581
            # typically this will be useful enough.
 
582
            except Exception, e:
 
583
                found_exception = e
 
584
        if found_exception is not None:
 
585
            # don't do a plan raise, because the last exception may have been
 
586
            # trashed, e is our sure-to-work exception even though it loses the
 
587
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
588
            # exc_info and if its the same one do a plain raise otherwise
 
589
            # 'raise e' as we do now.
 
590
            raise e
 
591
 
 
592
    def _cleanup_bound_branch(self):
 
593
        """Executed at the end of a try/finally to cleanup a bound branch.
 
594
 
 
595
        If the branch wasn't bound, this is a no-op.
 
596
        If it was, it resents self.branch to the local branch, instead
 
597
        of being the master.
 
598
        """
 
599
        if not self.bound_branch:
 
600
            return
 
601
        if self.master_locked:
 
602
            self.master_branch.unlock()
 
603
 
 
604
    def _escape_commit_message(self):
 
605
        """Replace xml-incompatible control characters."""
 
606
        # FIXME: RBC 20060419 this should be done by the revision
 
607
        # serialiser not by commit. Then we can also add an unescaper
 
608
        # in the deserializer and start roundtripping revision messages
 
609
        # precisely. See repository_implementations/test_repository.py
 
610
 
 
611
        # Python strings can include characters that can't be
 
612
        # represented in well-formed XML; escape characters that
 
613
        # aren't listed in the XML specification
 
614
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
615
        self.message, escape_count = re.subn(
 
616
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
617
            lambda match: match.group(0).encode('unicode_escape'),
 
618
            self.message)
 
619
        if escape_count:
 
620
            self.reporter.escaped(escape_count, self.message)
 
621
 
584
622
    def _gather_parents(self):
585
623
        """Record the parents of a merge for merge detection."""
586
624
        # TODO: Make sure that this list doesn't contain duplicate
601
639
        """Update the commit builder with the data about what has changed.
602
640
        """
603
641
        exclude = self.exclude
604
 
        specific_files = self.specific_files
 
642
        specific_files = self.specific_files or []
605
643
        mutter("Selecting files for commit with filter %s", specific_files)
606
644
 
607
645
        self._check_strict()
608
646
        if self.use_record_iter_changes:
609
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
610
 
                specific_files=specific_files)
 
647
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
611
648
            iter_changes = self._filter_iter_changes(iter_changes)
612
649
            for file_id, path, fs_hash in self.builder.record_iter_changes(
613
650
                self.work_tree, self.basis_revid, iter_changes):
666
703
                            reporter.snapshot_change('modified', new_path)
667
704
            self._next_progress_entry()
668
705
        # Unversion IDs that were found to be deleted
669
 
        self.deleted_ids = deleted_ids
 
706
        self.work_tree.unversion(deleted_ids)
670
707
 
671
708
    def _record_unselected(self):
672
709
        # If specific files are selected, then all un-selected files must be
785
822
                # _update_builder_with_changes.
786
823
                continue
787
824
            content_summary = self.work_tree.path_content_summary(path)
788
 
            kind = content_summary[0]
789
825
            # Note that when a filter of specific files is given, we must only
790
826
            # skip/record deleted files matching that filter.
791
827
            if not specific_files or is_inside_any(specific_files, path):
792
 
                if kind == 'missing':
 
828
                if content_summary[0] == 'missing':
793
829
                    if not deleted_paths:
794
830
                        # path won't have been split yet.
795
831
                        path_segments = splitpath(path)
802
838
                    continue
803
839
            # TODO: have the builder do the nested commit just-in-time IF and
804
840
            # only if needed.
805
 
            if kind == 'tree-reference':
 
841
            if content_summary[0] == 'tree-reference':
806
842
                # enforce repository nested tree policy.
807
843
                if (not self.work_tree.supports_tree_reference() or
808
844
                    # repository does not support it either.
809
845
                    not self.branch.repository._format.supports_tree_reference):
810
 
                    kind = 'directory'
811
 
                    content_summary = (kind, None, None, None)
812
 
                elif self.recursive == 'down':
 
846
                    content_summary = ('directory',) + content_summary[1:]
 
847
            kind = content_summary[0]
 
848
            # TODO: specific_files filtering before nested tree processing
 
849
            if kind == 'tree-reference':
 
850
                if self.recursive == 'down':
813
851
                    nested_revision_id = self._commit_nested_tree(
814
852
                        file_id, path)
815
 
                    content_summary = (kind, None, None, nested_revision_id)
 
853
                    content_summary = content_summary[:3] + (
 
854
                        nested_revision_id,)
816
855
                else:
817
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
818
 
                    content_summary = (kind, None, None, nested_revision_id)
 
856
                    content_summary = content_summary[:3] + (
 
857
                        self.work_tree.get_reference_revision(file_id),)
819
858
 
820
859
            # Record an entry for this item
821
860
            # Note: I don't particularly want to have the existing_ie
827
866
                content_summary)
828
867
 
829
868
        # Unversion IDs that were found to be deleted
830
 
        self.deleted_ids = deleted_ids
 
869
        self.work_tree.unversion(deleted_ids)
831
870
 
832
871
    def _commit_nested_tree(self, file_id, path):
833
872
        "Commit a nested tree."