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,
68
minimum_path_selection,
70
from .trace import mutter, note, is_quiet
71
from .urlutils import unescape_for_display
72
from .i18n import gettext
75
class PointlessCommit(BzrError):
77
_fmt = "No changes to commit"
80
class CannotCommitSelectedFileMerge(BzrError):
82
_fmt = 'Selected-file commit of merges is not supported yet:'\
83
' files %(files_str)s'
85
def __init__(self, files):
86
files_str = ', '.join(files)
87
BzrError.__init__(self, files=files, files_str=files_str)
90
def filter_excluded(iter_changes, exclude):
91
"""Filter exclude filenames.
93
:param iter_changes: iter_changes function
94
:param exclude: List of paths to exclude
95
:return: iter_changes function
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
97
for change in iter_changes:
98
old_path = change[1][0]
99
new_path = change[1][1]
101
new_excluded = (new_path is not None and
102
is_inside_any(exclude, new_path))
104
old_excluded = (old_path is not None and
105
is_inside_any(exclude, old_path))
107
if old_excluded and new_excluded:
110
if old_excluded or new_excluded:
111
# TODO(jelmer): Perhaps raise an error here instead?
109
117
class NullCommitReporter(object):
110
118
"""I report on progress of a commit."""
120
def started(self, revno, revid, location):
112
123
def snapshot_change(self, change, path):
115
126
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
129
def deleted(self, path):
124
132
def missing(self, path):
135
def renamed(self, change, old_path, new_path):
138
def is_verbose(self):
128
142
class ReportCommitToLog(NullCommitReporter):
144
def _note(self, format, *args):
147
Subclasses may choose to override this method.
130
151
def snapshot_change(self, change, path):
131
if change == 'unchanged':
152
if path == '' and change in (gettext('added'), gettext('modified')):
133
note("%s %s", change, path)
154
self._note("%s %s", change, path)
156
def started(self, revno, rev_id, location):
158
gettext('Committing to: %s'),
159
unescape_for_display(location, 'utf-8'))
135
161
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
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)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
170
def deleted(self, path):
171
self._note(gettext('deleted %s'), path)
144
173
def missing(self, path):
145
note('missing %s', path)
174
self._note(gettext('missing %s'), path)
176
def renamed(self, change, old_path, new_path):
177
self._note('%s %s => %s', change, old_path, new_path)
179
def is_verbose(self):
148
183
class Commit(object):
183
241
working_tree=None,
245
message_callback=None,
248
possible_master_transports=None,
187
250
"""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.
252
:param message: the commit message (it or message_callback is required)
253
:param message_callback: A callback: message =
254
message_callback(cmt_obj)
256
:param timestamp: if not None, seconds-since-epoch for a
257
postdated/predated commit.
259
:param specific_files: If not None, commit only those files. An empty
260
list means 'commit no files'.
262
:param rev_id: If set, use this as the new revision id.
200
263
Useful for test or import commands that need to tightly
201
264
control what revisions are assigned. If you duplicate
202
265
a revision id that exists elsewhere it is your own fault.
203
266
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
268
:param allow_pointless: If true (default), commit even if nothing
206
269
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
271
:param strict: If true, don't allow a commit if the working tree
209
272
contains unknown files.
211
revprops -- Properties for new revision
274
:param revprops: Properties for new revision
212
275
:param local: Perform a local only commit.
276
:param reporter: the reporter to use or None for the default
277
:param verbose: if True and the reporter is not None, report everything
278
:param recursive: If set to 'down', commit in any subtrees that have
279
pending changes of any sort during this commit.
280
:param exclude: None or a list of relative paths to exclude from the
281
commit. Pending changes to excluded files will be ignored by the
283
:param lossy: When committing to a foreign VCS, ignore any
284
data that can not be natively represented.
286
operation = OperationWithCleanups(self._commit)
287
self.revprops = revprops or {}
288
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
self.config_stack = config or self.config_stack
290
return operation.run(
295
specific_files=specific_files,
297
allow_pointless=allow_pointless,
300
working_tree=working_tree,
303
message_callback=message_callback,
306
possible_master_transports=possible_master_transports,
309
def _commit(self, operation, message, timestamp, timezone, committer,
310
specific_files, rev_id, allow_pointless, strict, verbose,
311
working_tree, local, reporter, message_callback, recursive,
312
exclude, possible_master_transports, lossy):
214
313
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().")
315
if working_tree is None:
316
raise BzrError("working_tree must be passed into commit().")
225
318
self.work_tree = working_tree
226
319
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
320
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
321
if not self.branch.repository.supports_rich_root():
322
raise errors.RootNotRich()
323
if message_callback is None:
324
if message is not None:
325
if isinstance(message, bytes):
326
message = message.decode(get_user_encoding())
328
def message_callback(x):
331
raise BzrError("The message or message_callback keyword"
332
" parameter is required for commit().")
231
334
self.bound_branch = None
335
self.any_entries_deleted = False
336
if exclude is not None:
337
self.exclude = sorted(
338
minimum_path_selection(exclude))
232
341
self.local = local
233
342
self.master_branch = None
234
self.master_locked = False
236
self.specific_files = specific_files
343
self.recursive = recursive
345
# self.specific_files is None to indicate no filter, or any iterable to
346
# indicate a filter - [] means no files at all, as per iter_changes.
347
if specific_files is not None:
348
self.specific_files = sorted(
349
minimum_path_selection(specific_files))
351
self.specific_files = None
237
353
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
354
self.message_callback = message_callback
355
self.timestamp = timestamp
356
self.timezone = timezone
357
self.committer = committer
359
self.verbose = verbose
247
361
self.work_tree.lock_write()
362
operation.add_cleanup(self.work_tree.unlock)
363
self.parents = self.work_tree.get_parent_ids()
364
self.pb = ui.ui_factory.nested_progress_bar()
365
operation.add_cleanup(self.pb.finished)
366
self.basis_revid = self.work_tree.last_revision()
367
self.basis_tree = self.work_tree.basis_tree()
368
self.basis_tree.lock_read()
369
operation.add_cleanup(self.basis_tree.unlock)
370
# Cannot commit with conflicts present.
371
if len(self.work_tree.conflicts()) > 0:
372
raise ConflictsInTree
374
# Setup the bound branch variables as needed.
375
self._check_bound_branch(operation, possible_master_transports)
377
# Check that the working tree is up to date
378
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
380
# Complete configuration setup
381
if reporter is not None:
382
self.reporter = reporter
383
elif self.reporter is None:
384
self.reporter = self._select_reporter()
385
if self.config_stack is None:
386
self.config_stack = self.work_tree.get_config_stack()
388
# Setup the progress bar. As the number of files that need to be
389
# committed in unknown, progress is reported as stages.
390
# We keep track of entries separately though and include that
391
# information in the progress bar during the relevant stages.
392
self.pb_stage_name = ""
393
self.pb_stage_count = 0
394
self.pb_stage_total = 5
395
if self.bound_branch:
396
# 2 extra stages: "Uploading data to master branch" and "Merging
397
# tags to master branch"
398
self.pb_stage_total += 2
399
self.pb.show_pct = False
400
self.pb.show_spinner = False
401
self.pb.show_eta = False
402
self.pb.show_count = True
403
self.pb.show_bar = True
405
# After a merge, a selected file commit is not supported.
406
# See 'bzr help merge' for an explanation as to why.
407
if len(self.parents) > 1 and self.specific_files is not None:
408
raise CannotCommitSelectedFileMerge(self.specific_files)
409
# Excludes are a form of selected file commit.
410
if len(self.parents) > 1 and self.exclude:
411
raise CannotCommitSelectedFileMerge(self.exclude)
413
# Collect the changes
414
self._set_progress_stage("Collecting changes", counter=True)
416
self.builder = self.branch.get_commit_builder(
417
self.parents, self.config_stack, timestamp, timezone, committer,
418
self.revprops, rev_id, lossy=lossy)
420
if self.builder.updates_branch and self.bound_branch:
422
raise AssertionError(
423
"bound branches not supported for commit builders "
424
"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)
427
# find the location being committed to
428
if self.bound_branch:
429
master_location = self.master_branch.base
431
master_location = self.branch.base
433
# report the start of the commit
434
self.reporter.started(new_revno, self.rev_id, master_location)
436
self._update_builder_with_changes()
437
self._check_pointless()
439
# TODO: Now the new inventory is known, check for conflicts.
440
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
441
# weave lines, because nothing should be recorded until it is known
442
# that commit will succeed.
443
self._set_progress_stage("Saving data locally")
444
self.builder.finish_inventory()
446
# Prompt the user for a commit message if none provided
447
message = message_callback(self)
290
448
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.
450
# Add revision data to the local branch
451
self.rev_id = self.builder.commit(self.message)
454
mutter("aborting commit write group because of exception:")
455
trace.log_exception_quietly()
459
self._update_branches(old_revno, old_revid, new_revno)
461
# Make the working tree be up to date with the branch. This
462
# includes automatic changes scheduled to be made to the tree, such
463
# as updating its basis and unversioning paths that were missing.
464
self.work_tree.unversion(self.deleted_paths)
465
self._set_progress_stage("Updating the working tree")
466
self.work_tree.update_basis_by_delta(self.rev_id,
467
self.builder.get_basis_delta())
468
self.reporter.completed(new_revno, self.rev_id)
469
self._process_post_hooks(old_revno, new_revno)
472
def _update_branches(self, old_revno, old_revid, new_revno):
473
"""Update the master and local branch to the new revision.
475
This will try to make sure that the master branch is updated
476
before the local branch.
478
:param old_revno: Revision number of master branch before the
480
:param old_revid: Tip of master branch before the commit
481
:param new_revno: Revision number of the new commit
483
if not self.builder.updates_branch:
484
self._process_pre_hooks(old_revno, new_revno)
486
# Upload revision data to the master.
487
# this will propagate merged revisions too if needed.
325
488
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)
489
self._set_progress_stage("Uploading data to master branch")
490
# 'commit' to the master first so a timeout here causes the
491
# local branch to be out of date
492
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
493
self.branch, new_revno, self.rev_id, lossy=self._lossy)
495
self.branch.fetch(self.master_branch, self.rev_id)
333
497
# 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):
498
self.branch.set_last_revision_info(new_revno, self.rev_id)
501
self._process_pre_hooks(old_revno, new_revno)
502
except BaseException:
503
# The commit builder will already have updated the branch,
505
self.branch.set_last_revision_info(old_revno, old_revid)
508
# Merge local tags to remote
509
if self.bound_branch:
510
self._set_progress_stage("Merging tags to master branch")
511
tag_updates, tag_conflicts = self.branch.tags.merge_to(
512
self.master_branch.tags)
514
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
515
note(gettext("Conflicting tags in bound branch:\n{0}".format(
516
"\n".join(warning_lines))))
518
def _select_reporter(self):
519
"""Select the CommitReporter to use."""
521
return NullCommitReporter()
522
return ReportCommitToLog()
524
def _check_pointless(self):
525
if self.allow_pointless:
527
# A merge with no effect on files
528
if len(self.parents) > 1:
530
if self.builder.any_changes():
532
raise PointlessCommit()
534
def _check_bound_branch(self, operation, possible_master_transports=None):
354
535
"""Check to see if the local branch is bound.
356
537
If it is bound, then most of the commit will actually be
371
553
# If the master branch is bound, we must fail
372
554
master_bound_location = self.master_branch.get_bound_location()
373
555
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
556
raise errors.CommitToDoubleBoundBranch(
557
self.branch, self.master_branch, master_bound_location)
377
559
# TODO: jam 20051230 We could automatically push local
378
560
# commits to the remote branch if they would fit.
379
561
# But for now, just require remote to be identical
382
564
# 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:
565
master_revid = self.master_branch.last_revision()
566
local_revid = self.branch.last_revision()
567
if local_revid != master_revid:
386
568
raise errors.BoundBranchOutOfDate(self.branch,
389
571
# Now things are ready to change the master branch
390
572
# so grab the lock
391
573
self.bound_branch = self.branch
392
574
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
575
operation.add_cleanup(self.master_branch.unlock)
577
def _check_out_of_date_tree(self):
578
"""Check that the working tree is up to date.
580
:return: old_revision_number, old_revision_id, new_revision_number
584
first_tree_parent = self.work_tree.get_parent_ids()[0]
586
# if there are no parents, treat our parent as 'None'
587
# this is so that we still consider the master branch
588
# - in a checkout scenario the tree may have no
589
# parents but the branch may do.
590
first_tree_parent = breezy.revision.NULL_REVISION
592
old_revno, master_last = self.master_branch.last_revision_info()
593
except errors.UnsupportedOperation:
594
master_last = self.master_branch.last_revision()
595
old_revno = self.branch.revision_id_to_revno(master_last)
596
if master_last != first_tree_parent:
597
if master_last != breezy.revision.NULL_REVISION:
598
raise errors.OutOfDateTree(self.work_tree)
599
if self.branch.repository.has_revision(first_tree_parent):
600
new_revno = old_revno + 1
602
# ghost parents never appear in revision history.
604
return old_revno, master_last, new_revno
606
def _process_pre_hooks(self, old_revno, new_revno):
607
"""Process any registered pre commit hooks."""
608
self._set_progress_stage("Running pre_commit hooks")
609
self._process_hooks("pre_commit", old_revno, new_revno)
611
def _process_post_hooks(self, old_revno, new_revno):
612
"""Process any registered post commit hooks."""
613
# Process the post commit hooks, if any
614
self._set_progress_stage("Running post_commit hooks")
615
# old style commit hooks - should be deprecated ? (obsoleted in
616
# 0.15^H^H^H^H 2.5.0)
617
post_commit = self.config_stack.get('post_commit')
618
if post_commit is not None:
619
hooks = post_commit.split(' ')
620
# this would be nicer with twisted.python.reflect.namedAny
622
result = eval(hook + '(branch, rev_id)',
623
{'branch': self.branch,
625
'rev_id': self.rev_id})
626
# process new style post commit hooks
627
self._process_hooks("post_commit", old_revno, new_revno)
629
def _process_hooks(self, hook_name, old_revno, new_revno):
630
if not Branch.hooks[hook_name]:
633
# new style commit hooks:
410
634
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)
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))
635
hook_master = self.branch
638
hook_master = self.master_branch
639
hook_local = self.branch
640
# With bound branches, when the master is behind the local branch,
641
# the 'old_revno' and old_revid values here are incorrect.
642
# XXX: FIXME ^. RBC 20060206
644
old_revid = self.parents[0]
646
old_revid = breezy.revision.NULL_REVISION
648
if hook_name == "pre_commit":
649
future_tree = self.builder.revision_tree()
650
tree_delta = future_tree.changes_from(self.basis_tree,
653
for hook in Branch.hooks[hook_name]:
654
# show the running hook in the progress bar. As hooks may
655
# end up doing nothing (e.g. because they are not configured by
656
# the user) this is still showing progress, not showing overall
657
# actions - its up to each plugin to show a UI if it want's to
658
# (such as 'Emailing diff to foo@example.com').
659
self.pb_stage_name = "Running %s hooks [%s]" % \
660
(hook_name, Branch.hooks.get_hook_name(hook))
661
self._emit_progress()
662
if 'hooks' in debug.debug_flags:
663
mutter("Invoking commit hook: %r", hook)
664
if hook_name == "post_commit":
665
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
667
elif hook_name == "pre_commit":
668
hook(hook_local, hook_master,
669
old_revno, old_revid, new_revno, self.rev_id,
670
tree_delta, future_tree)
672
def _update_builder_with_changes(self):
673
"""Update the commit builder with the data about what has changed.
675
specific_files = self.specific_files
676
mutter("Selecting files for commit with filter %r", specific_files)
679
iter_changes = self.work_tree.iter_changes(
680
self.basis_tree, specific_files=specific_files)
682
iter_changes = filter_excluded(iter_changes, self.exclude)
683
iter_changes = self._filter_iter_changes(iter_changes)
684
for path, fs_hash in self.builder.record_iter_changes(
685
self.work_tree, self.basis_revid, iter_changes):
686
self.work_tree._observed_sha1(path, fs_hash)
688
def _filter_iter_changes(self, iter_changes):
689
"""Process iter_changes.
691
This method reports on the changes in iter_changes to the user, and
692
converts 'missing' entries in the iter_changes iterator to 'deleted'
693
entries. 'missing' entries have their
695
:param iter_changes: An iter_changes to process.
696
:return: A generator of changes.
698
reporter = self.reporter
699
report_changes = reporter.is_verbose()
701
for change in iter_changes:
703
old_path = change[1][0]
704
new_path = change[1][1]
705
versioned = change[3][1]
707
versioned = change[3][1]
708
if kind is None and versioned:
711
reporter.missing(new_path)
712
deleted_paths.append(change[1][1])
713
# Reset the new path (None) and new versioned flag (False)
714
change = (change[0], (change[1][0], None), change[2],
715
(change[3][0], False)) + change[4:]
716
new_path = change[1][1]
718
elif kind == 'tree-reference':
719
if self.recursive == 'down':
720
self._commit_nested_tree(change[1][1])
721
if change[3][0] or change[3][1]:
725
reporter.deleted(old_path)
726
elif old_path is None:
727
reporter.snapshot_change(gettext('added'), new_path)
728
elif old_path != new_path:
729
reporter.renamed(gettext('renamed'),
733
or self.work_tree.branch.repository._format.rich_root_data):
734
# Don't report on changes to '' in non rich root
736
reporter.snapshot_change(
737
gettext('modified'), new_path)
738
self._next_progress_entry()
739
# Unversion files that were found to be deleted
740
self.deleted_paths = deleted_paths
742
def _check_strict(self):
743
# XXX: when we use iter_changes this would likely be faster if
744
# iter_changes would check for us (even in the presence of
747
# raise an exception as soon as we find a single unknown.
748
for unknown in self.work_tree.unknowns():
749
raise StrictCommitFailed()
751
def _commit_nested_tree(self, path):
752
"Commit a nested tree."
753
sub_tree = self.work_tree.get_nested_tree(path)
754
# FIXME: be more comprehensive here:
755
# this works when both trees are in --trees repository,
756
# but when both are bound to a different repository,
757
# it fails; a better way of approaching this is to
758
# finally implement the explicit-caches approach design
759
# a while back - RBC 20070306.
760
if sub_tree.branch.repository.has_same_location(
761
self.work_tree.branch.repository):
762
sub_tree.branch.repository = \
763
self.work_tree.branch.repository
765
return sub_tree.commit(message=None, revprops=self.revprops,
766
recursive=self.recursive,
767
message_callback=self.message_callback,
768
timestamp=self.timestamp,
769
timezone=self.timezone,
770
committer=self.committer,
771
allow_pointless=self.allow_pointless,
772
strict=self.strict, verbose=self.verbose,
773
local=self.local, reporter=self.reporter)
774
except PointlessCommit:
775
return self.work_tree.get_reference_revision(path)
777
def _set_progress_stage(self, name, counter=False):
778
"""Set the progress stage and emit an update to the progress bar."""
779
self.pb_stage_name = name
780
self.pb_stage_count += 1
782
self.pb_entries_count = 0
784
self.pb_entries_count = None
785
self._emit_progress()
787
def _next_progress_entry(self):
788
"""Emit an update to the progress bar and increment the entry count."""
789
self.pb_entries_count += 1
790
self._emit_progress()
792
def _emit_progress(self):
793
if self.pb_entries_count is not None:
794
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
795
self.pb_entries_count)
797
text = gettext("%s - Stage") % (self.pb_stage_name, )
798
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
