← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

Fix the remaining 'edge' references.

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,
204
233
        """Commit working copy as a new revision.
205
234
 
206
235
        :param message: the commit message (it or message_callback is required)
 
236
        :param message_callback: A callback: message = message_callback(cmt_obj)
207
237
 
208
238
        :param timestamp: if not None, seconds-since-epoch for a
209
239
            postdated/predated commit.
210
240
 
211
 
        :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'.
212
243
 
213
244
        :param rev_id: If set, use this as the new revision id.
214
245
            Useful for test or import commands that need to tightly
232
263
            commit. Pending changes to excluded files will be ignored by the
233
264
            commit.
234
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):
235
292
        mutter('preparing to commit')
236
293
 
237
294
        if working_tree is None:
260
317
            self.exclude = []
261
318
        self.local = local
262
319
        self.master_branch = None
263
 
        self.master_locked = False
264
320
        self.recursive = recursive
265
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.
266
324
        if specific_files is not None:
267
325
            self.specific_files = sorted(
268
326
                minimum_path_selection(specific_files))
270
328
            self.specific_files = None
271
329
            
272
330
        self.allow_pointless = allow_pointless
273
 
        self.revprops = revprops
274
331
        self.message_callback = message_callback
275
332
        self.timestamp = timestamp
276
333
        self.timezone = timezone
279
336
        self.verbose = verbose
280
337
 
281
338
        self.work_tree.lock_write()
 
339
        operation.add_cleanup(self.work_tree.unlock)
282
340
        self.parents = self.work_tree.get_parent_ids()
283
341
        # We can use record_iter_changes IFF iter_changes is compatible with
284
342
        # the command line parameters, and the repository has fast delta
285
343
        # generation. See bug 347649.
286
344
        self.use_record_iter_changes = (
287
 
            not self.specific_files and
288
345
            not self.exclude and 
289
346
            not self.branch.repository._format.supports_tree_reference and
290
347
            (self.branch.repository._format.fast_deltas or
291
348
             len(self.parents) < 2))
292
349
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
350
        operation.add_cleanup(self.pb.finished)
293
351
        self.basis_revid = self.work_tree.last_revision()
294
352
        self.basis_tree = self.work_tree.basis_tree()
295
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
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
384
            # tags to master branch"
 
385
            self.pb_stage_total += 2
 
386
        self.pb.show_pct = False
 
387
        self.pb.show_spinner = False
 
388
        self.pb.show_eta = False
 
389
        self.pb.show_count = True
 
390
        self.pb.show_bar = True
 
391
 
 
392
        self._gather_parents()
 
393
        # After a merge, a selected file commit is not supported.
 
394
        # See 'bzr help merge' for an explanation as to why.
 
395
        if len(self.parents) > 1 and self.specific_files is not None:
 
396
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
397
        # Excludes are a form of selected file commit.
 
398
        if len(self.parents) > 1 and self.exclude:
 
399
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
400
 
 
401
        # Collect the changes
 
402
        self._set_progress_stage("Collecting changes", counter=True)
 
403
        self.builder = self.branch.get_commit_builder(self.parents,
 
404
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
405
 
296
406
        try:
297
 
            # Cannot commit with conflicts present.
298
 
            if len(self.work_tree.conflicts()) > 0:
299
 
                raise ConflictsInTree
300
 
 
301
 
            # Setup the bound branch variables as needed.
302
 
            self._check_bound_branch(possible_master_transports)
303
 
 
304
 
            # Check that the working tree is up to date
305
 
            old_revno, new_revno = self._check_out_of_date_tree()
306
 
 
307
 
            # Complete configuration setup
308
 
            if reporter is not None:
309
 
                self.reporter = reporter
310
 
            elif self.reporter is None:
311
 
                self.reporter = self._select_reporter()
312
 
            if self.config is None:
313
 
                self.config = self.branch.get_config()
314
 
 
315
 
            self._set_specific_file_ids()
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
324
 
            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
 
            self._gather_parents()
333
 
            # After a merge, a selected file commit is not supported.
334
 
            # See 'bzr help merge' for an explanation as to why.
335
 
            if len(self.parents) > 1 and self.specific_files:
336
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
337
 
            # Excludes are a form of selected file commit.
338
 
            if len(self.parents) > 1 and self.exclude:
339
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
340
 
 
341
 
            # Collect the changes
342
 
            self._set_progress_stage("Collecting changes", counter=True)
343
 
            self.builder = self.branch.get_commit_builder(self.parents,
344
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
345
 
 
346
 
            try:
347
 
                self.builder.will_record_deletes()
348
 
                # find the location being committed to
349
 
                if self.bound_branch:
350
 
                    master_location = self.master_branch.base
351
 
                else:
352
 
                    master_location = self.branch.base
353
 
 
354
 
                # report the start of the commit
355
 
                self.reporter.started(new_revno, self.rev_id, master_location)
356
 
 
357
 
                self._update_builder_with_changes()
358
 
                self._check_pointless()
359
 
 
360
 
                # TODO: Now the new inventory is known, check for conflicts.
361
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
362
 
                # weave lines, because nothing should be recorded until it is known
363
 
                # that commit will succeed.
364
 
                self._set_progress_stage("Saving data locally")
365
 
                self.builder.finish_inventory()
366
 
 
367
 
                # Prompt the user for a commit message if none provided
368
 
                message = message_callback(self)
369
 
                self.message = message
370
 
 
371
 
                # Add revision data to the local branch
372
 
                self.rev_id = self.builder.commit(self.message)
373
 
 
374
 
            except Exception, e:
375
 
                mutter("aborting commit write group because of exception:")
376
 
                trace.log_exception_quietly()
377
 
                note("aborting commit write group: %r" % (e,))
378
 
                self.builder.abort()
379
 
                raise
380
 
 
381
 
            self._process_pre_hooks(old_revno, new_revno)
382
 
 
383
 
            # Upload revision data to the master.
384
 
            # this will propagate merged revisions too if needed.
385
 
            if self.bound_branch:
386
 
                self._set_progress_stage("Uploading data to master branch")
387
 
                # 'commit' to the master first so a timeout here causes the
388
 
                # local branch to be out of date
389
 
                self.master_branch.import_last_revision_info(
390
 
                    self.branch.repository, new_revno, self.rev_id)
391
 
 
392
 
            # and now do the commit locally.
393
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
394
 
 
395
 
            # Make the working tree up to date with the branch
396
 
            self._set_progress_stage("Updating the working tree")
397
 
            self.work_tree.update_basis_by_delta(self.rev_id,
398
 
                 self.builder.get_basis_delta())
399
 
            self.reporter.completed(new_revno, self.rev_id)
400
 
            self._process_post_hooks(old_revno, new_revno)
401
 
        finally:
402
 
            self._cleanup()
 
407
            self.builder.will_record_deletes()
 
408
            # find the location being committed to
 
409
            if self.bound_branch:
 
410
                master_location = self.master_branch.base
 
411
            else:
 
412
                master_location = self.branch.base
 
413
 
 
414
            # report the start of the commit
 
415
            self.reporter.started(new_revno, self.rev_id, master_location)
 
416
 
 
417
            self._update_builder_with_changes()
 
418
            self._check_pointless()
 
419
 
 
420
            # TODO: Now the new inventory is known, check for conflicts.
 
421
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
422
            # weave lines, because nothing should be recorded until it is known
 
423
            # that commit will succeed.
 
424
            self._set_progress_stage("Saving data locally")
 
425
            self.builder.finish_inventory()
 
426
 
 
427
            # Prompt the user for a commit message if none provided
 
428
            message = message_callback(self)
 
429
            self.message = message
 
430
 
 
431
            # Add revision data to the local branch
 
432
            self.rev_id = self.builder.commit(self.message)
 
433
 
 
434
        except Exception, e:
 
435
            mutter("aborting commit write group because of exception:")
 
436
            trace.log_exception_quietly()
 
437
            note("aborting commit write group: %r" % (e,))
 
438
            self.builder.abort()
 
439
            raise
 
440
 
 
441
        self._process_pre_hooks(old_revno, new_revno)
 
442
 
 
443
        # Upload revision data to the master.
 
444
        # this will propagate merged revisions too if needed.
 
445
        if self.bound_branch:
 
446
            self._set_progress_stage("Uploading data to master branch")
 
447
            # 'commit' to the master first so a timeout here causes the
 
448
            # local branch to be out of date
 
449
            self.master_branch.import_last_revision_info(
 
450
                self.branch.repository, new_revno, self.rev_id)
 
451
 
 
452
        # and now do the commit locally.
 
453
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
454
 
 
455
        # Merge local tags to remote
 
456
        if self.bound_branch:
 
457
            self._set_progress_stage("Merging tags to master branch")
 
458
            tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
 
459
            if tag_conflicts:
 
460
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
 
461
                note("Conflicting tags in bound branch:\n" +
 
462
                    "\n".join(warning_lines))
 
463
 
 
464
        # Make the working tree be up to date with the branch. This
 
465
        # includes automatic changes scheduled to be made to the tree, such
 
466
        # as updating its basis and unversioning paths that were missing.
 
467
        self.work_tree.unversion(self.deleted_ids)
 
468
        self._set_progress_stage("Updating the working tree")
 
469
        self.work_tree.update_basis_by_delta(self.rev_id,
 
470
             self.builder.get_basis_delta())
 
471
        self.reporter.completed(new_revno, self.rev_id)
 
472
        self._process_post_hooks(old_revno, new_revno)
403
473
        return self.rev_id
404
474
 
405
475
    def _select_reporter(self):
427
497
            return
428
498
        raise PointlessCommit()
429
499
 
430
 
    def _check_bound_branch(self, possible_master_transports=None):
 
500
    def _check_bound_branch(self, operation, possible_master_transports=None):
431
501
        """Check to see if the local branch is bound.
