1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working tree. Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree. If they were only
23
# deleted from disk, they are removed from the working inventory.
25
# We then consider the remaining entries, which will be in the new
26
# version. Directory entries are simply copied across. File entries
27
# must be checked to see if a new version of the file should be
28
# recorded. For each parent revision tree, we check to see what
29
# version of the file was present. If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version. Otherwise, a new version
32
# representing the merger of the file versions must be added.
34
# TODO: Update hashcache before and after - or does the WorkingTree
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
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.
57
from cStringIO import StringIO
66
from bzrlib.branch import Branch
68
from bzrlib.errors import (BzrError, PointlessCommit,
72
from bzrlib.osutils import (get_user_encoding,
73
kind_marker, isdir,isfile, is_inside_any,
74
is_inside_or_parent_of_any,
75
minimum_path_selection,
76
quotefn, sha_file, split_lines,
79
from bzrlib.testament import Testament
80
from bzrlib.trace import mutter, note, warning, is_quiet
81
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
82
from bzrlib import symbol_versioning
83
from bzrlib.symbol_versioning import (deprecated_passed,
86
from bzrlib.workingtree import WorkingTree
87
from bzrlib.urlutils import unescape_for_display
91
class NullCommitReporter(object):
92
"""I report on progress of a commit."""
94
def started(self, revno, revid, location=None):
96
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
97
"to started.", DeprecationWarning,
101
def snapshot_change(self, change, path):
104
def completed(self, revno, rev_id):
107
def deleted(self, path):
110
def escaped(self, escape_count, message):
113
def missing(self, path):
116
def renamed(self, change, old_path, new_path):
119
def is_verbose(self):
123
class ReportCommitToLog(NullCommitReporter):
125
def _note(self, format, *args):
128
Subclasses may choose to override this method.
132
def snapshot_change(self, change, path):
133
if path == '' and change in ('added', 'modified'):
135
self._note("%s %s", change, path)
137
def started(self, revno, rev_id, location=None):
138
if location is not None:
139
location = ' to: ' + unescape_for_display(location, 'utf-8')
141
# When started was added, location was only made optional by
142
# accident. Matt Nordhoff 20071129
143
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
144
"to started.", DeprecationWarning,
147
self._note('Committing%s', location)
149
def completed(self, revno, rev_id):
150
self._note('Committed revision %d.', revno)
152
def deleted(self, path):
153
self._note('deleted %s', path)
155
def escaped(self, escape_count, message):
156
self._note("replaced %d control characters in message", escape_count)
158
def missing(self, path):
159
self._note('missing %s', path)
161
def renamed(self, change, old_path, new_path):
162
self._note('%s %s => %s', change, old_path, new_path)
164
def is_verbose(self):
168
class Commit(object):
169
"""Task of committing a new revision.
171
This is a MethodObject: it accumulates state as the commit is
172
prepared, and then it is discarded. It doesn't represent
173
historical revisions, just the act of recording a new one.
176
Modified to hold a list of files that have been deleted from
177
the working directory; these should be removed from the
183
"""Create a Commit object.
185
:param reporter: the default reporter to use or None to decide later
187
self.reporter = reporter
197
allow_pointless=True,
205
message_callback=None,
208
possible_master_transports=None):
209
"""Commit working copy as a new revision.
211
:param message: the commit message (it or message_callback is required)
213
:param timestamp: if not None, seconds-since-epoch for a
214
postdated/predated commit.
216
:param specific_files: If true, commit only those files.
218
:param rev_id: If set, use this as the new revision id.
219
Useful for test or import commands that need to tightly
220
control what revisions are assigned. If you duplicate
221
a revision id that exists elsewhere it is your own fault.
222
If null (default), a time/random revision id is generated.
224
:param allow_pointless: If true (default), commit even if nothing
225
has changed and no merges are recorded.
227
:param strict: If true, don't allow a commit if the working tree
228
contains unknown files.
230
:param revprops: Properties for new revision
231
:param local: Perform a local only commit.
232
:param reporter: the reporter to use or None for the default
233
:param verbose: if True and the reporter is not None, report everything
234
:param recursive: If set to 'down', commit in any subtrees that have
235
pending changes of any sort during this commit.
236
:param exclude: None or a list of relative paths to exclude from the
237
commit. Pending changes to excluded files will be ignored by the
240
mutter('preparing to commit')
242
if working_tree is None:
243
raise BzrError("working_tree must be passed into commit().")
245
self.work_tree = working_tree
246
self.branch = self.work_tree.branch
247
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
248
if not self.branch.repository.supports_rich_root():
249
raise errors.RootNotRich()
250
if message_callback is None:
251
if message is not None:
252
if isinstance(message, str):
253
message = message.decode(get_user_encoding())
254
message_callback = lambda x: message
256
raise BzrError("The message or message_callback keyword"
257
" parameter is required for commit().")
259
self.bound_branch = None
260
self.any_entries_deleted = False
261
if exclude is not None:
262
self.exclude = sorted(
263
minimum_path_selection(exclude))
267
self.master_branch = None
268
self.master_locked = False
269
self.recursive = recursive
271
if specific_files is not None:
272
self.specific_files = sorted(
273
minimum_path_selection(specific_files))
275
self.specific_files = None
277
self.allow_pointless = allow_pointless
278
self.revprops = revprops
279
self.message_callback = message_callback
280
self.timestamp = timestamp
281
self.timezone = timezone
282
self.committer = committer
284
self.verbose = verbose
286
self.work_tree.lock_write()
287
self.parents = self.work_tree.get_parent_ids()
288
# We can use record_iter_changes IFF iter_changes is compatible with
289
# the command line parameters, and the repository has fast delta
290
# generation. See bug 347649.
291
self.use_record_iter_changes = (
292
not self.specific_files and
294
not self.branch.repository._format.supports_tree_reference and
295
self.branch.repository._format.fast_deltas or len(self.parents) < 2)
296
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
297
self.basis_revid = self.work_tree.last_revision()
298
self.basis_tree = self.work_tree.basis_tree()
299
self.basis_tree.lock_read()
301
# Cannot commit with conflicts present.
302
if len(self.work_tree.conflicts()) > 0:
303
raise ConflictsInTree
305
# Setup the bound branch variables as needed.
306
self._check_bound_branch(possible_master_transports)
308
# Check that the working tree is up to date
309
old_revno, new_revno = self._check_out_of_date_tree()
311
# Complete configuration setup
312
if reporter is not None:
313
self.reporter = reporter
314
elif self.reporter is None:
315
self.reporter = self._select_reporter()
316
if self.config is None:
317
self.config = self.branch.get_config()
319
self._set_specific_file_ids()
321
# Setup the progress bar. As the number of files that need to be
322
# committed in unknown, progress is reported as stages.
323
# We keep track of entries separately though and include that
324
# information in the progress bar during the relevant stages.
325
self.pb_stage_name = ""
326
self.pb_stage_count = 0
327
self.pb_stage_total = 5
328
if self.bound_branch:
329
self.pb_stage_total += 1
330
self.pb.show_pct = False
331
self.pb.show_spinner = False
332
self.pb.show_eta = False
333
self.pb.show_count = True
334
self.pb.show_bar = True
336
self._gather_parents()
337
# After a merge, a selected file commit is not supported.
338
# See 'bzr help merge' for an explanation as to why.
339
if len(self.parents) > 1 and self.specific_files:
340
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
341
# Excludes are a form of selected file commit.
342
if len(self.parents) > 1 and self.exclude:
343
raise errors.CannotCommitSelectedFileMerge(self.exclude)
345
# Collect the changes
346
self._set_progress_stage("Collecting changes", counter=True)
347
self.builder = self.branch.get_commit_builder(self.parents,
348
self.config, timestamp, timezone, committer, revprops, rev_id)
351
self.builder.will_record_deletes()
352
# find the location being committed to
353
if self.bound_branch:
354
master_location = self.master_branch.base
356
master_location = self.branch.base
358
# report the start of the commit
359
self.reporter.started(new_revno, self.rev_id, master_location)
361
self._update_builder_with_changes()
362
self._check_pointless()
364
# TODO: Now the new inventory is known, check for conflicts.
365
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
366
# weave lines, because nothing should be recorded until it is known
367
# that commit will succeed.
368
self._set_progress_stage("Saving data locally")
369
self.builder.finish_inventory()
371
# Prompt the user for a commit message if none provided
372
message = message_callback(self)
373
self.message = message
374
self._escape_commit_message()
376
# Add revision data to the local branch
377
self.rev_id = self.builder.commit(self.message)
380
mutter("aborting commit write group because of exception:")
381
trace.log_exception_quietly()
382
note("aborting commit write group: %r" % (e,))
386
self._process_pre_hooks(old_revno, new_revno)
388
# Upload revision data to the master.
389
# this will propagate merged revisions too if needed.
390
if self.bound_branch:
391
self._set_progress_stage("Uploading data to master branch")
392
# 'commit' to the master first so a timeout here causes the
393
# local branch to be out of date
394
self.master_branch.import_last_revision_info(
395
self.branch.repository, new_revno, self.rev_id)
397
# and now do the commit locally.
398
self.branch.set_last_revision_info(new_revno, self.rev_id)
400
# Make the working tree up to date with the branch
401
self._set_progress_stage("Updating the working tree")
402
self.work_tree.update_basis_by_delta(self.rev_id,
403
self.builder.get_basis_delta())
404
self.reporter.completed(new_revno, self.rev_id)
405
self._process_post_hooks(old_revno, new_revno)
410
def _select_reporter(self):
411
"""Select the CommitReporter to use."""
413
return NullCommitReporter()
414
return ReportCommitToLog()
416
def _check_pointless(self):
417
if self.allow_pointless:
419
# A merge with no effect on files
420
if len(self.parents) > 1:
422
# TODO: we could simplify this by using self.builder.basis_delta.
424
# The initial commit adds a root directory, but this in itself is not
425
# a worthwhile commit.
426
if (self.basis_revid == revision.NULL_REVISION and
427
((self.builder.new_inventory is not None and
428
len(self.builder.new_inventory) == 1) or
429
len(self.builder._basis_delta) == 1)):
430
raise PointlessCommit()
431
if self.builder.any_changes():
433
raise PointlessCommit()
435
def _check_bound_branch(self, possible_master_transports=None):
436
"""Check to see if the local branch is bound.
438
If it is bound, then most of the commit will actually be
439
done using the remote branch as the target branch.
440
Only at the end will the local branch be updated.
442
if self.local and not self.branch.get_bound_location():
443
raise errors.LocalRequiresBoundBranch()
446
self.master_branch = self.branch.get_master_branch(
447
possible_master_transports)
449
if not self.master_branch:
450
# make this branch the reference branch for out of date checks.
451
self.master_branch = self.branch
454
# If the master branch is bound, we must fail
455
master_bound_location = self.master_branch.get_bound_location()
456
if master_bound_location:
457
raise errors.CommitToDoubleBoundBranch(self.branch,
458
self.master_branch, master_bound_location)
460
# TODO: jam 20051230 We could automatically push local
461
# commits to the remote branch if they would fit.
462
# But for now, just require remote to be identical
465
# Make sure the local branch is identical to the master
466
master_info = self.master_branch.last_revision_info()
467
local_info = self.branch.last_revision_info()
468
if local_info != master_info:
469
raise errors.BoundBranchOutOfDate(self.branch,
472
# Now things are ready to change the master branch
474
self.bound_branch = self.branch
475
self.master_branch.lock_write()
476
self.master_locked = True
478
def _check_out_of_date_tree(self):
479
"""Check that the working tree is up to date.
481
:return: old_revision_number,new_revision_number tuple
484
first_tree_parent = self.work_tree.get_parent_ids()[0]
486
# if there are no parents, treat our parent as 'None'
487
# this is so that we still consider the master branch
488
# - in a checkout scenario the tree may have no
489
# parents but the branch may do.
490
first_tree_parent = bzrlib.revision.NULL_REVISION
491
old_revno, master_last = self.master_branch.last_revision_info()
492
if master_last != first_tree_parent:
493
if master_last != bzrlib.revision.NULL_REVISION:
494
raise errors.OutOfDateTree(self.work_tree)
495
if self.branch.repository.has_revision(first_tree_parent):
496
new_revno = old_revno + 1
498
# ghost parents never appear in revision history.
500
return old_revno,new_revno
502
def _process_pre_hooks(self, old_revno, new_revno):
503
"""Process any registered pre commit hooks."""
504
self._set_progress_stage("Running pre_commit hooks")
505
self._process_hooks("pre_commit", old_revno, new_revno)
507
def _process_post_hooks(self, old_revno, new_revno):
508
"""Process any registered post commit hooks."""
509
# Process the post commit hooks, if any
510
self._set_progress_stage("Running post_commit hooks")
511
# old style commit hooks - should be deprecated ? (obsoleted in
513
if self.config.post_commit() is not None:
514
hooks = self.config.post_commit().split(' ')
515
# this would be nicer with twisted.python.reflect.namedAny
517
result = eval(hook + '(branch, rev_id)',
518
{'branch':self.branch,
520
'rev_id':self.rev_id})
521
# process new style post commit hooks
522
self._process_hooks("post_commit", old_revno, new_revno)
524
def _process_hooks(self, hook_name, old_revno, new_revno):
525
if not Branch.hooks[hook_name]:
528
# new style commit hooks:
529
if not self.bound_branch:
530
hook_master = self.branch
533
hook_master = self.master_branch
534
hook_local = self.branch
535
# With bound branches, when the master is behind the local branch,
536
# the 'old_revno' and old_revid values here are incorrect.
537
# XXX: FIXME ^. RBC 20060206
539
old_revid = self.parents[0]
541
old_revid = bzrlib.revision.NULL_REVISION
543
if hook_name == "pre_commit":
544
future_tree = self.builder.revision_tree()
545
tree_delta = future_tree.changes_from(self.basis_tree,
548
for hook in Branch.hooks[hook_name]:
549
# show the running hook in the progress bar. As hooks may
550
# end up doing nothing (e.g. because they are not configured by
551
# the user) this is still showing progress, not showing overall
552
# actions - its up to each plugin to show a UI if it want's to
553
# (such as 'Emailing diff to foo@example.com').
554
self.pb_stage_name = "Running %s hooks [%s]" % \
555
(hook_name, Branch.hooks.get_hook_name(hook))
556
self._emit_progress()
557
if 'hooks' in debug.debug_flags:
558
mutter("Invoking commit hook: %r", hook)
559
if hook_name == "post_commit":
560
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
562
elif hook_name == "pre_commit":
563
hook(hook_local, hook_master,
564
old_revno, old_revid, new_revno, self.rev_id,
565
tree_delta, future_tree)
568
"""Cleanup any open locks, progress bars etc."""
569
cleanups = [self._cleanup_bound_branch,
570
self.basis_tree.unlock,
571
self.work_tree.unlock,
573
found_exception = None
574
for cleanup in cleanups:
577
# we want every cleanup to run no matter what.
578
# so we have a catchall here, but we will raise the
579
# last encountered exception up the stack: and
580
# typically this will be useful enough.
583
if found_exception is not None:
584
# don't do a plan raise, because the last exception may have been
585
# trashed, e is our sure-to-work exception even though it loses the
586
# full traceback. XXX: RBC 20060421 perhaps we could check the
587
# exc_info and if its the same one do a plain raise otherwise
588
# 'raise e' as we do now.
591
def _cleanup_bound_branch(self):
592
"""Executed at the end of a try/finally to cleanup a bound branch.
594
If the branch wasn't bound, this is a no-op.
595
If it was, it resents self.branch to the local branch, instead
598
if not self.bound_branch:
600
if self.master_locked:
601
self.master_branch.unlock()
603
def _escape_commit_message(self):
604
"""Replace xml-incompatible control characters."""
605
# FIXME: RBC 20060419 this should be done by the revision
606
# serialiser not by commit. Then we can also add an unescaper
607
# in the deserializer and start roundtripping revision messages
608
# precisely. See repository_implementations/test_repository.py
610
# Python strings can include characters that can't be
611
# represented in well-formed XML; escape characters that
612
# aren't listed in the XML specification
613
# (http://www.w3.org/TR/REC-xml/#NT-Char).
614
self.message, escape_count = re.subn(
615
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
616
lambda match: match.group(0).encode('unicode_escape'),
619
self.reporter.escaped(escape_count, self.message)
621
def _gather_parents(self):
622
"""Record the parents of a merge for merge detection."""
623
# TODO: Make sure that this list doesn't contain duplicate
624
# entries and the order is preserved when doing this.
625
if self.use_record_iter_changes:
627
self.basis_inv = self.basis_tree.inventory
628
self.parent_invs = [self.basis_inv]
629
for revision in self.parents[1:]:
630
if self.branch.repository.has_revision(revision):
631
mutter('commit parent revision {%s}', revision)
632
inventory = self.branch.repository.get_inventory(revision)
633
self.parent_invs.append(inventory)
635
mutter('commit parent ghost revision {%s}', revision)
637
def _update_builder_with_changes(self):
638
"""Update the commit builder with the data about what has changed.
640
exclude = self.exclude
641
specific_files = self.specific_files or []
642
mutter("Selecting files for commit with filter %s", specific_files)
645
if self.use_record_iter_changes:
646
iter_changes = self.work_tree.iter_changes(self.basis_tree)
647
iter_changes = self._filter_iter_changes(iter_changes)
648
for file_id, path, fs_hash in self.builder.record_iter_changes(
649
self.work_tree, self.basis_revid, iter_changes):
650
self.work_tree._observed_sha1(file_id, path, fs_hash)
652
# Build the new inventory
653
self._populate_from_inventory()
654
self._record_unselected()
655
self._report_and_accumulate_deletes()
657
def _filter_iter_changes(self, iter_changes):
658
"""Process iter_changes.
660
This method reports on the changes in iter_changes to the user, and
661
converts 'missing' entries in the iter_changes iterator to 'deleted'
662
entries. 'missing' entries have their
664
:param iter_changes: An iter_changes to process.
665
:return: A generator of changes.
667
reporter = self.reporter
668
report_changes = reporter.is_verbose()
670
for change in iter_changes:
672
old_path = change[1][0]
673
new_path = change[1][1]
674
versioned = change[3][1]
676
versioned = change[3][1]
677
if kind is None and versioned:
680
reporter.missing(new_path)
681
deleted_ids.append(change[0])
682
# Reset the new path (None) and new versioned flag (False)
683
change = (change[0], (change[1][0], None), change[2],
684
(change[3][0], False)) + change[4:]
685
elif kind == 'tree-reference':
686
if self.recursive == 'down':
687
self._commit_nested_tree(change[0], change[1][1])
688
if change[3][0] or change[3][1]:
692
reporter.deleted(old_path)
693
elif old_path is None:
694
reporter.snapshot_change('added', new_path)
695
elif old_path != new_path:
696
reporter.renamed('renamed', old_path, new_path)
699
self.work_tree.branch.repository._format.rich_root_data):
700
# Don't report on changes to '' in non rich root
702
reporter.snapshot_change('modified', new_path)
703
self._next_progress_entry()
704
# Unversion IDs that were found to be deleted
705
self.work_tree.unversion(deleted_ids)
707
def _record_unselected(self):
708
# If specific files are selected, then all un-selected files must be
709
# recorded in their previous state. For more details, see
710
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
711
if self.specific_files or self.exclude:
712
specific_files = self.specific_files or []
713
for path, old_ie in self.basis_inv.iter_entries():
714
if old_ie.file_id in self.builder.new_inventory:
715
# already added - skip.
717
if (is_inside_any(specific_files, path)
718
and not is_inside_any(self.exclude, path)):
719
# was inside the selected path, and not excluded - if not
720
# present it has been deleted so skip.
722
# From here down it was either not selected, or was excluded:
723
# We preserve the entry unaltered.
725
# Note: specific file commits after a merge are currently
726
# prohibited. This test is for sanity/safety in case it's
727
# required after that changes.
728
if len(self.parents) > 1:
730
self.builder.record_entry_contents(ie, self.parent_invs, path,
731
self.basis_tree, None)
733
def _report_and_accumulate_deletes(self):
734
if (isinstance(self.basis_inv, Inventory)
735
and isinstance(self.builder.new_inventory, Inventory)):
736
# the older Inventory classes provide a _byid dict, and building a
737
# set from the keys of this dict is substantially faster than even
738
# getting a set of ids from the inventory
740
# <lifeless> set(dict) is roughly the same speed as
741
# set(iter(dict)) and both are significantly slower than
743
deleted_ids = set(self.basis_inv._byid.keys()) - \
744
set(self.builder.new_inventory._byid.keys())
746
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
748
self.any_entries_deleted = True
749
deleted = [(self.basis_tree.id2path(file_id), file_id)
750
for file_id in deleted_ids]
752
# XXX: this is not quite directory-order sorting
753
for path, file_id in deleted:
754
self.builder.record_delete(path, file_id)
755
self.reporter.deleted(path)
757
def _check_strict(self):
758
# XXX: when we use iter_changes this would likely be faster if
759
# iter_changes would check for us (even in the presence of
762
# raise an exception as soon as we find a single unknown.
763
for unknown in self.work_tree.unknowns():
764
raise StrictCommitFailed()
766
def _populate_from_inventory(self):
767
"""Populate the CommitBuilder by walking the working tree inventory."""
768
# Build the revision inventory.
770
# This starts by creating a new empty inventory. Depending on
771
# which files are selected for commit, and what is present in the
772
# current tree, the new inventory is populated. inventory entries
773
# which are candidates for modification have their revision set to
774
# None; inventory entries that are carried over untouched have their
775
# revision set to their prior value.
777
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
778
# results to create a new inventory at the same time, which results
779
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
782
specific_files = self.specific_files
783
exclude = self.exclude
784
report_changes = self.reporter.is_verbose()
786
# A tree of paths that have been deleted. E.g. if foo/bar has been
787
# deleted, then we have {'foo':{'bar':{}}}
789
# XXX: Note that entries may have the wrong kind because the entry does
790
# not reflect the status on disk.
791
work_inv = self.work_tree.inventory
792
# NB: entries will include entries within the excluded ids/paths
793
# because iter_entries_by_dir has no 'exclude' facility today.
794
entries = work_inv.iter_entries_by_dir(
795
specific_file_ids=self.specific_file_ids, yield_parents=True)
796
for path, existing_ie in entries:
797
file_id = existing_ie.file_id
798
name = existing_ie.name
799
parent_id = existing_ie.parent_id
800
kind = existing_ie.kind
801
# Skip files that have been deleted from the working tree.
802
# The deleted path ids are also recorded so they can be explicitly
805
path_segments = splitpath(path)
806
deleted_dict = deleted_paths
807
for segment in path_segments:
808
deleted_dict = deleted_dict.get(segment, None)
810
# We either took a path not present in the dict
811
# (deleted_dict was None), or we've reached an empty
812
# child dir in the dict, so are now a sub-path.
816
if deleted_dict is not None:
817
# the path has a deleted parent, do not add it.
819
if exclude and is_inside_any(exclude, path):
820
# Skip excluded paths. Excluded paths are processed by
821
# _update_builder_with_changes.
823
content_summary = self.work_tree.path_content_summary(path)
824
# Note that when a filter of specific files is given, we must only
825
# skip/record deleted files matching that filter.
826
if not specific_files or is_inside_any(specific_files, path):
827
if content_summary[0] == 'missing':
828
if not deleted_paths:
829
# path won't have been split yet.
830
path_segments = splitpath(path)
831
deleted_dict = deleted_paths
832
for segment in path_segments:
833
deleted_dict = deleted_dict.setdefault(segment, {})
834
self.reporter.missing(path)
835
self._next_progress_entry()
836
deleted_ids.append(file_id)
838
# TODO: have the builder do the nested commit just-in-time IF and
840
if content_summary[0] == 'tree-reference':
841
# enforce repository nested tree policy.
842
if (not self.work_tree.supports_tree_reference() or
843
# repository does not support it either.
844
not self.branch.repository._format.supports_tree_reference):
845
content_summary = ('directory',) + content_summary[1:]
846
kind = content_summary[0]
847
# TODO: specific_files filtering before nested tree processing
848
if kind == 'tree-reference':
849
if self.recursive == 'down':
850
nested_revision_id = self._commit_nested_tree(
852
content_summary = content_summary[:3] + (
855
content_summary = content_summary[:3] + (
856
self.work_tree.get_reference_revision(file_id),)
858
# Record an entry for this item
859
# Note: I don't particularly want to have the existing_ie
860
# parameter but the test suite currently (28-Jun-07) breaks
861
# without it thanks to a unicode normalisation issue. :-(
862
definitely_changed = kind != existing_ie.kind
863
self._record_entry(path, file_id, specific_files, kind, name,
864
parent_id, definitely_changed, existing_ie, report_changes,
867
# Unversion IDs that were found to be deleted
868
self.work_tree.unversion(deleted_ids)
870
def _commit_nested_tree(self, file_id, path):
871
"Commit a nested tree."
872
sub_tree = self.work_tree.get_nested_tree(file_id, path)
873
# FIXME: be more comprehensive here:
874
# this works when both trees are in --trees repository,
875
# but when both are bound to a different repository,
876
# it fails; a better way of approaching this is to
877
# finally implement the explicit-caches approach design
878
# a while back - RBC 20070306.
879
if sub_tree.branch.repository.has_same_location(
880
self.work_tree.branch.repository):
881
sub_tree.branch.repository = \
882
self.work_tree.branch.repository
884
return sub_tree.commit(message=None, revprops=self.revprops,
885
recursive=self.recursive,
886
message_callback=self.message_callback,
887
timestamp=self.timestamp, timezone=self.timezone,
888
committer=self.committer,
889
allow_pointless=self.allow_pointless,
890
strict=self.strict, verbose=self.verbose,
891
local=self.local, reporter=self.reporter)
892
except errors.PointlessCommit:
893
return self.work_tree.get_reference_revision(file_id)
895
def _record_entry(self, path, file_id, specific_files, kind, name,
896
parent_id, definitely_changed, existing_ie, report_changes,
898
"Record the new inventory entry for a path if any."
899
# mutter('check %s {%s}', path, file_id)
900
# mutter('%s selected for commit', path)
901
if definitely_changed or existing_ie is None:
902
ie = make_entry(kind, name, parent_id, file_id)
904
ie = existing_ie.copy()
906
# For carried over entries we don't care about the fs hash - the repo
907
# isn't generating a sha, so we're not saving computation time.
908
_, _, fs_hash = self.builder.record_entry_contents(
909
ie, self.parent_invs, path, self.work_tree, content_summary)
911
self._report_change(ie, path)
913
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
916
def _report_change(self, ie, path):
917
"""Report a change to the user.
919
The change that has occurred is described relative to the basis
922
if (self.basis_inv.has_id(ie.file_id)):
923
basis_ie = self.basis_inv[ie.file_id]
926
change = ie.describe_change(basis_ie, ie)
927
if change in (InventoryEntry.RENAMED,
928
InventoryEntry.MODIFIED_AND_RENAMED):
929
old_path = self.basis_inv.id2path(ie.file_id)
930
self.reporter.renamed(change, old_path, path)
931
self._next_progress_entry()
933
if change == 'unchanged':
935
self.reporter.snapshot_change(change, path)
936
self._next_progress_entry()
938
def _set_progress_stage(self, name, counter=False):
939
"""Set the progress stage and emit an update to the progress bar."""
940
self.pb_stage_name = name
941
self.pb_stage_count += 1
943
self.pb_entries_count = 0
945
self.pb_entries_count = None
946
self._emit_progress()
948
def _next_progress_entry(self):
949
"""Emit an update to the progress bar and increment the entry count."""
950
self.pb_entries_count += 1
951
self._emit_progress()
953
def _emit_progress(self):
954
if self.pb_entries_count is not None:
955
text = "%s [%d] - Stage" % (self.pb_stage_name,
956
self.pb_entries_count)
958
text = "%s - Stage" % (self.pb_stage_name, )
959
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
961
def _set_specific_file_ids(self):
962
"""populate self.specific_file_ids if we will use it."""
963
if not self.use_record_iter_changes:
964
# If provided, ensure the specified files are versioned
965
if self.specific_files is not None:
966
# Note: This routine is being called because it raises
967
# PathNotVersionedError as a side effect of finding the IDs. We
968
# later use the ids we found as input to the working tree
969
# inventory iterator, so we only consider those ids rather than
970
# examining the whole tree again.
971
# XXX: Dont we have filter_unversioned to do this more
973
self.specific_file_ids = tree.find_ids_across_trees(
974
self.specific_files, [self.basis_tree, self.work_tree])
976
self.specific_file_ids = None
added
removed
bzrlib/commit.py
