47
56
# merges from, then it should still be reported as newly added
48
57
# relative to the basis revision.
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
# the rest of the code; add a deprecation of the old name.
59
from .branch import Branch
60
from .cleanup import OperationWithCleanups
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
68
minimum_path_selection,
70
from .trace import mutter, note, is_quiet
71
from .urlutils import unescape_for_display
72
from .i18n import gettext
75
class PointlessCommit(BzrError):
77
_fmt = "No changes to commit"
80
class CannotCommitSelectedFileMerge(BzrError):
82
_fmt = 'Selected-file commit of merges is not supported yet:'\
83
' files %(files_str)s'
85
def __init__(self, files):
86
files_str = ', '.join(files)
87
BzrError.__init__(self, files=files, files_str=files_str)
90
def filter_excluded(iter_changes, exclude):
91
"""Filter exclude filenames.
93
:param iter_changes: iter_changes function
94
:param exclude: List of paths to exclude
95
:return: iter_changes function
59
# TODO: Do checks that the tree can be committed *before* running the
60
# editor; this should include checks for a pointless commit and for
61
# unknown or missing files.
63
# TODO: If commit fails, leave the message in a file somewhere.
72
from binascii import hexlify
73
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
78
kind_marker, is_inside_any, quotefn,
79
sha_string, sha_strings, sha_file, isdir, isfile,
82
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
from bzrlib.trace import mutter, note, warning
91
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
95
from bzrlib.workingtree import WorkingTree
98
def commit(*args, **kwargs):
99
"""Commit a new revision to a branch.
101
Function-style interface for convenience of old callers.
103
New code should use the Commit class instead.
97
for change in iter_changes:
98
old_path = change[1][0]
99
new_path = change[1][1]
101
new_excluded = (new_path is not None and
102
is_inside_any(exclude, new_path))
104
old_excluded = (old_path is not None and
105
is_inside_any(exclude, old_path))
107
if old_excluded and new_excluded:
110
if old_excluded or new_excluded:
111
# TODO(jelmer): Perhaps raise an error here instead?
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
117
109
class NullCommitReporter(object):
118
110
"""I report on progress of a commit."""
120
def started(self, revno, revid, location):
123
112
def snapshot_change(self, change, path):
126
115
def completed(self, revno, rev_id):
129
def deleted(self, path):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
132
124
def missing(self, path):
135
def renamed(self, change, old_path, new_path):
138
def is_verbose(self):
142
128
class ReportCommitToLog(NullCommitReporter):
144
def _note(self, format, *args):
147
Subclasses may choose to override this method.
151
130
def snapshot_change(self, change, path):
152
if path == '' and change in (gettext('added'), gettext('modified')):
154
self._note("%s %s", change, path)
156
def started(self, revno, rev_id, location):
158
gettext('Committing to: %s'),
159
unescape_for_display(location, 'utf-8'))
131
note("%s %s", change, path)
161
133
def completed(self, revno, rev_id):
162
self._note(gettext('Committed revision %d.'), revno)
163
# self._note goes to the console too; so while we want to log the
164
# rev_id, we can't trivially only log it. (See bug 526425). Long
165
# term we should rearrange the reporting structure, but for now
166
# we just mutter seperately. We mutter the revid and revno together
167
# so that concurrent bzr invocations won't lead to confusion.
168
mutter('Committed revid %s as revno %d.', rev_id, revno)
134
note('committed r%d {%s}', revno, rev_id)
136
def deleted(self, file_id):
137
note('deleted %s', file_id)
170
def deleted(self, path):
171
self._note(gettext('deleted %s'), path)
139
def escaped(self, escape_count, message):
140
note("replaced %d control characters in message", escape_count)
173
142
def missing(self, path):
174
self._note(gettext('missing %s'), path)
176
def renamed(self, change, old_path, new_path):
177
self._note('%s %s => %s', change, old_path, new_path)
179
def is_verbose(self):
143
note('missing %s', path)
183
146
class Commit(object):
237
177
allow_pointless=True,
245
message_callback=None,
248
possible_master_transports=None,
250
181
"""Commit working copy as a new revision.
252
:param message: the commit message (it or message_callback is required)
253
:param message_callback: A callback: message =
254
message_callback(cmt_obj)
256
:param timestamp: if not None, seconds-since-epoch for a
257
postdated/predated commit.
259
:param specific_files: If not None, commit only those files. An empty
260
list means 'commit no files'.
262
:param rev_id: If set, use this as the new revision id.
183
timestamp -- if not None, seconds-since-epoch for a
184
postdated/predated commit.
186
specific_files -- If true, commit only those files.
188
rev_id -- If set, use this as the new revision id.
263
189
Useful for test or import commands that need to tightly
264
190
control what revisions are assigned. If you duplicate
265
191
a revision id that exists elsewhere it is your own fault.
266
192
If null (default), a time/random revision id is generated.
268
:param allow_pointless: If true (default), commit even if nothing
194
allow_pointless -- If true (default), commit even if nothing
269
195
has changed and no merges are recorded.
271
:param strict: If true, don't allow a commit if the working tree
197
strict -- If true, don't allow a commit if the working tree
272
198
contains unknown files.
274
:param revprops: Properties for new revision
275
:param local: Perform a local only commit.
276
:param reporter: the reporter to use or None for the default
277
:param verbose: if True and the reporter is not None, report everything
278
:param recursive: If set to 'down', commit in any subtrees that have
279
pending changes of any sort during this commit.
280
:param exclude: None or a list of relative paths to exclude from the
281
commit. Pending changes to excluded files will be ignored by the
283
:param lossy: When committing to a foreign VCS, ignore any
284
data that can not be natively represented.
200
revprops -- Properties for new revision
286
operation = OperationWithCleanups(self._commit)
287
self.revprops = revprops or {}
288
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
self.config_stack = config or self.config_stack
290
return operation.run(
295
specific_files=specific_files,
297
allow_pointless=allow_pointless,
300
working_tree=working_tree,
303
message_callback=message_callback,
306
possible_master_transports=possible_master_transports,
309
def _commit(self, operation, message, timestamp, timezone, committer,
310
specific_files, rev_id, allow_pointless, strict, verbose,
311
working_tree, local, reporter, message_callback, recursive,
312
exclude, possible_master_transports, lossy):
313
202
mutter('preparing to commit')
315
if working_tree is None:
316
raise BzrError("working_tree must be passed into commit().")
318
self.work_tree = working_tree
319
self.branch = self.work_tree.branch
320
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
321
if not self.branch.repository.supports_rich_root():
322
raise errors.RootNotRich()
323
if message_callback is None:
324
if message is not None:
325
if isinstance(message, bytes):
326
message = message.decode(get_user_encoding())
328
def message_callback(x):
331
raise BzrError("The message or message_callback keyword"
332
" parameter is required for commit().")
334
self.bound_branch = None
335
self.any_entries_deleted = False
336
if exclude is not None:
337
self.exclude = sorted(
338
minimum_path_selection(exclude))
342
self.master_branch = None
343
self.recursive = recursive
345
# self.specific_files is None to indicate no filter, or any iterable to
346
# indicate a filter - [] means no files at all, as per iter_changes.
347
if specific_files is not None:
348
self.specific_files = sorted(
349
minimum_path_selection(specific_files))
351
self.specific_files = None
205
self.weave_store = branch.weave_store
207
self.specific_files = specific_files
353
208
self.allow_pointless = allow_pointless
354
self.message_callback = message_callback
355
self.timestamp = timestamp
356
self.timezone = timezone
357
self.committer = committer
359
self.verbose = verbose
361
self.work_tree.lock_write()
362
operation.add_cleanup(self.work_tree.unlock)
363
self.parents = self.work_tree.get_parent_ids()
364
self.pb = ui.ui_factory.nested_progress_bar()
365
operation.add_cleanup(self.pb.finished)
366
self.basis_revid = self.work_tree.last_revision()
367
self.basis_tree = self.work_tree.basis_tree()
368
self.basis_tree.lock_read()
369
operation.add_cleanup(self.basis_tree.unlock)
370
# Cannot commit with conflicts present.
371
if len(self.work_tree.conflicts()) > 0:
372
raise ConflictsInTree
374
# Setup the bound branch variables as needed.
375
self._check_bound_branch(operation, possible_master_transports)
377
# Check that the working tree is up to date
378
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
380
# Complete configuration setup
381
if reporter is not None:
382
self.reporter = reporter
383
elif self.reporter is None:
384
self.reporter = self._select_reporter()
385
if self.config_stack is None:
386
self.config_stack = self.work_tree.get_config_stack()
388
# Setup the progress bar. As the number of files that need to be
389
# committed in unknown, progress is reported as stages.
390
# We keep track of entries separately though and include that
391
# information in the progress bar during the relevant stages.
392
self.pb_stage_name = ""
393
self.pb_stage_count = 0
394
self.pb_stage_total = 5
395
if self.bound_branch:
396
# 2 extra stages: "Uploading data to master branch" and "Merging
397
# tags to master branch"
398
self.pb_stage_total += 2
399
self.pb.show_pct = False
400
self.pb.show_spinner = False
401
self.pb.show_eta = False
402
self.pb.show_count = True
403
self.pb.show_bar = True
405
# After a merge, a selected file commit is not supported.
406
# See 'bzr help merge' for an explanation as to why.
407
if len(self.parents) > 1 and self.specific_files is not None:
408
raise CannotCommitSelectedFileMerge(self.specific_files)
409
# Excludes are a form of selected file commit.
410
if len(self.parents) > 1 and self.exclude:
411
raise CannotCommitSelectedFileMerge(self.exclude)
413
# Collect the changes
414
self._set_progress_stage("Collecting changes", counter=True)
416
self.builder = self.branch.get_commit_builder(
417
self.parents, self.config_stack, timestamp, timezone, committer,
418
self.revprops, rev_id, lossy=lossy)
420
if self.builder.updates_branch and self.bound_branch:
422
raise AssertionError(
423
"bound branches not supported for commit builders "
424
"that update the branch")
427
# find the location being committed to
428
if self.bound_branch:
429
master_location = self.master_branch.base
431
master_location = self.branch.base
433
# report the start of the commit
434
self.reporter.started(new_revno, self.rev_id, master_location)
436
self._update_builder_with_changes()
437
self._check_pointless()
439
# TODO: Now the new inventory is known, check for conflicts.
440
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
441
# weave lines, because nothing should be recorded until it is known
442
# that commit will succeed.
443
self._set_progress_stage("Saving data locally")
444
self.builder.finish_inventory()
446
# Prompt the user for a commit message if none provided
447
message = message_callback(self)
448
self.message = message
450
# Add revision data to the local branch
451
self.rev_id = self.builder.commit(self.message)
454
mutter("aborting commit write group because of exception:")
455
trace.log_exception_quietly()
459
self._update_branches(old_revno, old_revid, new_revno)
461
# Make the working tree be up to date with the branch. This
462
# includes automatic changes scheduled to be made to the tree, such
463
# as updating its basis and unversioning paths that were missing.
464
self.work_tree.unversion(self.deleted_paths)
465
self._set_progress_stage("Updating the working tree")
466
self.work_tree.update_basis_by_delta(self.rev_id,
467
self.builder.get_basis_delta())
468
self.reporter.completed(new_revno, self.rev_id)
469
self._process_post_hooks(old_revno, new_revno)
472
def _update_branches(self, old_revno, old_revid, new_revno):
473
"""Update the master and local branch to the new revision.
475
This will try to make sure that the master branch is updated
476
before the local branch.
478
:param old_revno: Revision number of master branch before the
480
:param old_revid: Tip of master branch before the commit
481
:param new_revno: Revision number of the new commit
483
if not self.builder.updates_branch:
484
self._process_pre_hooks(old_revno, new_revno)
486
# Upload revision data to the master.
487
# this will propagate merged revisions too if needed.
488
if self.bound_branch:
489
self._set_progress_stage("Uploading data to master branch")
490
# 'commit' to the master first so a timeout here causes the
491
# local branch to be out of date
492
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
493
self.branch, new_revno, self.rev_id, lossy=self._lossy)
495
self.branch.fetch(self.master_branch, self.rev_id)
497
# and now do the commit locally.
498
self.branch.set_last_revision_info(new_revno, self.rev_id)
501
self._process_pre_hooks(old_revno, new_revno)
502
except BaseException:
503
# The commit builder will already have updated the branch,
505
self.branch.set_last_revision_info(old_revno, old_revid)
508
# Merge local tags to remote
509
if self.bound_branch:
510
self._set_progress_stage("Merging tags to master branch")
511
tag_updates, tag_conflicts = self.branch.tags.merge_to(
512
self.master_branch.tags)
514
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
515
note(gettext("Conflicting tags in bound branch:\n{0}".format(
516
"\n".join(warning_lines))))
518
def _select_reporter(self):
519
"""Select the CommitReporter to use."""
521
return NullCommitReporter()
522
return ReportCommitToLog()
524
def _check_pointless(self):
525
if self.allow_pointless:
527
# A merge with no effect on files
528
if len(self.parents) > 1:
530
if self.builder.any_changes():
532
raise PointlessCommit()
534
def _check_bound_branch(self, operation, possible_master_transports=None):
535
"""Check to see if the local branch is bound.
537
If it is bound, then most of the commit will actually be
538
done using the remote branch as the target branch.
539
Only at the end will the local branch be updated.
541
if self.local and not self.branch.get_bound_location():
542
raise errors.LocalRequiresBoundBranch()
545
self.master_branch = self.branch.get_master_branch(
546
possible_master_transports)
548
if not self.master_branch:
549
# make this branch the reference branch for out of date checks.
550
self.master_branch = self.branch
553
# If the master branch is bound, we must fail
554
master_bound_location = self.master_branch.get_bound_location()
555
if master_bound_location:
556
raise errors.CommitToDoubleBoundBranch(
557
self.branch, self.master_branch, master_bound_location)
559
# TODO: jam 20051230 We could automatically push local
560
# commits to the remote branch if they would fit.
561
# But for now, just require remote to be identical
564
# Make sure the local branch is identical to the master
565
master_info = self.master_branch.last_revision_info()
566
local_info = self.branch.last_revision_info()
567
if local_info != master_info:
568
raise errors.BoundBranchOutOfDate(self.branch,
571
# Now things are ready to change the master branch
573
self.bound_branch = self.branch
574
self.master_branch.lock_write()
575
operation.add_cleanup(self.master_branch.unlock)
577
def _check_out_of_date_tree(self):
578
"""Check that the working tree is up to date.
580
:return: old_revision_number, old_revision_id, new_revision_number
584
first_tree_parent = self.work_tree.get_parent_ids()[0]
586
# if there are no parents, treat our parent as 'None'
587
# this is so that we still consider the master branch
588
# - in a checkout scenario the tree may have no
589
# parents but the branch may do.
590
first_tree_parent = breezy.revision.NULL_REVISION
591
old_revno, master_last = self.master_branch.last_revision_info()
592
if master_last != first_tree_parent:
593
if master_last != breezy.revision.NULL_REVISION:
594
raise errors.OutOfDateTree(self.work_tree)
595
if self.branch.repository.has_revision(first_tree_parent):
596
new_revno = old_revno + 1
598
# ghost parents never appear in revision history.
600
return old_revno, master_last, new_revno
602
def _process_pre_hooks(self, old_revno, new_revno):
603
"""Process any registered pre commit hooks."""
604
self._set_progress_stage("Running pre_commit hooks")
605
self._process_hooks("pre_commit", old_revno, new_revno)
607
def _process_post_hooks(self, old_revno, new_revno):
608
"""Process any registered post commit hooks."""
609
# Process the post commit hooks, if any
610
self._set_progress_stage("Running post_commit hooks")
611
# old style commit hooks - should be deprecated ? (obsoleted in
612
# 0.15^H^H^H^H 2.5.0)
613
post_commit = self.config_stack.get('post_commit')
614
if post_commit is not None:
615
hooks = post_commit.split(' ')
616
# this would be nicer with twisted.python.reflect.namedAny
618
result = eval(hook + '(branch, rev_id)',
619
{'branch': self.branch,
621
'rev_id': self.rev_id})
622
# process new style post commit hooks
623
self._process_hooks("post_commit", old_revno, new_revno)
625
def _process_hooks(self, hook_name, old_revno, new_revno):
626
if not Branch.hooks[hook_name]:
629
# new style commit hooks:
630
if not self.bound_branch:
631
hook_master = self.branch
634
hook_master = self.master_branch
635
hook_local = self.branch
636
# With bound branches, when the master is behind the local branch,
637
# the 'old_revno' and old_revid values here are incorrect.
638
# XXX: FIXME ^. RBC 20060206
640
old_revid = self.parents[0]
642
old_revid = breezy.revision.NULL_REVISION
644
if hook_name == "pre_commit":
645
future_tree = self.builder.revision_tree()
646
tree_delta = future_tree.changes_from(self.basis_tree,
649
for hook in Branch.hooks[hook_name]:
650
# show the running hook in the progress bar. As hooks may
651
# end up doing nothing (e.g. because they are not configured by
652
# the user) this is still showing progress, not showing overall
653
# actions - its up to each plugin to show a UI if it want's to
654
# (such as 'Emailing diff to foo@example.com').
655
self.pb_stage_name = "Running %s hooks [%s]" % \
656
(hook_name, Branch.hooks.get_hook_name(hook))
657
self._emit_progress()
658
if 'hooks' in debug.debug_flags:
659
mutter("Invoking commit hook: %r", hook)
660
if hook_name == "post_commit":
661
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
663
elif hook_name == "pre_commit":
664
hook(hook_local, hook_master,
665
old_revno, old_revid, new_revno, self.rev_id,
666
tree_delta, future_tree)
668
def _update_builder_with_changes(self):
669
"""Update the commit builder with the data about what has changed.
671
specific_files = self.specific_files
672
mutter("Selecting files for commit with filter %r", specific_files)
675
iter_changes = self.work_tree.iter_changes(
676
self.basis_tree, specific_files=specific_files)
678
iter_changes = filter_excluded(iter_changes, self.exclude)
679
iter_changes = self._filter_iter_changes(iter_changes)
680
for file_id, path, fs_hash in self.builder.record_iter_changes(
681
self.work_tree, self.basis_revid, iter_changes):
682
self.work_tree._observed_sha1(path, fs_hash)
684
def _filter_iter_changes(self, iter_changes):
685
"""Process iter_changes.
687
This method reports on the changes in iter_changes to the user, and
688
converts 'missing' entries in the iter_changes iterator to 'deleted'
689
entries. 'missing' entries have their
691
:param iter_changes: An iter_changes to process.
692
:return: A generator of changes.
694
reporter = self.reporter
695
report_changes = reporter.is_verbose()
697
for change in iter_changes:
699
old_path = change[1][0]
700
new_path = change[1][1]
701
versioned = change[3][1]
703
versioned = change[3][1]
704
if kind is None and versioned:
707
reporter.missing(new_path)
708
deleted_paths.append(change[1][1])
709
# Reset the new path (None) and new versioned flag (False)
710
change = (change[0], (change[1][0], None), change[2],
711
(change[3][0], False)) + change[4:]
712
new_path = change[1][1]
714
elif kind == 'tree-reference':
715
if self.recursive == 'down':
716
self._commit_nested_tree(change[1][1])
717
if change[3][0] or change[3][1]:
721
reporter.deleted(old_path)
722
elif old_path is None:
723
reporter.snapshot_change(gettext('added'), new_path)
724
elif old_path != new_path:
725
reporter.renamed(gettext('renamed'),
729
or self.work_tree.branch.repository._format.rich_root_data):
730
# Don't report on changes to '' in non rich root
732
reporter.snapshot_change(
733
gettext('modified'), new_path)
734
self._next_progress_entry()
735
# Unversion files that were found to be deleted
736
self.deleted_paths = deleted_paths
738
def _check_strict(self):
739
# XXX: when we use iter_changes this would likely be faster if
740
# iter_changes would check for us (even in the presence of
209
self.revprops = {'branch-nick': branch.nick}
211
self.revprops.update(revprops)
212
self.work_tree = WorkingTree(branch.base, branch)
743
215
# raise an exception as soon as we find a single unknown.
744
216
for unknown in self.work_tree.unknowns():
745
217
raise StrictCommitFailed()
747
def _commit_nested_tree(self, path):
748
"Commit a nested tree."
749
sub_tree = self.work_tree.get_nested_tree(path)
750
# FIXME: be more comprehensive here:
751
# this works when both trees are in --trees repository,
752
# but when both are bound to a different repository,
753
# it fails; a better way of approaching this is to
754
# finally implement the explicit-caches approach design
755
# a while back - RBC 20070306.
756
if sub_tree.branch.repository.has_same_location(
757
self.work_tree.branch.repository):
758
sub_tree.branch.repository = \
759
self.work_tree.branch.repository
219
if timestamp is None:
220
self.timestamp = time.time()
222
self.timestamp = long(timestamp)
224
if self.config is None:
225
self.config = bzrlib.config.BranchConfig(self.branch)
228
self.rev_id = _gen_revision_id(self.config, self.timestamp)
232
if committer is None:
233
self.committer = self.config.username()
235
assert isinstance(committer, basestring), type(committer)
236
self.committer = committer
239
self.timezone = local_time_offset()
241
self.timezone = int(timezone)
243
if isinstance(message, str):
244
message = message.decode(bzrlib.user_encoding)
245
assert isinstance(message, unicode), type(message)
246
self.message = message
247
self._escape_commit_message()
249
self.branch.lock_write()
761
return sub_tree.commit(message=None, revprops=self.revprops,
762
recursive=self.recursive,
763
message_callback=self.message_callback,
764
timestamp=self.timestamp,
765
timezone=self.timezone,
766
committer=self.committer,
767
allow_pointless=self.allow_pointless,
768
strict=self.strict, verbose=self.verbose,
769
local=self.local, reporter=self.reporter)
770
except PointlessCommit:
771
return self.work_tree.get_reference_revision(path)
773
def _set_progress_stage(self, name, counter=False):
774
"""Set the progress stage and emit an update to the progress bar."""
775
self.pb_stage_name = name
776
self.pb_stage_count += 1
778
self.pb_entries_count = 0
780
self.pb_entries_count = None
781
self._emit_progress()
783
def _next_progress_entry(self):
784
"""Emit an update to the progress bar and increment the entry count."""
785
self.pb_entries_count += 1
786
self._emit_progress()
788
def _emit_progress(self):
789
if self.pb_entries_count is not None:
790
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
791
self.pb_entries_count)
793
text = gettext("%s - Stage") % (self.pb_stage_name, )
794
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
251
self.work_inv = self.work_tree.inventory
252
self.basis_tree = self.branch.basis_tree()
253
self.basis_inv = self.basis_tree.inventory
255
self._gather_parents()
256
if len(self.parents) > 1 and self.specific_files:
257
raise NotImplementedError('selected-file commit of merges is not supported yet')
258
self._check_parents_present()
260
self._remove_deleted()
261
self._populate_new_inv()
262
self._store_snapshot()
263
self._report_deletes()
265
if not (self.allow_pointless
266
or len(self.parents) > 1
267
or self.new_inv != self.basis_inv):
268
raise PointlessCommit()
270
if len(list(self.work_tree.iter_conflicts()))>0:
271
raise ConflictsInTree
273
self._record_inventory()
274
self._make_revision()
275
self.work_tree.set_pending_merges([])
276
self.branch.append_revision(self.rev_id)
277
self.reporter.completed(self.branch.revno()+1, self.rev_id)
278
if self.config.post_commit() is not None:
279
hooks = self.config.post_commit().split(' ')
280
# this would be nicer with twisted.python.reflect.namedAny
282
result = eval(hook + '(branch, rev_id)',
283
{'branch':self.branch,
285
'rev_id':self.rev_id})
289
def _record_inventory(self):
290
"""Store the inventory for the new revision."""
291
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
292
self.inv_sha1 = sha_string(inv_text)
293
s = self.branch.control_weaves
294
s.add_text('inventory', self.rev_id,
295
split_lines(inv_text), self.present_parents,
296
self.branch.get_transaction())
298
def _escape_commit_message(self):
299
"""Replace xml-incompatible control characters."""
300
# Python strings can include characters that can't be
301
# represented in well-formed XML; escape characters that
302
# aren't listed in the XML specification
303
# (http://www.w3.org/TR/REC-xml/#NT-Char).
304
self.message, escape_count = re.subn(
305
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
306
lambda match: match.group(0).encode('unicode_escape'),
309
self.reporter.escaped(escape_count, self.message)
311
def _gather_parents(self):
312
"""Record the parents of a merge for merge detection."""
313
pending_merges = self.work_tree.pending_merges()
315
self.parent_invs = []
316
self.present_parents = []
317
precursor_id = self.branch.last_revision()
319
self.parents.append(precursor_id)
320
self.parents += pending_merges
321
for revision in self.parents:
322
if self.branch.has_revision(revision):
323
self.parent_invs.append(self.branch.get_inventory(revision))
324
self.present_parents.append(revision)
326
def _check_parents_present(self):
327
for parent_id in self.parents:
328
mutter('commit parent revision {%s}', parent_id)
329
if not self.branch.has_revision(parent_id):
330
if parent_id == self.branch.last_revision():
331
warning("parent is missing %r", parent_id)
332
raise HistoryMissing(self.branch, 'revision', parent_id)
334
mutter("commit will ghost revision %r", parent_id)
336
def _make_revision(self):
337
"""Record a new revision object for this commit."""
338
self.rev = Revision(timestamp=self.timestamp,
339
timezone=self.timezone,
340
committer=self.committer,
341
message=self.message,
342
inventory_sha1=self.inv_sha1,
343
revision_id=self.rev_id,
344
properties=self.revprops)
345
self.rev.parent_ids = self.parents
347
serializer_v5.write_revision(self.rev, rev_tmp)
349
if self.config.signature_needed():
350
plaintext = Testament(self.rev, self.new_inv).as_short_text()
351
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
352
plaintext, self.rev_id)
353
self.branch.revision_store.add(rev_tmp, self.rev_id)
354
mutter('new revision_id is {%s}', self.rev_id)
356
def _remove_deleted(self):
357
"""Remove deleted files from the working inventories.
359
This is done prior to taking the working inventory as the
360
basis for the new committed inventory.
362
This returns true if any files
363
*that existed in the basis inventory* were deleted.
364
Files that were added and deleted
365
in the working copy don't matter.
367
specific = self.specific_files
369
for path, ie in self.work_inv.iter_entries():
370
if specific and not is_inside_any(specific, path):
372
if not self.work_tree.has_filename(path):
373
self.reporter.missing(path)
374
deleted_ids.append((path, ie.file_id))
376
deleted_ids.sort(reverse=True)
377
for path, file_id in deleted_ids:
378
del self.work_inv[file_id]
379
self.work_tree._write_inventory(self.work_inv)
381
def _store_snapshot(self):
382
"""Pass over inventory and record a snapshot.
384
Entries get a new revision when they are modified in
385
any way, which includes a merge with a new set of
386
parents that have the same entry.
388
# XXX: Need to think more here about when the user has
389
# made a specific decision on a particular value -- c.f.
391
for path, ie in self.new_inv.iter_entries():
392
previous_entries = ie.find_previous_heads(
394
self.weave_store.get_weave_or_empty(ie.file_id,
395
self.branch.get_transaction()))
396
if ie.revision is None:
397
change = ie.snapshot(self.rev_id, path, previous_entries,
398
self.work_tree, self.weave_store,
399
self.branch.get_transaction())
402
self.reporter.snapshot_change(change, path)
404
def _populate_new_inv(self):
405
"""Build revision inventory.
407
This creates a new empty inventory. Depending on
408
which files are selected for commit, and what is present in the
409
current tree, the new inventory is populated. inventory entries
410
which are candidates for modification have their revision set to
411
None; inventory entries that are carried over untouched have their
412
revision set to their prior value.
414
mutter("Selecting files for commit with filter %s", self.specific_files)
415
self.new_inv = Inventory()
416
for path, new_ie in self.work_inv.iter_entries():
417
file_id = new_ie.file_id
418
mutter('check %s {%s}', path, new_ie.file_id)
419
if self.specific_files:
420
if not is_inside_any(self.specific_files, path):
421
mutter('%s not selected for commit', path)
422
self._carry_entry(file_id)
425
# this is selected, ensure its parents are too.
426
parent_id = new_ie.parent_id
427
while parent_id != ROOT_ID:
428
if not self.new_inv.has_id(parent_id):
429
ie = self._select_entry(self.work_inv[parent_id])
430
mutter('%s selected for commit because of %s',
431
self.new_inv.id2path(parent_id), path)
433
ie = self.new_inv[parent_id]
434
if ie.revision is not None:
436
mutter('%s selected for commit because of %s',
437
self.new_inv.id2path(parent_id), path)
438
parent_id = ie.parent_id
439
mutter('%s selected for commit', path)
440
self._select_entry(new_ie)
442
def _select_entry(self, new_ie):
443
"""Make new_ie be considered for committing."""
449
def _carry_entry(self, file_id):
450
"""Carry the file unchanged from the basis revision."""
451
if self.basis_inv.has_id(file_id):
452
self.new_inv.add(self.basis_inv[file_id].copy())
454
def _report_deletes(self):
455
for file_id in self.basis_inv:
456
if file_id not in self.new_inv:
457
self.reporter.deleted(self.basis_inv.id2path(file_id))
459
def _gen_revision_id(config, when):
460
"""Return new revision-id."""
461
s = '%s-%s-' % (config.user_email(), compact_date(when))
462
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
