← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

Merge up through 2.2.0.

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,
234
263
            commit. Pending changes to excluded files will be ignored by the
235
264
            commit.
236
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):
237
292
        mutter('preparing to commit')
238
293
 
239
294
        if working_tree is None:
262
317
            self.exclude = []
263
318
        self.local = local
264
319
        self.master_branch = None
265
 
        self.master_locked = False
266
320
        self.recursive = recursive
267
321
        self.rev_id = None
268
322
        # self.specific_files is None to indicate no filter, or any iterable to
274
328
            self.specific_files = None
275
329
            
276
330
        self.allow_pointless = allow_pointless
277
 
        self.revprops = revprops
278
331
        self.message_callback = message_callback
279
332
        self.timestamp = timestamp
280
333
        self.timezone = timezone
283
336
        self.verbose = verbose
284
337
 
285
338
        self.work_tree.lock_write()
 
339
        operation.add_cleanup(self.work_tree.unlock)
286
340
        self.parents = self.work_tree.get_parent_ids()
287
341
        # We can use record_iter_changes IFF iter_changes is compatible with
288
342
        # the command line parameters, and the repository has fast delta
293
347
            (self.branch.repository._format.fast_deltas or
294
348
             len(self.parents) < 2))
295
349
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
350
        operation.add_cleanup(self.pb.finished)
296
351
        self.basis_revid = self.work_tree.last_revision()
297
352
        self.basis_tree = self.work_tree.basis_tree()
298
353
        self.basis_tree.lock_read()
 
354
        operation.add_cleanup(self.basis_tree.unlock)
 
355
        # Cannot commit with conflicts present.
 
356
        if len(self.work_tree.conflicts()) > 0:
 
357
            raise ConflictsInTree
 
358
 
 
359
        # Setup the bound branch variables as needed.
 
360
        self._check_bound_branch(operation, possible_master_transports)
 
361
 
 
362
        # Check that the working tree is up to date
 
363
        old_revno, new_revno = self._check_out_of_date_tree()
 
364
 
 
365
        # Complete configuration setup
 
366
        if reporter is not None:
 
367
            self.reporter = reporter
 
368
        elif self.reporter is None:
 
369
            self.reporter = self._select_reporter()
 
370
        if self.config is None:
 
371
            self.config = self.branch.get_config()
 
372
 
 
373
        self._set_specific_file_ids()
 
374
 
 
375
        # Setup the progress bar. As the number of files that need to be
 
376
        # committed in unknown, progress is reported as stages.
 
377
        # We keep track of entries separately though and include that
 
378
        # information in the progress bar during the relevant stages.
 
379
        self.pb_stage_name = ""
 
380
        self.pb_stage_count = 0
 
381
        self.pb_stage_total = 5
 
382
        if self.bound_branch:
 
383
            self.pb_stage_total += 1
 
384
        self.pb.show_pct = False
 
385
        self.pb.show_spinner = False
 
386
        self.pb.show_eta = False
 
387
        self.pb.show_count = True
 
388
        self.pb.show_bar = True
 
389
 
 
390
        self._gather_parents()
 
391
        # After a merge, a selected file commit is not supported.
 
392
        # See 'bzr help merge' for an explanation as to why.
 
393
        if len(self.parents) > 1 and self.specific_files is not None:
 
394
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
395
        # Excludes are a form of selected file commit.
 
396
        if len(self.parents) > 1 and self.exclude:
 
397
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
398
 
 
399
        # Collect the changes
 
400
        self._set_progress_stage("Collecting changes", counter=True)
 