432
502
 
433
503
        If it is bound, then most of the commit will actually be
468
538
        # so grab the lock
469
539
        self.bound_branch = self.branch
470
540
        self.master_branch.lock_write()
471
 
        self.master_locked = True
 
541
        operation.add_cleanup(self.master_branch.unlock)
472
542
 
473
543
    def _check_out_of_date_tree(self):
474
544
        """Check that the working tree is up to date.
559
629
                     old_revno, old_revid, new_revno, self.rev_id,
560
630
                     tree_delta, future_tree)
561
631
 
562
 
    def _cleanup(self):
563
 
        """Cleanup any open locks, progress bars etc."""
564
 
        cleanups = [self._cleanup_bound_branch,
565
 
                    self.basis_tree.unlock,
566
 
                    self.work_tree.unlock,
567
 
                    self.pb.finished]
568
 
        found_exception = None
569
 
        for cleanup in cleanups:
570
 
            try:
571
 
                cleanup()
572
 
            # we want every cleanup to run no matter what.
573
 
            # so we have a catchall here, but we will raise the
574
 
            # last encountered exception up the stack: and
575
 
            # typically this will be useful enough.
576
 
            except Exception, e:
577
 
                found_exception = e
578
 
        if found_exception is not None:
579
 
            # don't do a plan raise, because the last exception may have been
580
 
            # trashed, e is our sure-to-work exception even though it loses the
581
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
582
 
            # exc_info and if its the same one do a plain raise otherwise
583
 
            # 'raise e' as we do now.
584
 
            raise e
585
 
 
586
 
    def _cleanup_bound_branch(self):
587
 
        """Executed at the end of a try/finally to cleanup a bound branch.
