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
# 2 extra stages: "Uploading data to master branch" and "Merging
384
# tags to master branch"
385
self.pb_stage_total += 2
386
self.pb.show_pct = False
387
self.pb.show_spinner = False
388
self.pb.show_eta = False
389
self.pb.show_count = True
390
self.pb.show_bar = True
392
self._gather_parents()
393
# After a merge, a selected file commit is not supported.
394
# See 'bzr help merge' for an explanation as to why.
395
if len(self.parents) > 1 and self.specific_files is not None:
396
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
397
# Excludes are a form of selected file commit.
398
if len(self.parents) > 1 and self.exclude:
399
raise errors.CannotCommitSelectedFileMerge(self.exclude)
401
# Collect the changes
402
self._set_progress_stage("Collecting changes", counter=True)
403
self.builder = self.branch.get_commit_builder(self.parents,
404
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)
407
self.builder.will_record_deletes()
408
# find the location being committed to
409
if self.bound_branch:
410
master_location = self.master_branch.base
412
master_location = self.branch.base
414
# report the start of the commit
415
self.reporter.started(new_revno, self.rev_id, master_location)
417
self._update_builder_with_changes()
418
self._check_pointless()
420
# TODO: Now the new inventory is known, check for conflicts.
421
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
422
# weave lines, because nothing should be recorded until it is known
423
# that commit will succeed.
424
self._set_progress_stage("Saving data locally")
425
self.builder.finish_inventory()
427
# Prompt the user for a commit message if none provided
428
message = message_callback(self)
290
429
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):
431
# Add revision data to the local branch
432
self.rev_id = self.builder.commit(self.message)
435
mutter("aborting commit write group because of exception:")
436
trace.log_exception_quietly()
437
note("aborting commit write group: %r" % (e,))
441
self._process_pre_hooks(old_revno, new_revno)
443
# Upload revision data to the master.
444
# this will propagate merged revisions too if needed.
445
if self.bound_branch:
446
self._set_progress_stage("Uploading data to master branch")
447
# 'commit' to the master first so a timeout here causes the
448
# local branch to be out of date
449
self.master_branch.import_last_revision_info(
450
self.branch.repository, new_revno, self.rev_id)
452
# and now do the commit locally.
453
self.branch.set_last_revision_info(new_revno, self.rev_id)
455
# Merge local tags to remote
456
if self.bound_branch:
457
self._set_progress_stage("Merging tags to master branch")
458
tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
460
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
461
note("Conflicting tags in bound branch:\n" +
462
"\n".join(warning_lines))
464
# Make the working tree be up to date with the branch. This
465
# includes automatic changes scheduled to be made to the tree, such
466
# as updating its basis and unversioning paths that were missing.
467
self.work_tree.unversion(self.deleted_ids)
468
self._set_progress_stage("Updating the working tree")
469
self.work_tree.update_basis_by_delta(self.rev_id,
470
self.builder.get_basis_delta())
471
self.reporter.completed(new_revno, self.rev_id)
472
self._process_post_hooks(old_revno, new_revno)
475
def _select_reporter(self):
476
"""Select the CommitReporter to use."""
478
return NullCommitReporter()
479
return ReportCommitToLog()
481
def _check_pointless(self):
482
if self.allow_pointless:
484
# A merge with no effect on files
485
if len(self.parents) > 1:
487
# TODO: we could simplify this by using self.builder.basis_delta.
489
# The initial commit adds a root directory, but this in itself is not
490
# a worthwhile commit.
491
if (self.basis_revid == revision.NULL_REVISION and
492
((self.builder.new_inventory is not None and
493
len(self.builder.new_inventory) == 1) or
494
len(self.builder._basis_delta) == 1)):
495
raise PointlessCommit()
496
if self.builder.any_changes():
498
raise PointlessCommit()
500
def _check_bound_branch(self, operation, possible_master_transports=None):
354
501
"""Check to see if the local branch is bound.
356
503
If it is bound, then most of the commit will actually be
390
538
# so grab the lock
391
539
self.bound_branch = self.branch
392
540
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
541
operation.add_cleanup(self.master_branch.unlock)
543
def _check_out_of_date_tree(self):
544
"""Check that the working tree is up to date.
546
:return: old_revision_number,new_revision_number tuple
549
first_tree_parent = self.work_tree.get_parent_ids()[0]
551
# if there are no parents, treat our parent as 'None'
552
# this is so that we still consider the master branch
553
# - in a checkout scenario the tree may have no
554
# parents but the branch may do.
555
first_tree_parent = bzrlib.revision.NULL_REVISION
556
old_revno, master_last = self.master_branch.last_revision_info()
557
if master_last != first_tree_parent:
558
if master_last != bzrlib.revision.NULL_REVISION:
559
raise errors.OutOfDateTree(self.work_tree)
560
if self.branch.repository.has_revision(first_tree_parent):
561
new_revno = old_revno + 1
563
# ghost parents never appear in revision history.
565
return old_revno,new_revno
567
def _process_pre_hooks(self, old_revno, new_revno):
568
"""Process any registered pre commit hooks."""
569
self._set_progress_stage("Running pre_commit hooks")
570
self._process_hooks("pre_commit", old_revno, new_revno)
572
def _process_post_hooks(self, old_revno, new_revno):
573
"""Process any registered post commit hooks."""
574
# Process the post commit hooks, if any
575
self._set_progress_stage("Running post_commit hooks")
576
# old style commit hooks - should be deprecated ? (obsoleted in
578
if self.config.post_commit() is not None:
579
hooks = self.config.post_commit().split(' ')
580
# this would be nicer with twisted.python.reflect.namedAny
582
result = eval(hook + '(branch, rev_id)',
583
{'branch':self.branch,
585
'rev_id':self.rev_id})
586
# process new style post commit hooks
587
self._process_hooks("post_commit", old_revno, new_revno)
589
def _process_hooks(self, hook_name, old_revno, new_revno):
590
if not Branch.hooks[hook_name]:
593
# new style commit hooks:
410
594
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)
595
hook_master = self.branch
598
hook_master = self.master_branch
599
hook_local = self.branch
600
# With bound branches, when the master is behind the local branch,
601
# the 'old_revno' and old_revid values here are incorrect.
602
# XXX: FIXME ^. RBC 20060206
604
old_revid = self.parents[0]
606
old_revid = bzrlib.revision.NULL_REVISION
608
if hook_name == "pre_commit":
609
future_tree = self.builder.revision_tree()
610
tree_delta = future_tree.changes_from(self.basis_tree,
613
for hook in Branch.hooks[hook_name]:
614
# show the running hook in the progress bar. As hooks may
615
# end up doing nothing (e.g. because they are not configured by
616
# the user) this is still showing progress, not showing overall
617
# actions - its up to each plugin to show a UI if it want's to
618
# (such as 'Emailing diff to foo@example.com').
619
self.pb_stage_name = "Running %s hooks [%s]" % \
620
(hook_name, Branch.hooks.get_hook_name(hook))
621
self._emit_progress()
622
if 'hooks' in debug.debug_flags:
623
mutter("Invoking commit hook: %r", hook)
624
if hook_name == "post_commit":
625
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
627
elif hook_name == "pre_commit":
628
hook(hook_local, hook_master,
629
old_revno, old_revid, new_revno, self.rev_id,
630
tree_delta, future_tree)
428
632
def _gather_parents(self):
429
633
"""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:
634
# TODO: Make sure that this list doesn't contain duplicate
635
# entries and the order is preserved when doing this.
636
if self.use_record_iter_changes:
638
self.basis_inv = self.basis_tree.inventory
639
self.parent_invs = [self.basis_inv]
640
for revision in self.parents[1:]:
439
641
if self.branch.repository.has_revision(revision):
642
mutter('commit parent revision {%s}', revision)
440
643
inventory = self.branch.repository.get_inventory(revision)
441
644
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)
646
mutter('commit parent ghost revision {%s}', revision)
648
def _update_builder_with_changes(self):
649
"""Update the commit builder with the data about what has changed.
651
exclude = self.exclude
652
specific_files = self.specific_files
653
mutter("Selecting files for commit with filter %s", specific_files)
656
if self.use_record_iter_changes:
657
iter_changes = self.work_tree.iter_changes(self.basis_tree,
658
specific_files=specific_files)
659
iter_changes = self._filter_iter_changes(iter_changes)
660
for file_id, path, fs_hash in self.builder.record_iter_changes(
661
self.work_tree, self.basis_revid, iter_changes):
662
self.work_tree._observed_sha1(file_id, path, fs_hash)
664
# Build the new inventory
665
self._populate_from_inventory()
666
self._record_unselected()
667
self._report_and_accumulate_deletes()
669
def _filter_iter_changes(self, iter_changes):
670
"""Process iter_changes.
672
This method reports on the changes in iter_changes to the user, and
673
converts 'missing' entries in the iter_changes iterator to 'deleted'
674
entries. 'missing' entries have their
676
:param iter_changes: An iter_changes to process.
677
:return: A generator of changes.
679
reporter = self.reporter
680
report_changes = reporter.is_verbose()
682
for change in iter_changes:
684
old_path = change[1][0]
685
new_path = change[1][1]
686
versioned = change[3][1]
688
versioned = change[3][1]
689
if kind is None and versioned:
692
reporter.missing(new_path)
693
deleted_ids.append(change[0])
694
# Reset the new path (None) and new versioned flag (False)
695
change = (change[0], (change[1][0], None), change[2],
696
(change[3][0], False)) + change[4:]
697
elif kind == 'tree-reference':
698
if self.recursive == 'down':
699
self._commit_nested_tree(change[0], change[1][1])
700
if change[3][0] or change[3][1]:
704
reporter.deleted(old_path)
705
elif old_path is None:
706
reporter.snapshot_change('added', new_path)
707
elif old_path != new_path:
708
reporter.renamed('renamed', old_path, new_path)
711
self.work_tree.branch.repository._format.rich_root_data):
712
# Don't report on changes to '' in non rich root
714
reporter.snapshot_change('modified', new_path)
715
self._next_progress_entry()
716
# Unversion IDs that were found to be deleted
717
self.deleted_ids = deleted_ids
719
def _record_unselected(self):
720
# If specific files are selected, then all un-selected files must be
721
# recorded in their previous state. For more details, see
722
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
723
if self.specific_files or self.exclude:
724
specific_files = self.specific_files or []
725
for path, old_ie in self.basis_inv.iter_entries():
726
if old_ie.file_id in self.builder.new_inventory:
727
# already added - skip.
729
if (is_inside_any(specific_files, path)
730
and not is_inside_any(self.exclude, path)):
731
# was inside the selected path, and not excluded - if not
732
# present it has been deleted so skip.
734
# From here down it was either not selected, or was excluded:
735
# We preserve the entry unaltered.
737
# Note: specific file commits after a merge are currently
738
# prohibited. This test is for sanity/safety in case it's
739
# required after that changes.
740
if len(self.parents) > 1:
742
self.builder.record_entry_contents(ie, self.parent_invs, path,
743
self.basis_tree, None)
745
def _report_and_accumulate_deletes(self):
746
if (isinstance(self.basis_inv, Inventory)
747
and isinstance(self.builder.new_inventory, Inventory)):
748
# the older Inventory classes provide a _byid dict, and building a
749
# set from the keys of this dict is substantially faster than even
750
# getting a set of ids from the inventory
752
# <lifeless> set(dict) is roughly the same speed as
753
# set(iter(dict)) and both are significantly slower than
755
deleted_ids = set(self.basis_inv._byid.keys()) - \
756
set(self.builder.new_inventory._byid.keys())
758
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
760
self.any_entries_deleted = True
761
deleted = [(self.basis_tree.id2path(file_id), file_id)
762
for file_id in deleted_ids]
764
# XXX: this is not quite directory-order sorting
765
for path, file_id in deleted:
766
self.builder.record_delete(path, file_id)
767
self.reporter.deleted(path)
769
def _check_strict(self):
770
# XXX: when we use iter_changes this would likely be faster if
771
# iter_changes would check for us (even in the presence of
774
# raise an exception as soon as we find a single unknown.
775
for unknown in self.work_tree.unknowns():
776
raise StrictCommitFailed()
778
def _populate_from_inventory(self):
779
"""Populate the CommitBuilder by walking the working tree inventory."""
780
# Build the revision inventory.
782
# This starts by creating a new empty inventory. Depending on
783
# which files are selected for commit, and what is present in the
784
# current tree, the new inventory is populated. inventory entries
785
# which are candidates for modification have their revision set to
786
# None; inventory entries that are carried over untouched have their
787
# revision set to their prior value.
789
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
790
# results to create a new inventory at the same time, which results
791
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
794
specific_files = self.specific_files
795
exclude = self.exclude
796
report_changes = self.reporter.is_verbose()
798
# A tree of paths that have been deleted. E.g. if foo/bar has been
799
# deleted, then we have {'foo':{'bar':{}}}
801
# XXX: Note that entries may have the wrong kind because the entry does
802
# not reflect the status on disk.
803
work_inv = self.work_tree.inventory
804
# NB: entries will include entries within the excluded ids/paths
805
# because iter_entries_by_dir has no 'exclude' facility today.
806
entries = work_inv.iter_entries_by_dir(
807
specific_file_ids=self.specific_file_ids, yield_parents=True)
808
for path, existing_ie in entries:
809
file_id = existing_ie.file_id
810
name = existing_ie.name
811
parent_id = existing_ie.parent_id
812
kind = existing_ie.kind
813
# Skip files that have been deleted from the working tree.
814
# The deleted path ids are also recorded so they can be explicitly
817
path_segments = splitpath(path)
818
deleted_dict = deleted_paths
819
for segment in path_segments:
820
deleted_dict = deleted_dict.get(segment, None)
822
# We either took a path not present in the dict
823
# (deleted_dict was None), or we've reached an empty
824
# 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):
828
if deleted_dict is not None:
829
# the path has a deleted parent, do not add it.
831
if exclude and is_inside_any(exclude, path):
832
# Skip excluded paths. Excluded paths are processed by
833
# _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.
835
content_summary = self.work_tree.path_content_summary(path)
836
kind = content_summary[0]
837
# Note that when a filter of specific files is given, we must only
838
# skip/record deleted files matching that filter.
839
if not specific_files or is_inside_any(specific_files, path):
840
if kind == 'missing':
841
if not deleted_paths:
842
# path won't have been split yet.
843
path_segments = splitpath(path)
844
deleted_dict = deleted_paths
845
for segment in path_segments:
846
deleted_dict = deleted_dict.setdefault(segment, {})
847
self.reporter.missing(path)
848
self._next_progress_entry()
849
deleted_ids.append(file_id)
851
# TODO: have the builder do the nested commit just-in-time IF and
853
if kind == 'tree-reference':
854
# enforce repository nested tree policy.
855
if (not self.work_tree.supports_tree_reference() or
856
# repository does not support it either.
857
not self.branch.repository._format.supports_tree_reference):
859
content_summary = (kind, None, None, None)
860
elif self.recursive == 'down':
861
nested_revision_id = self._commit_nested_tree(
863
content_summary = (kind, None, None, nested_revision_id)
865
nested_revision_id = self.work_tree.get_reference_revision(file_id)
866
content_summary = (kind, None, None, nested_revision_id)
868
# Record an entry for this item
869
# Note: I don't particularly want to have the existing_ie
870
# parameter but the test suite currently (28-Jun-07) breaks
871
# without it thanks to a unicode normalisation issue. :-(
872
definitely_changed = kind != existing_ie.kind
873
self._record_entry(path, file_id, specific_files, kind, name,
874
parent_id, definitely_changed, existing_ie, report_changes,
877
# Unversion IDs that were found to be deleted
878
self.deleted_ids = deleted_ids
880
def _commit_nested_tree(self, file_id, path):
881
"Commit a nested tree."
882
sub_tree = self.work_tree.get_nested_tree(file_id, path)
883
# FIXME: be more comprehensive here:
884
# this works when both trees are in --trees repository,
885
# but when both are bound to a different repository,
886
# it fails; a better way of approaching this is to
887
# finally implement the explicit-caches approach design
888
# a while back - RBC 20070306.
889
if sub_tree.branch.repository.has_same_location(
890
self.work_tree.branch.repository):
891
sub_tree.branch.repository = \
892
self.work_tree.branch.repository
894
return sub_tree.commit(message=None, revprops=self.revprops,
895
recursive=self.recursive,
896
message_callback=self.message_callback,
897
timestamp=self.timestamp, timezone=self.timezone,
898
committer=self.committer,
899
allow_pointless=self.allow_pointless,
900
strict=self.strict, verbose=self.verbose,
901
local=self.local, reporter=self.reporter)
902
except errors.PointlessCommit:
903
return self.work_tree.get_reference_revision(file_id)
905
def _record_entry(self, path, file_id, specific_files, kind, name,
906
parent_id, definitely_changed, existing_ie, report_changes,
908
"Record the new inventory entry for a path if any."
909
# mutter('check %s {%s}', path, file_id)
910
# mutter('%s selected for commit', path)
911
if definitely_changed or existing_ie is None:
912
ie = make_entry(kind, name, parent_id, file_id)
914
ie = existing_ie.copy()
916
# For carried over entries we don't care about the fs hash - the repo
917
# isn't generating a sha, so we're not saving computation time.
918
_, _, fs_hash = self.builder.record_entry_contents(
919
ie, self.parent_invs, path, self.work_tree, content_summary)
921
self._report_change(ie, path)
923
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
926
def _report_change(self, ie, path):
927
"""Report a change to the user.
929
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())
932
if (self.basis_inv.has_id(ie.file_id)):
933
basis_ie = self.basis_inv[ie.file_id]
936
change = ie.describe_change(basis_ie, ie)
937
if change in (InventoryEntry.RENAMED,
938
InventoryEntry.MODIFIED_AND_RENAMED):
939
old_path = self.basis_inv.id2path(ie.file_id)
940
self.reporter.renamed(change, old_path, path)
941
self._next_progress_entry()
943
if change == 'unchanged':
512
945
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))
946
self._next_progress_entry()
948
def _set_progress_stage(self, name, counter=False):
949
"""Set the progress stage and emit an update to the progress bar."""
950
self.pb_stage_name = name
951
self.pb_stage_count += 1
953
self.pb_entries_count = 0
955
self.pb_entries_count = None
956
self._emit_progress()
958
def _next_progress_entry(self):
959
"""Emit an update to the progress bar and increment the entry count."""
960
self.pb_entries_count += 1
961
self._emit_progress()
963
def _emit_progress(self):
964
if self.pb_entries_count is not None:
965
text = "%s [%d] - Stage" % (self.pb_stage_name,
966
self.pb_entries_count)
968
text = "%s - Stage" % (self.pb_stage_name, )
969
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
971
def _set_specific_file_ids(self):
972
"""populate self.specific_file_ids if we will use it."""
973
if not self.use_record_iter_changes:
974
# If provided, ensure the specified files are versioned
975
if self.specific_files is not None:
976
# Note: This routine is being called because it raises
977
# PathNotVersionedError as a side effect of finding the IDs. We
978
# later use the ids we found as input to the working tree
979
# inventory iterator, so we only consider those ids rather than
980
# examining the whole tree again.
981
# XXX: Dont we have filter_unversioned to do this more
983
self.specific_file_ids = tree.find_ids_across_trees(
984
self.specific_files, [self.basis_tree, self.work_tree])
986
self.specific_file_ids = None
added
removed
bzrlib/commit.py
