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.
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.
72
from binascii import hexlify
73
57
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,
67
from bzrlib.branch import Branch
81
68
import bzrlib.config
82
import bzrlib.errors as errors
83
69
from bzrlib.errors import (BzrError, PointlessCommit,
88
from bzrlib.revision import Revision
73
from bzrlib.osutils import (get_user_encoding,
74
kind_marker, isdir,isfile, is_inside_any,
75
is_inside_or_parent_of_any,
76
minimum_path_selection,
77
quotefn, sha_file, split_lines,
89
80
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 *
81
from bzrlib.trace import mutter, note, warning, is_quiet
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
83
from bzrlib import symbol_versioning
84
from bzrlib.symbol_versioning import (deprecated_passed,
94
87
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)
88
from bzrlib.urlutils import unescape_for_display
109
92
class NullCommitReporter(object):
110
93
"""I report on progress of a commit."""
95
def started(self, revno, revid, location=None):
97
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
98
"to started.", DeprecationWarning,
112
102
def snapshot_change(self, change, path):
115
105
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
108
def deleted(self, path):
124
111
def missing(self, path):
114
def renamed(self, change, old_path, new_path):
117
def is_verbose(self):
128
121
class ReportCommitToLog(NullCommitReporter):
123
def _note(self, format, *args):
126
Subclasses may choose to override this method.
130
130
def snapshot_change(self, change, path):
131
if change == 'unchanged':
131
if path == '' and change in ('added', 'modified'):
133
note("%s %s", change, path)
133
self._note("%s %s", change, path)
135
def started(self, revno, rev_id, location=None):
136
if location is not None:
137
location = ' to: ' + unescape_for_display(location, 'utf-8')
139
# When started was added, location was only made optional by
140
# accident. Matt Nordhoff 20071129
141
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
142
"to started.", DeprecationWarning,
145
self._note('Committing%s', location)
135
147
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
148
self._note('Committed revision %d.', revno)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
150
def deleted(self, path):
151
self._note('deleted %s', path)
144
153
def missing(self, path):
145
note('missing %s', path)
154
self._note('missing %s', path)
156
def renamed(self, change, old_path, new_path):
157
self._note('%s %s => %s', change, old_path, new_path)
159
def is_verbose(self):
148
163
class Commit(object):
183
196
working_tree=None,
200
message_callback=None,
203
possible_master_transports=None):
187
204
"""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.
206
:param message: the commit message (it or message_callback is required)
208
:param timestamp: if not None, seconds-since-epoch for a
209
postdated/predated commit.
211
:param specific_files: If true, commit only those files.
213
:param rev_id: If set, use this as the new revision id.
200
214
Useful for test or import commands that need to tightly
201
215
control what revisions are assigned. If you duplicate
202
216
a revision id that exists elsewhere it is your own fault.
203
217
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
219
:param allow_pointless: If true (default), commit even if nothing
206
220
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
222
:param strict: If true, don't allow a commit if the working tree
209
223
contains unknown files.
211
revprops -- Properties for new revision
225
:param revprops: Properties for new revision
212
226
:param local: Perform a local only commit.
227
:param reporter: the reporter to use or None for the default
228
:param verbose: if True and the reporter is not None, report everything
229
:param recursive: If set to 'down', commit in any subtrees that have
230
pending changes of any sort during this commit.
231
:param exclude: None or a list of relative paths to exclude from the
232
commit. Pending changes to excluded files will be ignored by the
214
235
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().")
237
if working_tree is None:
238
raise BzrError("working_tree must be passed into commit().")
225
240
self.work_tree = working_tree
226
241
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
242
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
243
if not self.branch.repository.supports_rich_root():
244
raise errors.RootNotRich()
245
if message_callback is None:
246
if message is not None:
247
if isinstance(message, str):
248
message = message.decode(get_user_encoding())
249
message_callback = lambda x: message
251
raise BzrError("The message or message_callback keyword"
252
" parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
254
self.bound_branch = None
255
self.any_entries_deleted = False
256
if exclude is not None:
257
self.exclude = sorted(
258
minimum_path_selection(exclude))
232
261
self.local = local
233
262
self.master_branch = None
234
263
self.master_locked = False
236
self.specific_files = specific_files
264
self.recursive = recursive
266
if specific_files is not None:
267
self.specific_files = sorted(
268
minimum_path_selection(specific_files))
270
self.specific_files = None
237
272
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
273
self.revprops = revprops
274
self.message_callback = message_callback
275
self.timestamp = timestamp
276
self.timezone = timezone
277
self.committer = committer
279
self.verbose = verbose
247
281
self.work_tree.lock_write()
282
self.parents = self.work_tree.get_parent_ids()
283
# We can use record_iter_changes IFF iter_changes is compatible with
284
# the command line parameters, and the repository has fast delta
285
# generation. See bug 347649.
286
self.use_record_iter_changes = (
287
not self.specific_files and
289
not self.branch.repository._format.supports_tree_reference and
290
(self.branch.repository._format.fast_deltas or
291
len(self.parents) < 2))
292
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
293
self.basis_revid = self.work_tree.last_revision()
294
self.basis_tree = self.work_tree.basis_tree()
295
self.basis_tree.lock_read()
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)
297
# Cannot commit with conflicts present.
298
if len(self.work_tree.conflicts()) > 0:
299
raise ConflictsInTree
301
# Setup the bound branch variables as needed.
302
self._check_bound_branch(possible_master_transports)
304
# Check that the working tree is up to date
305
old_revno, new_revno = self._check_out_of_date_tree()
307
# Complete configuration setup
308
if reporter is not None:
309
self.reporter = reporter
310
elif self.reporter is None:
311
self.reporter = self._select_reporter()
268
312
if self.config is None:
269
self.config = bzrlib.config.BranchConfig(self.branch)
272
self.rev_id = _gen_revision_id(self.config, self.timestamp)
276
if committer is None:
277
self.committer = self.config.username()
279
assert isinstance(committer, basestring), type(committer)
280
self.committer = committer
283
self.timezone = local_time_offset()
285
self.timezone = int(timezone)
287
if isinstance(message, str):
288
message = message.decode(bzrlib.user_encoding)
289
assert isinstance(message, unicode), type(message)
290
self.message = message
291
self._escape_commit_message()
293
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
295
self.basis_inv = self.basis_tree.inventory
313
self.config = self.branch.get_config()
315
self._set_specific_file_ids()
317
# Setup the progress bar. As the number of files that need to be
318
# committed in unknown, progress is reported as stages.
319
# We keep track of entries separately though and include that
320
# information in the progress bar during the relevant stages.
321
self.pb_stage_name = ""
322
self.pb_stage_count = 0
323
self.pb_stage_total = 5
324
if self.bound_branch:
325
self.pb_stage_total += 1
326
self.pb.show_pct = False
327
self.pb.show_spinner = False
328
self.pb.show_eta = False
329
self.pb.show_count = True
330
self.pb.show_bar = True
297
332
self._gather_parents()
333
# After a merge, a selected file commit is not supported.
334
# See 'bzr help merge' for an explanation as to why.
298
335
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.
336
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
337
# Excludes are a form of selected file commit.
338
if len(self.parents) > 1 and self.exclude:
339
raise errors.CannotCommitSelectedFileMerge(self.exclude)
341
# Collect the changes
342
self._set_progress_stage("Collecting changes", counter=True)
343
self.builder = self.branch.get_commit_builder(self.parents,
344
self.config, timestamp, timezone, committer, revprops, rev_id)
347
self.builder.will_record_deletes()
348
# find the location being committed to
349
if self.bound_branch:
350
master_location = self.master_branch.base
352
master_location = self.branch.base
354
# report the start of the commit
355
self.reporter.started(new_revno, self.rev_id, master_location)
357
self._update_builder_with_changes()
358
self._check_pointless()
360
# TODO: Now the new inventory is known, check for conflicts.
361
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
362
# weave lines, because nothing should be recorded until it is known
363
# that commit will succeed.
364
self._set_progress_stage("Saving data locally")
365
self.builder.finish_inventory()
367
# Prompt the user for a commit message if none provided
368
message = message_callback(self)
369
self.message = message
371
# Add revision data to the local branch
372
self.rev_id = self.builder.commit(self.message)
375
mutter("aborting commit write group because of exception:")
376
trace.log_exception_quietly()
377
note("aborting commit write group: %r" % (e,))
381
self._process_pre_hooks(old_revno, new_revno)
383
# Upload revision data to the master.
384
# this will propagate merged revisions too if needed.
325
385
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)
386
self._set_progress_stage("Uploading data to master branch")
387
# 'commit' to the master first so a timeout here causes the
388
# local branch to be out of date
389
self.master_branch.import_last_revision_info(
390
self.branch.repository, new_revno, self.rev_id)
333
392
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
393
self.branch.set_last_revision_info(new_revno, 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})
395
# Make the working tree up to date with the branch
396
self._set_progress_stage("Updating the working tree")
397
self.work_tree.update_basis_by_delta(self.rev_id,
398
self.builder.get_basis_delta())
399
self.reporter.completed(new_revno, self.rev_id)
400
self._process_post_hooks(old_revno, new_revno)
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
405
def _select_reporter(self):
406
"""Select the CommitReporter to use."""
408
return NullCommitReporter()
409
return ReportCommitToLog()
411
def _check_pointless(self):
412
if self.allow_pointless:
414
# A merge with no effect on files
415
if len(self.parents) > 1:
417
# TODO: we could simplify this by using self.builder.basis_delta.
419
# The initial commit adds a root directory, but this in itself is not
420
# a worthwhile commit.
421
if (self.basis_revid == revision.NULL_REVISION and
422
((self.builder.new_inventory is not None and
423
len(self.builder.new_inventory) == 1) or
424
len(self.builder._basis_delta) == 1)):
425
raise PointlessCommit()
426
if self.builder.any_changes():
428
raise PointlessCommit()
430
def _check_bound_branch(self, possible_master_transports=None):
354
431
"""Check to see if the local branch is bound.
356
433
If it is bound, then most of the commit will actually be
391
469
self.bound_branch = self.branch
392
470
self.master_branch.lock_write()
393
471
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)
473
def _check_out_of_date_tree(self):
474
"""Check that the working tree is up to date.
476
:return: old_revision_number,new_revision_number tuple
479
first_tree_parent = self.work_tree.get_parent_ids()[0]
481
# if there are no parents, treat our parent as 'None'
482
# this is so that we still consider the master branch
483
# - in a checkout scenario the tree may have no
484
# parents but the branch may do.
485
first_tree_parent = bzrlib.revision.NULL_REVISION
486
old_revno, master_last = self.master_branch.last_revision_info()
487
if master_last != first_tree_parent:
488
if master_last != bzrlib.revision.NULL_REVISION:
489
raise errors.OutOfDateTree(self.work_tree)
490
if self.branch.repository.has_revision(first_tree_parent):
491
new_revno = old_revno + 1
493
# ghost parents never appear in revision history.
495
return old_revno,new_revno
497
def _process_pre_hooks(self, old_revno, new_revno):
498
"""Process any registered pre commit hooks."""
499
self._set_progress_stage("Running pre_commit hooks")
500
self._process_hooks("pre_commit", old_revno, new_revno)
502
def _process_post_hooks(self, old_revno, new_revno):
503
"""Process any registered post commit hooks."""
504
# Process the post commit hooks, if any
505
self._set_progress_stage("Running post_commit hooks")
506
# old style commit hooks - should be deprecated ? (obsoleted in
508
if self.config.post_commit() is not None:
509
hooks = self.config.post_commit().split(' ')
510
# this would be nicer with twisted.python.reflect.namedAny
512
result = eval(hook + '(branch, rev_id)',
513
{'branch':self.branch,
515
'rev_id':self.rev_id})
516
# process new style post commit hooks
517
self._process_hooks("post_commit", old_revno, new_revno)
519
def _process_hooks(self, hook_name, old_revno, new_revno):
520
if not Branch.hooks[hook_name]:
523
# new style commit hooks:
524
if not self.bound_branch:
525
hook_master = self.branch
528
hook_master = self.master_branch
529
hook_local = self.branch
530
# With bound branches, when the master is behind the local branch,
531
# the 'old_revno' and old_revid values here are incorrect.
532
# XXX: FIXME ^. RBC 20060206
534
old_revid = self.parents[0]
536
old_revid = bzrlib.revision.NULL_REVISION
538
if hook_name == "pre_commit":
539
future_tree = self.builder.revision_tree()
540
tree_delta = future_tree.changes_from(self.basis_tree,
543
for hook in Branch.hooks[hook_name]:
544
# show the running hook in the progress bar. As hooks may
545
# end up doing nothing (e.g. because they are not configured by
546
# the user) this is still showing progress, not showing overall
547
# actions - its up to each plugin to show a UI if it want's to
548
# (such as 'Emailing diff to foo@example.com').
549
self.pb_stage_name = "Running %s hooks [%s]" % \
550
(hook_name, Branch.hooks.get_hook_name(hook))
551
self._emit_progress()
552
if 'hooks' in debug.debug_flags:
553
mutter("Invoking commit hook: %r", hook)
554
if hook_name == "post_commit":
555
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
557
elif hook_name == "pre_commit":
558
hook(hook_local, hook_master,
559
old_revno, old_revid, new_revno, self.rev_id,
560
tree_delta, future_tree)
563
"""Cleanup any open locks, progress bars etc."""
564
cleanups = [self._cleanup_bound_branch,
565
self.basis_tree.unlock,
566
self.work_tree.unlock,
568
found_exception = None
569
for cleanup in cleanups:
572
# we want every cleanup to run no matter what.
573
# so we have a catchall here, but we will raise the
574
# last encountered exception up the stack: and
575
# typically this will be useful enough.
578
if found_exception is not None:
579
# don't do a plan raise, because the last exception may have been
580
# trashed, e is our sure-to-work exception even though it loses the
581
# full traceback. XXX: RBC 20060421 perhaps we could check the
582
# exc_info and if its the same one do a plain raise otherwise
583
# 'raise e' as we do now.
403
586
def _cleanup_bound_branch(self):
404
587
"""Executed at the end of a try/finally to cleanup a bound branch.
412
595
if self.master_locked:
413
596
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)
428
598
def _gather_parents(self):
429
599
"""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:
600
# TODO: Make sure that this list doesn't contain duplicate
601
# entries and the order is preserved when doing this.
602
if self.use_record_iter_changes:
604
self.basis_inv = self.basis_tree.inventory
605
self.parent_invs = [self.basis_inv]
606
for revision in self.parents[1:]:
439
607
if self.branch.repository.has_revision(revision):
608
mutter('commit parent revision {%s}', revision)
440
609
inventory = self.branch.repository.get_inventory(revision)
441
610
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)
612
mutter('commit parent ghost revision {%s}', revision)
614
def _update_builder_with_changes(self):
615
"""Update the commit builder with the data about what has changed.
617
exclude = self.exclude
618
specific_files = self.specific_files or []
619
mutter("Selecting files for commit with filter %s", specific_files)
622
if self.use_record_iter_changes:
623
iter_changes = self.work_tree.iter_changes(self.basis_tree)
624
iter_changes = self._filter_iter_changes(iter_changes)
625
for file_id, path, fs_hash in self.builder.record_iter_changes(
626
self.work_tree, self.basis_revid, iter_changes):
627
self.work_tree._observed_sha1(file_id, path, fs_hash)
629
# Build the new inventory
630
self._populate_from_inventory()
631
self._record_unselected()
632
self._report_and_accumulate_deletes()
634
def _filter_iter_changes(self, iter_changes):
635
"""Process iter_changes.
637
This method reports on the changes in iter_changes to the user, and
638
converts 'missing' entries in the iter_changes iterator to 'deleted'
639
entries. 'missing' entries have their
641
:param iter_changes: An iter_changes to process.
642
:return: A generator of changes.
644
reporter = self.reporter
645
report_changes = reporter.is_verbose()
647
for change in iter_changes:
649
old_path = change[1][0]
650
new_path = change[1][1]
651
versioned = change[3][1]
653
versioned = change[3][1]
654
if kind is None and versioned:
657
reporter.missing(new_path)
658
deleted_ids.append(change[0])
659
# Reset the new path (None) and new versioned flag (False)
660
change = (change[0], (change[1][0], None), change[2],
661
(change[3][0], False)) + change[4:]
662
elif kind == 'tree-reference':
663
if self.recursive == 'down':
664
self._commit_nested_tree(change[0], change[1][1])
665
if change[3][0] or change[3][1]:
669
reporter.deleted(old_path)
670
elif old_path is None:
671
reporter.snapshot_change('added', new_path)
672
elif old_path != new_path:
673
reporter.renamed('renamed', old_path, new_path)
676
self.work_tree.branch.repository._format.rich_root_data):
677
# Don't report on changes to '' in non rich root
679
reporter.snapshot_change('modified', new_path)
680
self._next_progress_entry()
681
# Unversion IDs that were found to be deleted
682
self.work_tree.unversion(deleted_ids)
684
def _record_unselected(self):
685
# If specific files are selected, then all un-selected files must be
686
# recorded in their previous state. For more details, see
687
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
688
if self.specific_files or self.exclude:
689
specific_files = self.specific_files or []
690
for path, old_ie in self.basis_inv.iter_entries():
691
if old_ie.file_id in self.builder.new_inventory:
692
# already added - skip.
694
if (is_inside_any(specific_files, path)
695
and not is_inside_any(self.exclude, path)):
696
# was inside the selected path, and not excluded - if not
697
# present it has been deleted so skip.
699
# From here down it was either not selected, or was excluded:
700
# We preserve the entry unaltered.
702
# Note: specific file commits after a merge are currently
703
# prohibited. This test is for sanity/safety in case it's
704
# required after that changes.
705
if len(self.parents) > 1:
707
self.builder.record_entry_contents(ie, self.parent_invs, path,
708
self.basis_tree, None)
710
def _report_and_accumulate_deletes(self):
711
if (isinstance(self.basis_inv, Inventory)
712
and isinstance(self.builder.new_inventory, Inventory)):
713
# the older Inventory classes provide a _byid dict, and building a
714
# set from the keys of this dict is substantially faster than even
715
# getting a set of ids from the inventory
717
# <lifeless> set(dict) is roughly the same speed as
718
# set(iter(dict)) and both are significantly slower than
720
deleted_ids = set(self.basis_inv._byid.keys()) - \
721
set(self.builder.new_inventory._byid.keys())
723
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
725
self.any_entries_deleted = True
726
deleted = [(self.basis_tree.id2path(file_id), file_id)
727
for file_id in deleted_ids]
729
# XXX: this is not quite directory-order sorting
730
for path, file_id in deleted:
731
self.builder.record_delete(path, file_id)
732
self.reporter.deleted(path)
734
def _check_strict(self):
735
# XXX: when we use iter_changes this would likely be faster if
736
# iter_changes would check for us (even in the presence of
739
# raise an exception as soon as we find a single unknown.
740
for unknown in self.work_tree.unknowns():
741
raise StrictCommitFailed()
743
def _populate_from_inventory(self):
744
"""Populate the CommitBuilder by walking the working tree inventory."""
745
# Build the revision inventory.
747
# This starts by creating a new empty inventory. Depending on
748
# which files are selected for commit, and what is present in the
749
# current tree, the new inventory is populated. inventory entries
750
# which are candidates for modification have their revision set to
751
# None; inventory entries that are carried over untouched have their
752
# revision set to their prior value.
754
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
755
# results to create a new inventory at the same time, which results
756
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
759
specific_files = self.specific_files
760
exclude = self.exclude
761
report_changes = self.reporter.is_verbose()
763
# A tree of paths that have been deleted. E.g. if foo/bar has been
764
# deleted, then we have {'foo':{'bar':{}}}
766
# XXX: Note that entries may have the wrong kind because the entry does
767
# not reflect the status on disk.
768
work_inv = self.work_tree.inventory
769
# NB: entries will include entries within the excluded ids/paths
770
# because iter_entries_by_dir has no 'exclude' facility today.
771
entries = work_inv.iter_entries_by_dir(
772
specific_file_ids=self.specific_file_ids, yield_parents=True)
773
for path, existing_ie in entries:
774
file_id = existing_ie.file_id
775
name = existing_ie.name
776
parent_id = existing_ie.parent_id
777
kind = existing_ie.kind
778
# Skip files that have been deleted from the working tree.
779
# The deleted path ids are also recorded so they can be explicitly
782
path_segments = splitpath(path)
783
deleted_dict = deleted_paths
784
for segment in path_segments:
785
deleted_dict = deleted_dict.get(segment, None)
787
# We either took a path not present in the dict
788
# (deleted_dict was None), or we've reached an empty
789
# 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):
793
if deleted_dict is not None:
794
# the path has a deleted parent, do not add it.
796
if exclude and is_inside_any(exclude, path):
797
# Skip excluded paths. Excluded paths are processed by
798
# _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.
800
content_summary = self.work_tree.path_content_summary(path)
801
# Note that when a filter of specific files is given, we must only
802
# skip/record deleted files matching that filter.
803
if not specific_files or is_inside_any(specific_files, path):
804
if content_summary[0] == 'missing':
805
if not deleted_paths:
806
# path won't have been split yet.
807
path_segments = splitpath(path)
808
deleted_dict = deleted_paths
809
for segment in path_segments:
810
deleted_dict = deleted_dict.setdefault(segment, {})
811
self.reporter.missing(path)
812
self._next_progress_entry()
813
deleted_ids.append(file_id)
815
# TODO: have the builder do the nested commit just-in-time IF and
817
if content_summary[0] == 'tree-reference':
818
# enforce repository nested tree policy.
819
if (not self.work_tree.supports_tree_reference() or
820
# repository does not support it either.
821
not self.branch.repository._format.supports_tree_reference):
822
content_summary = ('directory',) + content_summary[1:]
823
kind = content_summary[0]
824
# TODO: specific_files filtering before nested tree processing
825
if kind == 'tree-reference':
826
if self.recursive == 'down':
827
nested_revision_id = self._commit_nested_tree(
829
content_summary = content_summary[:3] + (
832
content_summary = content_summary[:3] + (
833
self.work_tree.get_reference_revision(file_id),)
835
# Record an entry for this item
836
# Note: I don't particularly want to have the existing_ie
837
# parameter but the test suite currently (28-Jun-07) breaks
838
# without it thanks to a unicode normalisation issue. :-(
839
definitely_changed = kind != existing_ie.kind
840
self._record_entry(path, file_id, specific_files, kind, name,
841
parent_id, definitely_changed, existing_ie, report_changes,
844
# Unversion IDs that were found to be deleted
845
self.work_tree.unversion(deleted_ids)
847
def _commit_nested_tree(self, file_id, path):
848
"Commit a nested tree."
849
sub_tree = self.work_tree.get_nested_tree(file_id, path)
850
# FIXME: be more comprehensive here:
851
# this works when both trees are in --trees repository,
852
# but when both are bound to a different repository,
853
# it fails; a better way of approaching this is to
854
# finally implement the explicit-caches approach design
855
# a while back - RBC 20070306.
856
if sub_tree.branch.repository.has_same_location(
857
self.work_tree.branch.repository):
858
sub_tree.branch.repository = \
859
self.work_tree.branch.repository
861
return sub_tree.commit(message=None, revprops=self.revprops,
862
recursive=self.recursive,
863
message_callback=self.message_callback,
864
timestamp=self.timestamp, timezone=self.timezone,
865
committer=self.committer,
866
allow_pointless=self.allow_pointless,
867
strict=self.strict, verbose=self.verbose,
868
local=self.local, reporter=self.reporter)
869
except errors.PointlessCommit:
870
return self.work_tree.get_reference_revision(file_id)
872
def _record_entry(self, path, file_id, specific_files, kind, name,
873
parent_id, definitely_changed, existing_ie, report_changes,
875
"Record the new inventory entry for a path if any."
876
# mutter('check %s {%s}', path, file_id)
877
# mutter('%s selected for commit', path)
878
if definitely_changed or existing_ie is None:
879
ie = make_entry(kind, name, parent_id, file_id)
881
ie = existing_ie.copy()
883
# For carried over entries we don't care about the fs hash - the repo
884
# isn't generating a sha, so we're not saving computation time.
885
_, _, fs_hash = self.builder.record_entry_contents(
886
ie, self.parent_invs, path, self.work_tree, content_summary)
888
self._report_change(ie, path)
890
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
893
def _report_change(self, ie, path):
894
"""Report a change to the user.
896
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())
899
if (self.basis_inv.has_id(ie.file_id)):
900
basis_ie = self.basis_inv[ie.file_id]
903
change = ie.describe_change(basis_ie, ie)
904
if change in (InventoryEntry.RENAMED,
905
InventoryEntry.MODIFIED_AND_RENAMED):
906
old_path = self.basis_inv.id2path(ie.file_id)
907
self.reporter.renamed(change, old_path, path)
908
self._next_progress_entry()
910
if change == 'unchanged':
512
912
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))
913
self._next_progress_entry()
915
def _set_progress_stage(self, name, counter=False):
916
"""Set the progress stage and emit an update to the progress bar."""
917
self.pb_stage_name = name
918
self.pb_stage_count += 1
920
self.pb_entries_count = 0
922
self.pb_entries_count = None
923
self._emit_progress()
925
def _next_progress_entry(self):
926
"""Emit an update to the progress bar and increment the entry count."""
927
self.pb_entries_count += 1
928
self._emit_progress()
930
def _emit_progress(self):
931
if self.pb_entries_count is not None:
932
text = "%s [%d] - Stage" % (self.pb_stage_name,
933
self.pb_entries_count)
935
text = "%s - Stage" % (self.pb_stage_name, )
936
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
938
def _set_specific_file_ids(self):
939
"""populate self.specific_file_ids if we will use it."""
940
if not self.use_record_iter_changes:
941
# If provided, ensure the specified files are versioned
942
if self.specific_files is not None:
943
# Note: This routine is being called because it raises
944
# PathNotVersionedError as a side effect of finding the IDs. We
945
# later use the ids we found as input to the working tree
946
# inventory iterator, so we only consider those ids rather than
947
# examining the whole tree again.
948
# XXX: Dont we have filter_unversioned to do this more
950
self.specific_file_ids = tree.find_ids_across_trees(
951
self.specific_files, [self.basis_tree, self.work_tree])
953
self.specific_file_ids = None
added
removed
bzrlib/commit.py
