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