/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2010-04-16 07:56:51 UTC
  • mfrom: (5160 +trunk)
  • mto: (5050.3.4 2.2)
  • mto: This revision was merged to the branch mainline in revision 5173.
  • Revision ID: mbp@sourcefrog.net-20100416075651-bf23hr9hlof64gpj
merge trunk to 2.2 preparing for 2.2b2

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
65
65
    xml_serializer,
66
66
    )
67
67
from bzrlib.branch import Branch
 
68
from bzrlib.cleanup import OperationWithCleanups
68
69
import bzrlib.config
69
70
from bzrlib.errors import (BzrError, PointlessCommit,
70
71
                           ConflictsInTree,
108
109
    def deleted(self, path):
109
110
        pass
110
111
 
111
 
    def escaped(self, escape_count, message):
112
 
        pass
113
 
 
114
112
    def missing(self, path):
115
113
        pass
116
114
 
149
147
 
150
148
    def completed(self, revno, rev_id):
151
149
        self._note('Committed revision %d.', revno)
 
150
        # self._note goes to the console too; so while we want to log the
 
151
        # rev_id, we can't trivially only log it. (See bug 526425). Long
 
152
        # term we should rearrange the reporting structure, but for now
 
153
        # we just mutter seperately. We mutter the revid and revno together
 
154
        # so that concurrent bzr invocations won't lead to confusion.
 
155
        mutter('Committed revid %s as revno %d.', rev_id, revno)
152
156
 
153
157
    def deleted(self, path):
154
158
        self._note('deleted %s', path)
155
159
 
156
 
    def escaped(self, escape_count, message):
157
 
        self._note("replaced %d control characters in message", escape_count)
158
 
 
159
160
    def missing(self, path):
160
161
        self._note('missing %s', path)
161
162
 
210
211
        """Commit working copy as a new revision.
211
212
 
212
213
        :param message: the commit message (it or message_callback is required)
 
214
        :param message_callback: A callback: message = message_callback(cmt_obj)
213
215
 
214
216
        :param timestamp: if not None, seconds-since-epoch for a
215
217
            postdated/predated commit.
216
218
 
217
 
        :param specific_files: If true, commit only those files.
 
219
        :param specific_files: If not None, commit only those files. An empty
 
220
            list means 'commit no files'.
218
221
 
219
222
        :param rev_id: If set, use this as the new revision id.
220
223
            Useful for test or import commands that need to tightly
238
241
            commit. Pending changes to excluded files will be ignored by the
239
242
            commit.
240
243
        """
 
244
        operation = OperationWithCleanups(self._commit)
 
245
        self.revprops = revprops or {}
 
246
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
247
        self.config = config or self.config
 
248
        return operation.run(
 
249
               message=message,
 
250
               timestamp=timestamp,
 
251
               timezone=timezone,
 
252
               committer=committer,
 
253
               specific_files=specific_files,
 
254
               rev_id=rev_id,
 
255
               allow_pointless=allow_pointless,
 
256
               strict=strict,
 
257
               verbose=verbose,
 
258
               working_tree=working_tree,
 
259
               local=local,
 
260
               reporter=reporter,
 
261
               message_callback=message_callback,
 
262
               recursive=recursive,
 
263
               exclude=exclude,
 
264
               possible_master_transports=possible_master_transports)
 
265
 
 
266
    def _commit(self, operation, message, timestamp, timezone, committer,
 
267
            specific_files, rev_id, allow_pointless, strict, verbose,
 
268
            working_tree, local, reporter, message_callback, recursive,
 
269
            exclude, possible_master_transports):
241
270
        mutter('preparing to commit')
242
271
 
243
272
        if working_tree is None:
266
295
            self.exclude = []
267
296
        self.local = local
268
297
        self.master_branch = None
269
 
        self.master_locked = False
270
298
        self.recursive = recursive
271
299
        self.rev_id = None
 
300
        # self.specific_files is None to indicate no filter, or any iterable to
 
301
        # indicate a filter - [] means no files at all, as per iter_changes.
272
302
        if specific_files is not None:
273
303
            self.specific_files = sorted(
274
304
                minimum_path_selection(specific_files))
276
306
            self.specific_files = None
277
307
            
278
308
        self.allow_pointless = allow_pointless
279
 
        self.revprops = revprops
280
309
        self.message_callback = message_callback
281
310
        self.timestamp = timestamp
282
311
        self.timezone = timezone
285
314
        self.verbose = verbose
286
315
 
287
316
        self.work_tree.lock_write()
 
317
        operation.add_cleanup(self.work_tree.unlock)
288
318
        self.parents = self.work_tree.get_parent_ids()
289
319
        # We can use record_iter_changes IFF iter_changes is compatible with
290
320
        # the command line parameters, and the repository has fast delta
291
321
        # generation. See bug 347649.
292
322
        self.use_record_iter_changes = (
293
 
            not self.specific_files and
294
323
            not self.exclude and 
295
324
            not self.branch.repository._format.supports_tree_reference and
296
325
            (self.branch.repository._format.fast_deltas or
297
326
             len(self.parents) < 2))
298
327
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
328
        operation.add_cleanup(self.pb.finished)
299
329
        self.basis_revid = self.work_tree.last_revision()
300
330
        self.basis_tree = self.work_tree.basis_tree()
301
331
        self.basis_tree.lock_read()
 
332
        operation.add_cleanup(self.basis_tree.unlock)
 
333
        # Cannot commit with conflicts present.
 
334
        if len(self.work_tree.conflicts()) > 0:
 
335
            raise ConflictsInTree
 
336
 
 
337
        # Setup the bound branch variables as needed.
 
338
        self._check_bound_branch(operation, possible_master_transports)
 
339
 
 
340
        # Check that the working tree is up to date
 
341
        old_revno, new_revno = self._check_out_of_date_tree()
 
342
 
 
343
        # Complete configuration setup
 
344
        if reporter is not None:
 
345
            self.reporter = reporter
 
346
        elif self.reporter is None:
 
347
            self.reporter = self._select_reporter()
 
348
        if self.config is None:
 
349
            self.config = self.branch.get_config()
 
350
 
 
351
        self._set_specific_file_ids()
 
352
 
 
353
        # Setup the progress bar. As the number of files that need to be
 
354
        # committed in unknown, progress is reported as stages.
 
355
        # We keep track of entries separately though and include that
 
356
        # information in the progress bar during the relevant stages.
 
357
        self.pb_stage_name = ""
 
358
        self.pb_stage_count = 0
 
359
        self.pb_stage_total = 5
 
360
        if self.bound_branch:
 
361
            self.pb_stage_total += 1
 
362
        self.pb.show_pct = False
 
363
        self.pb.show_spinner = False
 
364
        self.pb.show_eta = False
 
365
        self.pb.show_count = True
 
366
        self.pb.show_bar = True
 
367
 
 
368
        self._gather_parents()
 
369
        # After a merge, a selected file commit is not supported.
 
370
        # See 'bzr help merge' for an explanation as to why.
 
371
        if len(self.parents) > 1 and self.specific_files is not None:
 
372
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
373
        # Excludes are a form of selected file commit.
 
374
        if len(self.parents) > 1 and self.exclude:
 
375
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
376
 
 
377
        # Collect the changes
 
378
        self._set_progress_stage("Collecting changes", counter=True)
 
379
        self.builder = self.branch.get_commit_builder(self.parents,
 
380
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
381
 
302
382
        try:
303
 
            # Cannot commit with conflicts present.
304
 
            if len(self.work_tree.conflicts()) > 0:
305
 
                raise ConflictsInTree
306
 
 
307
 
            # Setup the bound branch variables as needed.
308
 
            self._check_bound_branch(possible_master_transports)
309
 
 
310
 
            # Check that the working tree is up to date
311
 
            old_revno, new_revno = self._check_out_of_date_tree()
312
 
 
313
 
            # Complete configuration setup
314
 
            if reporter is not None:
315
 
                self.reporter = reporter
316
 
            elif self.reporter is None:
317
 
                self.reporter = self._select_reporter()
318
 
            if self.config is None:
319
 
                self.config = self.branch.get_config()
320
 
 
321
 
            self._set_specific_file_ids()
322
 
 
323
 
            # Setup the progress bar. As the number of files that need to be
324
 
            # committed in unknown, progress is reported as stages.
325
 
            # We keep track of entries separately though and include that
326
 
            # information in the progress bar during the relevant stages.
327
 
            self.pb_stage_name = ""
328
 
            self.pb_stage_count = 0
329
 
            self.pb_stage_total = 5
330
 
            if self.bound_branch:
331
 
                self.pb_stage_total += 1
332
 
            self.pb.show_pct = False
333
 
            self.pb.show_spinner = False
334
 
            self.pb.show_eta = False
335
 
            self.pb.show_count = True
336
 
            self.pb.show_bar = True
337
 
 
338
 
            self._gather_parents()
339
 
            # After a merge, a selected file commit is not supported.
340
 
            # See 'bzr help merge' for an explanation as to why.
341
 
            if len(self.parents) > 1 and self.specific_files:
342
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
343
 
            # Excludes are a form of selected file commit.
344
 
            if len(self.parents) > 1 and self.exclude:
345
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
346
 
 
347
 
            # Collect the changes
348
 
            self._set_progress_stage("Collecting changes", counter=True)
349
 
            self.builder = self.branch.get_commit_builder(self.parents,
350
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
351
 
 
352
 
            try:
353
 
                self.builder.will_record_deletes()
354
 
                # find the location being committed to
355
 
                if self.bound_branch:
356
 
                    master_location = self.master_branch.base
357
 
                else:
358
 
                    master_location = self.branch.base
359
 
 
360
 
                # report the start of the commit
361
 
                self.reporter.started(new_revno, self.rev_id, master_location)
362
 
 
363
 
                self._update_builder_with_changes()
364
 
                self._check_pointless()
365
 
 
366
 
                # TODO: Now the new inventory is known, check for conflicts.
367
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
368
 
                # weave lines, because nothing should be recorded until it is known
369
 
                # that commit will succeed.
370
 
                self._set_progress_stage("Saving data locally")
371
 
                self.builder.finish_inventory()
372
 
 
373
 
                # Prompt the user for a commit message if none provided
374
 
                message = message_callback(self)
375
 
                self.message = message
376
 
                self._escape_commit_message()
377
 
 
378
 
                # Add revision data to the local branch
379
 
                self.rev_id = self.builder.commit(self.message)
380
 
 
381
 
            except Exception, e:
382
 
                mutter("aborting commit write group because of exception:")
383
 
                trace.log_exception_quietly()
384
 
                note("aborting commit write group: %r" % (e,))
385
 
                self.builder.abort()
386
 
                raise
387
 
 
388
 
            self._process_pre_hooks(old_revno, new_revno)
389
 
 
390
 
            # Upload revision data to the master.
391
 
            # this will propagate merged revisions too if needed.
392
 
            if self.bound_branch:
393
 
                self._set_progress_stage("Uploading data to master branch")
394
 
                # 'commit' to the master first so a timeout here causes the
395
 
                # local branch to be out of date
396
 
                self.master_branch.import_last_revision_info(
397
 
                    self.branch.repository, new_revno, self.rev_id)
398
 
 
399
 
            # and now do the commit locally.
400
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
401
 
 
402
 
            # Make the working tree up to date with the branch
403
 
            self._set_progress_stage("Updating the working tree")
404
 
            self.work_tree.update_basis_by_delta(self.rev_id,
405
 
                 self.builder.get_basis_delta())
406
 
            self.reporter.completed(new_revno, self.rev_id)
407
 
            self._process_post_hooks(old_revno, new_revno)
408
 
        finally:
409
 
            self._cleanup()
 
383
            self.builder.will_record_deletes()
 
384
            # find the location being committed to
 
385
            if self.bound_branch:
 
386
                master_location = self.master_branch.base
 
387
            else:
 
388
                master_location = self.branch.base
 
389
 
 
390
            # report the start of the commit
 
391
            self.reporter.started(new_revno, self.rev_id, master_location)
 
392
 
 
393
            self._update_builder_with_changes()
 
394
            self._check_pointless()
 
395
 
 
396
            # TODO: Now the new inventory is known, check for conflicts.
 
397
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
398
            # weave lines, because nothing should be recorded until it is known
 
399
            # that commit will succeed.
 
400
            self._set_progress_stage("Saving data locally")
 
401
            self.builder.finish_inventory()
 
402
 
 
403
            # Prompt the user for a commit message if none provided
 
404
            message = message_callback(self)
 
405
            self.message = message
 
406
 
 
407
            # Add revision data to the local branch
 
408
            self.rev_id = self.builder.commit(self.message)
 
409
 
 
410
        except Exception, e:
 
411
            mutter("aborting commit write group because of exception:")
 
412
            trace.log_exception_quietly()
 
413
            note("aborting commit write group: %r" % (e,))
 
414
            self.builder.abort()
 
415
            raise
 
416
 
 
417
        self._process_pre_hooks(old_revno, new_revno)
 
418
 
 
419
        # Upload revision data to the master.
 
420
        # this will propagate merged revisions too if needed.
 
421
        if self.bound_branch:
 
422
            self._set_progress_stage("Uploading data to master branch")
 
423
            # 'commit' to the master first so a timeout here causes the
 
424
            # local branch to be out of date
 
425
            self.master_branch.import_last_revision_info(
 
426
                self.branch.repository, new_revno, self.rev_id)
 
427
 
 
428
        # and now do the commit locally.
 
429
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
430
 
 
431
        # Make the working tree be up to date with the branch. This
 
432
        # includes automatic changes scheduled to be made to the tree, such
 
433
        # as updating its basis and unversioning paths that were missing.
 
434
        self.work_tree.unversion(self.deleted_ids)
 
435
        self._set_progress_stage("Updating the working tree")
 
436
        self.work_tree.update_basis_by_delta(self.rev_id,
 
437
             self.builder.get_basis_delta())
 
438
        self.reporter.completed(new_revno, self.rev_id)
 
439
        self._process_post_hooks(old_revno, new_revno)
410
440
        return self.rev_id
411
441
 
412
442
    def _select_reporter(self):
434
464
            return
435
465
        raise PointlessCommit()
436
466
 
437
 
    def _check_bound_branch(self, possible_master_transports=None):
 
467
    def _check_bound_branch(self, operation, possible_master_transports=None):
438
468
        """Check to see if the local branch is bound.
439
469
 
440
470
        If it is bound, then most of the commit will actually be
475
505
        # so grab the lock
476
506
        self.bound_branch = self.branch
477
507
        self.master_branch.lock_write()
478
 
        self.master_locked = True
 
508
        operation.add_cleanup(self.master_branch.unlock)
479
509
 
480
510
    def _check_out_of_date_tree(self):
481
511
        """Check that the working tree is up to date.
566
596
                     old_revno, old_revid, new_revno, self.rev_id,
567
597
                     tree_delta, future_tree)
568
598
 
569
 
    def _cleanup(self):
570
 
        """Cleanup any open locks, progress bars etc."""
571
 
        cleanups = [self._cleanup_bound_branch,
572
 
                    self.basis_tree.unlock,
573
 
                    self.work_tree.unlock,
574
 
                    self.pb.finished]
575
 
        found_exception = None
576
 
        for cleanup in cleanups:
577
 
            try:
578
 
                cleanup()
579
 
            # we want every cleanup to run no matter what.
580
 
            # so we have a catchall here, but we will raise the
581
 
            # last encountered exception up the stack: and
582
 
            # typically this will be useful enough.
583
 
            except Exception, e:
584
 
                found_exception = e
585
 
        if found_exception is not None:
586
 
            # don't do a plan raise, because the last exception may have been
587
 
            # trashed, e is our sure-to-work exception even though it loses the
588
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
589
 
            # exc_info and if its the same one do a plain raise otherwise
590
 
            # 'raise e' as we do now.
591
 
            raise e
592
 
 
593
 
    def _cleanup_bound_branch(self):
594
 
        """Executed at the end of a try/finally to cleanup a bound branch.
595
 
 
596
 
        If the branch wasn't bound, this is a no-op.
597
 
        If it was, it resents self.branch to the local branch, instead
598
 
        of being the master.
599
 
        """
600
 
        if not self.bound_branch:
601
 
            return
602
 
        if self.master_locked:
603
 
            self.master_branch.unlock()
604
 
 
605
 
    def _escape_commit_message(self):
606
 
        """Replace xml-incompatible control characters."""
607
 
        # FIXME: RBC 20060419 this should be done by the revision
608
 
        # serialiser not by commit. Then we can also add an unescaper
609
 
        # in the deserializer and start roundtripping revision messages
610
 
        # precisely. See repository_implementations/test_repository.py
611
 
        self.message, escape_count = xml_serializer.escape_invalid_chars(
612
 
            self.message)
613
 
        if escape_count:
614
 
            self.reporter.escaped(escape_count, self.message)
615
 
 
616
599
    def _gather_parents(self):
617
600
        """Record the parents of a merge for merge detection."""
618
601
        # TODO: Make sure that this list doesn't contain duplicate
633
616
        """Update the commit builder with the data about what has changed.
634
617
        """
635
618
        exclude = self.exclude
636
 
        specific_files = self.specific_files or []
 
619
        specific_files = self.specific_files
637
620
        mutter("Selecting files for commit with filter %s", specific_files)
638
621
 
639
622
        self._check_strict()
640
623
        if self.use_record_iter_changes:
641
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
624
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
625
                specific_files=specific_files)
642
626
            iter_changes = self._filter_iter_changes(iter_changes)
643
627
            for file_id, path, fs_hash in self.builder.record_iter_changes(
644
628
                self.work_tree, self.basis_revid, iter_changes):
697
681
                            reporter.snapshot_change('modified', new_path)
698
682
            self._next_progress_entry()
699
683
        # Unversion IDs that were found to be deleted
700
 
        self.work_tree.unversion(deleted_ids)
 
684
        self.deleted_ids = deleted_ids
701
685
 
702
686
    def _record_unselected(self):
703
687
        # If specific files are selected, then all un-selected files must be
816
800
                # _update_builder_with_changes.
817
801
                continue
818
802
            content_summary = self.work_tree.path_content_summary(path)
 
803
            kind = content_summary[0]
819
804
            # Note that when a filter of specific files is given, we must only
820
805
            # skip/record deleted files matching that filter.
821
806
            if not specific_files or is_inside_any(specific_files, path):
822
 
                if content_summary[0] == 'missing':
 
807
                if kind == 'missing':
823
808
                    if not deleted_paths:
824
809
                        # path won't have been split yet.
825
810
                        path_segments = splitpath(path)
832
817
                    continue
833
818
            # TODO: have the builder do the nested commit just-in-time IF and
834
819
            # only if needed.
835
 
            if content_summary[0] == 'tree-reference':
 
820
            if kind == 'tree-reference':
836
821
                # enforce repository nested tree policy.
837
822
                if (not self.work_tree.supports_tree_reference() or
838
823
                    # repository does not support it either.
839
824
                    not self.branch.repository._format.supports_tree_reference):
840
 
                    content_summary = ('directory',) + content_summary[1:]
841
 
            kind = content_summary[0]
842
 
            # TODO: specific_files filtering before nested tree processing
843
 
            if kind == 'tree-reference':
844
 
                if self.recursive == 'down':
 
825
                    kind = 'directory'
 
826
                    content_summary = (kind, None, None, None)
 
827
                elif self.recursive == 'down':
845
828
                    nested_revision_id = self._commit_nested_tree(
846
829
                        file_id, path)
847
 
                    content_summary = content_summary[:3] + (
848
 
                        nested_revision_id,)
 
830
                    content_summary = (kind, None, None, nested_revision_id)
849
831
                else:
850
 
                    content_summary = content_summary[:3] + (
851
 
                        self.work_tree.get_reference_revision(file_id),)
 
832
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
833
                    content_summary = (kind, None, None, nested_revision_id)
852
834
 
853
835
            # Record an entry for this item
854
836
            # Note: I don't particularly want to have the existing_ie
860
842
                content_summary)
861
843
 
862
844
        # Unversion IDs that were found to be deleted
863
 
        self.work_tree.unversion(deleted_ids)
 
845
        self.deleted_ids = deleted_ids
864
846
 
865
847
    def _commit_nested_tree(self, file_id, path):
866
848
        "Commit a nested tree."