1
# Copyright (C) 2005-2011 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.
59
from bzrlib.branch import Branch
60
from bzrlib.cleanup import OperationWithCleanups
62
from bzrlib.errors import (BzrError, PointlessCommit,
66
from bzrlib.osutils import (get_user_encoding,
68
minimum_path_selection,
71
from bzrlib.trace import mutter, note, is_quiet
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
73
from bzrlib import symbol_versioning
74
from bzrlib.urlutils import unescape_for_display
75
from bzrlib.i18n import gettext
77
class NullCommitReporter(object):
78
"""I report on progress of a commit."""
80
def started(self, revno, revid, location=None):
82
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
83
"to started.", DeprecationWarning,
87
def snapshot_change(self, change, path):
90
def completed(self, revno, rev_id):
93
def deleted(self, path):
96
def missing(self, path):
99
def renamed(self, change, old_path, new_path):
102
def is_verbose(self):
106
class ReportCommitToLog(NullCommitReporter):
108
def _note(self, format, *args):
111
Subclasses may choose to override this method.
115
def snapshot_change(self, change, path):
116
if path == '' and change in (gettext('added'), gettext('modified')):
118
self._note("%s %s", change, path)
120
def started(self, revno, rev_id, location=None):
121
if location is not None:
122
location = ' to: ' + unescape_for_display(location, 'utf-8')
124
# When started was added, location was only made optional by
125
# accident. Matt Nordhoff 20071129
126
symbol_versioning.warn("As of bzr 1.0 you must pass a location "
127
"to started.", DeprecationWarning,
130
self._note(gettext('Committing%s'), location)
132
def completed(self, revno, rev_id):
133
self._note(gettext('Committed revision %d.'), revno)
134
# self._note goes to the console too; so while we want to log the
135
# rev_id, we can't trivially only log it. (See bug 526425). Long
136
# term we should rearrange the reporting structure, but for now
137
# we just mutter seperately. We mutter the revid and revno together
138
# so that concurrent bzr invocations won't lead to confusion.
139
mutter('Committed revid %s as revno %d.', rev_id, revno)
141
def deleted(self, path):
142
self._note(gettext('deleted %s'), path)
144
def missing(self, path):
145
self._note(gettext('missing %s'), path)
147
def renamed(self, change, old_path, new_path):
148
self._note('%s %s => %s', change, old_path, new_path)
150
def is_verbose(self):
154
class Commit(object):
155
"""Task of committing a new revision.
157
This is a MethodObject: it accumulates state as the commit is
158
prepared, and then it is discarded. It doesn't represent
159
historical revisions, just the act of recording a new one.
162
Modified to hold a list of files that have been deleted from
163
the working directory; these should be removed from the
169
"""Create a Commit object.
171
:param reporter: the default reporter to use or None to decide later
173
self.reporter = reporter
174
self.config_stack = config_stack
177
def update_revprops(revprops, branch, authors=None, author=None,
178
local=False, possible_master_transports=None):
181
if possible_master_transports is None:
182
possible_master_transports = []
183
if not 'branch-nick' in revprops:
184
revprops['branch-nick'] = branch._get_nick(
186
possible_master_transports)
187
if authors is not None:
188
if author is not None:
189
raise AssertionError('Specifying both author and authors '
190
'is not allowed. Specify just authors instead')
191
if 'author' in revprops or 'authors' in revprops:
192
# XXX: maybe we should just accept one of them?
193
raise AssertionError('author property given twice')
195
for individual in authors:
196
if '\n' in individual:
197
raise AssertionError('\\n is not a valid character '
198
'in an author identity')
199
revprops['authors'] = '\n'.join(authors)
200
if author is not None:
201
symbol_versioning.warn('The parameter author was deprecated'
202
' in version 1.13. Use authors instead',
204
if 'author' in revprops or 'authors' in revprops:
205
# XXX: maybe we should just accept one of them?
206
raise AssertionError('author property given twice')
208
raise AssertionError('\\n is not a valid character '
209
'in an author identity')
210
revprops['authors'] = author
220
allow_pointless=True,
228
message_callback=None,
231
possible_master_transports=None,
233
"""Commit working copy as a new revision.
235
:param message: the commit message (it or message_callback is required)
236
:param message_callback: A callback: message = message_callback(cmt_obj)
238
:param timestamp: if not None, seconds-since-epoch for a
239
postdated/predated commit.
241
:param specific_files: If not None, commit only those files. An empty
242
list means 'commit no files'.
244
:param rev_id: If set, use this as the new revision id.
245
Useful for test or import commands that need to tightly
246
control what revisions are assigned. If you duplicate
247
a revision id that exists elsewhere it is your own fault.
248
If null (default), a time/random revision id is generated.
250
:param allow_pointless: If true (default), commit even if nothing
251
has changed and no merges are recorded.
253
:param strict: If true, don't allow a commit if the working tree
254
contains unknown files.
256
:param revprops: Properties for new revision
257
:param local: Perform a local only commit.
258
:param reporter: the reporter to use or None for the default
259
:param verbose: if True and the reporter is not None, report everything
260
:param recursive: If set to 'down', commit in any subtrees that have
261
pending changes of any sort during this commit.
262
:param exclude: None or a list of relative paths to exclude from the
263
commit. Pending changes to excluded files will be ignored by the
265
:param lossy: When committing to a foreign VCS, ignore any
266
data that can not be natively represented.
268
operation = OperationWithCleanups(self._commit)
269
self.revprops = revprops or {}
270
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
271
self.config_stack = config or self.config_stack
272
return operation.run(
277
specific_files=specific_files,
279
allow_pointless=allow_pointless,
282
working_tree=working_tree,
285
message_callback=message_callback,
288
possible_master_transports=possible_master_transports,
291
def _commit(self, operation, message, timestamp, timezone, committer,
292
specific_files, rev_id, allow_pointless, strict, verbose,
293
working_tree, local, reporter, message_callback, recursive,
294
exclude, possible_master_transports, lossy):
295
mutter('preparing to commit')
297
if working_tree is None:
298
raise BzrError("working_tree must be passed into commit().")
300
self.work_tree = working_tree
301
self.branch = self.work_tree.branch
302
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
303
if not self.branch.repository.supports_rich_root():
304
raise errors.RootNotRich()
305
if message_callback is None:
306
if message is not None:
307
if isinstance(message, str):
308
message = message.decode(get_user_encoding())
309
message_callback = lambda x: message
311
raise BzrError("The message or message_callback keyword"
312
" parameter is required for commit().")
314
self.bound_branch = None
315
self.any_entries_deleted = False
316
if exclude is not None:
317
self.exclude = sorted(
318
minimum_path_selection(exclude))
322
self.master_branch = None
323
self.recursive = recursive
325
# self.specific_files is None to indicate no filter, or any iterable to
326
# indicate a filter - [] means no files at all, as per iter_changes.
327
if specific_files is not None:
328
self.specific_files = sorted(
329
minimum_path_selection(specific_files))
331
self.specific_files = None
333
self.allow_pointless = allow_pointless
334
self.message_callback = message_callback
335
self.timestamp = timestamp
336
self.timezone = timezone
337
self.committer = committer
339
self.verbose = verbose
341
self.work_tree.lock_write()
342
operation.add_cleanup(self.work_tree.unlock)
343
self.parents = self.work_tree.get_parent_ids()
344
# We can use record_iter_changes IFF iter_changes is compatible with
345
# the command line parameters, and the repository has fast delta
346
# generation. See bug 347649.
347
self.use_record_iter_changes = (
349
not self.branch.repository._format.supports_tree_reference and
350
(self.branch.repository._format.fast_deltas or
351
len(self.parents) < 2))
352
self.pb = ui.ui_factory.nested_progress_bar()
353
operation.add_cleanup(self.pb.finished)
354
self.basis_revid = self.work_tree.last_revision()
355
self.basis_tree = self.work_tree.basis_tree()
356
self.basis_tree.lock_read()
357
operation.add_cleanup(self.basis_tree.unlock)
358
# Cannot commit with conflicts present.
359
if len(self.work_tree.conflicts()) > 0:
360
raise ConflictsInTree
362
# Setup the bound branch variables as needed.
363
self._check_bound_branch(operation, possible_master_transports)
365
# Check that the working tree is up to date
366
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
368
# Complete configuration setup
369
if reporter is not None:
370
self.reporter = reporter
371
elif self.reporter is None:
372
self.reporter = self._select_reporter()
373
if self.config_stack is None:
374
self.config_stack = self.branch.get_config_stack()
376
self._set_specific_file_ids()
378
# Setup the progress bar. As the number of files that need to be
379
# committed in unknown, progress is reported as stages.
380
# We keep track of entries separately though and include that
381
# information in the progress bar during the relevant stages.
382
self.pb_stage_name = ""
383
self.pb_stage_count = 0
384
self.pb_stage_total = 5
385
if self.bound_branch:
386
# 2 extra stages: "Uploading data to master branch" and "Merging
387
# tags to master branch"
388
self.pb_stage_total += 2
389
self.pb.show_pct = False
390
self.pb.show_spinner = False
391
self.pb.show_eta = False
392
self.pb.show_count = True
393
self.pb.show_bar = True
395
self._gather_parents()
396
# After a merge, a selected file commit is not supported.
397
# See 'bzr help merge' for an explanation as to why.
398
if len(self.parents) > 1 and self.specific_files is not None:
399
raise errors.CannotCommitSelectedFileMerge(self.specific_files)
400
# Excludes are a form of selected file commit.
401
if len(self.parents) > 1 and self.exclude:
402
raise errors.CannotCommitSelectedFileMerge(self.exclude)
404
# Collect the changes
405
self._set_progress_stage("Collecting changes", counter=True)
407
self.builder = self.branch.get_commit_builder(self.parents,
408
self.config_stack, timestamp, timezone, committer, self.revprops,
410
if not self.builder.supports_record_entry_contents and self.exclude:
412
raise errors.ExcludesUnsupported(self.branch.repository)
414
if self.builder.updates_branch and self.bound_branch:
416
raise AssertionError(
417
"bound branches not supported for commit builders "
418
"that update the branch")
421
self.builder.will_record_deletes()
422
# find the location being committed to
423
if self.bound_branch:
424
master_location = self.master_branch.base
426
master_location = self.branch.base
428
# report the start of the commit
429
self.reporter.started(new_revno, self.rev_id, master_location)
431
self._update_builder_with_changes()
432
self._check_pointless()
434
# TODO: Now the new inventory is known, check for conflicts.
435
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
436
# weave lines, because nothing should be recorded until it is known
437
# that commit will succeed.
438
self._set_progress_stage("Saving data locally")
439
self.builder.finish_inventory()
441
# Prompt the user for a commit message if none provided
442
message = message_callback(self)
443
self.message = message
445
# Add revision data to the local branch
446
self.rev_id = self.builder.commit(self.message)
449
mutter("aborting commit write group because of exception:")
450
trace.log_exception_quietly()
454
self._update_branches(old_revno, old_revid, new_revno)
456
# Make the working tree be up to date with the branch. This
457
# includes automatic changes scheduled to be made to the tree, such
458
# as updating its basis and unversioning paths that were missing.
459
self.work_tree.unversion(self.deleted_ids)
460
self._set_progress_stage("Updating the working tree")
461
self.work_tree.update_basis_by_delta(self.rev_id,
462
self.builder.get_basis_delta())
463
self.reporter.completed(new_revno, self.rev_id)
464
self._process_post_hooks(old_revno, new_revno)
467
def _update_branches(self, old_revno, old_revid, new_revno):
468
"""Update the master and local branch to the new revision.
470
This will try to make sure that the master branch is updated
471
before the local branch.
473
:param old_revno: Revision number of master branch before the
475
:param old_revid: Tip of master branch before the commit
476
:param new_revno: Revision number of the new commit
478
if not self.builder.updates_branch:
479
self._process_pre_hooks(old_revno, new_revno)
481
# Upload revision data to the master.
482
# this will propagate merged revisions too if needed.
483
if self.bound_branch:
484
self._set_progress_stage("Uploading data to master branch")
485
# 'commit' to the master first so a timeout here causes the
486
# local branch to be out of date
487
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
488
self.branch, new_revno, self.rev_id, lossy=self._lossy)
490
self.branch.fetch(self.master_branch, self.rev_id)
492
# and now do the commit locally.
493
self.branch.set_last_revision_info(new_revno, self.rev_id)
496
self._process_pre_hooks(old_revno, new_revno)
498
# The commit builder will already have updated the branch,
500
self.branch.set_last_revision_info(old_revno, old_revid)
503
# Merge local tags to remote
504
if self.bound_branch:
505
self._set_progress_stage("Merging tags to master branch")
506
tag_updates, tag_conflicts = self.branch.tags.merge_to(
507
self.master_branch.tags)
509
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
510
note( gettext("Conflicting tags in bound branch:\n{0}".format(
511
"\n".join(warning_lines))) )
513
def _select_reporter(self):
514
"""Select the CommitReporter to use."""
516
return NullCommitReporter()
517
return ReportCommitToLog()
519
def _check_pointless(self):
520
if self.allow_pointless:
522
# A merge with no effect on files
523
if len(self.parents) > 1:
525
if self.builder.any_changes():
527
raise PointlessCommit()
529
def _check_bound_branch(self, operation, possible_master_transports=None):
530
"""Check to see if the local branch is bound.
532
If it is bound, then most of the commit will actually be
533
done using the remote branch as the target branch.
534
Only at the end will the local branch be updated.
536
if self.local and not self.branch.get_bound_location():
537
raise errors.LocalRequiresBoundBranch()
540
self.master_branch = self.branch.get_master_branch(
541
possible_master_transports)
543
if not self.master_branch:
544
# make this branch the reference branch for out of date checks.
545
self.master_branch = self.branch
548
# If the master branch is bound, we must fail
549
master_bound_location = self.master_branch.get_bound_location()
550
if master_bound_location:
551
raise errors.CommitToDoubleBoundBranch(self.branch,
552
self.master_branch, master_bound_location)
554
# TODO: jam 20051230 We could automatically push local
555
# commits to the remote branch if they would fit.
556
# But for now, just require remote to be identical
559
# Make sure the local branch is identical to the master
560
master_info = self.master_branch.last_revision_info()
561
local_info = self.branch.last_revision_info()
562
if local_info != master_info:
563
raise errors.BoundBranchOutOfDate(self.branch,
566
# Now things are ready to change the master branch
568
self.bound_branch = self.branch
569
self.master_branch.lock_write()
570
operation.add_cleanup(self.master_branch.unlock)
572
def _check_out_of_date_tree(self):
573
"""Check that the working tree is up to date.
575
:return: old_revision_number, old_revision_id, new_revision_number
579
first_tree_parent = self.work_tree.get_parent_ids()[0]
581
# if there are no parents, treat our parent as 'None'
582
# this is so that we still consider the master branch
583
# - in a checkout scenario the tree may have no
584
# parents but the branch may do.
585
first_tree_parent = bzrlib.revision.NULL_REVISION
586
old_revno, master_last = self.master_branch.last_revision_info()
587
if master_last != first_tree_parent:
588
if master_last != bzrlib.revision.NULL_REVISION:
589
raise errors.OutOfDateTree(self.work_tree)
590
if self.branch.repository.has_revision(first_tree_parent):
591
new_revno = old_revno + 1
593
# ghost parents never appear in revision history.
595
return old_revno, master_last, new_revno
597
def _process_pre_hooks(self, old_revno, new_revno):
598
"""Process any registered pre commit hooks."""
599
self._set_progress_stage("Running pre_commit hooks")
600
self._process_hooks("pre_commit", old_revno, new_revno)
602
def _process_post_hooks(self, old_revno, new_revno):
603
"""Process any registered post commit hooks."""
604
# Process the post commit hooks, if any
605
self._set_progress_stage("Running post_commit hooks")
606
# old style commit hooks - should be deprecated ? (obsoleted in
607
# 0.15^H^H^H^H 2.5.0)
608
post_commit = self.config_stack.get('post_commit')
609
if post_commit is not None:
610
hooks = post_commit.split(' ')
611
# this would be nicer with twisted.python.reflect.namedAny
613
result = eval(hook + '(branch, rev_id)',
614
{'branch':self.branch,
616
'rev_id':self.rev_id})
617
# process new style post commit hooks
618
self._process_hooks("post_commit", old_revno, new_revno)
620
def _process_hooks(self, hook_name, old_revno, new_revno):
621
if not Branch.hooks[hook_name]:
624
# new style commit hooks:
625
if not self.bound_branch:
626
hook_master = self.branch
629
hook_master = self.master_branch
630
hook_local = self.branch
631
# With bound branches, when the master is behind the local branch,
632
# the 'old_revno' and old_revid values here are incorrect.
633
# XXX: FIXME ^. RBC 20060206
635
old_revid = self.parents[0]
637
old_revid = bzrlib.revision.NULL_REVISION
639
if hook_name == "pre_commit":
640
future_tree = self.builder.revision_tree()
641
tree_delta = future_tree.changes_from(self.basis_tree,
644
for hook in Branch.hooks[hook_name]:
645
# show the running hook in the progress bar. As hooks may
646
# end up doing nothing (e.g. because they are not configured by
647
# the user) this is still showing progress, not showing overall
648
# actions - its up to each plugin to show a UI if it want's to
649
# (such as 'Emailing diff to foo@example.com').
650
self.pb_stage_name = "Running %s hooks [%s]" % \
651
(hook_name, Branch.hooks.get_hook_name(hook))
652
self._emit_progress()
653
if 'hooks' in debug.debug_flags:
654
mutter("Invoking commit hook: %r", hook)
655
if hook_name == "post_commit":
656
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
658
elif hook_name == "pre_commit":
659
hook(hook_local, hook_master,
660
old_revno, old_revid, new_revno, self.rev_id,
661
tree_delta, future_tree)
663
def _gather_parents(self):
664
"""Record the parents of a merge for merge detection."""
665
# TODO: Make sure that this list doesn't contain duplicate
666
# entries and the order is preserved when doing this.
667
if self.use_record_iter_changes:
669
self.basis_inv = self.basis_tree.inventory
670
self.parent_invs = [self.basis_inv]
671
for revision in self.parents[1:]:
672
if self.branch.repository.has_revision(revision):
673
mutter('commit parent revision {%s}', revision)
674
inventory = self.branch.repository.get_inventory(revision)
675
self.parent_invs.append(inventory)
677
mutter('commit parent ghost revision {%s}', revision)
679
def _update_builder_with_changes(self):
680
"""Update the commit builder with the data about what has changed.
682
exclude = self.exclude
683
specific_files = self.specific_files
684
mutter("Selecting files for commit with filter %s", specific_files)
687
if self.use_record_iter_changes:
688
iter_changes = self.work_tree.iter_changes(self.basis_tree,
689
specific_files=specific_files)
690
iter_changes = self._filter_iter_changes(iter_changes)
691
for file_id, path, fs_hash in self.builder.record_iter_changes(
692
self.work_tree, self.basis_revid, iter_changes):
693
self.work_tree._observed_sha1(file_id, path, fs_hash)
695
# Build the new inventory
696
self._populate_from_inventory()
697
self._record_unselected()
698
self._report_and_accumulate_deletes()
700
def _filter_iter_changes(self, iter_changes):
701
"""Process iter_changes.
703
This method reports on the changes in iter_changes to the user, and
704
converts 'missing' entries in the iter_changes iterator to 'deleted'
705
entries. 'missing' entries have their
707
:param iter_changes: An iter_changes to process.
708
:return: A generator of changes.
710
reporter = self.reporter
711
report_changes = reporter.is_verbose()
713
for change in iter_changes:
715
old_path = change[1][0]
716
new_path = change[1][1]
717
versioned = change[3][1]
719
versioned = change[3][1]
720
if kind is None and versioned:
723
reporter.missing(new_path)
724
deleted_ids.append(change[0])
725
# Reset the new path (None) and new versioned flag (False)
726
change = (change[0], (change[1][0], None), change[2],
727
(change[3][0], False)) + change[4:]
728
new_path = change[1][1]
730
elif kind == 'tree-reference':
731
if self.recursive == 'down':
732
self._commit_nested_tree(change[0], change[1][1])
733
if change[3][0] or change[3][1]:
737
reporter.deleted(old_path)
738
elif old_path is None:
739
reporter.snapshot_change(gettext('added'), new_path)
740
elif old_path != new_path:
741
reporter.renamed(gettext('renamed'), old_path, new_path)
744
self.work_tree.branch.repository._format.rich_root_data):
745
# Don't report on changes to '' in non rich root
747
reporter.snapshot_change(gettext('modified'), new_path)
748
self._next_progress_entry()
749
# Unversion IDs that were found to be deleted
750
self.deleted_ids = deleted_ids
752
def _record_unselected(self):
753
# If specific files are selected, then all un-selected files must be
754
# recorded in their previous state. For more details, see
755
# https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
756
if self.specific_files or self.exclude:
757
specific_files = self.specific_files or []
758
for path, old_ie in self.basis_inv.iter_entries():
759
if self.builder.new_inventory.has_id(old_ie.file_id):
760
# already added - skip.
762
if (is_inside_any(specific_files, path)
763
and not is_inside_any(self.exclude, path)):
764
# was inside the selected path, and not excluded - if not
765
# present it has been deleted so skip.
767
# From here down it was either not selected, or was excluded:
768
# We preserve the entry unaltered.
770
# Note: specific file commits after a merge are currently
771
# prohibited. This test is for sanity/safety in case it's
772
# required after that changes.
773
if len(self.parents) > 1:
775
self.builder.record_entry_contents(ie, self.parent_invs, path,
776
self.basis_tree, None)
778
def _report_and_accumulate_deletes(self):
779
if (isinstance(self.basis_inv, Inventory)
780
and isinstance(self.builder.new_inventory, Inventory)):
781
# the older Inventory classes provide a _byid dict, and building a
782
# set from the keys of this dict is substantially faster than even
783
# getting a set of ids from the inventory
785
# <lifeless> set(dict) is roughly the same speed as
786
# set(iter(dict)) and both are significantly slower than
788
deleted_ids = set(self.basis_inv._byid.keys()) - \
789
set(self.builder.new_inventory._byid.keys())
791
deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
793
self.any_entries_deleted = True
794
deleted = [(self.basis_tree.id2path(file_id), file_id)
795
for file_id in deleted_ids]
797
# XXX: this is not quite directory-order sorting
798
for path, file_id in deleted:
799
self.builder.record_delete(path, file_id)
800
self.reporter.deleted(path)
802
def _check_strict(self):
803
# XXX: when we use iter_changes this would likely be faster if
804
# iter_changes would check for us (even in the presence of
807
# raise an exception as soon as we find a single unknown.
808
for unknown in self.work_tree.unknowns():
809
raise StrictCommitFailed()
811
def _populate_from_inventory(self):
812
"""Populate the CommitBuilder by walking the working tree inventory."""
813
# Build the revision inventory.
815
# This starts by creating a new empty inventory. Depending on
816
# which files are selected for commit, and what is present in the
817
# current tree, the new inventory is populated. inventory entries
818
# which are candidates for modification have their revision set to
819
# None; inventory entries that are carried over untouched have their
820
# revision set to their prior value.
822
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
823
# results to create a new inventory at the same time, which results
824
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
827
specific_files = self.specific_files
828
exclude = self.exclude
829
report_changes = self.reporter.is_verbose()
831
# A tree of paths that have been deleted. E.g. if foo/bar has been
832
# deleted, then we have {'foo':{'bar':{}}}
834
# XXX: Note that entries may have the wrong kind because the entry does
835
# not reflect the status on disk.
836
work_inv = self.work_tree.inventory
837
# NB: entries will include entries within the excluded ids/paths
838
# because iter_entries_by_dir has no 'exclude' facility today.
839
entries = work_inv.iter_entries_by_dir(
840
specific_file_ids=self.specific_file_ids, yield_parents=True)
841
for path, existing_ie in entries:
842
file_id = existing_ie.file_id
843
name = existing_ie.name
844
parent_id = existing_ie.parent_id
845
kind = existing_ie.kind
846
# Skip files that have been deleted from the working tree.
847
# The deleted path ids are also recorded so they can be explicitly
850
path_segments = splitpath(path)
851
deleted_dict = deleted_paths
852
for segment in path_segments:
853
deleted_dict = deleted_dict.get(segment, None)
855
# We either took a path not present in the dict
856
# (deleted_dict was None), or we've reached an empty
857
# child dir in the dict, so are now a sub-path.
861
if deleted_dict is not None:
862
# the path has a deleted parent, do not add it.
864
if exclude and is_inside_any(exclude, path):
865
# Skip excluded paths. Excluded paths are processed by
866
# _update_builder_with_changes.
868
content_summary = self.work_tree.path_content_summary(path)
869
kind = content_summary[0]
870
# Note that when a filter of specific files is given, we must only
871
# skip/record deleted files matching that filter.
872
if not specific_files or is_inside_any(specific_files, path):
873
if kind == 'missing':
874
if not deleted_paths:
875
# path won't have been split yet.
876
path_segments = splitpath(path)
877
deleted_dict = deleted_paths
878
for segment in path_segments:
879
deleted_dict = deleted_dict.setdefault(segment, {})
880
self.reporter.missing(path)
881
self._next_progress_entry()
882
deleted_ids.append(file_id)
884
# TODO: have the builder do the nested commit just-in-time IF and
886
if kind == 'tree-reference':
887
# enforce repository nested tree policy.
888
if (not self.work_tree.supports_tree_reference() or
889
# repository does not support it either.
890
not self.branch.repository._format.supports_tree_reference):
892
content_summary = (kind, None, None, None)
893
elif self.recursive == 'down':
894
nested_revision_id = self._commit_nested_tree(
896
content_summary = (kind, None, None, nested_revision_id)
898
nested_revision_id = self.work_tree.get_reference_revision(file_id)
899
content_summary = (kind, None, None, nested_revision_id)
901
# Record an entry for this item
902
# Note: I don't particularly want to have the existing_ie
903
# parameter but the test suite currently (28-Jun-07) breaks
904
# without it thanks to a unicode normalisation issue. :-(
905
definitely_changed = kind != existing_ie.kind
906
self._record_entry(path, file_id, specific_files, kind, name,
907
parent_id, definitely_changed, existing_ie, report_changes,
910
# Unversion IDs that were found to be deleted
911
self.deleted_ids = deleted_ids
913
def _commit_nested_tree(self, file_id, path):
914
"Commit a nested tree."
915
sub_tree = self.work_tree.get_nested_tree(file_id, path)
916
# FIXME: be more comprehensive here:
917
# this works when both trees are in --trees repository,
918
# but when both are bound to a different repository,
919
# it fails; a better way of approaching this is to
920
# finally implement the explicit-caches approach design
921
# a while back - RBC 20070306.
922
if sub_tree.branch.repository.has_same_location(
923
self.work_tree.branch.repository):
924
sub_tree.branch.repository = \
925
self.work_tree.branch.repository
927
return sub_tree.commit(message=None, revprops=self.revprops,
928
recursive=self.recursive,
929
message_callback=self.message_callback,
930
timestamp=self.timestamp, timezone=self.timezone,
931
committer=self.committer,
932
allow_pointless=self.allow_pointless,
933
strict=self.strict, verbose=self.verbose,
934
local=self.local, reporter=self.reporter)
935
except errors.PointlessCommit:
936
return self.work_tree.get_reference_revision(file_id)
938
def _record_entry(self, path, file_id, specific_files, kind, name,
939
parent_id, definitely_changed, existing_ie, report_changes,
941
"Record the new inventory entry for a path if any."
942
# mutter('check %s {%s}', path, file_id)
943
# mutter('%s selected for commit', path)
944
if definitely_changed or existing_ie is None:
945
ie = make_entry(kind, name, parent_id, file_id)
947
ie = existing_ie.copy()
949
# For carried over entries we don't care about the fs hash - the repo
950
# isn't generating a sha, so we're not saving computation time.
951
_, _, fs_hash = self.builder.record_entry_contents(
952
ie, self.parent_invs, path, self.work_tree, content_summary)
954
self._report_change(ie, path)
956
self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
959
def _report_change(self, ie, path):
960
"""Report a change to the user.
962
The change that has occurred is described relative to the basis
965
if (self.basis_inv.has_id(ie.file_id)):
966
basis_ie = self.basis_inv[ie.file_id]
969
change = ie.describe_change(basis_ie, ie)
970
if change in (InventoryEntry.RENAMED,
971
InventoryEntry.MODIFIED_AND_RENAMED):
972
old_path = self.basis_inv.id2path(ie.file_id)
973
self.reporter.renamed(change, old_path, path)
974
self._next_progress_entry()
976
if change == gettext('unchanged'):
978
self.reporter.snapshot_change(change, path)
979
self._next_progress_entry()
981
def _set_progress_stage(self, name, counter=False):
982
"""Set the progress stage and emit an update to the progress bar."""
983
self.pb_stage_name = name
984
self.pb_stage_count += 1
986
self.pb_entries_count = 0
988
self.pb_entries_count = None
989
self._emit_progress()
991
def _next_progress_entry(self):
992
"""Emit an update to the progress bar and increment the entry count."""
993
self.pb_entries_count += 1
994
self._emit_progress()
996
def _emit_progress(self):
997
if self.pb_entries_count is not None:
998
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
999
self.pb_entries_count)
1001
text = gettext("%s - Stage") % (self.pb_stage_name, )
1002
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
1004
def _set_specific_file_ids(self):
1005
"""populate self.specific_file_ids if we will use it."""
1006
if not self.use_record_iter_changes:
1007
# If provided, ensure the specified files are versioned
1008
if self.specific_files is not None:
1009
# Note: This routine is being called because it raises
1010
# PathNotVersionedError as a side effect of finding the IDs. We
1011
# later use the ids we found as input to the working tree
1012
# inventory iterator, so we only consider those ids rather than
1013
# examining the whole tree again.
1014
# XXX: Dont we have filter_unversioned to do this more
1016
self.specific_file_ids = tree.find_ids_across_trees(
1017
self.specific_files, [self.basis_tree, self.work_tree])
1019
self.specific_file_ids = None
added
removed
bzrlib/commit.py
