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
109
78
class NullCommitReporter(object):
110
79
"""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,
112
88
def snapshot_change(self, change, path):
115
91
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
94
def deleted(self, path):
124
97
def missing(self, path):
100
def renamed(self, change, old_path, new_path):
103
def is_verbose(self):
128
107
class ReportCommitToLog(NullCommitReporter):
109
def _note(self, format, *args):
112
Subclasses may choose to override this method.
130
116
def snapshot_change(self, change, path):
131
if change == 'unchanged':
117
if path == '' and change in ('added', 'modified'):
133
note("%s %s", change, path)
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)
135
133
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_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)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
142
def deleted(self, path):
143
self._note('deleted %s', path)
144
145
def missing(self, path):
145
note('missing %s', 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):
148
155
class Commit(object):
183
225
working_tree=None,
229
message_callback=None,
232
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
266
operation = OperationWithCleanups(self._commit)
267
self.revprops = revprops or {}
268
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
269
self.config = config or self.config
270
return operation.run(
275
specific_files=specific_files,
277
allow_pointless=allow_pointless,
280
working_tree=working_tree,
283
message_callback=message_callback,
286
possible_master_transports=possible_master_transports)
288
def _commit(self, operation, message, timestamp, timezone, committer,
289
specific_files, rev_id, allow_pointless, strict, verbose,
290
working_tree, local, reporter, message_callback, recursive,
291
exclude, possible_master_transports):
214
292
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().")
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
225
297
self.work_tree = working_tree
226
298
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, str):
305
message = message.decode(get_user_encoding())
306
message_callback = lambda x: message
308
raise BzrError("The message or message_callback keyword"
309
" parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
311
self.bound_branch = None
312
self.any_entries_deleted = False
313
if exclude is not None:
314
self.exclude = sorted(
315
minimum_path_selection(exclude))
232
318
self.local = local
233
319
self.master_branch = None
234
self.master_locked = False
236
self.specific_files = specific_files
320
self.recursive = recursive
322
# self.specific_files is None to indicate no filter, or any iterable to
323
# indicate a filter - [] means no files at all, as per iter_changes.
324
if specific_files is not None:
325
self.specific_files = sorted(
326
minimum_path_selection(specific_files))
328
self.specific_files = None
237
330
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
331
self.message_callback = message_callback
332
self.timestamp = timestamp
333
self.timezone = timezone
334
self.committer = committer
336
self.verbose = verbose
247
338
self.work_tree.lock_write()
339
operation.add_cleanup(self.work_tree.unlock)
340
self.parents = self.work_tree.get_parent_ids()
341
# We can use record_iter_changes IFF iter_changes is compatible with
342
# the command line parameters, and the repository has fast delta
343
# generation. See bug 347649.
344
self.use_record_iter_changes = (
346
not self.branch.repository._format.supports_tree_reference and
347
(self.branch.repository._format.fast_deltas or
348
len(self.parents) < 2))
349
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
350
operation.add_cleanup(self.pb.finished)
351
self.basis_revid = self.work_tree.last_revision()
352
self.basis_tree = self.work_tree.basis_tree()
353
self.basis_tree.lock_read()
354
operation.add_cleanup(self.basis_tree.unlock)
355
# Cannot commit with conflicts present.
356
if len(self.work_tree.conflicts()) > 0:
357
raise ConflictsInTree
359
# Setup the bound branch variables as needed.
360
self._check_bound_branch(operation, possible_master_transports)
362
# Check that the working tree is up to date
363
old_revno, new_revno = self._check_out_of_date_tree()
365
# Complete configuration setup
366
if reporter is not None:
367
self.reporter = reporter
368
elif self.reporter is None:
369
self.reporter = self._select_reporter()
370
if self.config is None:
371
self.config = self.branch.get_config()
373
self._set_specific_file_ids()
375
# Setup the progress bar. As the number of files that need to be
376
# committed in unknown, progress is reported as stages.
377
# We keep track of entries separately though and include that
378
# information in the progress bar during the relevant stages.
379
self.pb_stage_name = ""
380
self.pb_stage_count = 0
381
self.pb_stage_total = 5
382
if self.bound_branch:
383
self.pb_stage_total += 1
384
self.pb.show_pct = False
385
self.pb.show_spinner = False
386
self.pb.show_eta = False
387
self.pb.show_count = True
388
self.pb.show_bar = True
390
self._gather_parents()
391
# After a merge, a selected file commit is not supported.
392
# See 'bzr help merge' for an explanation as to why.
393
if len(self.parents) > 1 and self.specific_files is not None:
394
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
395
# Excludes are a form of selected file commit.
396
if len(self.parents) > 1 and self.exclude:
397
raise errors.CannotCommitSelectedFileMerge(self.exclude)
399
# Collect the changes
400
self._set_progress_stage("Collecting changes", counter=True)
401
self.builder = self.branch.get_commit_builder(self.parents,
402
self.config, timestamp, timezone, committer, self.revprops, rev_id)
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)
405
self.builder.will_record_deletes()
406
# find the location being committed to
407
if self.bound_branch:
408
master_location = self.master_branch.base
410
master_location = self.branch.base
412
# report the start of the commit
413
self.reporter.started(new_revno, self.rev_id, master_location)
415
self._update_builder_with_changes()
416
self._check_pointless()
418
# TODO: Now the new inventory is known, check for conflicts.
419
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
420
# weave lines, because nothing should be recorded until it is known
421
# that commit will succeed.
422
self._set_progress_stage("Saving data locally")
423
self.builder.finish_inventory()
425
# Prompt the user for a commit message if none provided
426
message = message_callback(self)
290
427
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):
429
# Add revision data to the local branch
430
self.rev_id = self.builder.commit(self.message)
433
mutter("aborting commit write group because of exception:")
434
trace.log_exception_quietly()
435
note("aborting commit write group: %r" % (e,))
439
self._process_pre_hooks(old_revno, new_revno)
441
# Upload revision data to the master.
442
# this will propagate merged revisions too if needed.
443
if self.bound_branch:
444
self._set_progress_stage("Uploading data to master branch")
445
# 'commit' to the master first so a timeout here causes the
446
# local branch to be out of date
447
self.master_branch.import_last_revision_info(
448
self.branch.repository, new_revno, self.rev_id)
450
# and now do the commit locally.
451
self.branch.set_last_revision_info(new_revno, self.rev_id)
453
# Make the working tree be up to date with the branch. This
454
# includes automatic changes scheduled to be made to the tree, such
455
# as updating its basis and unversioning paths that were missing.
456
self.work_tree.unversion(self.deleted_ids)
457
self._set_progress_stage("Updating the working tree")
458
self.work_tree.update_basis_by_delta(self.rev_id,
459
self.builder.get_basis_delta())
460
self.reporter.completed(new_revno, self.rev_id)
461
self._process_post_hooks(old_revno, new_revno)
464
def _select_reporter(self):
465
"""Select the CommitReporter to use."""
467
return NullCommitReporter()
468
return ReportCommitToLog()
470
def _check_pointless(self):
471
if self.allow_pointless:
473
# A merge with no effect on files
474
if len(self.parents) > 1:
476
# TODO: we could simplify this by using self.builder.basis_delta.
478
# The initial commit adds a root directory, but this in itself is not
479
# a worthwhile commit.
480
if (self.basis_revid == revision.NULL_REVISION and
481
((self.builder.new_inventory is not None and
482
len(self.builder.new_inventory) == 1) or
483
len(self.builder._basis_delta) == 1)):
484
raise PointlessCommit()
485
if self.builder.any_changes():
487
raise PointlessCommit()
489
def _check_bound_branch(self, operation, possible_master_transports=None):
354
490
"""Check to see if the local branch is bound.
356
492
If it is bound, then most of the commit will actually be
390
527
# so grab the lock
391
528
self.bound_branch = self.branch
392
529
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
530
operation.add_cleanup(self.master_branch.unlock)
532
def _check_out_of_date_tree(self):
533
"""Check that the working tree is up to date.
535
:return: old_revision_number,new_revision_number tuple
538
first_tree_parent = self.work_tree.get_parent_ids()[0]
540
# if there are no parents, treat our parent as 'None'
541
# this is so that we still consider the master branch
542
# - in a checkout scenario the tree may have no
543
# parents but the branch may do.
544
first_tree_parent = bzrlib.revision.NULL_REVISION
545
old_revno, master_last = self.master_branch.last_revision_info()
546
if master_last != first_tree_parent:
547
if master_last != bzrlib.revision.NULL_REVISION:
548
raise errors.OutOfDateTree(self.work_tree)
549
if self.branch.repository.has_revision(first_tree_parent):
550
new_revno = old_revno + 1
552
# ghost parents never appear in revision history.
554
return old_revno,new_revno
556
def _process_pre_hooks(self, old_revno, new_revno):
557
"""Process any registered pre commit hooks."""
558
self._set_progress_stage("Running pre_commit hooks")
559
self._process_hooks("pre_commit", old_revno, new_revno)
561
def _process_post_hooks(self, old_revno, new_revno):
562
"""Process any registered post commit hooks."""
563
# Process the post commit hooks, if any
564
self._set_progress_stage("Running post_commit hooks")
565
# old style commit hooks - should be deprecated ? (obsoleted in
567
if self.config.post_commit() is not None:
568
hooks = self.config.post_commit().split(' ')
569
# this would be nicer with twisted.python.reflect.namedAny
571
result = eval(hook + '(branch, rev_id)',
572
{'branch':self.branch,
574
'rev_id':self.rev_id})
575
# process new style post commit hooks
576
self._process_hooks("post_commit", old_revno, new_revno)
578
def _process_hooks(self, hook_name, old_revno, new_revno):
579
if not Branch.hooks[hook_name]:
582
# new style commit hooks:
410
583
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)
584
hook_master = self.branch
587
hook_master = self.master_branch
588
hook_local = self.branch
589
# With bound branches, when the master is behind the local branch,
590
# the 'old_revno' and old_revid values here are incorrect.
591
# XXX: FIXME ^. RBC 20060206
593
old_revid = self.parents[0]
595
old_revid = bzrlib.revision.NULL_REVISION
597
if hook_name == "pre_commit":
598
future_tree = self.builder.revision_tree()
599
tree_delta = future_tree.changes_from(self.basis_tree,
602
for hook in Branch.hooks[hook_name]:
603
# show the running hook in the progress bar. As hooks may
604
# end up doing nothing (e.g. because they are not configured by
605
# the user) this is still showing progress, not showing overall
606
# actions - its up to each plugin to show a UI if it want's to
607
# (such as 'Emailing diff to foo@example.com').
608
self.pb_stage_name = "Running %s hooks [%s]" % \
609
(hook_name, Branch.hooks.get_hook_name(hook))
610
self._emit_progress()
611
if 'hooks' in debug.debug_flags:
612
mutter("Invoking commit hook: %r", hook)
613
if hook_name == "post_commit":
614
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
616
elif hook_name == "pre_commit":
617
hook(hook_local, hook_master,
618
old_revno, old_revid, new_revno, self.rev_id,
619
tree_delta, future_tree)
428
621
def _gather_parents(self):
429
622
"""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:
623
# TODO: Make sure that this list doesn't contain duplicate
624
# entries and the order is preserved when doing this.
625
if self.use_record_iter_changes:
627
self.basis_inv = self.basis_tree.inventory
628
self.parent_invs = [self.basis_inv]
629
for revision in self.parents[1:]:
439
630
if self.branch.repository.has_revision(revision):
631
mutter('commit parent revision {%s}', revision)
440
632
inventory = self.branch.repository.get_inventory(revision)
441
633
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)
635
mutter('commit parent ghost revision {%s}', revision)
637
def _update_builder_with_changes(self):
638
"""Update the commit builder with the data about what has changed.
640
exclude = self.exclude
641
specific_files = self.specific_files
642
mutter("Selecting files for commit with filter %s", specific_files)
645
if self.use_record_iter_changes:
646
iter_changes = self.work_tree.iter_changes(self.basis_tree,
647
specific_files=specific_files)
648
iter_changes = self._filter_iter_changes(iter_changes)
649
for file_id, path, fs_hash in self.builder.record_iter_changes(
650
self.work_tree, self.basis_revid, iter_changes):
651
self.work_tree._observed_sha1(file_id, path, fs_hash)
653
# Build the new inventory
654
self._populate_from_inventory()
655
self._record_unselected()
656
self._report_and_accumulate_deletes()
658
def _filter_iter_changes(self, iter_changes):
659
"""Process iter_changes.
661
This method reports on the changes in iter_changes to the user, and
662
converts 'missing' entries in the iter_changes iterator to 'deleted'
663
entries. 'missing' entries have their
665
:param iter_changes: An iter_changes to process.
666
:return: A generator of changes.
668
reporter = self.reporter
669
report_changes = reporter.is_verbose()
671
for change in iter_changes:
673
old_path = change[1][0]
674
new_path = change[1][1]
675
versioned = change[3][1]
677
versioned = change[3][1]
678
if kind is None and versioned:
681
reporter.missing(new_path)
682
deleted_ids.append(change[0])
683
# Reset the new path (None) and new versioned flag (False)
684
change = (change[0], (change[1][0], None), change[2],
685
(change[3][0], False)) + change[4:]
686
elif kind == 'tree-reference':
687
if self.recursive == 'down':
688
self._commit_nested_tree(change[0], change[1][1])
689
if change[3][0] or change[3][1]:
693
reporter.deleted(old_path)
694
elif old_path is None:
695
reporter.snapshot_change('added', new_path)
696
elif old_path != new_path:
697
reporter.renamed('renamed', old_path, new_path)
700
self.work_tree.branch.repository._format.rich_root_data):
701
# Don't report on changes to '' in non rich root
703
reporter.snapshot_change('modified', new_path)
704
self._next_progress_entry()
705
# Unversion IDs that were found to be deleted
706
self.deleted_ids = deleted_ids
708
def _record_unselected(self):
709
# If specific files are selected, then all un-selected files must be
710
# recorded in their previous state. For more details, see
711
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
if self.specific_files or self.exclude:
713
specific_files = self.specific_files or []
714
for path, old_ie in self.basis_inv.iter_entries():
715
if old_ie.file_id in self.builder.new_inventory:
716
# already added - skip.
718
if (is_inside_any(specific_files, path)
719
and not is_inside_any(self.exclude, path)):
720
# was inside the selected path, and not excluded - if not
721
# present it has been deleted so skip.
723
# From here down it was either not selected, or was excluded:
724
# We preserve the entry unaltered.
726
# Note: specific file commits after a merge are currently
727
# prohibited. This test is for sanity/safety in case it's
728
# required after that changes.
729
if len(self.parents) > 1:
731
self.builder.record_entry_contents(ie, self.parent_invs, path,
732
self.basis_tree, None)
734
def _report_and_accumulate_deletes(self):
735
if (isinstance(self.basis_inv, Inventory)
736
and isinstance(self.builder.new_inventory, Inventory)):
737
# the older Inventory classes provide a _byid dict, and building a
738
# set from the keys of this dict is substantially faster than even
739
# getting a set of ids from the inventory
741
# <lifeless> set(dict) is roughly the same speed as
742
# set(iter(dict)) and both are significantly slower than
744
deleted_ids = set(self.basis_inv._byid.keys()) - \
745
set(self.builder.new_inventory._byid.keys())
747
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
749
self.any_entries_deleted = True
750
deleted = [(self.basis_tree.id2path(file_id), file_id)
751
for file_id in deleted_ids]
753
# XXX: this is not quite directory-order sorting
754
for path, file_id in deleted:
755
self.builder.record_delete(path, file_id)
756
self.reporter.deleted(path)
758
def _check_strict(self):
759
# XXX: when we use iter_changes this would likely be faster if
760
# iter_changes would check for us (even in the presence of
763
# raise an exception as soon as we find a single unknown.
764
for unknown in self.work_tree.unknowns():
765
raise StrictCommitFailed()
767
def _populate_from_inventory(self):
768
"""Populate the CommitBuilder by walking the working tree inventory."""
769
# Build the revision inventory.
771
# This starts by creating a new empty inventory. Depending on
772
# which files are selected for commit, and what is present in the
773
# current tree, the new inventory is populated. inventory entries
774
# which are candidates for modification have their revision set to
775
# None; inventory entries that are carried over untouched have their
776
# revision set to their prior value.
778
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
779
# results to create a new inventory at the same time, which results
780
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
783
specific_files = self.specific_files
784
exclude = self.exclude
785
report_changes = self.reporter.is_verbose()
787
# A tree of paths that have been deleted. E.g. if foo/bar has been
788
# deleted, then we have {'foo':{'bar':{}}}
790
# XXX: Note that entries may have the wrong kind because the entry does
791
# not reflect the status on disk.
792
work_inv = self.work_tree.inventory
793
# NB: entries will include entries within the excluded ids/paths
794
# because iter_entries_by_dir has no 'exclude' facility today.
795
entries = work_inv.iter_entries_by_dir(
796
specific_file_ids=self.specific_file_ids, yield_parents=True)
797
for path, existing_ie in entries:
798
file_id = existing_ie.file_id
799
name = existing_ie.name
800
parent_id = existing_ie.parent_id
801
kind = existing_ie.kind
802
# Skip files that have been deleted from the working tree.
803
# The deleted path ids are also recorded so they can be explicitly
806
path_segments = splitpath(path)
807
deleted_dict = deleted_paths
808
for segment in path_segments:
809
deleted_dict = deleted_dict.get(segment, None)
811
# We either took a path not present in the dict
812
# (deleted_dict was None), or we've reached an empty
813
# 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):
817
if deleted_dict is not None:
818
# the path has a deleted parent, do not add it.
820
if exclude and is_inside_any(exclude, path):
821
# Skip excluded paths. Excluded paths are processed by
822
# _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.
824
content_summary = self.work_tree.path_content_summary(path)
825
kind = content_summary[0]
826
# Note that when a filter of specific files is given, we must only
827
# skip/record deleted files matching that filter.
828
if not specific_files or is_inside_any(specific_files, path):
829
if kind == 'missing':
830
if not deleted_paths:
831
# path won't have been split yet.
832
path_segments = splitpath(path)
833
deleted_dict = deleted_paths
834
for segment in path_segments:
835
deleted_dict = deleted_dict.setdefault(segment, {})
836
self.reporter.missing(path)
837
self._next_progress_entry()
838
deleted_ids.append(file_id)
840
# TODO: have the builder do the nested commit just-in-time IF and
842
if kind == 'tree-reference':
843
# enforce repository nested tree policy.
844
if (not self.work_tree.supports_tree_reference() or
845
# repository does not support it either.
846
not self.branch.repository._format.supports_tree_reference):
848
content_summary = (kind, None, None, None)
849
elif self.recursive == 'down':
850
nested_revision_id = self._commit_nested_tree(
852
content_summary = (kind, None, None, nested_revision_id)
854
nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
content_summary = (kind, None, None, nested_revision_id)
857
# Record an entry for this item
858
# Note: I don't particularly want to have the existing_ie
859
# parameter but the test suite currently (28-Jun-07) breaks
860
# without it thanks to a unicode normalisation issue. :-(
861
definitely_changed = kind != existing_ie.kind
862
self._record_entry(path, file_id, specific_files, kind, name,
863
parent_id, definitely_changed, existing_ie, report_changes,
866
# Unversion IDs that were found to be deleted
867
self.deleted_ids = deleted_ids
869
def _commit_nested_tree(self, file_id, path):
870
"Commit a nested tree."
871
sub_tree = self.work_tree.get_nested_tree(file_id, path)
872
# FIXME: be more comprehensive here:
873
# this works when both trees are in --trees repository,
874
# but when both are bound to a different repository,
875
# it fails; a better way of approaching this is to
876
# finally implement the explicit-caches approach design
877
# a while back - RBC 20070306.
878
if sub_tree.branch.repository.has_same_location(
879
self.work_tree.branch.repository):
880
sub_tree.branch.repository = \
881
self.work_tree.branch.repository
883
return sub_tree.commit(message=None, revprops=self.revprops,
884
recursive=self.recursive,
885
message_callback=self.message_callback,
886
timestamp=self.timestamp, timezone=self.timezone,
887
committer=self.committer,
888
allow_pointless=self.allow_pointless,
889
strict=self.strict, verbose=self.verbose,
890
local=self.local, reporter=self.reporter)
891
except errors.PointlessCommit:
892
return self.work_tree.get_reference_revision(file_id)
894
def _record_entry(self, path, file_id, specific_files, kind, name,
895
parent_id, definitely_changed, existing_ie, report_changes,
897
"Record the new inventory entry for a path if any."
898
# mutter('check %s {%s}', path, file_id)
899
# mutter('%s selected for commit', path)
900
if definitely_changed or existing_ie is None:
901
ie = make_entry(kind, name, parent_id, file_id)
903
ie = existing_ie.copy()
905
# For carried over entries we don't care about the fs hash - the repo
906
# isn't generating a sha, so we're not saving computation time.
907
_, _, fs_hash = self.builder.record_entry_contents(
908
ie, self.parent_invs, path, self.work_tree, content_summary)
910
self._report_change(ie, path)
912
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
915
def _report_change(self, ie, path):
916
"""Report a change to the user.
918
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())
921
if (self.basis_inv.has_id(ie.file_id)):
922
basis_ie = self.basis_inv[ie.file_id]
925
change = ie.describe_change(basis_ie, ie)
926
if change in (InventoryEntry.RENAMED,
927
InventoryEntry.MODIFIED_AND_RENAMED):
928
old_path = self.basis_inv.id2path(ie.file_id)
929
self.reporter.renamed(change, old_path, path)
930
self._next_progress_entry()
932
if change == 'unchanged':
512
934
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))
935
self._next_progress_entry()
937
def _set_progress_stage(self, name, counter=False):
938
"""Set the progress stage and emit an update to the progress bar."""
939
self.pb_stage_name = name
940
self.pb_stage_count += 1
942
self.pb_entries_count = 0
944
self.pb_entries_count = None
945
self._emit_progress()
947
def _next_progress_entry(self):
948
"""Emit an update to the progress bar and increment the entry count."""
949
self.pb_entries_count += 1
950
self._emit_progress()
952
def _emit_progress(self):
953
if self.pb_entries_count is not None:
954
text = "%s [%d] - Stage" % (self.pb_stage_name,
955
self.pb_entries_count)
957
text = "%s - Stage" % (self.pb_stage_name, )
958
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
960
def _set_specific_file_ids(self):
961
"""populate self.specific_file_ids if we will use it."""
962
if not self.use_record_iter_changes:
963
# If provided, ensure the specified files are versioned
964
if self.specific_files is not None:
965
# Note: This routine is being called because it raises
966
# PathNotVersionedError as a side effect of finding the IDs. We
967
# later use the ids we found as input to the working tree
968
# inventory iterator, so we only consider those ids rather than
969
# examining the whole tree again.
970
# XXX: Dont we have filter_unversioned to do this more
972
self.specific_file_ids = tree.find_ids_across_trees(
973
self.specific_files, [self.basis_tree, self.work_tree])
975
self.specific_file_ids = None
added
removed
bzrlib/commit.py
