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)
207
:param message_callback: A callback: message = message_callback(cmt_obj)
209
:param timestamp: if not None, seconds-since-epoch for a
210
postdated/predated commit.
212
:param specific_files: If true, commit only those files.
214
:param rev_id: If set, use this as the new revision id.
200
215
Useful for test or import commands that need to tightly
201
216
control what revisions are assigned. If you duplicate
202
217
a revision id that exists elsewhere it is your own fault.
203
218
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
220
:param allow_pointless: If true (default), commit even if nothing
206
221
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
223
:param strict: If true, don't allow a commit if the working tree
209
224
contains unknown files.
211
revprops -- Properties for new revision
226
:param revprops: Properties for new revision
212
227
:param local: Perform a local only commit.
228
:param reporter: the reporter to use or None for the default
229
:param verbose: if True and the reporter is not None, report everything
230
:param recursive: If set to 'down', commit in any subtrees that have
231
pending changes of any sort during this commit.
232
:param exclude: None or a list of relative paths to exclude from the
233
commit. Pending changes to excluded files will be ignored by the
214
236
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().")
238
if working_tree is None:
239
raise BzrError("working_tree must be passed into commit().")
225
241
self.work_tree = working_tree
226
242
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
243
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
244
if not self.branch.repository.supports_rich_root():
245
raise errors.RootNotRich()
246
if message_callback is None:
247
if message is not None:
248
if isinstance(message, str):
249
message = message.decode(get_user_encoding())
250
message_callback = lambda x: message
252
raise BzrError("The message or message_callback keyword"
253
" parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
255
self.bound_branch = None
256
self.any_entries_deleted = False
257
if exclude is not None:
258
self.exclude = sorted(
259
minimum_path_selection(exclude))
232
262
self.local = local
233
263
self.master_branch = None
234
264
self.master_locked = False
236
self.specific_files = specific_files
265
self.recursive = recursive
267
if specific_files is not None:
268
self.specific_files = sorted(
269
minimum_path_selection(specific_files))
271
self.specific_files = None
237
273
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
274
self.revprops = revprops
275
self.message_callback = message_callback
276
self.timestamp = timestamp
277
self.timezone = timezone
278
self.committer = committer
280
self.verbose = verbose
247
282
self.work_tree.lock_write()
283
self.parents = self.work_tree.get_parent_ids()
284
# We can use record_iter_changes IFF iter_changes is compatible with
285
# the command line parameters, and the repository has fast delta
286
# generation. See bug 347649.
287
self.use_record_iter_changes = (
288
not self.specific_files and
290
not self.branch.repository._format.supports_tree_reference and
291
(self.branch.repository._format.fast_deltas or
292
len(self.parents) < 2))
293
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
294
self.basis_revid = self.work_tree.last_revision()
295
self.basis_tree = self.work_tree.basis_tree()
296
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)
298
# Cannot commit with conflicts present.
299
if len(self.work_tree.conflicts()) > 0:
300
raise ConflictsInTree
302
# Setup the bound branch variables as needed.
303
self._check_bound_branch(possible_master_transports)
305
# Check that the working tree is up to date
306
old_revno, new_revno = self._check_out_of_date_tree()
308
# Complete configuration setup
309
if reporter is not None:
310
self.reporter = reporter
311
elif self.reporter is None:
312
self.reporter = self._select_reporter()
268
313
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
314
self.config = self.branch.get_config()
316
self._set_specific_file_ids()
318
# Setup the progress bar. As the number of files that need to be
319
# committed in unknown, progress is reported as stages.
320
# We keep track of entries separately though and include that
321
# information in the progress bar during the relevant stages.
322
self.pb_stage_name = ""
323
self.pb_stage_count = 0
324
self.pb_stage_total = 5
325
if self.bound_branch:
326
self.pb_stage_total += 1
327
self.pb.show_pct = False
328
self.pb.show_spinner = False
329
self.pb.show_eta = False
330
self.pb.show_count = True
331
self.pb.show_bar = True
297
333
self._gather_parents()
334
# After a merge, a selected file commit is not supported.
335
# See 'bzr help merge' for an explanation as to why.
298
336
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.
337
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
338
# Excludes are a form of selected file commit.
339
if len(self.parents) > 1 and self.exclude:
340
raise errors.CannotCommitSelectedFileMerge(self.exclude)
342
# Collect the changes
343
self._set_progress_stage("Collecting changes", counter=True)
344
self.builder = self.branch.get_commit_builder(self.parents,
345
self.config, timestamp, timezone, committer, revprops, rev_id)
348
self.builder.will_record_deletes()
349
# find the location being committed to
350
if self.bound_branch:
351
master_location = self.master_branch.base
353
master_location = self.branch.base
355
# report the start of the commit
356
self.reporter.started(new_revno, self.rev_id, master_location)
358
self._update_builder_with_changes()
359
self._check_pointless()
361
# TODO: Now the new inventory is known, check for conflicts.
362
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
363
# weave lines, because nothing should be recorded until it is known
364
# that commit will succeed.
365
self._set_progress_stage("Saving data locally")
366
self.builder.finish_inventory()
368
# Prompt the user for a commit message if none provided
369
message = message_callback(self)
370
self.message = message
372
# Add revision data to the local branch
373
self.rev_id = self.builder.commit(self.message)
376
mutter("aborting commit write group because of exception:")
377
trace.log_exception_quietly()
378
note("aborting commit write group: %r" % (e,))
382
self._process_pre_hooks(old_revno, new_revno)
384
# Upload revision data to the master.
385
# this will propagate merged revisions too if needed.
325
386
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)
387
self._set_progress_stage("Uploading data to master branch")
388
# 'commit' to the master first so a timeout here causes the
389
# local branch to be out of date
390
self.master_branch.import_last_revision_info(
391
self.branch.repository, new_revno, self.rev_id)
333
393
# and now do the commit locally.
334
self.branch.append_revision(self.rev_id)
394
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})
396
# Make the working tree be up to date with the branch. This
397
# includes automatic changes scheduled to be made to the tree, such
398
# as updating its basis and unversioning paths that were missing.
399
self.work_tree.unversion(self.deleted_ids)
400
self._set_progress_stage("Updating the working tree")
401
self.work_tree.update_basis_by_delta(self.rev_id,
402
self.builder.get_basis_delta())
403
self.reporter.completed(new_revno, self.rev_id)
404
self._process_post_hooks(old_revno, new_revno)
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
409
def _select_reporter(self):
410
"""Select the CommitReporter to use."""
412
return NullCommitReporter()
413
return ReportCommitToLog()
415
def _check_pointless(self):
416
if self.allow_pointless:
418
# A merge with no effect on files
419
if len(self.parents) > 1:
421
# TODO: we could simplify this by using self.builder.basis_delta.
423
# The initial commit adds a root directory, but this in itself is not
424
# a worthwhile commit.
425
if (self.basis_revid == revision.NULL_REVISION and
426
((self.builder.new_inventory is not None and
427
len(self.builder.new_inventory) == 1) or
428
len(self.builder._basis_delta) == 1)):
429
raise PointlessCommit()
430
if self.builder.any_changes():
432
raise PointlessCommit()
434
def _check_bound_branch(self, possible_master_transports=None):
354
435
"""Check to see if the local branch is bound.
356
437
If it is bound, then most of the commit will actually be
391
473
self.bound_branch = self.branch
392
474
self.master_branch.lock_write()
393
475
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)
477
def _check_out_of_date_tree(self):
478
"""Check that the working tree is up to date.
480
:return: old_revision_number,new_revision_number tuple
483
first_tree_parent = self.work_tree.get_parent_ids()[0]
485
# if there are no parents, treat our parent as 'None'
486
# this is so that we still consider the master branch
487
# - in a checkout scenario the tree may have no
488
# parents but the branch may do.
489
first_tree_parent = bzrlib.revision.NULL_REVISION
490
old_revno, master_last = self.master_branch.last_revision_info()
491
if master_last != first_tree_parent:
492
if master_last != bzrlib.revision.NULL_REVISION:
493
raise errors.OutOfDateTree(self.work_tree)
494
if self.branch.repository.has_revision(first_tree_parent):
495
new_revno = old_revno + 1
497
# ghost parents never appear in revision history.
499
return old_revno,new_revno
501
def _process_pre_hooks(self, old_revno, new_revno):
502
"""Process any registered pre commit hooks."""
503
self._set_progress_stage("Running pre_commit hooks")
504
self._process_hooks("pre_commit", old_revno, new_revno)
506
def _process_post_hooks(self, old_revno, new_revno):
507
"""Process any registered post commit hooks."""
508
# Process the post commit hooks, if any
509
self._set_progress_stage("Running post_commit hooks")
510
# old style commit hooks - should be deprecated ? (obsoleted in
512
if self.config.post_commit() is not None:
513
hooks = self.config.post_commit().split(' ')
514
# this would be nicer with twisted.python.reflect.namedAny
516
result = eval(hook + '(branch, rev_id)',
517
{'branch':self.branch,
519
'rev_id':self.rev_id})
520
# process new style post commit hooks
521
self._process_hooks("post_commit", old_revno, new_revno)
523
def _process_hooks(self, hook_name, old_revno, new_revno):
524
if not Branch.hooks[hook_name]:
527
# new style commit hooks:
528
if not self.bound_branch:
529
hook_master = self.branch
532
hook_master = self.master_branch
533
hook_local = self.branch
534
# With bound branches, when the master is behind the local branch,
535
# the 'old_revno' and old_revid values here are incorrect.
536
# XXX: FIXME ^. RBC 20060206
538
old_revid = self.parents[0]
540
old_revid = bzrlib.revision.NULL_REVISION
542
if hook_name == "pre_commit":
543
future_tree = self.builder.revision_tree()
544
tree_delta = future_tree.changes_from(self.basis_tree,
547
for hook in Branch.hooks[hook_name]:
548
# show the running hook in the progress bar. As hooks may
549
# end up doing nothing (e.g. because they are not configured by
550
# the user) this is still showing progress, not showing overall
551
# actions - its up to each plugin to show a UI if it want's to
552
# (such as 'Emailing diff to foo@example.com').
553
self.pb_stage_name = "Running %s hooks [%s]" % \
554
(hook_name, Branch.hooks.get_hook_name(hook))
555
self._emit_progress()
556
if 'hooks' in debug.debug_flags:
557
mutter("Invoking commit hook: %r", hook)
558
if hook_name == "post_commit":
559
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
561
elif hook_name == "pre_commit":
562
hook(hook_local, hook_master,
563
old_revno, old_revid, new_revno, self.rev_id,
564
tree_delta, future_tree)
567
"""Cleanup any open locks, progress bars etc."""
568
cleanups = [self._cleanup_bound_branch,
569
self.basis_tree.unlock,
570
self.work_tree.unlock,
572
found_exception = None
573
for cleanup in cleanups:
576
# we want every cleanup to run no matter what.
577
# so we have a catchall here, but we will raise the
578
# last encountered exception up the stack: and
579
# typically this will be useful enough.
582
if found_exception is not None:
583
# don't do a plan raise, because the last exception may have been
584
# trashed, e is our sure-to-work exception even though it loses the
585
# full traceback. XXX: RBC 20060421 perhaps we could check the
586
# exc_info and if its the same one do a plain raise otherwise
587
# 'raise e' as we do now.
403
590
def _cleanup_bound_branch(self):
404
591
"""Executed at the end of a try/finally to cleanup a bound branch.
412
599
if self.master_locked:
413
600
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
602
def _gather_parents(self):
429
603
"""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:
604
# TODO: Make sure that this list doesn't contain duplicate
605
# entries and the order is preserved when doing this.
606
if self.use_record_iter_changes:
608
self.basis_inv = self.basis_tree.inventory
609
self.parent_invs = [self.basis_inv]
610
for revision in self.parents[1:]:
439
611
if self.branch.repository.has_revision(revision):
612
mutter('commit parent revision {%s}', revision)
440
613
inventory = self.branch.repository.get_inventory(revision)
441
614
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)
616
mutter('commit parent ghost revision {%s}', revision)
618
def _update_builder_with_changes(self):
619
"""Update the commit builder with the data about what has changed.
621
exclude = self.exclude
622
specific_files = self.specific_files or []
623
mutter("Selecting files for commit with filter %s", specific_files)
626
if self.use_record_iter_changes:
627
iter_changes = self.work_tree.iter_changes(self.basis_tree)
628
iter_changes = self._filter_iter_changes(iter_changes)
629
for file_id, path, fs_hash in self.builder.record_iter_changes(
630
self.work_tree, self.basis_revid, iter_changes):
631
self.work_tree._observed_sha1(file_id, path, fs_hash)
633
# Build the new inventory
634
self._populate_from_inventory()
635
self._record_unselected()
636
self._report_and_accumulate_deletes()
638
def _filter_iter_changes(self, iter_changes):
639
"""Process iter_changes.
641
This method reports on the changes in iter_changes to the user, and
642
converts 'missing' entries in the iter_changes iterator to 'deleted'
643
entries. 'missing' entries have their
645
:param iter_changes: An iter_changes to process.
646
:return: A generator of changes.
648
reporter = self.reporter
649
report_changes = reporter.is_verbose()
651
for change in iter_changes:
653
old_path = change[1][0]
654
new_path = change[1][1]
655
versioned = change[3][1]
657
versioned = change[3][1]
658
if kind is None and versioned:
661
reporter.missing(new_path)
662
deleted_ids.append(change[0])
663
# Reset the new path (None) and new versioned flag (False)
664
change = (change[0], (change[1][0], None), change[2],
665
(change[3][0], False)) + change[4:]
666
elif kind == 'tree-reference':
667
if self.recursive == 'down':
668
self._commit_nested_tree(change[0], change[1][1])
669
if change[3][0] or change[3][1]:
673
reporter.deleted(old_path)
674
elif old_path is None:
675
reporter.snapshot_change('added', new_path)
676
elif old_path != new_path:
677
reporter.renamed('renamed', old_path, new_path)
680
self.work_tree.branch.repository._format.rich_root_data):
681
# Don't report on changes to '' in non rich root
683
reporter.snapshot_change('modified', new_path)
684
self._next_progress_entry()
685
# Unversion IDs that were found to be deleted
686
self.deleted_ids = deleted_ids
688
def _record_unselected(self):
689
# If specific files are selected, then all un-selected files must be
690
# recorded in their previous state. For more details, see
691
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
692
if self.specific_files or self.exclude:
693
specific_files = self.specific_files or []
694
for path, old_ie in self.basis_inv.iter_entries():
695
if old_ie.file_id in self.builder.new_inventory:
696
# already added - skip.
698
if (is_inside_any(specific_files, path)
699
and not is_inside_any(self.exclude, path)):
700
# was inside the selected path, and not excluded - if not
701
# present it has been deleted so skip.
703
# From here down it was either not selected, or was excluded:
704
# We preserve the entry unaltered.
706
# Note: specific file commits after a merge are currently
707
# prohibited. This test is for sanity/safety in case it's
708
# required after that changes.
709
if len(self.parents) > 1:
711
self.builder.record_entry_contents(ie, self.parent_invs, path,
712
self.basis_tree, None)
714
def _report_and_accumulate_deletes(self):
715
if (isinstance(self.basis_inv, Inventory)
716
and isinstance(self.builder.new_inventory, Inventory)):
717
# the older Inventory classes provide a _byid dict, and building a
718
# set from the keys of this dict is substantially faster than even
719
# getting a set of ids from the inventory
721
# <lifeless> set(dict) is roughly the same speed as
722
# set(iter(dict)) and both are significantly slower than
724
deleted_ids = set(self.basis_inv._byid.keys()) - \
725
set(self.builder.new_inventory._byid.keys())
727
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
729
self.any_entries_deleted = True
730
deleted = [(self.basis_tree.id2path(file_id), file_id)
731
for file_id in deleted_ids]
733
# XXX: this is not quite directory-order sorting
734
for path, file_id in deleted:
735
self.builder.record_delete(path, file_id)
736
self.reporter.deleted(path)
738
def _check_strict(self):
739
# XXX: when we use iter_changes this would likely be faster if
740
# iter_changes would check for us (even in the presence of
743
# raise an exception as soon as we find a single unknown.
744
for unknown in self.work_tree.unknowns():
745
raise StrictCommitFailed()
747
def _populate_from_inventory(self):
748
"""Populate the CommitBuilder by walking the working tree inventory."""
749
# Build the revision inventory.
751
# This starts by creating a new empty inventory. Depending on
752
# which files are selected for commit, and what is present in the
753
# current tree, the new inventory is populated. inventory entries
754
# which are candidates for modification have their revision set to
755
# None; inventory entries that are carried over untouched have their
756
# revision set to their prior value.
758
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
759
# results to create a new inventory at the same time, which results
760
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
763
specific_files = self.specific_files
764
exclude = self.exclude
765
report_changes = self.reporter.is_verbose()
767
# A tree of paths that have been deleted. E.g. if foo/bar has been
768
# deleted, then we have {'foo':{'bar':{}}}
770
# XXX: Note that entries may have the wrong kind because the entry does
771
# not reflect the status on disk.
772
work_inv = self.work_tree.inventory
773
# NB: entries will include entries within the excluded ids/paths
774
# because iter_entries_by_dir has no 'exclude' facility today.
775
entries = work_inv.iter_entries_by_dir(
776
specific_file_ids=self.specific_file_ids, yield_parents=True)
777
for path, existing_ie in entries:
778
file_id = existing_ie.file_id
779
name = existing_ie.name
780
parent_id = existing_ie.parent_id
781
kind = existing_ie.kind
782
# Skip files that have been deleted from the working tree.
783
# The deleted path ids are also recorded so they can be explicitly
786
path_segments = splitpath(path)
787
deleted_dict = deleted_paths
788
for segment in path_segments:
789
deleted_dict = deleted_dict.get(segment, None)
791
# We either took a path not present in the dict
792
# (deleted_dict was None), or we've reached an empty
793
# 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):
797
if deleted_dict is not None:
798
# the path has a deleted parent, do not add it.
800
if exclude and is_inside_any(exclude, path):
801
# Skip excluded paths. Excluded paths are processed by
802
# _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.
804
content_summary = self.work_tree.path_content_summary(path)
805
# Note that when a filter of specific files is given, we must only
806
# skip/record deleted files matching that filter.
807
if not specific_files or is_inside_any(specific_files, path):
808
if content_summary[0] == 'missing':
809
if not deleted_paths:
810
# path won't have been split yet.
811
path_segments = splitpath(path)
812
deleted_dict = deleted_paths
813
for segment in path_segments:
814
deleted_dict = deleted_dict.setdefault(segment, {})
815
self.reporter.missing(path)
816
self._next_progress_entry()
817
deleted_ids.append(file_id)
819
# TODO: have the builder do the nested commit just-in-time IF and
821
if content_summary[0] == 'tree-reference':
822
# enforce repository nested tree policy.
823
if (not self.work_tree.supports_tree_reference() or
824
# repository does not support it either.
825
not self.branch.repository._format.supports_tree_reference):
826
content_summary = ('directory',) + content_summary[1:]
827
kind = content_summary[0]
828
# TODO: specific_files filtering before nested tree processing
829
if kind == 'tree-reference':
830
if self.recursive == 'down':
831
nested_revision_id = self._commit_nested_tree(
833
content_summary = content_summary[:3] + (
836
content_summary = content_summary[:3] + (
837
self.work_tree.get_reference_revision(file_id),)
839
# Record an entry for this item
840
# Note: I don't particularly want to have the existing_ie
841
# parameter but the test suite currently (28-Jun-07) breaks
842
# without it thanks to a unicode normalisation issue. :-(
843
definitely_changed = kind != existing_ie.kind
844
self._record_entry(path, file_id, specific_files, kind, name,
845
parent_id, definitely_changed, existing_ie, report_changes,
848
# Unversion IDs that were found to be deleted
849
self.deleted_ids = deleted_ids
851
def _commit_nested_tree(self, file_id, path):
852
"Commit a nested tree."
853
sub_tree = self.work_tree.get_nested_tree(file_id, path)
854
# FIXME: be more comprehensive here:
855
# this works when both trees are in --trees repository,
856
# but when both are bound to a different repository,
857
# it fails; a better way of approaching this is to
858
# finally implement the explicit-caches approach design
859
# a while back - RBC 20070306.
860
if sub_tree.branch.repository.has_same_location(
861
self.work_tree.branch.repository):
862
sub_tree.branch.repository = \
863
self.work_tree.branch.repository
865
return sub_tree.commit(message=None, revprops=self.revprops,
866
recursive=self.recursive,
867
message_callback=self.message_callback,
868
timestamp=self.timestamp, timezone=self.timezone,
869
committer=self.committer,
870
allow_pointless=self.allow_pointless,
871
strict=self.strict, verbose=self.verbose,
872
local=self.local, reporter=self.reporter)
873
except errors.PointlessCommit:
874
return self.work_tree.get_reference_revision(file_id)
876
def _record_entry(self, path, file_id, specific_files, kind, name,
877
parent_id, definitely_changed, existing_ie, report_changes,
879
"Record the new inventory entry for a path if any."
880
# mutter('check %s {%s}', path, file_id)
881
# mutter('%s selected for commit', path)
882
if definitely_changed or existing_ie is None:
883
ie = make_entry(kind, name, parent_id, file_id)
885
ie = existing_ie.copy()
887
# For carried over entries we don't care about the fs hash - the repo
888
# isn't generating a sha, so we're not saving computation time.
889
_, _, fs_hash = self.builder.record_entry_contents(
890
ie, self.parent_invs, path, self.work_tree, content_summary)
892
self._report_change(ie, path)
894
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
897
def _report_change(self, ie, path):
898
"""Report a change to the user.
900
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())
903
if (self.basis_inv.has_id(ie.file_id)):
904
basis_ie = self.basis_inv[ie.file_id]
907
change = ie.describe_change(basis_ie, ie)
908
if change in (InventoryEntry.RENAMED,
909
InventoryEntry.MODIFIED_AND_RENAMED):
910
old_path = self.basis_inv.id2path(ie.file_id)
911
self.reporter.renamed(change, old_path, path)
912
self._next_progress_entry()
914
if change == 'unchanged':
512
916
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))
917
self._next_progress_entry()
919
def _set_progress_stage(self, name, counter=False):
920
"""Set the progress stage and emit an update to the progress bar."""
921
self.pb_stage_name = name
922
self.pb_stage_count += 1
924
self.pb_entries_count = 0
926
self.pb_entries_count = None
927
self._emit_progress()
929
def _next_progress_entry(self):
930
"""Emit an update to the progress bar and increment the entry count."""
931
self.pb_entries_count += 1
932
self._emit_progress()
934
def _emit_progress(self):
935
if self.pb_entries_count is not None:
936
text = "%s [%d] - Stage" % (self.pb_stage_name,
937
self.pb_entries_count)
939
text = "%s - Stage" % (self.pb_stage_name, )
940
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
942
def _set_specific_file_ids(self):
943
"""populate self.specific_file_ids if we will use it."""
944
if not self.use_record_iter_changes:
945
# If provided, ensure the specified files are versioned
946
if self.specific_files is not None:
947
# Note: This routine is being called because it raises
948
# PathNotVersionedError as a side effect of finding the IDs. We
949
# later use the ids we found as input to the working tree
950
# inventory iterator, so we only consider those ids rather than
951
# examining the whole tree again.
952
# XXX: Dont we have filter_unversioned to do this more
954
self.specific_file_ids = tree.find_ids_across_trees(
955
self.specific_files, [self.basis_tree, self.work_tree])
957
self.specific_file_ids = None
added
removed
bzrlib/commit.py