401
        self.builder = self.branch.get_commit_builder(self.parents,
 
402
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
403
 
299
404
        try:
300
 
            # Cannot commit with conflicts present.
301
 
            if len(self.work_tree.conflicts()) > 0:
302
 
                raise ConflictsInTree
303
 
 
304
 
            # Setup the bound branch variables as needed.
305
 
            self._check_bound_branch(possible_master_transports)
306
 
 
307
 
            # Check that the working tree is up to date
308
 
            old_revno, new_revno = self._check_out_of_date_tree()
309
 
 
310
 
            # Complete configuration setup
311
 
            if reporter is not None:
312
 
                self.reporter = reporter
313
 
            elif self.reporter is None:
314
 
                self.reporter = self._select_reporter()
315
 
            if self.config is None:
316
 
                self.config = self.branch.get_config()
317
 
 
318
 
            self._set_specific_file_ids()
319
 
 
320
 
            # Setup the progress bar. As the number of files that need to be
321
 
            # committed in unknown, progress is reported as stages.
322
 
            # We keep track of entries separately though and include that
323
 
            # information in the progress bar during the relevant stages.
324
 
            self.pb_stage_name = ""
325
 
            self.pb_stage_count = 0
326
 
            self.pb_stage_total = 5
327
 
            if self.bound_branch:
328
 
                self.pb_stage_total += 1
329
 
            self.pb.show_pct = False
330
 
            self.pb.show_spinner = False
331
 
            self.pb.show_eta = False
332
 
            self.pb.show_count = True
333
 
            self.pb.show_bar = True
334
 
 
335
 
            self._gather_parents()
336
 
            # After a merge, a selected file commit is not supported.
337
 
            # See 'bzr help merge' for an explanation as to why.
338
 
            if len(self.parents) > 1 and self.specific_files is not None:
339
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
340
 
            # Excludes are a form of selected file commit.
341
 
            if len(self.parents) > 1 and self.exclude:
342
 
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
343
 
 
344
 
            # Collect the changes
345
 
            self._set_progress_stage("Collecting changes", counter=True)
346
 
            self.builder = self.branch.get_commit_builder(self.parents,
347
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
348
 
 
349
 
            try:
350
 
                self.builder.will_record_deletes()
351
 
                # find the location being committed to
352
 
                if self.bound_branch:
353
 
                    master_location = self.master_branch.base
354
 
                else:
355
 
                    master_location = self.branch.base
356
 
 
357
 
                # report the start of the commit
358
 
                self.reporter.started(new_revno, self.rev_id, master_location)
359
 
 
360
 
                self._update_builder_with_changes()
361
 
                self._check_pointless()
362
 
 
363
 
                # TODO: Now the new inventory is known, check for conflicts.
364
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
365
 
                # weave lines, because nothing should be recorded until it is known
366
 
                # that commit will succeed.
367
 
                self._set_progress_stage("Saving data locally")
368
 
                self.builder.finish_inventory()
369
 
 
370
 
                # Prompt the user for a commit message if none provided
371
 
                message = message_callback(self)
372
 
                self.message = message
373
 
 
374
 
                # Add revision data to the local branch
375
 
                self.rev_id = self.builder.commit(self.message)
376
 
 
377
 
            except Exception, e:
378
 
                mutter("aborting commit write group because of exception:")
379
 
                trace.log_exception_quietly()
380
 
                note("aborting commit write group: %r" % (e,))
381
 
                self.builder.abort()
382
 
                raise
383
 
 
384
 
            self._process_pre_hooks(old_revno, new_revno)
385
 
 
386
 
            # Upload revision data to the master.
387
 
            # this will propagate merged revisions too if needed.
388
 
            if self.bound_branch:
389
 
                self._set_progress_stage("Uploading data to master branch")
390
 
                # 'commit' to the master first so a timeout here causes the
391
 
                # local branch to be out of date
392
 
                self.master_branch.import_last_revision_info(
393
 
                    self.branch.repository, new_revno, self.rev_id)
394
 
 
395
 
            # and now do the commit locally.
396
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
397
 
 
398
 
            # Make the working tree be up to date with the branch. This
399
 
            # includes automatic changes scheduled to be made to the tree, such
400
 
            # as updating its basis and unversioning paths that were missing.
401
 
            self.work_tree.unversion(self.deleted_ids)
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()
 
405
            self.builder.will_record_deletes()
 
406
            # find the location being committed to
 
407
            if self.bound_branch:
 
408
                master_location = self.master_branch.base
 
409
            else:
 
410
                master_location = self.branch.base
 
411
 
 
412
            # report the start of the commit
 
413
            self.reporter.started(new_revno, self.rev_id, master_location)
 
414
 
 
415
            self._update_builder_with_changes()
 
416
            self._check_pointless()
 
417
 
 
418
            # TODO: Now the new inventory is known, check for conflicts.
 
419
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
420
            # weave lines, because nothing should be recorded until it is known
 
421
            # that commit will succeed.
 
422
            self._set_progress_stage("Saving data locally")
 
423
            self.builder.finish_inventory()
 
424
 
 
425
            # Prompt the user for a commit message if none provided
 
426
            message = message_callback(self)
 
427
            self.message = message
 
428
 
 
429
            # Add revision data to the local branch
 
430
            self.rev_id = self.builder.commit(self.message)
 
431
 
 
432
        except Exception, e:
 
433
            mutter("aborting commit write group because of exception:")
 
434
            trace.log_exception_quietly()
 
435
            note("aborting commit write group: %r" % (e,))
 
436
            self.builder.abort()
 
437
            raise
 
438
 
 
439
        self._process_pre_hooks(old_revno, new_revno)
 
440
 
 
441
        # Upload revision data to the master.
 
442
        # this will propagate merged revisions too if needed.
 
443
        if self.bound_branch:
 
444
            self._set_progress_stage("Uploading data to master branch")
 
445
            # 'commit' to the master first so a timeout here causes the
 
446
            # local branch to be out of date
 
447
            self.master_branch.import_last_revision_info(
 
448
                self.branch.repository, new_revno, self.rev_id)
 
449
 
 
450
        # and now do the commit locally.
 
451
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
452
 
 
453
        # Make the working tree be up to date with the branch. This
 
454
        # includes automatic changes scheduled to be made to the tree, such
 
455
        # as updating its basis and unversioning paths that were missing.
 
456
        self.work_tree.unversion(self.deleted_ids)
 
457
        self._set_progress_stage("Updating the working tree")
 
458
        self.work_tree.update_basis_by_delta(self.rev_id,
 
459
             self.builder.get_basis_delta())
 
460
        self.reporter.completed(new_revno, self.rev_id)
 
461
        self._process_post_hooks(old_revno, new_revno)
409
462
        return self.rev_id
410
463
 
411
464
    def _select_reporter(self):
433
486
            return
434
487
        raise PointlessCommit()
435
488
 
436
 
    def _check_bound_branch(self, possible_master_transports=None):
 
489
    def _check_bound_branch(self, operation, possible_master_transports=None):
437
490
        """Check to see if the local branch is bound.
438
491
 
439
492
        If it is bound, then most of the commit will actually be
474
527
        # so grab the lock
475
528
        self.bound_branch = self.branch
476
529
        self.master_branch.lock_write()
477
 
        self.master_locked = True
 
530
        operation.add_cleanup(self.master_branch.unlock)
478
531
 
479
532
    def _check_out_of_date_tree(self):
480
533
        """Check that the working tree is up to date.
565
618
                     old_revno, old_revid, new_revno, self.rev_id,
566
619
                     tree_delta, future_tree)
567
620
 
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
621
    def _gather_parents(self):
605
622
        """Record the parents of a merge for merge detection."""
606
623
        # TODO: Make sure that this list doesn't contain duplicate