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