/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

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)
204
196
        """Commit working copy as a new revision.
205
197
 
206
198
        :param message: the commit message (it or message_callback is required)
 
199
        :param message_callback: A callback: message = message_callback(cmt_obj)
207
200
 
208
201
        :param timestamp: if not None, seconds-since-epoch for a
209
202
            postdated/predated commit.
210
203
 
211
 
        :param specific_files: If true, commit only those files.
 
204
        :param specific_files: If not None, commit only those files. An empty
 
205
            list means 'commit no files'.
212
206
 
213
207
        :param rev_id: If set, use this as the new revision id.
214
208
            Useful for test or import commands that need to tightly
232
226
            commit. Pending changes to excluded files will be ignored by the
233
227
            commit.
234
228
        """
 
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):
235
255
        mutter('preparing to commit')
236
256
 
237
257
        if working_tree is None:
260
280
            self.exclude = []
261
281
        self.local = local
262
282
        self.master_branch = None
263
 
        self.master_locked = False
264
283
        self.recursive = recursive
265
284
        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.
266
287
        if specific_files is not None:
267
288
            self.specific_files = sorted(
268
289
                minimum_path_selection(specific_files))
270
291
            self.specific_files = None
271
292
            
272
293
        self.allow_pointless = allow_pointless
273
 
        self.revprops = revprops
274
294
        self.message_callback = message_callback
275
295
        self.timestamp = timestamp
276
296
        self.timezone = timezone
279
299
        self.verbose = verbose
280
300
 
281
301
        self.work_tree.lock_write()
 
302
        operation.add_cleanup(self.work_tree.unlock)
282
303
        self.parents = self.work_tree.get_parent_ids()
283
304
        # We can use record_iter_changes IFF iter_changes is compatible with
284
305
        # the command line parameters, and the repository has fast delta
285
306
        # generation. See bug 347649.
286
307
        self.use_record_iter_changes = (
287
 
            not self.specific_files and
288
308
            not self.exclude and 
289
309
            not self.branch.repository._format.supports_tree_reference and
290
310
            (self.branch.repository._format.fast_deltas or
291
311
             len(self.parents) < 2))
292
312
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
313
        operation.add_cleanup(self.pb.finished)
293
314
        self.basis_revid = self.work_tree.last_revision()
294
315
        self.basis_tree = self.work_tree.basis_tree()
295
316
        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
 
296
367
        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()
 
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)
403
425
        return self.rev_id
404
426
 
405
427
    def _select_reporter(self):
427
449
            return
428
450
        raise PointlessCommit()
429
451
 
430
 
    def _check_bound_branch(self, possible_master_transports=None):
 
452
    def _check_bound_branch(self, operation, possible_master_transports=None):
431
453
        """Check to see if the local branch is bound.
432
454
 
433
455
        If it is bound, then most of the commit will actually be
468
490
        # so grab the lock
469
491
        self.bound_branch = self.branch
470
492
        self.master_branch.lock_write()
471
 
        self.master_locked = True
 
493
        operation.add_cleanup(self.master_branch.unlock)
472
494
 
473
495
    def _check_out_of_date_tree(self):
474
496
        """Check that the working tree is up to date.
559
581
                     old_revno, old_revid, new_revno, self.rev_id,
560
582
                     tree_delta, future_tree)
561
583
 
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
584
    def _gather_parents(self):
599
585
        """Record the parents of a merge for merge detection."""
600
586
        # TODO: Make sure that this list doesn't contain duplicate
615
601
        """Update the commit builder with the data about what has changed.
616
602
        """
617
603
        exclude = self.exclude
618
 
        specific_files = self.specific_files or []
 
604
        specific_files = self.specific_files
619
605
        mutter("Selecting files for commit with filter %s", specific_files)
620
606
 
621
607
        self._check_strict()
622
608
        if self.use_record_iter_changes:
623
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
609
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
610
                specific_files=specific_files)
624
611
            iter_changes = self._filter_iter_changes(iter_changes)
625
612
            for file_id, path, fs_hash in self.builder.record_iter_changes(
626
613
                self.work_tree, self.basis_revid, iter_changes):
679
666
                            reporter.snapshot_change('modified', new_path)
680
667
            self._next_progress_entry()
681
668
        # Unversion IDs that were found to be deleted
682
 
        self.work_tree.unversion(deleted_ids)
 
669
        self.deleted_ids = deleted_ids
683
670
 
684
671
    def _record_unselected(self):
685
672
        # If specific files are selected, then all un-selected files must be
798
785
                # _update_builder_with_changes.
799
786
                continue
800
787
            content_summary = self.work_tree.path_content_summary(path)
 
788
            kind = content_summary[0]
801
789
            # Note that when a filter of specific files is given, we must only
802
790
            # skip/record deleted files matching that filter.
803
791
            if not specific_files or is_inside_any(specific_files, path):
804
 
                if content_summary[0] == 'missing':
 
792
                if kind == 'missing':
805
793
                    if not deleted_paths:
806
794
                        # path won't have been split yet.
807
795
                        path_segments = splitpath(path)
814
802
                    continue
815
803
            # TODO: have the builder do the nested commit just-in-time IF and
816
804
            # only if needed.
817
 
            if content_summary[0] == 'tree-reference':
 
805
            if kind == 'tree-reference':
818
806
                # enforce repository nested tree policy.
819
807
                if (not self.work_tree.supports_tree_reference() or
820
808
                    # repository does not support it either.
821
809
                    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':
 
810
                    kind = 'directory'
 
811
                    content_summary = (kind, None, None, None)
 
812
                elif self.recursive == 'down':
827
813
                    nested_revision_id = self._commit_nested_tree(
828
814
                        file_id, path)
829
 
                    content_summary = content_summary[:3] + (
830
 
                        nested_revision_id,)
 
815
                    content_summary = (kind, None, None, nested_revision_id)
831
816
                else:
832
 
                    content_summary = content_summary[:3] + (
833
 
                        self.work_tree.get_reference_revision(file_id),)
 
817
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
818
                    content_summary = (kind, None, None, nested_revision_id)
834
819
 
835
820
            # Record an entry for this item
836
821
            # Note: I don't particularly want to have the existing_ie
842
827
                content_summary)
843
828
 
844
829
        # Unversion IDs that were found to be deleted
845
 
        self.work_tree.unversion(deleted_ids)
 
830
        self.deleted_ids = deleted_ids
846
831
 
847
832
    def _commit_nested_tree(self, file_id, path):
848
833
        "Commit a nested tree."