1
# Copyright (C) 2005-2010 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
67
from bzrlib.branch import Branch
68
from bzrlib.cleanup import OperationWithCleanups
70
from bzrlib.errors import (BzrError, PointlessCommit,
74
from bzrlib.osutils import (get_user_encoding,
75
kind_marker, isdir,isfile, is_inside_any,
76
is_inside_or_parent_of_any,
77
minimum_path_selection,
78
quotefn, sha_file, split_lines,
81
from bzrlib.testament import Testament
82
from bzrlib.trace import mutter, note, warning, is_quiet
83
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (deprecated_passed,
88
from bzrlib.workingtree import WorkingTree
89
from bzrlib.urlutils import unescape_for_display
93
class NullCommitReporter(object):
94
"""I report on progress of a commit."""
96
def started(self, revno, revid, location=None):
98
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
99
"to started.", DeprecationWarning,
103
def snapshot_change(self, change, path):
106
def completed(self, revno, rev_id):
109
def deleted(self, path):
112
def missing(self, path):
115
def renamed(self, change, old_path, new_path):
118
def is_verbose(self):
122
class ReportCommitToLog(NullCommitReporter):
124
def _note(self, format, *args):
127
Subclasses may choose to override this method.
131
def snapshot_change(self, change, path):
132
if path == '' and change in ('added', 'modified'):
134
self._note("%s %s", change, path)
136
def started(self, revno, rev_id, location=None):
137
if location is not None:
138
location = ' to: ' + unescape_for_display(location, 'utf-8')
140
# When started was added, location was only made optional by
141
# accident. Matt Nordhoff 20071129
142
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
143
"to started.", DeprecationWarning,
146
self._note('Committing%s', location)
148
def completed(self, revno, rev_id):
149
self._note('Committed revision %d.', revno)
150
# self._note goes to the console too; so while we want to log the
151
# rev_id, we can't trivially only log it. (See bug 526425). Long
152
# term we should rearrange the reporting structure, but for now
153
# we just mutter seperately. We mutter the revid and revno together
154
# so that concurrent bzr invocations won't lead to confusion.
155
mutter('Committed revid %s as revno %d.', rev_id, revno)
157
def deleted(self, path):
158
self._note('deleted %s', path)
160
def missing(self, path):
161
self._note('missing %s', path)
163
def renamed(self, change, old_path, new_path):
164
self._note('%s %s => %s', change, old_path, new_path)
166
def is_verbose(self):
170
class Commit(object):
171
"""Task of committing a new revision.
173
This is a MethodObject: it accumulates state as the commit is
174
prepared, and then it is discarded. It doesn't represent
175
historical revisions, just the act of recording a new one.
178
Modified to hold a list of files that have been deleted from
179
the working directory; these should be removed from the
185
"""Create a Commit object.
187
:param reporter: the default reporter to use or None to decide later
189
self.reporter = reporter
199
allow_pointless=True,
207
message_callback=None,
210
possible_master_transports=None):
211
"""Commit working copy as a new revision.
213
:param message: the commit message (it or message_callback is required)
214
:param message_callback: A callback: message = message_callback(cmt_obj)
216
:param timestamp: if not None, seconds-since-epoch for a
217
postdated/predated commit.
219
:param specific_files: If not None, commit only those files. An empty
220
list means 'commit no files'.
222
:param rev_id: If set, use this as the new revision id.
223
Useful for test or import commands that need to tightly
224
control what revisions are assigned. If you duplicate
225
a revision id that exists elsewhere it is your own fault.
226
If null (default), a time/random revision id is generated.
228
:param allow_pointless: If true (default), commit even if nothing
229
has changed and no merges are recorded.
231
:param strict: If true, don't allow a commit if the working tree
232
contains unknown files.
234
:param revprops: Properties for new revision
235
:param local: Perform a local only commit.
236
:param reporter: the reporter to use or None for the default
237
:param verbose: if True and the reporter is not None, report everything
238
:param recursive: If set to 'down', commit in any subtrees that have
239
pending changes of any sort during this commit.
240
:param exclude: None or a list of relative paths to exclude from the
241
commit. Pending changes to excluded files will be ignored by the
244
operation = OperationWithCleanups(self._commit)
245
self.revprops = revprops or {}
246
return operation.run(
251
specific_files=specific_files,
253
allow_pointless=allow_pointless,
256
working_tree=working_tree,
260
message_callback=message_callback,
263
possible_master_transports=possible_master_transports)
265
def _commit(self, operation, message, timestamp, timezone, committer,
266
specific_files, rev_id, allow_pointless, strict, verbose,
267
working_tree, local, reporter, config, message_callback, recursive,
268
exclude, possible_master_transports):
269
mutter('preparing to commit')
271
if working_tree is None:
272
raise BzrError("working_tree must be passed into commit().")
274
self.work_tree = working_tree
275
self.branch = self.work_tree.branch
276
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
277
if not self.branch.repository.supports_rich_root():
278
raise errors.RootNotRich()
279
if message_callback is None:
280
if message is not None:
281
if isinstance(message, str):
282
message = message.decode(get_user_encoding())
283
message_callback = lambda x: message
285
raise BzrError("The message or message_callback keyword"
286
" parameter is required for commit().")
288
self.bound_branch = None
289
self.any_entries_deleted = False
290
if exclude is not None:
291
self.exclude = sorted(
292
minimum_path_selection(exclude))
296
self.master_branch = None
297
self.recursive = recursive
299
# self.specific_files is None to indicate no filter, or any iterable to
300
# indicate a filter - [] means no files at all, as per iter_changes.
301
if specific_files is not None:
302
self.specific_files = sorted(
303
minimum_path_selection(specific_files))
305
self.specific_files = None
307
self.allow_pointless = allow_pointless
308
self.message_callback = message_callback
309
self.timestamp = timestamp
310
self.timezone = timezone
311
self.committer = committer
313
self.verbose = verbose
315
self.work_tree.lock_write()
316
operation.add_cleanup(self.work_tree.unlock)
317
self.parents = self.work_tree.get_parent_ids()
318
# We can use record_iter_changes IFF iter_changes is compatible with
319
# the command line parameters, and the repository has fast delta
320
# generation. See bug 347649.
321
self.use_record_iter_changes = (
323
not self.branch.repository._format.supports_tree_reference and
324
(self.branch.repository._format.fast_deltas or
325
len(self.parents) < 2))
326
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
327
operation.add_cleanup(self.pb.finished)
328
self.basis_revid = self.work_tree.last_revision()
329
self.basis_tree = self.work_tree.basis_tree()
330
self.basis_tree.lock_read()
331
operation.add_cleanup(self.basis_tree.unlock)
332
# Cannot commit with conflicts present.
333
if len(self.work_tree.conflicts()) > 0:
334
raise ConflictsInTree
336
# Setup the bound branch variables as needed.
337
self._check_bound_branch(operation, possible_master_transports)
339
# Check that the working tree is up to date
340
old_revno, new_revno = self._check_out_of_date_tree()
342
# Complete configuration setup
343
if reporter is not None:
344
self.reporter = reporter
345
elif self.reporter is None:
346
self.reporter = self._select_reporter()
347
if self.config is None:
348
self.config = self.branch.get_config()
350
self._set_specific_file_ids()
352
# Setup the progress bar. As the number of files that need to be
353
# committed in unknown, progress is reported as stages.
354
# We keep track of entries separately though and include that
355
# information in the progress bar during the relevant stages.
356
self.pb_stage_name = ""
357
self.pb_stage_count = 0
358
self.pb_stage_total = 5
359
if self.bound_branch:
360
self.pb_stage_total += 1
361
self.pb.show_pct = False
362
self.pb.show_spinner = False
363
self.pb.show_eta = False
364
self.pb.show_count = True
365
self.pb.show_bar = True
367
self._gather_parents()
368
# After a merge, a selected file commit is not supported.
369
# See 'bzr help merge' for an explanation as to why.
370
if len(self.parents) > 1 and self.specific_files is not None:
371
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
372
# Excludes are a form of selected file commit.
373
if len(self.parents) > 1 and self.exclude:
374
raise errors.CannotCommitSelectedFileMerge(self.exclude)
376
# Collect the changes
377
self._set_progress_stage("Collecting changes", counter=True)
378
self.builder = self.branch.get_commit_builder(self.parents,
379
self.config, timestamp, timezone, committer, self.revprops, rev_id)
382
self.builder.will_record_deletes()
383
# find the location being committed to
384
if self.bound_branch:
385
master_location = self.master_branch.base
387
master_location = self.branch.base
389
# report the start of the commit
390
self.reporter.started(new_revno, self.rev_id, master_location)
392
self._update_builder_with_changes()
393
self._check_pointless()
395
# TODO: Now the new inventory is known, check for conflicts.
396
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
397
# weave lines, because nothing should be recorded until it is known
398
# that commit will succeed.
399
self._set_progress_stage("Saving data locally")
400
self.builder.finish_inventory()
402
# Prompt the user for a commit message if none provided
403
message = message_callback(self)
404
self.message = message
406
# Add revision data to the local branch
407
self.rev_id = self.builder.commit(self.message)
410
mutter("aborting commit write group because of exception:")
411
trace.log_exception_quietly()
412
note("aborting commit write group: %r" % (e,))
416
self._process_pre_hooks(old_revno, new_revno)
418
# Upload revision data to the master.
419
# this will propagate merged revisions too if needed.
420
if self.bound_branch:
421
self._set_progress_stage("Uploading data to master branch")
422
# 'commit' to the master first so a timeout here causes the
423
# local branch to be out of date
424
self.master_branch.import_last_revision_info(
425
self.branch.repository, new_revno, self.rev_id)
427
# and now do the commit locally.
428
self.branch.set_last_revision_info(new_revno, self.rev_id)
430
# Make the working tree be up to date with the branch. This
431
# includes automatic changes scheduled to be made to the tree, such
432
# as updating its basis and unversioning paths that were missing.
433
self.work_tree.unversion(self.deleted_ids)
434
self._set_progress_stage("Updating the working tree")
435
self.work_tree.update_basis_by_delta(self.rev_id,
436
self.builder.get_basis_delta())
437
self.reporter.completed(new_revno, self.rev_id)
438
self._process_post_hooks(old_revno, new_revno)
441
def _select_reporter(self):
442
"""Select the CommitReporter to use."""
444
return NullCommitReporter()
445
return ReportCommitToLog()
447
def _check_pointless(self):
448
if self.allow_pointless:
450
# A merge with no effect on files
451
if len(self.parents) > 1:
453
# TODO: we could simplify this by using self.builder.basis_delta.
455
# The initial commit adds a root directory, but this in itself is not
456
# a worthwhile commit.
457
if (self.basis_revid == revision.NULL_REVISION and
458
((self.builder.new_inventory is not None and
459
len(self.builder.new_inventory) == 1) or
460
len(self.builder._basis_delta) == 1)):
461
raise PointlessCommit()
462
if self.builder.any_changes():
464
raise PointlessCommit()
466
def _check_bound_branch(self, operation, possible_master_transports=None):
467
"""Check to see if the local branch is bound.
469
If it is bound, then most of the commit will actually be
470
done using the remote branch as the target branch.
471
Only at the end will the local branch be updated.
473
if self.local and not self.branch.get_bound_location():
474
raise errors.LocalRequiresBoundBranch()
477
self.master_branch = self.branch.get_master_branch(
478
possible_master_transports)
480
if not self.master_branch:
481
# make this branch the reference branch for out of date checks.
482
self.master_branch = self.branch
485
# If the master branch is bound, we must fail
486
master_bound_location = self.master_branch.get_bound_location()
487
if master_bound_location:
488
raise errors.CommitToDoubleBoundBranch(self.branch,
489
self.master_branch, master_bound_location)
491
# TODO: jam 20051230 We could automatically push local
492
# commits to the remote branch if they would fit.
493
# But for now, just require remote to be identical
496
# Make sure the local branch is identical to the master
497
master_info = self.master_branch.last_revision_info()
498
local_info = self.branch.last_revision_info()
499
if local_info != master_info:
500
raise errors.BoundBranchOutOfDate(self.branch,
503
# Now things are ready to change the master branch
505
self.bound_branch = self.branch
506
self.master_branch.lock_write()
507
operation.add_cleanup(self.master_branch.unlock)
509
def _check_out_of_date_tree(self):
510
"""Check that the working tree is up to date.
512
:return: old_revision_number,new_revision_number tuple
515
first_tree_parent = self.work_tree.get_parent_ids()[0]
517
# if there are no parents, treat our parent as 'None'
518
# this is so that we still consider the master branch
519
# - in a checkout scenario the tree may have no
520
# parents but the branch may do.
521
first_tree_parent = bzrlib.revision.NULL_REVISION
522
old_revno, master_last = self.master_branch.last_revision_info()
523
if master_last != first_tree_parent:
524
if master_last != bzrlib.revision.NULL_REVISION:
525
raise errors.OutOfDateTree(self.work_tree)
526
if self.branch.repository.has_revision(first_tree_parent):
527
new_revno = old_revno + 1
529
# ghost parents never appear in revision history.
531
return old_revno,new_revno
533
def _process_pre_hooks(self, old_revno, new_revno):
534
"""Process any registered pre commit hooks."""
535
self._set_progress_stage("Running pre_commit hooks")
536
self._process_hooks("pre_commit", old_revno, new_revno)
538
def _process_post_hooks(self, old_revno, new_revno):
539
"""Process any registered post commit hooks."""
540
# Process the post commit hooks, if any
541
self._set_progress_stage("Running post_commit hooks")
542
# old style commit hooks - should be deprecated ? (obsoleted in
544
if self.config.post_commit() is not None:
545
hooks = self.config.post_commit().split(' ')
546
# this would be nicer with twisted.python.reflect.namedAny
548
result = eval(hook + '(branch, rev_id)',
549
{'branch':self.branch,
551
'rev_id':self.rev_id})
552
# process new style post commit hooks
553
self._process_hooks("post_commit", old_revno, new_revno)
555
def _process_hooks(self, hook_name, old_revno, new_revno):
556
if not Branch.hooks[hook_name]:
559
# new style commit hooks:
560
if not self.bound_branch:
561
hook_master = self.branch
564
hook_master = self.master_branch
565
hook_local = self.branch
566
# With bound branches, when the master is behind the local branch,
567
# the 'old_revno' and old_revid values here are incorrect.
568
# XXX: FIXME ^. RBC 20060206
570
old_revid = self.parents[0]
572
old_revid = bzrlib.revision.NULL_REVISION
574
if hook_name == "pre_commit":
575
future_tree = self.builder.revision_tree()
576
tree_delta = future_tree.changes_from(self.basis_tree,
579
for hook in Branch.hooks[hook_name]:
580
# show the running hook in the progress bar. As hooks may
581
# end up doing nothing (e.g. because they are not configured by
582
# the user) this is still showing progress, not showing overall
583
# actions - its up to each plugin to show a UI if it want's to
584
# (such as 'Emailing diff to foo@example.com').
585
self.pb_stage_name = "Running %s hooks [%s]" % \
586
(hook_name, Branch.hooks.get_hook_name(hook))
587
self._emit_progress()
588
if 'hooks' in debug.debug_flags:
589
mutter("Invoking commit hook: %r", hook)
590
if hook_name == "post_commit":
591
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
593
elif hook_name == "pre_commit":
594
hook(hook_local, hook_master,
595
old_revno, old_revid, new_revno, self.rev_id,
596
tree_delta, future_tree)
598
def _gather_parents(self):
599
"""Record the parents of a merge for merge detection."""
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:]:
607
if self.branch.repository.has_revision(revision):
608
mutter('commit parent revision {%s}', revision)
609
inventory = self.branch.repository.get_inventory(revision)
610
self.parent_invs.append(inventory)
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
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
specific_files=specific_files)
625
iter_changes = self._filter_iter_changes(iter_changes)
626
for file_id, path, fs_hash in self.builder.record_iter_changes(
627
self.work_tree, self.basis_revid, iter_changes):
628
self.work_tree._observed_sha1(file_id, path, fs_hash)
630
# Build the new inventory
631
self._populate_from_inventory()
632
self._record_unselected()
633
self._report_and_accumulate_deletes()
635
def _filter_iter_changes(self, iter_changes):
636
"""Process iter_changes.
638
This method reports on the changes in iter_changes to the user, and
639
converts 'missing' entries in the iter_changes iterator to 'deleted'
640
entries. 'missing' entries have their
642
:param iter_changes: An iter_changes to process.
643
:return: A generator of changes.
645
reporter = self.reporter
646
report_changes = reporter.is_verbose()
648
for change in iter_changes:
650
old_path = change[1][0]
651
new_path = change[1][1]
652
versioned = change[3][1]
654
versioned = change[3][1]
655
if kind is None and versioned:
658
reporter.missing(new_path)
659
deleted_ids.append(change[0])
660
# Reset the new path (None) and new versioned flag (False)
661
change = (change[0], (change[1][0], None), change[2],
662
(change[3][0], False)) + change[4:]
663
elif kind == 'tree-reference':
664
if self.recursive == 'down':
665
self._commit_nested_tree(change[0], change[1][1])
666
if change[3][0] or change[3][1]:
670
reporter.deleted(old_path)
671
elif old_path is None:
672
reporter.snapshot_change('added', new_path)
673
elif old_path != new_path:
674
reporter.renamed('renamed', old_path, new_path)
677
self.work_tree.branch.repository._format.rich_root_data):
678
# Don't report on changes to '' in non rich root
680
reporter.snapshot_change('modified', new_path)
681
self._next_progress_entry()
682
# Unversion IDs that were found to be deleted
683
self.deleted_ids = deleted_ids
685
def _record_unselected(self):
686
# If specific files are selected, then all un-selected files must be
687
# recorded in their previous state. For more details, see
688
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
689
if self.specific_files or self.exclude:
690
specific_files = self.specific_files or []
691
for path, old_ie in self.basis_inv.iter_entries():
692
if old_ie.file_id in self.builder.new_inventory:
693
# already added - skip.
695
if (is_inside_any(specific_files, path)
696
and not is_inside_any(self.exclude, path)):
697
# was inside the selected path, and not excluded - if not
698
# present it has been deleted so skip.
700
# From here down it was either not selected, or was excluded:
701
# We preserve the entry unaltered.
703
# Note: specific file commits after a merge are currently
704
# prohibited. This test is for sanity/safety in case it's
705
# required after that changes.
706
if len(self.parents) > 1:
708
self.builder.record_entry_contents(ie, self.parent_invs, path,
709
self.basis_tree, None)
711
def _report_and_accumulate_deletes(self):
712
if (isinstance(self.basis_inv, Inventory)
713
and isinstance(self.builder.new_inventory, Inventory)):
714
# the older Inventory classes provide a _byid dict, and building a
715
# set from the keys of this dict is substantially faster than even
716
# getting a set of ids from the inventory
718
# <lifeless> set(dict) is roughly the same speed as
719
# set(iter(dict)) and both are significantly slower than
721
deleted_ids = set(self.basis_inv._byid.keys()) - \
722
set(self.builder.new_inventory._byid.keys())
724
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
726
self.any_entries_deleted = True
727
deleted = [(self.basis_tree.id2path(file_id), file_id)
728
for file_id in deleted_ids]
730
# XXX: this is not quite directory-order sorting
731
for path, file_id in deleted:
732
self.builder.record_delete(path, file_id)
733
self.reporter.deleted(path)
735
def _check_strict(self):
736
# XXX: when we use iter_changes this would likely be faster if
737
# iter_changes would check for us (even in the presence of
740
# raise an exception as soon as we find a single unknown.
741
for unknown in self.work_tree.unknowns():
742
raise StrictCommitFailed()
744
def _populate_from_inventory(self):
745
"""Populate the CommitBuilder by walking the working tree inventory."""
746
# Build the revision inventory.
748
# This starts by creating a new empty inventory. Depending on
749
# which files are selected for commit, and what is present in the
750
# current tree, the new inventory is populated. inventory entries
751
# which are candidates for modification have their revision set to
752
# None; inventory entries that are carried over untouched have their
753
# revision set to their prior value.
755
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
756
# results to create a new inventory at the same time, which results
757
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
760
specific_files = self.specific_files
761
exclude = self.exclude
762
report_changes = self.reporter.is_verbose()
764
# A tree of paths that have been deleted. E.g. if foo/bar has been
765
# deleted, then we have {'foo':{'bar':{}}}
767
# XXX: Note that entries may have the wrong kind because the entry does
768
# not reflect the status on disk.
769
work_inv = self.work_tree.inventory
770
# NB: entries will include entries within the excluded ids/paths
771
# because iter_entries_by_dir has no 'exclude' facility today.
772
entries = work_inv.iter_entries_by_dir(
773
specific_file_ids=self.specific_file_ids, yield_parents=True)
774
for path, existing_ie in entries:
775
file_id = existing_ie.file_id
776
name = existing_ie.name
777
parent_id = existing_ie.parent_id
778
kind = existing_ie.kind
779
# Skip files that have been deleted from the working tree.
780
# The deleted path ids are also recorded so they can be explicitly
783
path_segments = splitpath(path)
784
deleted_dict = deleted_paths
785
for segment in path_segments:
786
deleted_dict = deleted_dict.get(segment, None)
788
# We either took a path not present in the dict
789
# (deleted_dict was None), or we've reached an empty
790
# child dir in the dict, so are now a sub-path.
794
if deleted_dict is not None:
795
# the path has a deleted parent, do not add it.
797
if exclude and is_inside_any(exclude, path):
798
# Skip excluded paths. Excluded paths are processed by
799
# _update_builder_with_changes.
801
content_summary = self.work_tree.path_content_summary(path)
802
kind = content_summary[0]
803
# Note that when a filter of specific files is given, we must only
804
# skip/record deleted files matching that filter.
805
if not specific_files or is_inside_any(specific_files, path):
806
if kind == 'missing':
807
if not deleted_paths:
808
# path won't have been split yet.
809
path_segments = splitpath(path)
810
deleted_dict = deleted_paths
811
for segment in path_segments:
812
deleted_dict = deleted_dict.setdefault(segment, {})
813
self.reporter.missing(path)
814
self._next_progress_entry()
815
deleted_ids.append(file_id)
817
# TODO: have the builder do the nested commit just-in-time IF and
819
if kind == 'tree-reference':
820
# enforce repository nested tree policy.
821
if (not self.work_tree.supports_tree_reference() or
822
# repository does not support it either.
823
not self.branch.repository._format.supports_tree_reference):
825
content_summary = (kind, None, None, None)
826
elif self.recursive == 'down':
827
nested_revision_id = self._commit_nested_tree(
829
content_summary = (kind, None, None, nested_revision_id)
831
nested_revision_id = self.work_tree.get_reference_revision(file_id)
832
content_summary = (kind, None, None, nested_revision_id)
834
# Record an entry for this item
835
# Note: I don't particularly want to have the existing_ie
836
# parameter but the test suite currently (28-Jun-07) breaks
837
# without it thanks to a unicode normalisation issue. :-(
838
definitely_changed = kind != existing_ie.kind
839
self._record_entry(path, file_id, specific_files, kind, name,
840
parent_id, definitely_changed, existing_ie, report_changes,
843
# Unversion IDs that were found to be deleted
844
self.deleted_ids = deleted_ids
846
def _commit_nested_tree(self, file_id, path):
847
"Commit a nested tree."
848
sub_tree = self.work_tree.get_nested_tree(file_id, path)
849
# FIXME: be more comprehensive here:
850
# this works when both trees are in --trees repository,
851
# but when both are bound to a different repository,
852
# it fails; a better way of approaching this is to
853
# finally implement the explicit-caches approach design
854
# a while back - RBC 20070306.
855
if sub_tree.branch.repository.has_same_location(
856
self.work_tree.branch.repository):
857
sub_tree.branch.repository = \
858
self.work_tree.branch.repository
860
return sub_tree.commit(message=None, revprops=self.revprops,
861
recursive=self.recursive,
862
message_callback=self.message_callback,
863
timestamp=self.timestamp, timezone=self.timezone,
864
committer=self.committer,
865
allow_pointless=self.allow_pointless,
866
strict=self.strict, verbose=self.verbose,
867
local=self.local, reporter=self.reporter)
868
except errors.PointlessCommit:
869
return self.work_tree.get_reference_revision(file_id)
871
def _record_entry(self, path, file_id, specific_files, kind, name,
872
parent_id, definitely_changed, existing_ie, report_changes,
874
"Record the new inventory entry for a path if any."
875
# mutter('check %s {%s}', path, file_id)
876
# mutter('%s selected for commit', path)
877
if definitely_changed or existing_ie is None:
878
ie = make_entry(kind, name, parent_id, file_id)
880
ie = existing_ie.copy()
882
# For carried over entries we don't care about the fs hash - the repo
883
# isn't generating a sha, so we're not saving computation time.
884
_, _, fs_hash = self.builder.record_entry_contents(
885
ie, self.parent_invs, path, self.work_tree, content_summary)
887
self._report_change(ie, path)
889
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
892
def _report_change(self, ie, path):
893
"""Report a change to the user.
895
The change that has occurred is described relative to the basis
898
if (self.basis_inv.has_id(ie.file_id)):
899
basis_ie = self.basis_inv[ie.file_id]
902
change = ie.describe_change(basis_ie, ie)
903
if change in (InventoryEntry.RENAMED,
904
InventoryEntry.MODIFIED_AND_RENAMED):
905
old_path = self.basis_inv.id2path(ie.file_id)
906
self.reporter.renamed(change, old_path, path)
907
self._next_progress_entry()
909
if change == 'unchanged':
911
self.reporter.snapshot_change(change, path)
912
self._next_progress_entry()
914
def _set_progress_stage(self, name, counter=False):
915
"""Set the progress stage and emit an update to the progress bar."""
916
self.pb_stage_name = name
917
self.pb_stage_count += 1
919
self.pb_entries_count = 0
921
self.pb_entries_count = None
922
self._emit_progress()
924
def _next_progress_entry(self):
925
"""Emit an update to the progress bar and increment the entry count."""
926
self.pb_entries_count += 1
927
self._emit_progress()
929
def _emit_progress(self):
930
if self.pb_entries_count is not None:
931
text = "%s [%d] - Stage" % (self.pb_stage_name,
932
self.pb_entries_count)
934
text = "%s - Stage" % (self.pb_stage_name, )
935
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
937
def _set_specific_file_ids(self):
938
"""populate self.specific_file_ids if we will use it."""
939
if not self.use_record_iter_changes:
940
# If provided, ensure the specified files are versioned
941
if self.specific_files is not None:
942
# Note: This routine is being called because it raises
943
# PathNotVersionedError as a side effect of finding the IDs. We
944
# later use the ids we found as input to the working tree
945
# inventory iterator, so we only consider those ids rather than
946
# examining the whole tree again.
947
# XXX: Dont we have filter_unversioned to do this more
949
self.specific_file_ids = tree.find_ids_across_trees(
950
self.specific_files, [self.basis_tree, self.work_tree])
952
self.specific_file_ids = None
added
removed
bzrlib/commit.py
