47
56
# merges from, then it should still be reported as newly added
48
57
# relative to the basis revision.
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
# the rest of the code; add a deprecation of the old name.
59
from .branch import Branch
60
from .cleanup import ExitStack
62
from .errors import (BzrError,
66
from .osutils import (get_user_encoding,
69
minimum_path_selection,
71
from .trace import mutter, note, is_quiet
72
from .tree import TreeChange
73
from .urlutils import unescape_for_display
74
from .i18n import gettext
77
class PointlessCommit(BzrError):
79
_fmt = "No changes to commit"
82
class CannotCommitSelectedFileMerge(BzrError):
84
_fmt = 'Selected-file commit of merges is not supported yet:'\
85
' files %(files_str)s'
87
def __init__(self, files):
88
files_str = ', '.join(files)
89
BzrError.__init__(self, files=files, files_str=files_str)
92
def filter_excluded(iter_changes, exclude):
93
"""Filter exclude filenames.
95
:param iter_changes: iter_changes function
96
:param exclude: List of paths to exclude
97
:return: iter_changes function
59
# TODO: Do checks that the tree can be committed *before* running the
60
# editor; this should include checks for a pointless commit and for
61
# unknown or missing files.
63
# TODO: If commit fails, leave the message in a file somewhere.
72
from binascii import hexlify
73
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
78
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
82
import bzrlib.errors as errors
83
from bzrlib.errors import (BzrError, PointlessCommit,
88
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
from bzrlib.trace import mutter, note, warning
91
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.symbol_versioning import *
94
from bzrlib.weave import Weave
95
from bzrlib.weavefile import read_weave, write_weave_v5
96
from bzrlib.workingtree import WorkingTree
99
@deprecated_function(zero_seven)
100
def commit(*args, **kwargs):
101
"""Commit a new revision to a branch.
103
Function-style interface for convenience of old callers.
105
New code should use the Commit class instead.
99
for change in iter_changes:
100
new_excluded = (change.path[1] is not None and
101
is_inside_any(exclude, change.path[1]))
103
old_excluded = (change.path[0] is not None and
104
is_inside_any(exclude, change.path[0]))
106
if old_excluded and new_excluded:
109
if old_excluded or new_excluded:
110
# TODO(jelmer): Perhaps raise an error here instead?
107
## XXX: Remove this in favor of Branch.commit?
108
Commit().commit(*args, **kwargs)
116
111
class NullCommitReporter(object):
117
112
"""I report on progress of a commit."""
119
def started(self, revno, revid, location):
122
114
def snapshot_change(self, change, path):
125
117
def completed(self, revno, rev_id):
128
def deleted(self, path):
120
def deleted(self, file_id):
123
def escaped(self, escape_count, message):
131
126
def missing(self, path):
134
def renamed(self, change, old_path, new_path):
137
def is_verbose(self):
141
130
class ReportCommitToLog(NullCommitReporter):
143
def _note(self, format, *args):
146
Subclasses may choose to override this method.
150
132
def snapshot_change(self, change, path):
151
if path == '' and change in (gettext('added'), gettext('modified')):
153
self._note("%s %s", change, path)
155
def started(self, revno, rev_id, location):
157
gettext('Committing to: %s'),
158
unescape_for_display(location, 'utf-8'))
133
note("%s %s", change, path)
160
135
def completed(self, revno, rev_id):
161
if revno is not None:
162
self._note(gettext('Committed revision %d.'), revno)
163
# self._note goes to the console too; so while we want to log the
164
# rev_id, we can't trivially only log it. (See bug 526425). Long
165
# term we should rearrange the reporting structure, but for now
166
# we just mutter seperately. We mutter the revid and revno together
167
# so that concurrent bzr invocations won't lead to confusion.
168
mutter('Committed revid %s as revno %d.', rev_id, revno)
170
self._note(gettext('Committed revid %s.'), rev_id)
136
note('committed r%d {%s}', revno, rev_id)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
172
def deleted(self, path):
173
self._note(gettext('deleted %s'), path)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
175
144
def missing(self, path):
176
self._note(gettext('missing %s'), path)
178
def renamed(self, change, old_path, new_path):
179
self._note('%s %s => %s', change, old_path, new_path)
181
def is_verbose(self):
145
note('missing %s', path)
185
148
class Commit(object):
247
message_callback=None,
250
possible_master_transports=None,
252
184
"""Commit working copy as a new revision.
254
:param message: the commit message (it or message_callback is required)
255
:param message_callback: A callback: message =
256
message_callback(cmt_obj)
258
:param timestamp: if not None, seconds-since-epoch for a
259
postdated/predated commit.
261
:param specific_files: If not None, commit only those files. An empty
262
list means 'commit no files'.
264
:param rev_id: If set, use this as the new revision id.
186
branch -- the deprecated branch to commit to. New callers should pass in
189
message -- the commit message, a mandatory parameter
191
timestamp -- if not None, seconds-since-epoch for a
192
postdated/predated commit.
194
specific_files -- If true, commit only those files.
196
rev_id -- If set, use this as the new revision id.
265
197
Useful for test or import commands that need to tightly
266
198
control what revisions are assigned. If you duplicate
267
199
a revision id that exists elsewhere it is your own fault.
268
200
If null (default), a time/random revision id is generated.
270
:param allow_pointless: If true (default), commit even if nothing
202
allow_pointless -- If true (default), commit even if nothing
271
203
has changed and no merges are recorded.
273
:param strict: If true, don't allow a commit if the working tree
205
strict -- If true, don't allow a commit if the working tree
274
206
contains unknown files.
276
:param revprops: Properties for new revision
277
:param local: Perform a local only commit.
278
:param reporter: the reporter to use or None for the default
279
:param verbose: if True and the reporter is not None, report everything
280
:param recursive: If set to 'down', commit in any subtrees that have
281
pending changes of any sort during this commit.
282
:param exclude: None or a list of relative paths to exclude from the
283
commit. Pending changes to excluded files will be ignored by the
285
:param lossy: When committing to a foreign VCS, ignore any
286
data that can not be natively represented.
208
revprops -- Properties for new revision
288
with ExitStack() as stack:
289
self.revprops = revprops or {}
290
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
self.config_stack = config or self.config_stack
292
mutter('preparing to commit')
294
if working_tree is None:
295
raise BzrError("working_tree must be passed into commit().")
297
self.work_tree = working_tree
298
self.branch = self.work_tree.branch
299
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
300
if not self.branch.repository.supports_rich_root():
301
raise errors.RootNotRich()
302
if message_callback is None:
303
if message is not None:
304
if isinstance(message, bytes):
305
message = message.decode(get_user_encoding())
307
def message_callback(x):
310
raise BzrError("The message or message_callback keyword"
311
" parameter is required for commit().")
313
self.bound_branch = None
314
self.any_entries_deleted = False
315
if exclude is not None:
316
self.exclude = sorted(
317
minimum_path_selection(exclude))
321
self.master_branch = None
322
self.recursive = recursive
324
# self.specific_files is None to indicate no filter, or any iterable to
325
# indicate a filter - [] means no files at all, as per iter_changes.
326
if specific_files is not None:
327
self.specific_files = sorted(
328
minimum_path_selection(specific_files))
330
self.specific_files = None
332
self.allow_pointless = allow_pointless
333
self.message_callback = message_callback
334
self.timestamp = timestamp
335
self.timezone = timezone
210
mutter('preparing to commit')
212
if deprecated_passed(branch):
213
warn("Commit.commit (branch, ...): The branch parameter is "
214
"deprecated as of bzr 0.8. Please use working_tree= instead.",
215
DeprecationWarning, stacklevel=2)
217
self.work_tree = self.branch.bzrdir.open_workingtree()
218
elif working_tree is None:
219
raise BzrError("One of branch and working_tree must be passed into commit().")
221
self.work_tree = working_tree
222
self.branch = self.work_tree.branch
224
raise BzrError("The message keyword parameter is required for commit().")
226
self.weave_store = self.branch.repository.weave_store
228
self.specific_files = specific_files
229
self.allow_pointless = allow_pointless
230
self.revprops = {'branch-nick': self.branch.nick}
232
self.revprops.update(revprops)
234
# check for out of date working trees
235
if self.work_tree.last_revision() != self.branch.last_revision():
236
raise errors.OutOfDateTree(self.work_tree)
239
# raise an exception as soon as we find a single unknown.
240
for unknown in self.work_tree.unknowns():
241
raise StrictCommitFailed()
243
if timestamp is None:
244
self.timestamp = time.time()
246
self.timestamp = long(timestamp)
248
if self.config is None:
249
self.config = bzrlib.config.BranchConfig(self.branch)
252
self.rev_id = _gen_revision_id(self.config, self.timestamp)
256
if committer is None:
257
self.committer = self.config.username()
259
assert isinstance(committer, basestring), type(committer)
336
260
self.committer = committer
338
self.verbose = verbose
340
stack.enter_context(self.work_tree.lock_write())
341
self.parents = self.work_tree.get_parent_ids()
342
self.pb = ui.ui_factory.nested_progress_bar()
343
stack.callback(self.pb.finished)
344
self.basis_revid = self.work_tree.last_revision()
263
self.timezone = local_time_offset()
265
self.timezone = int(timezone)
267
if isinstance(message, str):
268
message = message.decode(bzrlib.user_encoding)
269
assert isinstance(message, unicode), type(message)
270
self.message = message
271
self._escape_commit_message()
273
self.branch.lock_write()
275
self.work_inv = self.work_tree.inventory
345
276
self.basis_tree = self.work_tree.basis_tree()
346
stack.enter_context(self.basis_tree.lock_read())
347
# Cannot commit with conflicts present.
348
if len(self.work_tree.conflicts()) > 0:
277
self.basis_inv = self.basis_tree.inventory
279
self._gather_parents()
280
if len(self.parents) > 1 and self.specific_files:
281
raise NotImplementedError('selected-file commit of merges is not supported yet')
282
self._check_parents_present()
284
self._remove_deleted()
285
self._populate_new_inv()
286
self._store_snapshot()
287
self._report_deletes()
289
if not (self.allow_pointless
290
or len(self.parents) > 1
291
or self.new_inv != self.basis_inv):
292
raise PointlessCommit()
294
if len(list(self.work_tree.iter_conflicts()))>0:
349
295
raise ConflictsInTree
351
# Setup the bound branch variables as needed.
352
self._check_bound_branch(stack, possible_master_transports)
353
if self.config_stack is None:
354
self.config_stack = self.work_tree.get_config_stack()
356
# Check that the working tree is up to date
357
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
359
# Complete configuration setup
360
if reporter is not None:
361
self.reporter = reporter
362
elif self.reporter is None:
363
self.reporter = self._select_reporter()
365
# Setup the progress bar. As the number of files that need to be
366
# committed in unknown, progress is reported as stages.
367
# We keep track of entries separately though and include that
368
# information in the progress bar during the relevant stages.
369
self.pb_stage_name = ""
370
self.pb_stage_count = 0
371
self.pb_stage_total = 5
372
if self.bound_branch:
373
# 2 extra stages: "Uploading data to master branch" and "Merging
374
# tags to master branch"
375
self.pb_stage_total += 2
376
self.pb.show_pct = False
377
self.pb.show_spinner = False
378
self.pb.show_eta = False
379
self.pb.show_count = True
380
self.pb.show_bar = True
382
# After a merge, a selected file commit is not supported.
383
# See 'bzr help merge' for an explanation as to why.
384
if len(self.parents) > 1 and self.specific_files is not None:
385
raise CannotCommitSelectedFileMerge(self.specific_files)
386
# Excludes are a form of selected file commit.
387
if len(self.parents) > 1 and self.exclude:
388
raise CannotCommitSelectedFileMerge(self.exclude)
390
# Collect the changes
391
self._set_progress_stage("Collecting changes", counter=True)
393
self.builder = self.branch.get_commit_builder(
394
self.parents, self.config_stack, timestamp, timezone, committer,
395
self.revprops, rev_id, lossy=lossy)
397
if self.builder.updates_branch and self.bound_branch:
399
raise AssertionError(
400
"bound branches not supported for commit builders "
401
"that update the branch")
404
# find the location being committed to
405
if self.bound_branch:
406
master_location = self.master_branch.base
297
self.inv_sha1 = self.branch.repository.add_inventory(
302
self._make_revision()
303
self.work_tree.set_pending_merges([])
304
self.branch.append_revision(self.rev_id)
305
if len(self.parents):
306
precursor = self.parents[0]
309
self.work_tree.set_last_revision(self.rev_id, precursor)
310
self.reporter.completed(self.branch.revno()+1, self.rev_id)
311
if self.config.post_commit() is not None:
312
hooks = self.config.post_commit().split(' ')
313
# this would be nicer with twisted.python.reflect.namedAny
315
result = eval(hook + '(branch, rev_id)',
316
{'branch':self.branch,
318
'rev_id':self.rev_id})
322
def _escape_commit_message(self):
323
"""Replace xml-incompatible control characters."""
324
# Python strings can include characters that can't be
325
# represented in well-formed XML; escape characters that
326
# aren't listed in the XML specification
327
# (http://www.w3.org/TR/REC-xml/#NT-Char).
328
self.message, escape_count = re.subn(
329
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
330
lambda match: match.group(0).encode('unicode_escape'),
333
self.reporter.escaped(escape_count, self.message)
335
def _gather_parents(self):
336
"""Record the parents of a merge for merge detection."""
337
pending_merges = self.work_tree.pending_merges()
339
self.parent_invs = []
340
self.present_parents = []
341
precursor_id = self.branch.last_revision()
343
self.parents.append(precursor_id)
344
self.parents += pending_merges
345
for revision in self.parents:
346
if self.branch.repository.has_revision(revision):
347
inventory = self.branch.repository.get_inventory(revision)
348
self.parent_invs.append(inventory)
349
self.present_parents.append(revision)
351
def _check_parents_present(self):
352
for parent_id in self.parents:
353
mutter('commit parent revision {%s}', parent_id)
354
if not self.branch.repository.has_revision(parent_id):
355
if parent_id == self.branch.last_revision():
356
warning("parent is missing %r", parent_id)
357
raise HistoryMissing(self.branch, 'revision', parent_id)
408
master_location = self.branch.base
410
# report the start of the commit
411
self.reporter.started(new_revno, self.rev_id, master_location)
413
self._update_builder_with_changes()
414
self._check_pointless()
416
# TODO: Now the new inventory is known, check for conflicts.
417
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
418
# weave lines, because nothing should be recorded until it is known
419
# that commit will succeed.
420
self._set_progress_stage("Saving data locally")
421
self.builder.finish_inventory()
423
# Prompt the user for a commit message if none provided
424
message = message_callback(self)
425
self.message = message
427
# Add revision data to the local branch
428
self.rev_id = self.builder.commit(self.message)
431
mutter("aborting commit write group because of exception:")
432
trace.log_exception_quietly()
436
self._update_branches(old_revno, old_revid, new_revno)
438
# Make the working tree be up to date with the branch. This
439
# includes automatic changes scheduled to be made to the tree, such
440
# as updating its basis and unversioning paths that were missing.
441
self.work_tree.unversion(self.deleted_paths)
442
self._set_progress_stage("Updating the working tree")
443
self.work_tree.update_basis_by_delta(self.rev_id,
444
self.builder.get_basis_delta())
445
self.reporter.completed(new_revno, self.rev_id)
446
self._process_post_hooks(old_revno, new_revno)
449
def _update_branches(self, old_revno, old_revid, new_revno):
450
"""Update the master and local branch to the new revision.
452
This will try to make sure that the master branch is updated
453
before the local branch.
455
:param old_revno: Revision number of master branch before the
457
:param old_revid: Tip of master branch before the commit
458
:param new_revno: Revision number of the new commit
460
if not self.builder.updates_branch:
461
self._process_pre_hooks(old_revno, new_revno)
463
# Upload revision data to the master.
464
# this will propagate merged revisions too if needed.
465
if self.bound_branch:
466
self._set_progress_stage("Uploading data to master branch")
467
# 'commit' to the master first so a timeout here causes the
468
# local branch to be out of date
469
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
470
self.branch, new_revno, self.rev_id, lossy=self._lossy)
472
self.branch.fetch(self.master_branch, self.rev_id)
474
# and now do the commit locally.
475
if new_revno is None:
476
# Keep existing behaviour around ghosts
478
self.branch.set_last_revision_info(new_revno, self.rev_id)
481
self._process_pre_hooks(old_revno, new_revno)
482
except BaseException:
483
# The commit builder will already have updated the branch,
485
self.branch.set_last_revision_info(old_revno, old_revid)
488
# Merge local tags to remote
489
if self.bound_branch:
490
self._set_progress_stage("Merging tags to master branch")
491
tag_updates, tag_conflicts = self.branch.tags.merge_to(
492
self.master_branch.tags)
494
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
495
note(gettext("Conflicting tags in bound branch:\n{0}".format(
496
"\n".join(warning_lines))))
498
def _select_reporter(self):
499
"""Select the CommitReporter to use."""
501
return NullCommitReporter()
502
return ReportCommitToLog()
504
def _check_pointless(self):
505
if self.allow_pointless:
507
# A merge with no effect on files
508
if len(self.parents) > 1:
510
if self.builder.any_changes():
512
raise PointlessCommit()
514
def _check_bound_branch(self, stack, possible_master_transports=None):
515
"""Check to see if the local branch is bound.
517
If it is bound, then most of the commit will actually be
518
done using the remote branch as the target branch.
519
Only at the end will the local branch be updated.
521
if self.local and not self.branch.get_bound_location():
522
raise errors.LocalRequiresBoundBranch()
525
self.master_branch = self.branch.get_master_branch(
526
possible_master_transports)
528
if not self.master_branch:
529
# make this branch the reference branch for out of date checks.
530
self.master_branch = self.branch
533
# If the master branch is bound, we must fail
534
master_bound_location = self.master_branch.get_bound_location()
535
if master_bound_location:
536
raise errors.CommitToDoubleBoundBranch(
537
self.branch, self.master_branch, master_bound_location)
539
# TODO: jam 20051230 We could automatically push local
540
# commits to the remote branch if they would fit.
541
# But for now, just require remote to be identical
544
# Make sure the local branch is identical to the master
545
master_revid = self.master_branch.last_revision()
546
local_revid = self.branch.last_revision()
547
if local_revid != master_revid:
548
raise errors.BoundBranchOutOfDate(self.branch,
551
# Now things are ready to change the master branch
553
self.bound_branch = self.branch
554
stack.enter_context(self.master_branch.lock_write())
556
def _check_out_of_date_tree(self):
557
"""Check that the working tree is up to date.
559
:return: old_revision_number, old_revision_id, new_revision_number
563
first_tree_parent = self.work_tree.get_parent_ids()[0]
565
# if there are no parents, treat our parent as 'None'
566
# this is so that we still consider the master branch
567
# - in a checkout scenario the tree may have no
568
# parents but the branch may do.
569
first_tree_parent = breezy.revision.NULL_REVISION
570
if (self.master_branch._format.stores_revno() or
571
self.config_stack.get('calculate_revnos')):
573
old_revno, master_last = self.master_branch.last_revision_info()
574
except errors.UnsupportedOperation:
575
master_last = self.master_branch.last_revision()
576
old_revno = self.branch.revision_id_to_revno(master_last)
578
master_last = self.master_branch.last_revision()
580
if master_last != first_tree_parent:
581
if master_last != breezy.revision.NULL_REVISION:
582
raise errors.OutOfDateTree(self.work_tree)
583
if (old_revno is not None and
584
self.branch.repository.has_revision(first_tree_parent)):
585
new_revno = old_revno + 1
587
# ghost parents never appear in revision history.
589
return old_revno, master_last, new_revno
591
def _process_pre_hooks(self, old_revno, new_revno):
592
"""Process any registered pre commit hooks."""
593
self._set_progress_stage("Running pre_commit hooks")
594
self._process_hooks("pre_commit", old_revno, new_revno)
596
def _process_post_hooks(self, old_revno, new_revno):
597
"""Process any registered post commit hooks."""
598
# Process the post commit hooks, if any
599
self._set_progress_stage("Running post_commit hooks")
600
# old style commit hooks - should be deprecated ? (obsoleted in
601
# 0.15^H^H^H^H 2.5.0)
602
post_commit = self.config_stack.get('post_commit')
603
if post_commit is not None:
604
hooks = post_commit.split(' ')
605
# this would be nicer with twisted.python.reflect.namedAny
607
result = eval(hook + '(branch, rev_id)',
608
{'branch': self.branch,
610
'rev_id': self.rev_id})
611
# process new style post commit hooks
612
self._process_hooks("post_commit", old_revno, new_revno)
614
def _process_hooks(self, hook_name, old_revno, new_revno):
615
if not Branch.hooks[hook_name]:
618
# new style commit hooks:
619
if not self.bound_branch:
620
hook_master = self.branch
623
hook_master = self.master_branch
624
hook_local = self.branch
625
# With bound branches, when the master is behind the local branch,
626
# the 'old_revno' and old_revid values here are incorrect.
627
# XXX: FIXME ^. RBC 20060206
629
old_revid = self.parents[0]
631
old_revid = breezy.revision.NULL_REVISION
633
if hook_name == "pre_commit":
634
future_tree = self.builder.revision_tree()
635
tree_delta = future_tree.changes_from(self.basis_tree,
638
for hook in Branch.hooks[hook_name]:
639
# show the running hook in the progress bar. As hooks may
640
# end up doing nothing (e.g. because they are not configured by
641
# the user) this is still showing progress, not showing overall
642
# actions - its up to each plugin to show a UI if it want's to
643
# (such as 'Emailing diff to foo@example.com').
644
self.pb_stage_name = "Running %s hooks [%s]" % \
645
(hook_name, Branch.hooks.get_hook_name(hook))
646
self._emit_progress()
647
if 'hooks' in debug.debug_flags:
648
mutter("Invoking commit hook: %r", hook)
649
if hook_name == "post_commit":
650
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
652
elif hook_name == "pre_commit":
653
hook(hook_local, hook_master,
654
old_revno, old_revid, new_revno, self.rev_id,
655
tree_delta, future_tree)
657
def _update_builder_with_changes(self):
658
"""Update the commit builder with the data about what has changed.
660
specific_files = self.specific_files
661
mutter("Selecting files for commit with filter %r", specific_files)
664
iter_changes = self.work_tree.iter_changes(
665
self.basis_tree, specific_files=specific_files)
667
iter_changes = filter_excluded(iter_changes, self.exclude)
668
iter_changes = self._filter_iter_changes(iter_changes)
669
for path, fs_hash in self.builder.record_iter_changes(
670
self.work_tree, self.basis_revid, iter_changes):
671
self.work_tree._observed_sha1(path, fs_hash)
673
def _filter_iter_changes(self, iter_changes):
674
"""Process iter_changes.
676
This method reports on the changes in iter_changes to the user, and
677
converts 'missing' entries in the iter_changes iterator to 'deleted'
678
entries. 'missing' entries have their
680
:param iter_changes: An iter_changes to process.
681
:return: A generator of changes.
683
reporter = self.reporter
684
report_changes = reporter.is_verbose()
686
for change in iter_changes:
688
old_path = change.path[0]
689
new_path = change.path[1]
690
versioned = change.versioned[1]
691
kind = change.kind[1]
692
versioned = change.versioned[1]
693
if kind is None and versioned:
696
reporter.missing(new_path)
697
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
698
trace.warning('Ignoring "%s" as symlinks are not '
699
'supported on this filesystem.' % (change.path[0],))
359
mutter("commit will ghost revision %r", parent_id)
361
def _make_revision(self):
362
"""Record a new revision object for this commit."""
363
rev = Revision(timestamp=self.timestamp,
364
timezone=self.timezone,
365
committer=self.committer,
366
message=self.message,
367
inventory_sha1=self.inv_sha1,
368
revision_id=self.rev_id,
369
properties=self.revprops)
370
rev.parent_ids = self.parents
371
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
373
def _remove_deleted(self):
374
"""Remove deleted files from the working inventories.
376
This is done prior to taking the working inventory as the
377
basis for the new committed inventory.
379
This returns true if any files
380
*that existed in the basis inventory* were deleted.
381
Files that were added and deleted
382
in the working copy don't matter.
384
specific = self.specific_files
386
for path, ie in self.work_inv.iter_entries():
387
if specific and not is_inside_any(specific, path):
389
if not self.work_tree.has_filename(path):
390
self.reporter.missing(path)
391
deleted_ids.append((path, ie.file_id))
393
deleted_ids.sort(reverse=True)
394
for path, file_id in deleted_ids:
395
del self.work_inv[file_id]
396
self.work_tree._write_inventory(self.work_inv)
398
def _store_snapshot(self):
399
"""Pass over inventory and record a snapshot.
401
Entries get a new revision when they are modified in
402
any way, which includes a merge with a new set of
403
parents that have the same entry.
405
# XXX: Need to think more here about when the user has
406
# made a specific decision on a particular value -- c.f.
408
for path, ie in self.new_inv.iter_entries():
409
previous_entries = ie.find_previous_heads(
411
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
412
self.branch.get_transaction()))
413
if ie.revision is None:
414
change = ie.snapshot(self.rev_id, path, previous_entries,
415
self.work_tree, self.weave_store,
416
self.branch.get_transaction())
419
self.reporter.snapshot_change(change, path)
421
def _populate_new_inv(self):
422
"""Build revision inventory.
424
This creates a new empty inventory. Depending on
425
which files are selected for commit, and what is present in the
426
current tree, the new inventory is populated. inventory entries
427
which are candidates for modification have their revision set to
428
None; inventory entries that are carried over untouched have their
429
revision set to their prior value.
431
mutter("Selecting files for commit with filter %s", self.specific_files)
432
self.new_inv = Inventory()
433
for path, new_ie in self.work_inv.iter_entries():
434
file_id = new_ie.file_id
435
mutter('check %s {%s}', path, new_ie.file_id)
436
if self.specific_files:
437
if not is_inside_any(self.specific_files, path):
438
mutter('%s not selected for commit', path)
439
self._carry_entry(file_id)
701
deleted_paths.append(change.path[1])
702
# Reset the new path (None) and new versioned flag (False)
703
change = change.discard_new()
704
new_path = change.path[1]
706
elif kind == 'tree-reference':
707
if self.recursive == 'down':
708
self._commit_nested_tree(change.path[1])
709
if change.versioned[0] or change.versioned[1]:
713
reporter.deleted(old_path)
714
elif old_path is None:
715
reporter.snapshot_change(gettext('added'), new_path)
716
elif old_path != new_path:
717
reporter.renamed(gettext('renamed'),
721
or self.work_tree.branch.repository._format.rich_root_data):
722
# Don't report on changes to '' in non rich root
724
reporter.snapshot_change(
725
gettext('modified'), new_path)
726
self._next_progress_entry()
727
# Unversion files that were found to be deleted
728
self.deleted_paths = deleted_paths
730
def _check_strict(self):
731
# XXX: when we use iter_changes this would likely be faster if
732
# iter_changes would check for us (even in the presence of
735
# raise an exception as soon as we find a single unknown.
736
for unknown in self.work_tree.unknowns():
737
raise StrictCommitFailed()
739
def _commit_nested_tree(self, path):
740
"Commit a nested tree."
741
sub_tree = self.work_tree.get_nested_tree(path)
742
# FIXME: be more comprehensive here:
743
# this works when both trees are in --trees repository,
744
# but when both are bound to a different repository,
745
# it fails; a better way of approaching this is to
746
# finally implement the explicit-caches approach design
747
# a while back - RBC 20070306.
748
if sub_tree.branch.repository.has_same_location(
749
self.work_tree.branch.repository):
750
sub_tree.branch.repository = \
751
self.work_tree.branch.repository
753
return sub_tree.commit(message=None, revprops=self.revprops,
754
recursive=self.recursive,
755
message_callback=self.message_callback,
756
timestamp=self.timestamp,
757
timezone=self.timezone,
758
committer=self.committer,
759
allow_pointless=self.allow_pointless,
760
strict=self.strict, verbose=self.verbose,
761
local=self.local, reporter=self.reporter)
762
except PointlessCommit:
763
return self.work_tree.get_reference_revision(path)
765
def _set_progress_stage(self, name, counter=False):
766
"""Set the progress stage and emit an update to the progress bar."""
767
self.pb_stage_name = name
768
self.pb_stage_count += 1
770
self.pb_entries_count = 0
772
self.pb_entries_count = None
773
self._emit_progress()
775
def _next_progress_entry(self):
776
"""Emit an update to the progress bar and increment the entry count."""
777
self.pb_entries_count += 1
778
self._emit_progress()
780
def _emit_progress(self):
781
if self.pb_entries_count is not None:
782
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
783
self.pb_entries_count)
785
text = gettext("%s - Stage") % (self.pb_stage_name, )
786
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
442
# this is selected, ensure its parents are too.
443
parent_id = new_ie.parent_id
444
while parent_id != ROOT_ID:
445
if not self.new_inv.has_id(parent_id):
446
ie = self._select_entry(self.work_inv[parent_id])
447
mutter('%s selected for commit because of %s',
448
self.new_inv.id2path(parent_id), path)
450
ie = self.new_inv[parent_id]
451
if ie.revision is not None:
453
mutter('%s selected for commit because of %s',
454
self.new_inv.id2path(parent_id), path)
455
parent_id = ie.parent_id
456
mutter('%s selected for commit', path)
457
self._select_entry(new_ie)
459
def _select_entry(self, new_ie):
460
"""Make new_ie be considered for committing."""
466
def _carry_entry(self, file_id):
467
"""Carry the file unchanged from the basis revision."""
468
if self.basis_inv.has_id(file_id):
469
self.new_inv.add(self.basis_inv[file_id].copy())
471
def _report_deletes(self):
472
for file_id in self.basis_inv:
473
if file_id not in self.new_inv:
474
self.reporter.deleted(self.basis_inv.id2path(file_id))
476
def _gen_revision_id(config, when):
477
"""Return new revision-id."""
478
s = '%s-%s-' % (config.user_email(), compact_date(when))
479
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
