46
56
# merges from, then it should still be reported as newly added
47
57
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
60
from bzrlib.branch import Branch
61
from bzrlib.cleanup import OperationWithCleanups
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_file, isdir, isfile,
62
81
import bzrlib.config
82
import bzrlib.errors as errors
63
83
from bzrlib.errors import (BzrError, PointlessCommit,
67
from bzrlib.osutils import (get_user_encoding,
69
minimum_path_selection,
72
from bzrlib.trace import mutter, note, is_quiet
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
74
from bzrlib import symbol_versioning
75
from bzrlib.urlutils import unescape_for_display
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.symbol_versioning import *
94
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
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.
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
78
109
class NullCommitReporter(object):
79
110
"""I report on progress of a commit."""
81
def started(self, revno, revid, location=None):
83
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
"to started.", DeprecationWarning,
88
112
def snapshot_change(self, change, path):
91
115
def completed(self, revno, rev_id):
94
def deleted(self, path):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
97
124
def missing(self, path):
100
def renamed(self, change, old_path, new_path):
103
def is_verbose(self):
107
128
class ReportCommitToLog(NullCommitReporter):
109
def _note(self, format, *args):
112
Subclasses may choose to override this method.
116
130
def snapshot_change(self, change, path):
117
if path == '' and change in ('added', 'modified'):
131
if change == 'unchanged':
119
self._note("%s %s", change, path)
121
def started(self, revno, rev_id, location=None):
122
if location is not None:
123
location = ' to: ' + unescape_for_display(location, 'utf-8')
125
# When started was added, location was only made optional by
126
# accident. Matt Nordhoff 20071129
127
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
"to started.", DeprecationWarning,
131
self._note('Committing%s', location)
133
note("%s %s", change, path)
133
135
def completed(self, revno, rev_id):
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)
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
142
def deleted(self, path):
143
self._note('deleted %s', path)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
145
144
def missing(self, path):
146
self._note('missing %s', path)
148
def renamed(self, change, old_path, new_path):
149
self._note('%s %s => %s', change, old_path, new_path)
151
def is_verbose(self):
145
note('missing %s', path)
155
148
class Commit(object):
225
183
working_tree=None,
229
message_callback=None,
232
possible_master_transports=None,
234
187
"""Commit working copy as a new revision.
236
:param message: the commit message (it or message_callback is required)
237
:param message_callback: A callback: message = message_callback(cmt_obj)
239
:param timestamp: if not None, seconds-since-epoch for a
240
postdated/predated commit.
242
:param specific_files: If not None, commit only those files. An empty
243
list means 'commit no files'.
245
:param rev_id: If set, use this as the new revision id.
189
branch -- the deprecated branch to commit to. New callers should pass in
192
message -- the commit message, a mandatory parameter
194
timestamp -- if not None, seconds-since-epoch for a
195
postdated/predated commit.
197
specific_files -- If true, commit only those files.
199
rev_id -- If set, use this as the new revision id.
246
200
Useful for test or import commands that need to tightly
247
201
control what revisions are assigned. If you duplicate
248
202
a revision id that exists elsewhere it is your own fault.
249
203
If null (default), a time/random revision id is generated.
251
:param allow_pointless: If true (default), commit even if nothing
205
allow_pointless -- If true (default), commit even if nothing
252
206
has changed and no merges are recorded.
254
:param strict: If true, don't allow a commit if the working tree
208
strict -- If true, don't allow a commit if the working tree
255
209
contains unknown files.
257
:param revprops: Properties for new revision
211
revprops -- Properties for new revision
258
212
:param local: Perform a local only commit.
259
:param reporter: the reporter to use or None for the default
260
:param verbose: if True and the reporter is not None, report everything
261
:param recursive: If set to 'down', commit in any subtrees that have
262
pending changes of any sort during this commit.
263
:param exclude: None or a list of relative paths to exclude from the
264
commit. Pending changes to excluded files will be ignored by the
266
:param lossy: When committing to a foreign VCS, ignore any
267
data that can not be natively represented.
269
operation = OperationWithCleanups(self._commit)
270
self.revprops = revprops or {}
271
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
272
self.config = config or self.config
273
return operation.run(
278
specific_files=specific_files,
280
allow_pointless=allow_pointless,
283
working_tree=working_tree,
286
message_callback=message_callback,
289
possible_master_transports=possible_master_transports,
292
def _commit(self, operation, message, timestamp, timezone, committer,
293
specific_files, rev_id, allow_pointless, strict, verbose,
294
working_tree, local, reporter, message_callback, recursive,
295
exclude, possible_master_transports, lossy):
296
214
mutter('preparing to commit')
298
if working_tree is None:
299
raise BzrError("working_tree must be passed into commit().")
216
if deprecated_passed(branch):
217
warn("Commit.commit (branch, ...): The branch parameter is "
218
"deprecated as of bzr 0.8. Please use working_tree= instead.",
219
DeprecationWarning, stacklevel=2)
221
self.work_tree = self.branch.bzrdir.open_workingtree()
222
elif working_tree is None:
223
raise BzrError("One of branch and working_tree must be passed into commit().")
301
225
self.work_tree = working_tree
302
226
self.branch = self.work_tree.branch
303
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
304
if not self.branch.repository.supports_rich_root():
305
raise errors.RootNotRich()
306
if message_callback is None:
307
if message is not None:
308
if isinstance(message, str):
309
message = message.decode(get_user_encoding())
310
message_callback = lambda x: message
312
raise BzrError("The message or message_callback keyword"
313
" parameter is required for commit().")
228
raise BzrError("The message keyword parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
315
231
self.bound_branch = None
316
self.any_entries_deleted = False
317
if exclude is not None:
318
self.exclude = sorted(
319
minimum_path_selection(exclude))
322
232
self.local = local
323
233
self.master_branch = None
324
self.recursive = recursive
326
# self.specific_files is None to indicate no filter, or any iterable to
327
# indicate a filter - [] means no files at all, as per iter_changes.
328
if specific_files is not None:
329
self.specific_files = sorted(
330
minimum_path_selection(specific_files))
332
self.specific_files = None
234
self.master_locked = False
236
self.specific_files = specific_files
334
237
self.allow_pointless = allow_pointless
335
self.message_callback = message_callback
336
self.timestamp = timestamp
337
self.timezone = timezone
338
self.committer = committer
340
self.verbose = verbose
239
if revprops is not None:
240
self.revprops.update(revprops)
242
if reporter is None and self.reporter is None:
243
self.reporter = NullCommitReporter()
244
elif reporter is not None:
245
self.reporter = reporter
342
247
self.work_tree.lock_write()
343
operation.add_cleanup(self.work_tree.unlock)
344
self.parents = self.work_tree.get_parent_ids()
345
# We can use record_iter_changes IFF iter_changes is compatible with
346
# the command line parameters, and the repository has fast delta
347
# generation. See bug 347649.
348
self.use_record_iter_changes = (
350
not self.branch.repository._format.supports_tree_reference and
351
(self.branch.repository._format.fast_deltas or
352
len(self.parents) < 2))
353
self.pb = ui.ui_factory.nested_progress_bar()
354
operation.add_cleanup(self.pb.finished)
355
self.basis_revid = self.work_tree.last_revision()
356
self.basis_tree = self.work_tree.basis_tree()
357
self.basis_tree.lock_read()
358
operation.add_cleanup(self.basis_tree.unlock)
359
# Cannot commit with conflicts present.
360
if len(self.work_tree.conflicts()) > 0:
361
raise ConflictsInTree
363
# Setup the bound branch variables as needed.
364
self._check_bound_branch(operation, possible_master_transports)
366
# Check that the working tree is up to date
367
old_revno, new_revno = self._check_out_of_date_tree()
369
# Complete configuration setup
370
if reporter is not None:
371
self.reporter = reporter
372
elif self.reporter is None:
373
self.reporter = self._select_reporter()
374
if self.config is None:
375
self.config = self.branch.get_config()
377
self._set_specific_file_ids()
379
# Setup the progress bar. As the number of files that need to be
380
# committed in unknown, progress is reported as stages.
381
# We keep track of entries separately though and include that
382
# information in the progress bar during the relevant stages.
383
self.pb_stage_name = ""
384
self.pb_stage_count = 0
385
self.pb_stage_total = 5
386
if self.bound_branch:
387
# 2 extra stages: "Uploading data to master branch" and "Merging
388
# tags to master branch"
389
self.pb_stage_total += 2
390
self.pb.show_pct = False
391
self.pb.show_spinner = False
392
self.pb.show_eta = False
393
self.pb.show_count = True
394
self.pb.show_bar = True
396
self._gather_parents()
397
# After a merge, a selected file commit is not supported.
398
# See 'bzr help merge' for an explanation as to why.
399
if len(self.parents) > 1 and self.specific_files is not None:
400
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
401
# Excludes are a form of selected file commit.
402
if len(self.parents) > 1 and self.exclude:
403
raise errors.CannotCommitSelectedFileMerge(self.exclude)
405
# Collect the changes
406
self._set_progress_stage("Collecting changes", counter=True)
408
self.builder = self.branch.get_commit_builder(self.parents,
409
self.config, timestamp, timezone, committer, self.revprops,
411
if not self.builder.supports_record_entry_contents and self.exclude:
413
raise errors.ExcludesUnsupported(self.branch.repository)
416
self.builder.will_record_deletes()
417
# find the location being committed to
249
# setup the bound branch variables as needed.
250
self._check_bound_branch()
252
# check for out of date working trees
253
# if we are bound, then self.branch is the master branch and this
254
# test is thus all we need.
255
if self.work_tree.last_revision() != self.master_branch.last_revision():
256
raise errors.OutOfDateTree(self.work_tree)
259
# raise an exception as soon as we find a single unknown.
260
for unknown in self.work_tree.unknowns():
261
raise StrictCommitFailed()
263
if timestamp is None:
264
self.timestamp = time.time()
266
self.timestamp = long(timestamp)
268
if self.config is None:
269
self.config = bzrlib.config.BranchConfig(self.branch)
272
self.rev_id = _gen_revision_id(self.config, self.timestamp)
276
if committer is None:
277
self.committer = self.config.username()
279
assert isinstance(committer, basestring), type(committer)
280
self.committer = committer
283
self.timezone = local_time_offset()
285
self.timezone = int(timezone)
287
if isinstance(message, str):
288
message = message.decode(bzrlib.user_encoding)
289
assert isinstance(message, unicode), type(message)
290
self.message = message
291
self._escape_commit_message()
293
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
295
self.basis_inv = self.basis_tree.inventory
297
self._gather_parents()
298
if len(self.parents) > 1 and self.specific_files:
299
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
301
self._check_parents_present()
303
self._remove_deleted()
304
self._populate_new_inv()
305
self._store_snapshot()
306
self._report_deletes()
308
if not (self.allow_pointless
309
or len(self.parents) > 1
310
or self.new_inv != self.basis_inv):
311
raise PointlessCommit()
313
if len(self.work_tree.conflicts())>0:
314
raise ConflictsInTree
316
self.inv_sha1 = self.branch.repository.add_inventory(
321
self._make_revision()
322
# revision data is in the local branch now.
324
# upload revision data to the master.
325
# this will propogate merged revisions too if needed.
418
326
if self.bound_branch:
419
master_location = self.master_branch.base
421
master_location = self.branch.base
423
# report the start of the commit
424
self.reporter.started(new_revno, self.rev_id, master_location)
426
self._update_builder_with_changes()
427
self._check_pointless()
429
# TODO: Now the new inventory is known, check for conflicts.
430
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
431
# weave lines, because nothing should be recorded until it is known
432
# that commit will succeed.
433
self._set_progress_stage("Saving data locally")
434
self.builder.finish_inventory()
436
# Prompt the user for a commit message if none provided
437
message = message_callback(self)
438
self.message = message
440
# Add revision data to the local branch
441
self.rev_id = self.builder.commit(self.message)
444
mutter("aborting commit write group because of exception:")
445
trace.log_exception_quietly()
446
note("aborting commit write group: %r" % (e,))
450
self._process_pre_hooks(old_revno, new_revno)
452
# Upload revision data to the master.
453
# this will propagate merged revisions too if needed.
454
if self.bound_branch:
455
self._set_progress_stage("Uploading data to master branch")
456
# 'commit' to the master first so a timeout here causes the
457
# local branch to be out of date
458
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
459
self.branch, new_revno, self.rev_id, lossy=lossy)
461
self.branch.fetch(self.master_branch, self.rev_id)
463
# and now do the commit locally.
464
self.branch.set_last_revision_info(new_revno, self.rev_id)
466
# Merge local tags to remote
467
if self.bound_branch:
468
self._set_progress_stage("Merging tags to master branch")
469
tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
471
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
472
note("Conflicting tags in bound branch:\n" +
473
"\n".join(warning_lines))
475
# Make the working tree be up to date with the branch. This
476
# includes automatic changes scheduled to be made to the tree, such
477
# as updating its basis and unversioning paths that were missing.
478
self.work_tree.unversion(self.deleted_ids)
479
self._set_progress_stage("Updating the working tree")
480
self.work_tree.update_basis_by_delta(self.rev_id,
481
self.builder.get_basis_delta())
482
self.reporter.completed(new_revno, self.rev_id)
483
self._process_post_hooks(old_revno, new_revno)
486
def _select_reporter(self):
487
"""Select the CommitReporter to use."""
489
return NullCommitReporter()
490
return ReportCommitToLog()
492
def _check_pointless(self):
493
if self.allow_pointless:
495
# A merge with no effect on files
496
if len(self.parents) > 1:
498
# TODO: we could simplify this by using self.builder.basis_delta.
500
# The initial commit adds a root directory, but this in itself is not
501
# a worthwhile commit.
502
if (self.basis_revid == revision.NULL_REVISION and
503
((self.builder.new_inventory is not None and
504
len(self.builder.new_inventory) == 1) or
505
len(self.builder._basis_delta) == 1)):
506
raise PointlessCommit()
507
if self.builder.any_changes():
509
raise PointlessCommit()
511
def _check_bound_branch(self, operation, possible_master_transports=None):
327
self.master_branch.repository.fetch(self.branch.repository,
328
revision_id=self.rev_id)
329
# now the master has the revision data
330
# 'commit' to the master first so a timeout here causes the local
331
# branch to be out of date
332
self.master_branch.append_revision(self.rev_id)
334
# and now do the commit locally.
335
self.branch.append_revision(self.rev_id)
337
self.work_tree.set_pending_merges([])
338
self.work_tree.set_last_revision(self.rev_id)
339
# now the work tree is up to date with the branch
341
self.reporter.completed(self.branch.revno(), self.rev_id)
342
if self.config.post_commit() is not None:
343
hooks = self.config.post_commit().split(' ')
344
# this would be nicer with twisted.python.reflect.namedAny
346
result = eval(hook + '(branch, rev_id)',
347
{'branch':self.branch,
349
'rev_id':self.rev_id})
351
self._cleanup_bound_branch()
352
self.work_tree.unlock()
354
def _check_bound_branch(self):
512
355
"""Check to see if the local branch is bound.
514
357
If it is bound, then most of the commit will actually be
549
391
# so grab the lock
550
392
self.bound_branch = self.branch
551
393
self.master_branch.lock_write()
552
operation.add_cleanup(self.master_branch.unlock)
554
def _check_out_of_date_tree(self):
555
"""Check that the working tree is up to date.
557
:return: old_revision_number,new_revision_number tuple
394
self.master_locked = True
396
#### # Check to see if we have any pending merges. If we do
397
#### # those need to be pushed into the master branch
398
#### pending_merges = self.work_tree.pending_merges()
399
#### if pending_merges:
400
#### for revision_id in pending_merges:
401
#### self.master_branch.repository.fetch(self.bound_branch.repository,
402
#### revision_id=revision_id)
404
def _cleanup_bound_branch(self):
405
"""Executed at the end of a try/finally to cleanup a bound branch.
407
If the branch wasn't bound, this is a no-op.
408
If it was, it resents self.branch to the local branch, instead
560
first_tree_parent = self.work_tree.get_parent_ids()[0]
562
# if there are no parents, treat our parent as 'None'
563
# this is so that we still consider the master branch
564
# - in a checkout scenario the tree may have no
565
# parents but the branch may do.
566
first_tree_parent = bzrlib.revision.NULL_REVISION
567
old_revno, master_last = self.master_branch.last_revision_info()
568
if master_last != first_tree_parent:
569
if master_last != bzrlib.revision.NULL_REVISION:
570
raise errors.OutOfDateTree(self.work_tree)
571
if self.branch.repository.has_revision(first_tree_parent):
572
new_revno = old_revno + 1
574
# ghost parents never appear in revision history.
576
return old_revno,new_revno
578
def _process_pre_hooks(self, old_revno, new_revno):
579
"""Process any registered pre commit hooks."""
580
self._set_progress_stage("Running pre_commit hooks")
581
self._process_hooks("pre_commit", old_revno, new_revno)
583
def _process_post_hooks(self, old_revno, new_revno):
584
"""Process any registered post commit hooks."""
585
# Process the post commit hooks, if any
586
self._set_progress_stage("Running post_commit hooks")
587
# old style commit hooks - should be deprecated ? (obsoleted in
589
if self.config.post_commit() is not None:
590
hooks = self.config.post_commit().split(' ')
591
# this would be nicer with twisted.python.reflect.namedAny
593
result = eval(hook + '(branch, rev_id)',
594
{'branch':self.branch,
596
'rev_id':self.rev_id})
597
# process new style post commit hooks
598
self._process_hooks("post_commit", old_revno, new_revno)
600
def _process_hooks(self, hook_name, old_revno, new_revno):
601
if not Branch.hooks[hook_name]:
604
# new style commit hooks:
605
411
if not self.bound_branch:
606
hook_master = self.branch
609
hook_master = self.master_branch
610
hook_local = self.branch
611
# With bound branches, when the master is behind the local branch,
612
# the 'old_revno' and old_revid values here are incorrect.
613
# XXX: FIXME ^. RBC 20060206
615
old_revid = self.parents[0]
617
old_revid = bzrlib.revision.NULL_REVISION
619
if hook_name == "pre_commit":
620
future_tree = self.builder.revision_tree()
621
tree_delta = future_tree.changes_from(self.basis_tree,
624
for hook in Branch.hooks[hook_name]:
625
# show the running hook in the progress bar. As hooks may
626
# end up doing nothing (e.g. because they are not configured by
627
# the user) this is still showing progress, not showing overall
628
# actions - its up to each plugin to show a UI if it want's to
629
# (such as 'Emailing diff to foo@example.com').
630
self.pb_stage_name = "Running %s hooks [%s]" % \
631
(hook_name, Branch.hooks.get_hook_name(hook))
632
self._emit_progress()
633
if 'hooks' in debug.debug_flags:
634
mutter("Invoking commit hook: %r", hook)
635
if hook_name == "post_commit":
636
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
638
elif hook_name == "pre_commit":
639
hook(hook_local, hook_master,
640
old_revno, old_revid, new_revno, self.rev_id,
641
tree_delta, future_tree)
413
if self.master_locked:
414
self.master_branch.unlock()
416
def _escape_commit_message(self):
417
"""Replace xml-incompatible control characters."""
418
# FIXME: RBC 20060419 this should be done by the revision
419
# serialiser not by commit. Then we can also add an unescaper
420
# in the deserializer and start roundtripping revision messages
421
# precisely. See repository_implementations/test_repository.py
423
# Python strings can include characters that can't be
424
# represented in well-formed XML; escape characters that
425
# aren't listed in the XML specification
426
# (http://www.w3.org/TR/REC-xml/#NT-Char).
427
self.message, escape_count = re.subn(
428
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
429
lambda match: match.group(0).encode('unicode_escape'),
432
self.reporter.escaped(escape_count, self.message)
643
434
def _gather_parents(self):
644
435
"""Record the parents of a merge for merge detection."""
645
# TODO: Make sure that this list doesn't contain duplicate
646
# entries and the order is preserved when doing this.
647
if self.use_record_iter_changes:
649
self.basis_inv = self.basis_tree.inventory
650
self.parent_invs = [self.basis_inv]
651
for revision in self.parents[1:]:
436
pending_merges = self.work_tree.pending_merges()
438
self.parent_invs = []
439
self.present_parents = []
440
precursor_id = self.branch.last_revision()
442
self.parents.append(precursor_id)
443
self.parents += pending_merges
444
for revision in self.parents:
652
445
if self.branch.repository.has_revision(revision):
653
mutter('commit parent revision {%s}', revision)
654
446
inventory = self.branch.repository.get_inventory(revision)
655
447
self.parent_invs.append(inventory)
657
mutter('commit parent ghost revision {%s}', revision)
659
def _update_builder_with_changes(self):
660
"""Update the commit builder with the data about what has changed.
662
exclude = self.exclude
663
specific_files = self.specific_files
664
mutter("Selecting files for commit with filter %s", specific_files)
667
if self.use_record_iter_changes:
668
iter_changes = self.work_tree.iter_changes(self.basis_tree,
669
specific_files=specific_files)
670
iter_changes = self._filter_iter_changes(iter_changes)
671
for file_id, path, fs_hash in self.builder.record_iter_changes(
672
self.work_tree, self.basis_revid, iter_changes):
673
self.work_tree._observed_sha1(file_id, path, fs_hash)
675
# Build the new inventory
676
self._populate_from_inventory()
677
self._record_unselected()
678
self._report_and_accumulate_deletes()
680
def _filter_iter_changes(self, iter_changes):
681
"""Process iter_changes.
683
This method reports on the changes in iter_changes to the user, and
684
converts 'missing' entries in the iter_changes iterator to 'deleted'
685
entries. 'missing' entries have their
687
:param iter_changes: An iter_changes to process.
688
:return: A generator of changes.
690
reporter = self.reporter
691
report_changes = reporter.is_verbose()
448
self.present_parents.append(revision)
450
def _check_parents_present(self):
451
for parent_id in self.parents:
452
mutter('commit parent revision {%s}', parent_id)
453
if not self.branch.repository.has_revision(parent_id):
454
if parent_id == self.branch.last_revision():
455
warning("parent is missing %r", parent_id)
456
raise HistoryMissing(self.branch, 'revision', parent_id)
458
mutter("commit will ghost revision %r", parent_id)
460
def _make_revision(self):
461
"""Record a new revision object for this commit."""
462
rev = Revision(timestamp=self.timestamp,
463
timezone=self.timezone,
464
committer=self.committer,
465
message=self.message,
466
inventory_sha1=self.inv_sha1,
467
revision_id=self.rev_id,
468
properties=self.revprops)
469
rev.parent_ids = self.parents
470
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
472
def _remove_deleted(self):
473
"""Remove deleted files from the working inventories.
475
This is done prior to taking the working inventory as the
476
basis for the new committed inventory.
478
This returns true if any files
479
*that existed in the basis inventory* were deleted.
480
Files that were added and deleted
481
in the working copy don't matter.
483
specific = self.specific_files
693
for change in iter_changes:
695
old_path = change[1][0]
696
new_path = change[1][1]
697
versioned = change[3][1]
699
versioned = change[3][1]
700
if kind is None and versioned:
703
reporter.missing(new_path)
704
deleted_ids.append(change[0])
705
# Reset the new path (None) and new versioned flag (False)
706
change = (change[0], (change[1][0], None), change[2],
707
(change[3][0], False)) + change[4:]
708
elif kind == 'tree-reference':
709
if self.recursive == 'down':
710
self._commit_nested_tree(change[0], change[1][1])
711
if change[3][0] or change[3][1]:
715
reporter.deleted(old_path)
716
elif old_path is None:
717
reporter.snapshot_change('added', new_path)
718
elif old_path != new_path:
719
reporter.renamed('renamed', old_path, new_path)
722
self.work_tree.branch.repository._format.rich_root_data):
723
# Don't report on changes to '' in non rich root
725
reporter.snapshot_change('modified', new_path)
726
self._next_progress_entry()
727
# Unversion IDs that were found to be deleted
728
self.deleted_ids = deleted_ids
730
def _record_unselected(self):
731
# If specific files are selected, then all un-selected files must be
732
# recorded in their previous state. For more details, see
733
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
734
if self.specific_files or self.exclude:
735
specific_files = self.specific_files or []
736
for path, old_ie in self.basis_inv.iter_entries():
737
if old_ie.file_id in self.builder.new_inventory:
738
# already added - skip.
740
if (is_inside_any(specific_files, path)
741
and not is_inside_any(self.exclude, path)):
742
# was inside the selected path, and not excluded - if not
743
# present it has been deleted so skip.
745
# From here down it was either not selected, or was excluded:
746
# We preserve the entry unaltered.
748
# Note: specific file commits after a merge are currently
749
# prohibited. This test is for sanity/safety in case it's
750
# required after that changes.
751
if len(self.parents) > 1:
753
self.builder.record_entry_contents(ie, self.parent_invs, path,
754
self.basis_tree, None)
756
def _report_and_accumulate_deletes(self):
757
if (isinstance(self.basis_inv, Inventory)
758
and isinstance(self.builder.new_inventory, Inventory)):
759
# the older Inventory classes provide a _byid dict, and building a
760
# set from the keys of this dict is substantially faster than even
761
# getting a set of ids from the inventory
763
# <lifeless> set(dict) is roughly the same speed as
764
# set(iter(dict)) and both are significantly slower than
766
deleted_ids = set(self.basis_inv._byid.keys()) - \
767
set(self.builder.new_inventory._byid.keys())
769
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
485
for path, ie in self.work_inv.iter_entries():
486
if specific and not is_inside_any(specific, path):
488
if not self.work_tree.has_filename(path):
489
self.reporter.missing(path)
490
deleted_ids.append((path, ie.file_id))
771
self.any_entries_deleted = True
772
deleted = [(self.basis_tree.id2path(file_id), file_id)
773
for file_id in deleted_ids]
775
# XXX: this is not quite directory-order sorting
776
for path, file_id in deleted:
777
self.builder.record_delete(path, file_id)
778
self.reporter.deleted(path)
780
def _check_strict(self):
781
# XXX: when we use iter_changes this would likely be faster if
782
# iter_changes would check for us (even in the presence of
785
# raise an exception as soon as we find a single unknown.
786
for unknown in self.work_tree.unknowns():
787
raise StrictCommitFailed()
789
def _populate_from_inventory(self):
790
"""Populate the CommitBuilder by walking the working tree inventory."""
791
# Build the revision inventory.
793
# This starts by creating a new empty inventory. Depending on
794
# which files are selected for commit, and what is present in the
795
# current tree, the new inventory is populated. inventory entries
796
# which are candidates for modification have their revision set to
797
# None; inventory entries that are carried over untouched have their
798
# revision set to their prior value.
800
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
801
# results to create a new inventory at the same time, which results
802
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
805
specific_files = self.specific_files
806
exclude = self.exclude
807
report_changes = self.reporter.is_verbose()
809
# A tree of paths that have been deleted. E.g. if foo/bar has been
810
# deleted, then we have {'foo':{'bar':{}}}
812
# XXX: Note that entries may have the wrong kind because the entry does
813
# not reflect the status on disk.
814
work_inv = self.work_tree.inventory
815
# NB: entries will include entries within the excluded ids/paths
816
# because iter_entries_by_dir has no 'exclude' facility today.
817
entries = work_inv.iter_entries_by_dir(
818
specific_file_ids=self.specific_file_ids, yield_parents=True)
819
for path, existing_ie in entries:
820
file_id = existing_ie.file_id
821
name = existing_ie.name
822
parent_id = existing_ie.parent_id
823
kind = existing_ie.kind
824
# Skip files that have been deleted from the working tree.
825
# The deleted path ids are also recorded so they can be explicitly
828
path_segments = splitpath(path)
829
deleted_dict = deleted_paths
830
for segment in path_segments:
831
deleted_dict = deleted_dict.get(segment, None)
833
# We either took a path not present in the dict
834
# (deleted_dict was None), or we've reached an empty
835
# child dir in the dict, so are now a sub-path.
839
if deleted_dict is not None:
840
# the path has a deleted parent, do not add it.
842
if exclude and is_inside_any(exclude, path):
843
# Skip excluded paths. Excluded paths are processed by
844
# _update_builder_with_changes.
846
content_summary = self.work_tree.path_content_summary(path)
847
kind = content_summary[0]
848
# Note that when a filter of specific files is given, we must only
849
# skip/record deleted files matching that filter.
850
if not specific_files or is_inside_any(specific_files, path):
851
if kind == 'missing':
852
if not deleted_paths:
853
# path won't have been split yet.
854
path_segments = splitpath(path)
855
deleted_dict = deleted_paths
856
for segment in path_segments:
857
deleted_dict = deleted_dict.setdefault(segment, {})
858
self.reporter.missing(path)
859
self._next_progress_entry()
860
deleted_ids.append(file_id)
862
# TODO: have the builder do the nested commit just-in-time IF and
864
if kind == 'tree-reference':
865
# enforce repository nested tree policy.
866
if (not self.work_tree.supports_tree_reference() or
867
# repository does not support it either.
868
not self.branch.repository._format.supports_tree_reference):
870
content_summary = (kind, None, None, None)
871
elif self.recursive == 'down':
872
nested_revision_id = self._commit_nested_tree(
874
content_summary = (kind, None, None, nested_revision_id)
876
nested_revision_id = self.work_tree.get_reference_revision(file_id)
877
content_summary = (kind, None, None, nested_revision_id)
879
# Record an entry for this item
880
# Note: I don't particularly want to have the existing_ie
881
# parameter but the test suite currently (28-Jun-07) breaks
882
# without it thanks to a unicode normalisation issue. :-(
883
definitely_changed = kind != existing_ie.kind
884
self._record_entry(path, file_id, specific_files, kind, name,
885
parent_id, definitely_changed, existing_ie, report_changes,
888
# Unversion IDs that were found to be deleted
889
self.deleted_ids = deleted_ids
891
def _commit_nested_tree(self, file_id, path):
892
"Commit a nested tree."
893
sub_tree = self.work_tree.get_nested_tree(file_id, path)
894
# FIXME: be more comprehensive here:
895
# this works when both trees are in --trees repository,
896
# but when both are bound to a different repository,
897
# it fails; a better way of approaching this is to
898
# finally implement the explicit-caches approach design
899
# a while back - RBC 20070306.
900
if sub_tree.branch.repository.has_same_location(
901
self.work_tree.branch.repository):
902
sub_tree.branch.repository = \
903
self.work_tree.branch.repository
905
return sub_tree.commit(message=None, revprops=self.revprops,
906
recursive=self.recursive,
907
message_callback=self.message_callback,
908
timestamp=self.timestamp, timezone=self.timezone,
909
committer=self.committer,
910
allow_pointless=self.allow_pointless,
911
strict=self.strict, verbose=self.verbose,
912
local=self.local, reporter=self.reporter)
913
except errors.PointlessCommit:
914
return self.work_tree.get_reference_revision(file_id)
916
def _record_entry(self, path, file_id, specific_files, kind, name,
917
parent_id, definitely_changed, existing_ie, report_changes,
919
"Record the new inventory entry for a path if any."
920
# mutter('check %s {%s}', path, file_id)
921
# mutter('%s selected for commit', path)
922
if definitely_changed or existing_ie is None:
923
ie = make_entry(kind, name, parent_id, file_id)
925
ie = existing_ie.copy()
927
# For carried over entries we don't care about the fs hash - the repo
928
# isn't generating a sha, so we're not saving computation time.
929
_, _, fs_hash = self.builder.record_entry_contents(
930
ie, self.parent_invs, path, self.work_tree, content_summary)
932
self._report_change(ie, path)
934
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
492
deleted_ids.sort(reverse=True)
493
for path, file_id in deleted_ids:
494
del self.work_inv[file_id]
495
self.work_tree._write_inventory(self.work_inv)
497
def _store_snapshot(self):
498
"""Pass over inventory and record a snapshot.
500
Entries get a new revision when they are modified in
501
any way, which includes a merge with a new set of
502
parents that have the same entry.
504
# XXX: Need to think more here about when the user has
505
# made a specific decision on a particular value -- c.f.
507
for path, ie in self.new_inv.iter_entries():
508
previous_entries = ie.find_previous_heads(
511
self.branch.repository.get_transaction())
512
if ie.revision is None:
513
change = ie.snapshot(self.rev_id, path, previous_entries,
514
self.work_tree, self.weave_store,
515
self.branch.repository.get_transaction())
518
self.reporter.snapshot_change(change, path)
520
def _populate_new_inv(self):
521
"""Build revision inventory.
523
This creates a new empty inventory. Depending on
524
which files are selected for commit, and what is present in the
525
current tree, the new inventory is populated. inventory entries
526
which are candidates for modification have their revision set to
527
None; inventory entries that are carried over untouched have their
528
revision set to their prior value.
530
mutter("Selecting files for commit with filter %s", self.specific_files)
531
self.new_inv = Inventory(revision_id=self.rev_id)
532
for path, new_ie in self.work_inv.iter_entries():
533
file_id = new_ie.file_id
534
mutter('check %s {%s}', path, new_ie.file_id)
535
if self.specific_files:
536
if not is_inside_any(self.specific_files, path):
537
mutter('%s not selected for commit', path)
538
self._carry_entry(file_id)
541
# this is selected, ensure its parents are too.
542
parent_id = new_ie.parent_id
543
while parent_id != ROOT_ID:
544
if not self.new_inv.has_id(parent_id):
545
ie = self._select_entry(self.work_inv[parent_id])
546
mutter('%s selected for commit because of %s',
547
self.new_inv.id2path(parent_id), path)
549
ie = self.new_inv[parent_id]
550
if ie.revision is not None:
552
mutter('%s selected for commit because of %s',
553
self.new_inv.id2path(parent_id), path)
554
parent_id = ie.parent_id
555
mutter('%s selected for commit', path)
556
self._select_entry(new_ie)
558
def _select_entry(self, new_ie):
559
"""Make new_ie be considered for committing."""
937
def _report_change(self, ie, path):
938
"""Report a change to the user.
940
The change that has occurred is described relative to the basis
943
if (self.basis_inv.has_id(ie.file_id)):
944
basis_ie = self.basis_inv[ie.file_id]
947
change = ie.describe_change(basis_ie, ie)
948
if change in (InventoryEntry.RENAMED,
949
InventoryEntry.MODIFIED_AND_RENAMED):
950
old_path = self.basis_inv.id2path(ie.file_id)
951
self.reporter.renamed(change, old_path, path)
952
self._next_progress_entry()
954
if change == 'unchanged':
956
self.reporter.snapshot_change(change, path)
957
self._next_progress_entry()
959
def _set_progress_stage(self, name, counter=False):
960
"""Set the progress stage and emit an update to the progress bar."""
961
self.pb_stage_name = name
962
self.pb_stage_count += 1
964
self.pb_entries_count = 0
966
self.pb_entries_count = None
967
self._emit_progress()
969
def _next_progress_entry(self):
970
"""Emit an update to the progress bar and increment the entry count."""
971
self.pb_entries_count += 1
972
self._emit_progress()
974
def _emit_progress(self):
975
if self.pb_entries_count is not None:
976
text = "%s [%d] - Stage" % (self.pb_stage_name,
977
self.pb_entries_count)
979
text = "%s - Stage" % (self.pb_stage_name, )
980
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
982
def _set_specific_file_ids(self):
983
"""populate self.specific_file_ids if we will use it."""
984
if not self.use_record_iter_changes:
985
# If provided, ensure the specified files are versioned
986
if self.specific_files is not None:
987
# Note: This routine is being called because it raises
988
# PathNotVersionedError as a side effect of finding the IDs. We
989
# later use the ids we found as input to the working tree
990
# inventory iterator, so we only consider those ids rather than
991
# examining the whole tree again.
992
# XXX: Dont we have filter_unversioned to do this more
994
self.specific_file_ids = tree.find_ids_across_trees(
995
self.specific_files, [self.basis_tree, self.work_tree])
997
self.specific_file_ids = None
565
def _carry_entry(self, file_id):
566
"""Carry the file unchanged from the basis revision."""
567
if self.basis_inv.has_id(file_id):
568
self.new_inv.add(self.basis_inv[file_id].copy())
570
def _report_deletes(self):
571
for file_id in self.basis_inv:
572
if file_id not in self.new_inv:
573
self.reporter.deleted(self.basis_inv.id2path(file_id))
575
def _gen_revision_id(config, when):
576
"""Return new revision-id."""
577
s = '%s-%s-' % (config.user_email(), compact_date(when))
578
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