588
 
 
589
 
        If the branch wasn't bound, this is a no-op.
590
 
        If it was, it resents self.branch to the local branch, instead
591
 
        of being the master.
592
 
        """
593
 
        if not self.bound_branch:
594
 
            return
595
 
        if self.master_locked:
596
 
            self.master_branch.unlock()
597
 
 
598
632
    def _gather_parents(self):
599
633
        """Record the parents of a merge for merge detection."""
600
634
        # TODO: Make sure that this list doesn't contain duplicate
615
649
        """Update the commit builder with the data about what has changed.
616
650
        """
617
651
        exclude = self.exclude
618
 
        specific_files = self.specific_files or []
 
652
        specific_files = self.specific_files
619
653
        mutter("Selecting files for commit with filter %s", specific_files)
620
654
 
621
655
        self._check_strict()
622
656
        if self.use_record_iter_changes:
623
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
657
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
658
                specific_files=specific_files)
624
659
            iter_changes = self._filter_iter_changes(iter_changes)
625
660
            for file_id, path, fs_hash in self.builder.record_iter_changes(
626
661
                self.work_tree, self.basis_revid, iter_changes):
679
714
                            reporter.snapshot_change('modified', new_path)
680
715
            self._next_progress_entry()
681
716
        # Unversion IDs that were found to be deleted
682
 
        self.work_tree.unversion(deleted_ids)
 
717
        self.deleted_ids = deleted_ids
683
718
 
684
719
    def _record_unselected(self):
685
720
        # If specific files are selected, then all un-selected files must be
798
833
                # _update_builder_with_changes.
799
834
                continue
800
835
            content_summary = self.work_tree.path_content_summary(path)
 
836
            kind = content_summary[0]
801
837
            # Note that when a filter of specific files is given, we must only
802
838
            # skip/record deleted files matching that filter.
803
839
            if not specific_files or is_inside_any(specific_files, path):
804
 
                if content_summary[0] == 'missing':
 
840
                if kind == 'missing':
805
841
                    if not deleted_paths:
806
842
                        # path won't have been split yet.
807
843
                        path_segments = splitpath(path)
814
850
                    continue
815
851
            # TODO: have the builder do the nested commit just-in-time IF and
816
852
            # only if needed.
817
 
            if content_summary[0] == 'tree-reference':
 
853
            if kind == 'tree-reference':
818
854
                # enforce repository nested tree policy.
819
855
                if (not self.work_tree.supports_tree_reference() or
820
856
                    # repository does not support it either.
821
857
                    not self.branch.repository._format.supports_tree_reference):
822
 
                    content_summary = ('directory',) + content_summary[1:]
823
 
            kind = content_summary[0]
824
 
            # TODO: specific_files filtering before nested tree processing
825
 
            if kind == 'tree-reference':
826
 
                if self.recursive == 'down':
 
858
                    kind = 'directory'
 
859
                    content_summary = (kind, None, None, None)
 
860
                elif self.recursive == 'down':
827
861
                    nested_revision_id = self._commit_nested_tree(
828
862
                        file_id, path)
829
 
                    content_summary = content_summary[:3] + (
830
 
                        nested_revision_id,)
 
863
                    content_summary = (kind, None, None, nested_revision_id)
831
864
                else:
832
 
                    content_summary = content_summary[:3] + (
833
 
                        self.work_tree.get_reference_revision(file_id),)
 
865
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
866
                    content_summary = (kind, None, None, nested_revision_id)
834
867
 
835
868
            # Record an entry for this item
836
869
            # Note: I don't particularly want to have the existing_ie
842
875
                content_summary)
843
876
 
844
877
        # Unversion IDs that were found to be deleted
845
 
        self.work_tree.unversion(deleted_ids)
 
878
        self.deleted_ids = deleted_ids
846
879
 
847
880
    def _commit_nested_tree(self, file_id, path):
848
881
        "Commit a nested tree."