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)
151
def deleted(self, path):
152
self._note('deleted %s', path)
154
def missing(self, path):
155
self._note('missing %s', path)
157
def renamed(self, change, old_path, new_path):
158
self._note('%s %s => %s', change, old_path, new_path)
160
def is_verbose(self):
164
class Commit(object):
165
"""Task of committing a new revision.
167
This is a MethodObject: it accumulates state as the commit is
168
prepared, and then it is discarded. It doesn't represent
169
historical revisions, just the act of recording a new one.
172
Modified to hold a list of files that have been deleted from
173
the working directory; these should be removed from the
179
"""Create a Commit object.
181
:param reporter: the default reporter to use or None to decide later
183
self.reporter = reporter
193
allow_pointless=True,
201
message_callback=None,
204
possible_master_transports=None):
205
"""Commit working copy as a new revision.
207
:param message: the commit message (it or message_callback is required)
208
:param message_callback: A callback: message = message_callback(cmt_obj)
210
:param timestamp: if not None, seconds-since-epoch for a
211
postdated/predated commit.
213
:param specific_files: If not None, commit only those files. An empty
214
list means 'commit no files'.
216
:param rev_id: If set, use this as the new revision id.
217
Useful for test or import commands that need to tightly
218
control what revisions are assigned. If you duplicate
219
a revision id that exists elsewhere it is your own fault.
220
If null (default), a time/random revision id is generated.
222
:param allow_pointless: If true (default), commit even if nothing
223
has changed and no merges are recorded.
225
:param strict: If true, don't allow a commit if the working tree
226
contains unknown files.
228
:param revprops: Properties for new revision
229
:param local: Perform a local only commit.
230
:param reporter: the reporter to use or None for the default
231
:param verbose: if True and the reporter is not None, report everything
232
:param recursive: If set to 'down', commit in any subtrees that have
233
pending changes of any sort during this commit.
234
:param exclude: None or a list of relative paths to exclude from the
235
commit. Pending changes to excluded files will be ignored by the
238
operation = OperationWithCleanups(self._commit)
239
self.revprops = revprops or {}
240
return operation.run(
245
specific_files=specific_files,
247
allow_pointless=allow_pointless,
250
working_tree=working_tree,
254
message_callback=message_callback,
257
possible_master_transports=possible_master_transports)
259
def _commit(self, operation, message, timestamp, timezone, committer,
260
specific_files, rev_id, allow_pointless, strict, verbose,
261
working_tree, local, reporter, config, message_callback, recursive,
262
exclude, possible_master_transports):
263
mutter('preparing to commit')
265
if working_tree is None:
266
raise BzrError("working_tree must be passed into commit().")
268
self.work_tree = working_tree
269
self.branch = self.work_tree.branch
270
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
271
if not self.branch.repository.supports_rich_root():
272
raise errors.RootNotRich()
273
if message_callback is None:
274
if message is not None:
275
if isinstance(message, str):
276
message = message.decode(get_user_encoding())
277
message_callback = lambda x: message
279
raise BzrError("The message or message_callback keyword"
280
" parameter is required for commit().")
282
self.bound_branch = None
283
self.any_entries_deleted = False
284
if exclude is not None:
285
self.exclude = sorted(
286
minimum_path_selection(exclude))
290
self.master_branch = None
291
self.recursive = recursive
293
# self.specific_files is None to indicate no filter, or any iterable to
294
# indicate a filter - [] means no files at all, as per iter_changes.
295
if specific_files is not None:
296
self.specific_files = sorted(
297
minimum_path_selection(specific_files))
299
self.specific_files = None
301
self.allow_pointless = allow_pointless
302
self.message_callback = message_callback
303
self.timestamp = timestamp
304
self.timezone = timezone
305
self.committer = committer
307
self.verbose = verbose
309
self.work_tree.lock_write()
310
operation.add_cleanup(self.work_tree.unlock)
311
self.parents = self.work_tree.get_parent_ids()
312
# We can use record_iter_changes IFF iter_changes is compatible with
313
# the command line parameters, and the repository has fast delta
314
# generation. See bug 347649.
315
self.use_record_iter_changes = (
317
not self.branch.repository._format.supports_tree_reference and
318
(self.branch.repository._format.fast_deltas or
319
len(self.parents) < 2))
320
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
321
operation.add_cleanup(self.pb.finished)
322
self.basis_revid = self.work_tree.last_revision()
323
self.basis_tree = self.work_tree.basis_tree()
324
self.basis_tree.lock_read()
325
operation.add_cleanup(self.basis_tree.unlock)
326
# Cannot commit with conflicts present.
327
if len(self.work_tree.conflicts()) > 0:
328
raise ConflictsInTree
330
# Setup the bound branch variables as needed.
331
self._check_bound_branch(operation, possible_master_transports)
333
# Check that the working tree is up to date
334
old_revno, new_revno = self._check_out_of_date_tree()
336
# Complete configuration setup
337
if reporter is not None:
338
self.reporter = reporter
339
elif self.reporter is None:
340
self.reporter = self._select_reporter()
341
if self.config is None:
342
self.config = self.branch.get_config()
344
self._set_specific_file_ids()
346
# Setup the progress bar. As the number of files that need to be
347
# committed in unknown, progress is reported as stages.
348
# We keep track of entries separately though and include that
349
# information in the progress bar during the relevant stages.
350
self.pb_stage_name = ""
351
self.pb_stage_count = 0
352
self.pb_stage_total = 5
353
if self.bound_branch:
354
self.pb_stage_total += 1
355
self.pb.show_pct = False
356
self.pb.show_spinner = False
357
self.pb.show_eta = False
358
self.pb.show_count = True
359
self.pb.show_bar = True
361
self._gather_parents()
362
# After a merge, a selected file commit is not supported.
363
# See 'bzr help merge' for an explanation as to why.
364
if len(self.parents) > 1 and self.specific_files is not None:
365
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
366
# Excludes are a form of selected file commit.
367
if len(self.parents) > 1 and self.exclude:
368
raise errors.CannotCommitSelectedFileMerge(self.exclude)
370
# Collect the changes
371
self._set_progress_stage("Collecting changes", counter=True)
372
self.builder = self.branch.get_commit_builder(self.parents,
373
self.config, timestamp, timezone, committer, self.revprops, rev_id)
376
self.builder.will_record_deletes()
377
# find the location being committed to
378
if self.bound_branch:
379
master_location = self.master_branch.base
381
master_location = self.branch.base
383
# report the start of the commit
384
self.reporter.started(new_revno, self.rev_id, master_location)
386
self._update_builder_with_changes()
387
self._check_pointless()
389
# TODO: Now the new inventory is known, check for conflicts.
390
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
391
# weave lines, because nothing should be recorded until it is known
392
# that commit will succeed.
393
self._set_progress_stage("Saving data locally")
394
self.builder.finish_inventory()
396
# Prompt the user for a commit message if none provided
397
message = message_callback(self)
398
self.message = message
400
# Add revision data to the local branch
401
self.rev_id = self.builder.commit(self.message)
404
mutter("aborting commit write group because of exception:")
405
trace.log_exception_quietly()
406
note("aborting commit write group: %r" % (e,))
410
self._process_pre_hooks(old_revno, new_revno)
412
# Upload revision data to the master.
413
# this will propagate merged revisions too if needed.
414
if self.bound_branch:
415
self._set_progress_stage("Uploading data to master branch")
416
# 'commit' to the master first so a timeout here causes the
417
# local branch to be out of date
418
self.master_branch.import_last_revision_info(
419
self.branch.repository, new_revno, self.rev_id)
421
# and now do the commit locally.
422
self.branch.set_last_revision_info(new_revno, self.rev_id)
424
# Make the working tree be up to date with the branch. This
425
# includes automatic changes scheduled to be made to the tree, such
426
# as updating its basis and unversioning paths that were missing.
427
self.work_tree.unversion(self.deleted_ids)
428
self._set_progress_stage("Updating the working tree")
429
self.work_tree.update_basis_by_delta(self.rev_id,
430
self.builder.get_basis_delta())
431
self.reporter.completed(new_revno, self.rev_id)
432
self._process_post_hooks(old_revno, new_revno)
435
def _select_reporter(self):
436
"""Select the CommitReporter to use."""
438
return NullCommitReporter()
439
return ReportCommitToLog()
441
def _check_pointless(self):
442
if self.allow_pointless:
444
# A merge with no effect on files
445
if len(self.parents) > 1:
447
# TODO: we could simplify this by using self.builder.basis_delta.
449
# The initial commit adds a root directory, but this in itself is not
450
# a worthwhile commit.
451
if (self.basis_revid == revision.NULL_REVISION and
452
((self.builder.new_inventory is not None and
453
len(self.builder.new_inventory) == 1) or
454
len(self.builder._basis_delta) == 1)):
455
raise PointlessCommit()
456
if self.builder.any_changes():
458
raise PointlessCommit()
460
def _check_bound_branch(self, operation, possible_master_transports=None):
461
"""Check to see if the local branch is bound.
463
If it is bound, then most of the commit will actually be
464
done using the remote branch as the target branch.
465
Only at the end will the local branch be updated.
467
if self.local and not self.branch.get_bound_location():
468
raise errors.LocalRequiresBoundBranch()
471
self.master_branch = self.branch.get_master_branch(
472
possible_master_transports)
474
if not self.master_branch:
475
# make this branch the reference branch for out of date checks.
476
self.master_branch = self.branch
479
# If the master branch is bound, we must fail
480
master_bound_location = self.master_branch.get_bound_location()
481
if master_bound_location:
482
raise errors.CommitToDoubleBoundBranch(self.branch,
483
self.master_branch, master_bound_location)
485
# TODO: jam 20051230 We could automatically push local
486
# commits to the remote branch if they would fit.
487
# But for now, just require remote to be identical
490
# Make sure the local branch is identical to the master
491
master_info = self.master_branch.last_revision_info()
492
local_info = self.branch.last_revision_info()
493
if local_info != master_info:
494
raise errors.BoundBranchOutOfDate(self.branch,
497
# Now things are ready to change the master branch
499
self.bound_branch = self.branch
500
self.master_branch.lock_write()
501
operation.add_cleanup(self.master_branch.unlock)
503
def _check_out_of_date_tree(self):
504
"""Check that the working tree is up to date.
506
:return: old_revision_number,new_revision_number tuple
509
first_tree_parent = self.work_tree.get_parent_ids()[0]
511
# if there are no parents, treat our parent as 'None'
512
# this is so that we still consider the master branch
513
# - in a checkout scenario the tree may have no
514
# parents but the branch may do.
515
first_tree_parent = bzrlib.revision.NULL_REVISION
516
old_revno, master_last = self.master_branch.last_revision_info()
517
if master_last != first_tree_parent:
518
if master_last != bzrlib.revision.NULL_REVISION:
519
raise errors.OutOfDateTree(self.work_tree)
520
if self.branch.repository.has_revision(first_tree_parent):
521
new_revno = old_revno + 1
523
# ghost parents never appear in revision history.
525
return old_revno,new_revno
527
def _process_pre_hooks(self, old_revno, new_revno):
528
"""Process any registered pre commit hooks."""
529
self._set_progress_stage("Running pre_commit hooks")
530
self._process_hooks("pre_commit", old_revno, new_revno)
532
def _process_post_hooks(self, old_revno, new_revno):
533
"""Process any registered post commit hooks."""
534
# Process the post commit hooks, if any
535
self._set_progress_stage("Running post_commit hooks")
536
# old style commit hooks - should be deprecated ? (obsoleted in
538
if self.config.post_commit() is not None:
539
hooks = self.config.post_commit().split(' ')
540
# this would be nicer with twisted.python.reflect.namedAny
542
result = eval(hook + '(branch, rev_id)',
543
{'branch':self.branch,
545
'rev_id':self.rev_id})
546
# process new style post commit hooks
547
self._process_hooks("post_commit", old_revno, new_revno)
549
def _process_hooks(self, hook_name, old_revno, new_revno):
550
if not Branch.hooks[hook_name]:
553
# new style commit hooks:
554
if not self.bound_branch:
555
hook_master = self.branch
558
hook_master = self.master_branch
559
hook_local = self.branch
560
# With bound branches, when the master is behind the local branch,
561
# the 'old_revno' and old_revid values here are incorrect.
562
# XXX: FIXME ^. RBC 20060206
564
old_revid = self.parents[0]
566
old_revid = bzrlib.revision.NULL_REVISION
568
if hook_name == "pre_commit":
569
future_tree = self.builder.revision_tree()
570
tree_delta = future_tree.changes_from(self.basis_tree,
573
for hook in Branch.hooks[hook_name]:
574
# show the running hook in the progress bar. As hooks may
575
# end up doing nothing (e.g. because they are not configured by
576
# the user) this is still showing progress, not showing overall
577
# actions - its up to each plugin to show a UI if it want's to
578
# (such as 'Emailing diff to foo@example.com').
579
self.pb_stage_name = "Running %s hooks [%s]" % \
580
(hook_name, Branch.hooks.get_hook_name(hook))
581
self._emit_progress()
582
if 'hooks' in debug.debug_flags:
583
mutter("Invoking commit hook: %r", hook)
584
if hook_name == "post_commit":
585
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
587
elif hook_name == "pre_commit":
588
hook(hook_local, hook_master,
589
old_revno, old_revid, new_revno, self.rev_id,
590
tree_delta, future_tree)
592
def _gather_parents(self):
593
"""Record the parents of a merge for merge detection."""
594
# TODO: Make sure that this list doesn't contain duplicate
595
# entries and the order is preserved when doing this.
596
if self.use_record_iter_changes:
598
self.basis_inv = self.basis_tree.inventory
599
self.parent_invs = [self.basis_inv]
600
for revision in self.parents[1:]:
601
if self.branch.repository.has_revision(revision):
602
mutter('commit parent revision {%s}', revision)
603
inventory = self.branch.repository.get_inventory(revision)
604
self.parent_invs.append(inventory)
606
mutter('commit parent ghost revision {%s}', revision)
608
def _update_builder_with_changes(self):
609
"""Update the commit builder with the data about what has changed.
611
exclude = self.exclude
612
specific_files = self.specific_files
613
mutter("Selecting files for commit with filter %s", specific_files)
616
if self.use_record_iter_changes:
617
iter_changes = self.work_tree.iter_changes(self.basis_tree,
618
specific_files=specific_files)
619
iter_changes = self._filter_iter_changes(iter_changes)
620
for file_id, path, fs_hash in self.builder.record_iter_changes(
621
self.work_tree, self.basis_revid, iter_changes):
622
self.work_tree._observed_sha1(file_id, path, fs_hash)
624
# Build the new inventory
625
self._populate_from_inventory()
626
self._record_unselected()
627
self._report_and_accumulate_deletes()
629
def _filter_iter_changes(self, iter_changes):
630
"""Process iter_changes.
632
This method reports on the changes in iter_changes to the user, and
633
converts 'missing' entries in the iter_changes iterator to 'deleted'
634
entries. 'missing' entries have their
636
:param iter_changes: An iter_changes to process.
637
:return: A generator of changes.
639
reporter = self.reporter
640
report_changes = reporter.is_verbose()
642
for change in iter_changes:
644
old_path = change[1][0]
645
new_path = change[1][1]
646
versioned = change[3][1]
648
versioned = change[3][1]
649
if kind is None and versioned:
652
reporter.missing(new_path)
653
deleted_ids.append(change[0])
654
# Reset the new path (None) and new versioned flag (False)
655
change = (change[0], (change[1][0], None), change[2],
656
(change[3][0], False)) + change[4:]
657
elif kind == 'tree-reference':
658
if self.recursive == 'down':
659
self._commit_nested_tree(change[0], change[1][1])
660
if change[3][0] or change[3][1]:
664
reporter.deleted(old_path)
665
elif old_path is None:
666
reporter.snapshot_change('added', new_path)
667
elif old_path != new_path:
668
reporter.renamed('renamed', old_path, new_path)
671
self.work_tree.branch.repository._format.rich_root_data):
672
# Don't report on changes to '' in non rich root
674
reporter.snapshot_change('modified', new_path)
675
self._next_progress_entry()
676
# Unversion IDs that were found to be deleted
677
self.deleted_ids = deleted_ids
679
def _record_unselected(self):
680
# If specific files are selected, then all un-selected files must be
681
# recorded in their previous state. For more details, see
682
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
683
if self.specific_files or self.exclude:
684
specific_files = self.specific_files or []
685
for path, old_ie in self.basis_inv.iter_entries():
686
if old_ie.file_id in self.builder.new_inventory:
687
# already added - skip.
689
if (is_inside_any(specific_files, path)
690
and not is_inside_any(self.exclude, path)):
691
# was inside the selected path, and not excluded - if not
692
# present it has been deleted so skip.
694
# From here down it was either not selected, or was excluded:
695
# We preserve the entry unaltered.
697
# Note: specific file commits after a merge are currently
698
# prohibited. This test is for sanity/safety in case it's
699
# required after that changes.
700
if len(self.parents) > 1:
702
self.builder.record_entry_contents(ie, self.parent_invs, path,
703
self.basis_tree, None)
705
def _report_and_accumulate_deletes(self):
706
if (isinstance(self.basis_inv, Inventory)
707
and isinstance(self.builder.new_inventory, Inventory)):
708
# the older Inventory classes provide a _byid dict, and building a
709
# set from the keys of this dict is substantially faster than even
710
# getting a set of ids from the inventory
712
# <lifeless> set(dict) is roughly the same speed as
713
# set(iter(dict)) and both are significantly slower than
715
deleted_ids = set(self.basis_inv._byid.keys()) - \
716
set(self.builder.new_inventory._byid.keys())
718
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
720
self.any_entries_deleted = True
721
deleted = [(self.basis_tree.id2path(file_id), file_id)
722
for file_id in deleted_ids]
724
# XXX: this is not quite directory-order sorting
725
for path, file_id in deleted:
726
self.builder.record_delete(path, file_id)
727
self.reporter.deleted(path)
729
def _check_strict(self):
730
# XXX: when we use iter_changes this would likely be faster if
731
# iter_changes would check for us (even in the presence of
734
# raise an exception as soon as we find a single unknown.
735
for unknown in self.work_tree.unknowns():
736
raise StrictCommitFailed()
738
def _populate_from_inventory(self):
739
"""Populate the CommitBuilder by walking the working tree inventory."""
740
# Build the revision inventory.
742
# This starts by creating a new empty inventory. Depending on
743
# which files are selected for commit, and what is present in the
744
# current tree, the new inventory is populated. inventory entries
745
# which are candidates for modification have their revision set to
746
# None; inventory entries that are carried over untouched have their
747
# revision set to their prior value.
749
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
750
# results to create a new inventory at the same time, which results
751
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
754
specific_files = self.specific_files
755
exclude = self.exclude
756
report_changes = self.reporter.is_verbose()
758
# A tree of paths that have been deleted. E.g. if foo/bar has been
759
# deleted, then we have {'foo':{'bar':{}}}
761
# XXX: Note that entries may have the wrong kind because the entry does
762
# not reflect the status on disk.
763
work_inv = self.work_tree.inventory
764
# NB: entries will include entries within the excluded ids/paths
765
# because iter_entries_by_dir has no 'exclude' facility today.
766
entries = work_inv.iter_entries_by_dir(
767
specific_file_ids=self.specific_file_ids, yield_parents=True)
768
for path, existing_ie in entries:
769
file_id = existing_ie.file_id
770
name = existing_ie.name
771
parent_id = existing_ie.parent_id
772
kind = existing_ie.kind
773
# Skip files that have been deleted from the working tree.
774
# The deleted path ids are also recorded so they can be explicitly
777
path_segments = splitpath(path)
778
deleted_dict = deleted_paths
779
for segment in path_segments:
780
deleted_dict = deleted_dict.get(segment, None)
782
# We either took a path not present in the dict
783
# (deleted_dict was None), or we've reached an empty
784
# child dir in the dict, so are now a sub-path.
788
if deleted_dict is not None:
789
# the path has a deleted parent, do not add it.
791
if exclude and is_inside_any(exclude, path):
792
# Skip excluded paths. Excluded paths are processed by
793
# _update_builder_with_changes.
795
content_summary = self.work_tree.path_content_summary(path)
796
kind = content_summary[0]
797
# Note that when a filter of specific files is given, we must only
798
# skip/record deleted files matching that filter.
799
if not specific_files or is_inside_any(specific_files, path):
800
if kind == 'missing':
801
if not deleted_paths:
802
# path won't have been split yet.
803
path_segments = splitpath(path)
804
deleted_dict = deleted_paths
805
for segment in path_segments:
806
deleted_dict = deleted_dict.setdefault(segment, {})
807
self.reporter.missing(path)
808
self._next_progress_entry()
809
deleted_ids.append(file_id)
811
# TODO: have the builder do the nested commit just-in-time IF and
813
if kind == 'tree-reference':
814
# enforce repository nested tree policy.
815
if (not self.work_tree.supports_tree_reference() or
816
# repository does not support it either.
817
not self.branch.repository._format.supports_tree_reference):
819
content_summary = (kind, None, None, None)
820
elif self.recursive == 'down':
821
nested_revision_id = self._commit_nested_tree(
823
content_summary = (kind, None, None, nested_revision_id)
825
nested_revision_id = self.work_tree.get_reference_revision(file_id)
826
content_summary = (kind, None, None, nested_revision_id)
828
# Record an entry for this item
829
# Note: I don't particularly want to have the existing_ie
830
# parameter but the test suite currently (28-Jun-07) breaks
831
# without it thanks to a unicode normalisation issue. :-(
832
definitely_changed = kind != existing_ie.kind
833
self._record_entry(path, file_id, specific_files, kind, name,
834
parent_id, definitely_changed, existing_ie, report_changes,
837
# Unversion IDs that were found to be deleted
838
self.deleted_ids = deleted_ids
840
def _commit_nested_tree(self, file_id, path):
841
"Commit a nested tree."
842
sub_tree = self.work_tree.get_nested_tree(file_id, path)
843
# FIXME: be more comprehensive here:
844
# this works when both trees are in --trees repository,
845
# but when both are bound to a different repository,
846
# it fails; a better way of approaching this is to
847
# finally implement the explicit-caches approach design
848
# a while back - RBC 20070306.
849
if sub_tree.branch.repository.has_same_location(
850
self.work_tree.branch.repository):
851
sub_tree.branch.repository = \
852
self.work_tree.branch.repository
854
return sub_tree.commit(message=None, revprops=self.revprops,
855
recursive=self.recursive,
856
message_callback=self.message_callback,
857
timestamp=self.timestamp, timezone=self.timezone,
858
committer=self.committer,
859
allow_pointless=self.allow_pointless,
860
strict=self.strict, verbose=self.verbose,
861
local=self.local, reporter=self.reporter)
862
except errors.PointlessCommit:
863
return self.work_tree.get_reference_revision(file_id)
865
def _record_entry(self, path, file_id, specific_files, kind, name,
866
parent_id, definitely_changed, existing_ie, report_changes,
868
"Record the new inventory entry for a path if any."
869
# mutter('check %s {%s}', path, file_id)
870
# mutter('%s selected for commit', path)
871
if definitely_changed or existing_ie is None:
872
ie = make_entry(kind, name, parent_id, file_id)
874
ie = existing_ie.copy()
876
# For carried over entries we don't care about the fs hash - the repo
877
# isn't generating a sha, so we're not saving computation time.
878
_, _, fs_hash = self.builder.record_entry_contents(
879
ie, self.parent_invs, path, self.work_tree, content_summary)
881
self._report_change(ie, path)
883
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
886
def _report_change(self, ie, path):
887
"""Report a change to the user.
889
The change that has occurred is described relative to the basis
892
if (self.basis_inv.has_id(ie.file_id)):
893
basis_ie = self.basis_inv[ie.file_id]
896
change = ie.describe_change(basis_ie, ie)
897
if change in (InventoryEntry.RENAMED,
898
InventoryEntry.MODIFIED_AND_RENAMED):
899
old_path = self.basis_inv.id2path(ie.file_id)
900
self.reporter.renamed(change, old_path, path)
901
self._next_progress_entry()
903
if change == 'unchanged':
905
self.reporter.snapshot_change(change, path)
906
self._next_progress_entry()
908
def _set_progress_stage(self, name, counter=False):
909
"""Set the progress stage and emit an update to the progress bar."""
910
self.pb_stage_name = name
911
self.pb_stage_count += 1
913
self.pb_entries_count = 0
915
self.pb_entries_count = None
916
self._emit_progress()
918
def _next_progress_entry(self):
919
"""Emit an update to the progress bar and increment the entry count."""
920
self.pb_entries_count += 1
921
self._emit_progress()
923
def _emit_progress(self):
924
if self.pb_entries_count is not None:
925
text = "%s [%d] - Stage" % (self.pb_stage_name,
926
self.pb_entries_count)
928
text = "%s - Stage" % (self.pb_stage_name, )
929
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
931
def _set_specific_file_ids(self):
932
"""populate self.specific_file_ids if we will use it."""
933
if not self.use_record_iter_changes:
934
# If provided, ensure the specified files are versioned
935
if self.specific_files is not None:
936
# Note: This routine is being called because it raises
937
# PathNotVersionedError as a side effect of finding the IDs. We
938
# later use the ids we found as input to the working tree
939
# inventory iterator, so we only consider those ids rather than
940
# examining the whole tree again.
941
# XXX: Dont we have filter_unversioned to do this more
943
self.specific_file_ids = tree.find_ids_across_trees(
944
self.specific_files, [self.basis_tree, self.work_tree])
946
self.specific_file_ids = None
added
removed
bzrlib/commit.py
