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 .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
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
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?
109
116
class NullCommitReporter(object):
110
117
"""I report on progress of a commit."""
119
def started(self, revno, revid, location):
112
122
def snapshot_change(self, change, path):
115
125
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
128
def deleted(self, path):
124
131
def missing(self, path):
134
def renamed(self, change, old_path, new_path):
137
def is_verbose(self):
128
141
class ReportCommitToLog(NullCommitReporter):
143
def _note(self, format, *args):
146
Subclasses may choose to override this method.
130
150
def snapshot_change(self, change, path):
131
if change == 'unchanged':
151
if path == '' and change in (gettext('added'), gettext('modified')):
133
note("%s %s", change, path)
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'))
135
160
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
161
self._note(gettext('Committed revision %d.'), revno)
162
# self._note goes to the console too; so while we want to log the
163
# rev_id, we can't trivially only log it. (See bug 526425). Long
164
# term we should rearrange the reporting structure, but for now
165
# we just mutter seperately. We mutter the revid and revno together
166
# so that concurrent bzr invocations won't lead to confusion.
167
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)
169
def deleted(self, path):
170
self._note(gettext('deleted %s'), path)
144
172
def missing(self, path):
145
note('missing %s', path)
173
self._note(gettext('missing %s'), path)
175
def renamed(self, change, old_path, new_path):
176
self._note('%s %s => %s', change, old_path, new_path)
178
def is_verbose(self):
148
182
class Commit(object):
183
240
working_tree=None,
244
message_callback=None,
247
possible_master_transports=None,
187
249
"""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.
251
:param message: the commit message (it or message_callback is required)
252
:param message_callback: A callback: message =
253
message_callback(cmt_obj)
255
:param timestamp: if not None, seconds-since-epoch for a
256
postdated/predated commit.
258
:param specific_files: If not None, commit only those files. An empty
259
list means 'commit no files'.
261
:param rev_id: If set, use this as the new revision id.
200
262
Useful for test or import commands that need to tightly
201
263
control what revisions are assigned. If you duplicate
202
264
a revision id that exists elsewhere it is your own fault.
203
265
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
267
:param allow_pointless: If true (default), commit even if nothing
206
268
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
270
:param strict: If true, don't allow a commit if the working tree
209
271
contains unknown files.
211
revprops -- Properties for new revision
273
:param revprops: Properties for new revision
212
274
:param local: Perform a local only commit.
275
:param reporter: the reporter to use or None for the default
276
:param verbose: if True and the reporter is not None, report everything
277
:param recursive: If set to 'down', commit in any subtrees that have
278
pending changes of any sort during this commit.
279
:param exclude: None or a list of relative paths to exclude from the
280
commit. Pending changes to excluded files will be ignored by the
282
:param lossy: When committing to a foreign VCS, ignore any
283
data that can not be natively represented.
285
operation = OperationWithCleanups(self._commit)
286
self.revprops = revprops or {}
287
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
288
self.config_stack = config or self.config_stack
289
return operation.run(
294
specific_files=specific_files,
296
allow_pointless=allow_pointless,
299
working_tree=working_tree,
302
message_callback=message_callback,
305
possible_master_transports=possible_master_transports,
308
def _commit(self, operation, message, timestamp, timezone, committer,
309
specific_files, rev_id, allow_pointless, strict, verbose,
310
working_tree, local, reporter, message_callback, recursive,
311
exclude, possible_master_transports, lossy):
214
312
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().")
314
if working_tree is None:
315
raise BzrError("working_tree must be passed into commit().")
225
317
self.work_tree = working_tree
226
318
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
319
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
320
if not self.branch.repository.supports_rich_root():
321
raise errors.RootNotRich()
322
if message_callback is None:
323
if message is not None:
324
if isinstance(message, bytes):
325
message = message.decode(get_user_encoding())
327
def message_callback(x):
330
raise BzrError("The message or message_callback keyword"
331
" parameter is required for commit().")
231
333
self.bound_branch = None
334
self.any_entries_deleted = False
335
if exclude is not None:
336
self.exclude = sorted(
337
minimum_path_selection(exclude))
232
340
self.local = local
233
341
self.master_branch = None
234
self.master_locked = False
236
self.specific_files = specific_files
342
self.recursive = recursive
344
# self.specific_files is None to indicate no filter, or any iterable to
345
# indicate a filter - [] means no files at all, as per iter_changes.
346
if specific_files is not None:
347
self.specific_files = sorted(
348
minimum_path_selection(specific_files))
350
self.specific_files = None
237
352
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
353
self.message_callback = message_callback
354
self.timestamp = timestamp
355
self.timezone = timezone
356
self.committer = committer
358
self.verbose = verbose
247
360
self.work_tree.lock_write()
361
operation.add_cleanup(self.work_tree.unlock)
362
self.parents = self.work_tree.get_parent_ids()
363
self.pb = ui.ui_factory.nested_progress_bar()
364
operation.add_cleanup(self.pb.finished)
365
self.basis_revid = self.work_tree.last_revision()
366
self.basis_tree = self.work_tree.basis_tree()
367
self.basis_tree.lock_read()
368
operation.add_cleanup(self.basis_tree.unlock)
369
# Cannot commit with conflicts present.
370
if len(self.work_tree.conflicts()) > 0:
371
raise ConflictsInTree
373
# Setup the bound branch variables as needed.
374
self._check_bound_branch(operation, possible_master_transports)
376
# Check that the working tree is up to date
377
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
379
# Complete configuration setup
380
if reporter is not None:
381
self.reporter = reporter
382
elif self.reporter is None:
383
self.reporter = self._select_reporter()
384
if self.config_stack is None:
385
self.config_stack = self.work_tree.get_config_stack()
387
# Setup the progress bar. As the number of files that need to be
388
# committed in unknown, progress is reported as stages.
389
# We keep track of entries separately though and include that
390
# information in the progress bar during the relevant stages.
391
self.pb_stage_name = ""
392
self.pb_stage_count = 0
393
self.pb_stage_total = 5
394
if self.bound_branch:
395
# 2 extra stages: "Uploading data to master branch" and "Merging
396
# tags to master branch"
397
self.pb_stage_total += 2
398
self.pb.show_pct = False
399
self.pb.show_spinner = False
400
self.pb.show_eta = False
401
self.pb.show_count = True
402
self.pb.show_bar = True
404
# After a merge, a selected file commit is not supported.
405
# See 'bzr help merge' for an explanation as to why.
406
if len(self.parents) > 1 and self.specific_files is not None:
407
raise CannotCommitSelectedFileMerge(self.specific_files)
408
# Excludes are a form of selected file commit.
409
if len(self.parents) > 1 and self.exclude:
410
raise CannotCommitSelectedFileMerge(self.exclude)
412
# Collect the changes
413
self._set_progress_stage("Collecting changes", counter=True)
415
self.builder = self.branch.get_commit_builder(
416
self.parents, self.config_stack, timestamp, timezone, committer,
417
self.revprops, rev_id, lossy=lossy)
419
if self.builder.updates_branch and self.bound_branch:
421
raise AssertionError(
422
"bound branches not supported for commit builders "
423
"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)
426
# find the location being committed to
427
if self.bound_branch:
428
master_location = self.master_branch.base
430
master_location = self.branch.base
432
# report the start of the commit
433
self.reporter.started(new_revno, self.rev_id, master_location)
435
self._update_builder_with_changes()
436
self._check_pointless()
438
# TODO: Now the new inventory is known, check for conflicts.
439
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
440
# weave lines, because nothing should be recorded until it is known
441
# that commit will succeed.
442
self._set_progress_stage("Saving data locally")
443
self.builder.finish_inventory()
445
# Prompt the user for a commit message if none provided
446
message = message_callback(self)
290
447
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.
449
# Add revision data to the local branch
450
self.rev_id = self.builder.commit(self.message)
453
mutter("aborting commit write group because of exception:")
454
trace.log_exception_quietly()
458
self._update_branches(old_revno, old_revid, new_revno)
460
# Make the working tree be up to date with the branch. This
461
# includes automatic changes scheduled to be made to the tree, such
462
# as updating its basis and unversioning paths that were missing.
463
self.work_tree.unversion(self.deleted_paths)
464
self._set_progress_stage("Updating the working tree")
465
self.work_tree.update_basis_by_delta(self.rev_id,
466
self.builder.get_basis_delta())
467
self.reporter.completed(new_revno, self.rev_id)
468
self._process_post_hooks(old_revno, new_revno)
471
def _update_branches(self, old_revno, old_revid, new_revno):
472
"""Update the master and local branch to the new revision.
474
This will try to make sure that the master branch is updated
475
before the local branch.
477
:param old_revno: Revision number of master branch before the
479
:param old_revid: Tip of master branch before the commit
480
:param new_revno: Revision number of the new commit
482
if not self.builder.updates_branch:
483
self._process_pre_hooks(old_revno, new_revno)
485
# Upload revision data to the master.
486
# this will propagate merged revisions too if needed.
325
487
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)
488
self._set_progress_stage("Uploading data to master branch")
489
# 'commit' to the master first so a timeout here causes the
490
# local branch to be out of date
491
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
492
self.branch, new_revno, self.rev_id, lossy=self._lossy)
494
self.branch.fetch(self.master_branch, self.rev_id)
333
496
# 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):
497
self.branch.set_last_revision_info(new_revno, self.rev_id)
500
self._process_pre_hooks(old_revno, new_revno)
501
except BaseException:
502
# The commit builder will already have updated the branch,
504
self.branch.set_last_revision_info(old_revno, old_revid)
507
# Merge local tags to remote
508
if self.bound_branch:
509
self._set_progress_stage("Merging tags to master branch")
510
tag_updates, tag_conflicts = self.branch.tags.merge_to(
511
self.master_branch.tags)
513
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
514
note(gettext("Conflicting tags in bound branch:\n{0}".format(
515
"\n".join(warning_lines))))
517
def _select_reporter(self):
518
"""Select the CommitReporter to use."""
520
return NullCommitReporter()
521
return ReportCommitToLog()
523
def _check_pointless(self):
524
if self.allow_pointless:
526
# A merge with no effect on files
527
if len(self.parents) > 1:
529
if self.builder.any_changes():
531
raise PointlessCommit()
533
def _check_bound_branch(self, operation, possible_master_transports=None):
354
534
"""Check to see if the local branch is bound.
356
536
If it is bound, then most of the commit will actually be
371
552
# If the master branch is bound, we must fail
372
553
master_bound_location = self.master_branch.get_bound_location()
373
554
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
555
raise errors.CommitToDoubleBoundBranch(
556
self.branch, self.master_branch, master_bound_location)
377
558
# TODO: jam 20051230 We could automatically push local
378
559
# commits to the remote branch if they would fit.
379
560
# But for now, just require remote to be identical
382
563
# 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:
564
master_revid = self.master_branch.last_revision()
565
local_revid = self.branch.last_revision()
566
if local_revid != master_revid:
386
567
raise errors.BoundBranchOutOfDate(self.branch,
389
570
# Now things are ready to change the master branch
390
571
# so grab the lock
391
572
self.bound_branch = self.branch
392
573
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
574
operation.add_cleanup(self.master_branch.unlock)
576
def _check_out_of_date_tree(self):
577
"""Check that the working tree is up to date.
579
:return: old_revision_number, old_revision_id, new_revision_number
583
first_tree_parent = self.work_tree.get_parent_ids()[0]
585
# if there are no parents, treat our parent as 'None'
586
# this is so that we still consider the master branch
587
# - in a checkout scenario the tree may have no
588
# parents but the branch may do.
589
first_tree_parent = breezy.revision.NULL_REVISION
591
old_revno, master_last = self.master_branch.last_revision_info()
592
except errors.UnsupportedOperation:
593
master_last = self.master_branch.last_revision()
594
old_revno = self.branch.revision_id_to_revno(master_last)
595
if master_last != first_tree_parent:
596
if master_last != breezy.revision.NULL_REVISION:
597
raise errors.OutOfDateTree(self.work_tree)
598
if self.branch.repository.has_revision(first_tree_parent):
599
new_revno = old_revno + 1
601
# ghost parents never appear in revision history.
603
return old_revno, master_last, new_revno
605
def _process_pre_hooks(self, old_revno, new_revno):
606
"""Process any registered pre commit hooks."""
607
self._set_progress_stage("Running pre_commit hooks")
608
self._process_hooks("pre_commit", old_revno, new_revno)
610
def _process_post_hooks(self, old_revno, new_revno):
611
"""Process any registered post commit hooks."""
612
# Process the post commit hooks, if any
613
self._set_progress_stage("Running post_commit hooks")
614
# old style commit hooks - should be deprecated ? (obsoleted in
615
# 0.15^H^H^H^H 2.5.0)
616
post_commit = self.config_stack.get('post_commit')
617
if post_commit is not None:
618
hooks = post_commit.split(' ')
619
# this would be nicer with twisted.python.reflect.namedAny
621
result = eval(hook + '(branch, rev_id)',
622
{'branch': self.branch,
624
'rev_id': self.rev_id})
625
# process new style post commit hooks
626
self._process_hooks("post_commit", old_revno, new_revno)
628
def _process_hooks(self, hook_name, old_revno, new_revno):
629
if not Branch.hooks[hook_name]:
632
# new style commit hooks:
410
633
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)
634
hook_master = self.branch
637
hook_master = self.master_branch
638
hook_local = self.branch
639
# With bound branches, when the master is behind the local branch,
640
# the 'old_revno' and old_revid values here are incorrect.
641
# XXX: FIXME ^. RBC 20060206
643
old_revid = self.parents[0]
645
old_revid = breezy.revision.NULL_REVISION
647
if hook_name == "pre_commit":
648
future_tree = self.builder.revision_tree()
649
tree_delta = future_tree.changes_from(self.basis_tree,
652
for hook in Branch.hooks[hook_name]:
653
# show the running hook in the progress bar. As hooks may
654
# end up doing nothing (e.g. because they are not configured by
655
# the user) this is still showing progress, not showing overall
656
# actions - its up to each plugin to show a UI if it want's to
657
# (such as 'Emailing diff to foo@example.com').
658
self.pb_stage_name = "Running %s hooks [%s]" % \
659
(hook_name, Branch.hooks.get_hook_name(hook))
660
self._emit_progress()
661
if 'hooks' in debug.debug_flags:
662
mutter("Invoking commit hook: %r", hook)
663
if hook_name == "post_commit":
664
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
666
elif hook_name == "pre_commit":
667
hook(hook_local, hook_master,
668
old_revno, old_revid, new_revno, self.rev_id,
669
tree_delta, future_tree)
671
def _update_builder_with_changes(self):
672
"""Update the commit builder with the data about what has changed.
674
specific_files = self.specific_files
675
mutter("Selecting files for commit with filter %r", specific_files)
678
iter_changes = self.work_tree.iter_changes(
679
self.basis_tree, specific_files=specific_files)
681
iter_changes = filter_excluded(iter_changes, self.exclude)
682
iter_changes = self._filter_iter_changes(iter_changes)
683
for path, fs_hash in self.builder.record_iter_changes(
684
self.work_tree, self.basis_revid, iter_changes):
685
self.work_tree._observed_sha1(path, fs_hash)
687
def _filter_iter_changes(self, iter_changes):
688
"""Process iter_changes.
690
This method reports on the changes in iter_changes to the user, and
691
converts 'missing' entries in the iter_changes iterator to 'deleted'
692
entries. 'missing' entries have their
694
:param iter_changes: An iter_changes to process.
695
:return: A generator of changes.
697
reporter = self.reporter
698
report_changes = reporter.is_verbose()
700
for change in iter_changes:
702
old_path = change.path[0]
703
new_path = change.path[1]
704
versioned = change.versioned[1]
705
kind = change.kind[1]
706
versioned = change.versioned[1]
707
if kind is None and versioned:
710
reporter.missing(new_path)
711
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
712
trace.warning('Ignoring "%s" as symlinks are not '
713
'supported on this filesystem.' % (change.path[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))
715
deleted_paths.append(change[1][1])
716
# Reset the new path (None) and new versioned flag (False)
717
change = change.discard_new()
718
new_path = change.path[1]
720
elif kind == 'tree-reference':
721
if self.recursive == 'down':
722
self._commit_nested_tree(change[1][1])
723
if change.versioned[0] or change.versioned[1]:
727
reporter.deleted(old_path)
728
elif old_path is None:
729
reporter.snapshot_change(gettext('added'), new_path)
730
elif old_path != new_path:
731
reporter.renamed(gettext('renamed'),
735
or self.work_tree.branch.repository._format.rich_root_data):
736
# Don't report on changes to '' in non rich root
738
reporter.snapshot_change(
739
gettext('modified'), new_path)
740
self._next_progress_entry()
741
# Unversion files that were found to be deleted
742
self.deleted_paths = deleted_paths
744
def _check_strict(self):
745
# XXX: when we use iter_changes this would likely be faster if
746
# iter_changes would check for us (even in the presence of
749
# raise an exception as soon as we find a single unknown.
750
for unknown in self.work_tree.unknowns():
751
raise StrictCommitFailed()
753
def _commit_nested_tree(self, path):
754
"Commit a nested tree."
755
sub_tree = self.work_tree.get_nested_tree(path)
756
# FIXME: be more comprehensive here:
757
# this works when both trees are in --trees repository,
758
# but when both are bound to a different repository,
759
# it fails; a better way of approaching this is to
760
# finally implement the explicit-caches approach design
761
# a while back - RBC 20070306.
762
if sub_tree.branch.repository.has_same_location(
763
self.work_tree.branch.repository):
764
sub_tree.branch.repository = \
765
self.work_tree.branch.repository
767
return sub_tree.commit(message=None, revprops=self.revprops,
768
recursive=self.recursive,
769
message_callback=self.message_callback,
770
timestamp=self.timestamp,
771
timezone=self.timezone,
772
committer=self.committer,
773
allow_pointless=self.allow_pointless,
774
strict=self.strict, verbose=self.verbose,
775
local=self.local, reporter=self.reporter)
776
except PointlessCommit:
777
return self.work_tree.get_reference_revision(path)
779
def _set_progress_stage(self, name, counter=False):
780
"""Set the progress stage and emit an update to the progress bar."""
781
self.pb_stage_name = name
782
self.pb_stage_count += 1
784
self.pb_entries_count = 0
786
self.pb_entries_count = None
787
self._emit_progress()
789
def _next_progress_entry(self):
790
"""Emit an update to the progress bar and increment the entry count."""
791
self.pb_entries_count += 1
792
self._emit_progress()
794
def _emit_progress(self):
795
if self.pb_entries_count is not None:
796
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
797
self.pb_entries_count)
799
text = gettext("%s - Stage") % (self.pb_stage_name, )
800
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
