56
45
# merges from, then it should still be reported as newly added
57
46
# 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.
48
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
49
# the rest of the code; add a deprecation of the old name.
57
from .branch import Branch
58
from contextlib import ExitStack
60
from .errors import (BzrError,
64
from .osutils import (get_user_encoding,
67
minimum_path_selection,
69
from .trace import mutter, note, is_quiet
70
from .tree import TreeChange
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
new_excluded = (change.path[1] is not None and
99
is_inside_any(exclude, change.path[1]))
101
old_excluded = (change.path[0] is not None and
102
is_inside_any(exclude, change.path[0]))
104
if old_excluded and new_excluded:
107
if old_excluded or new_excluded:
108
# TODO(jelmer): Perhaps raise an error here instead?
109
114
class NullCommitReporter(object):
110
115
"""I report on progress of a commit."""
117
def started(self, revno, revid, location):
112
120
def snapshot_change(self, change, path):
115
123
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
126
def deleted(self, path):
124
129
def missing(self, path):
132
def renamed(self, change, old_path, new_path):
135
def is_verbose(self):
128
139
class ReportCommitToLog(NullCommitReporter):
141
def _note(self, format, *args):
144
Subclasses may choose to override this method.
130
148
def snapshot_change(self, change, path):
131
if change == 'unchanged':
149
if path == '' and change in (gettext('added'), gettext('modified')):
133
note("%s %s", change, path)
151
self._note("%s %s", change, path)
153
def started(self, revno, rev_id, location):
155
gettext('Committing to: %s'),
156
unescape_for_display(location, 'utf-8'))
135
158
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
159
if revno is not None:
160
self._note(gettext('Committed revision %d.'), revno)
161
# self._note goes to the console too; so while we want to log the
162
# rev_id, we can't trivially only log it. (See bug 526425). Long
163
# term we should rearrange the reporting structure, but for now
164
# we just mutter seperately. We mutter the revid and revno together
165
# so that concurrent bzr invocations won't lead to confusion.
166
mutter('Committed revid %s as revno %d.', rev_id, revno)
168
self._note(gettext('Committed revid %s.'), rev_id)
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.
214
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().")
225
self.work_tree = working_tree
226
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
231
self.bound_branch = None
233
self.master_branch = None
234
self.master_locked = False
236
self.specific_files = specific_files
237
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
247
self.work_tree.lock_write()
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)
290
self.message = message
291
self._escape_commit_message()
293
self.work_inv = self.work_tree.inventory
286
with ExitStack() as stack:
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
mutter('preparing to commit')
292
if working_tree is None:
293
raise BzrError("working_tree must be passed into commit().")
295
self.work_tree = working_tree
296
self.branch = self.work_tree.branch
297
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
298
if not self.branch.repository.supports_rich_root():
299
raise errors.RootNotRich()
300
if message_callback is None:
301
if message is not None:
302
if isinstance(message, bytes):
303
message = message.decode(get_user_encoding())
305
def message_callback(x):
308
raise BzrError("The message or message_callback keyword"
309
" parameter is required for commit().")
311
self.bound_branch = None
312
self.any_entries_deleted = False
313
if exclude is not None:
314
self.exclude = sorted(
315
minimum_path_selection(exclude))
319
self.master_branch = None
320
self.recursive = recursive
322
# self.specific_files is None to indicate no filter, or any iterable to
323
# indicate a filter - [] means no files at all, as per iter_changes.
324
if specific_files is not None:
325
self.specific_files = sorted(
326
minimum_path_selection(specific_files))
328
self.specific_files = None
330
self.allow_pointless = allow_pointless
331
self.message_callback = message_callback
332
self.timestamp = timestamp
333
self.timezone = timezone
334
self.committer = committer
336
self.verbose = verbose
338
stack.enter_context(self.work_tree.lock_write())
339
self.parents = self.work_tree.get_parent_ids()
340
self.pb = ui.ui_factory.nested_progress_bar()
341
stack.callback(self.pb.finished)
342
self.basis_revid = self.work_tree.last_revision()
294
343
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:
344
stack.enter_context(self.basis_tree.lock_read())
345
# Cannot commit with conflicts present.
346
if len(self.work_tree.conflicts()) > 0:
313
347
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.
325
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)
349
# Setup the bound branch variables as needed.
350
self._check_bound_branch(stack, possible_master_transports)
351
if self.config_stack is None:
352
self.config_stack = self.work_tree.get_config_stack()
354
# Check that the working tree is up to date
355
old_revno, old_revid, new_revno = self._check_out_of_date_tree()
357
# Complete configuration setup
358
if reporter is not None:
359
self.reporter = reporter
360
elif self.reporter is None:
361
self.reporter = self._select_reporter()
363
# Setup the progress bar. As the number of files that need to be
364
# committed in unknown, progress is reported as stages.
365
# We keep track of entries separately though and include that
366
# information in the progress bar during the relevant stages.
367
self.pb_stage_name = ""
368
self.pb_stage_count = 0
369
self.pb_stage_total = 5
370
if self.bound_branch:
371
# 2 extra stages: "Uploading data to master branch" and "Merging
372
# tags to master branch"
373
self.pb_stage_total += 2
374
self.pb.show_pct = False
375
self.pb.show_spinner = False
376
self.pb.show_eta = False
377
self.pb.show_count = True
378
self.pb.show_bar = True
380
# After a merge, a selected file commit is not supported.
381
# See 'bzr help merge' for an explanation as to why.
382
if len(self.parents) > 1 and self.specific_files is not None:
383
raise CannotCommitSelectedFileMerge(self.specific_files)
384
# Excludes are a form of selected file commit.
385
if len(self.parents) > 1 and self.exclude:
386
raise CannotCommitSelectedFileMerge(self.exclude)
388
# Collect the changes
389
self._set_progress_stage("Collecting changes", counter=True)
391
self.builder = self.branch.get_commit_builder(
392
self.parents, self.config_stack, timestamp, timezone, committer,
393
self.revprops, rev_id, lossy=lossy)
395
if self.builder.updates_branch and self.bound_branch:
397
raise AssertionError(
398
"bound branches not supported for commit builders "
399
"that update the branch")
402
# find the location being committed to
403
if self.bound_branch:
404
master_location = self.master_branch.base
406
master_location = self.branch.base
408
# report the start of the commit
409
self.reporter.started(new_revno, self.rev_id, master_location)
411
self._update_builder_with_changes()
412
self._check_pointless()
414
# TODO: Now the new inventory is known, check for conflicts.
415
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
416
# weave lines, because nothing should be recorded until it is known
417
# that commit will succeed.
418
self._set_progress_stage("Saving data locally")
419
self.builder.finish_inventory()
421
# Prompt the user for a commit message if none provided
422
message = message_callback(self)
423
self.message = message
425
# Add revision data to the local branch
426
self.rev_id = self.builder.commit(self.message)
429
mutter("aborting commit write group because of exception:")
430
trace.log_exception_quietly()
434
self._update_branches(old_revno, old_revid, new_revno)
436
# Make the working tree be up to date with the branch. This
437
# includes automatic changes scheduled to be made to the tree, such
438
# as updating its basis and unversioning paths that were missing.
439
self.work_tree.unversion(self.deleted_paths)
440
self._set_progress_stage("Updating the working tree")
441
self.work_tree.update_basis_by_delta(self.rev_id,
442
self.builder.get_basis_delta())
443
self.reporter.completed(new_revno, self.rev_id)
444
self._process_post_hooks(old_revno, new_revno)
447
def _update_branches(self, old_revno, old_revid, new_revno):
448
"""Update the master and local branch to the new revision.
450
This will try to make sure that the master branch is updated
451
before the local branch.
453
:param old_revno: Revision number of master branch before the
455
:param old_revid: Tip of master branch before the commit
456
:param new_revno: Revision number of the new commit
458
if not self.builder.updates_branch:
459
self._process_pre_hooks(old_revno, new_revno)
461
# Upload revision data to the master.
462
# this will propagate merged revisions too if needed.
463
if self.bound_branch:
464
self._set_progress_stage("Uploading data to master branch")
465
# 'commit' to the master first so a timeout here causes the
466
# local branch to be out of date
467
(new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
468
self.branch, new_revno, self.rev_id, lossy=self._lossy)
470
self.branch.fetch(self.master_branch, self.rev_id)
333
472
# 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):
473
if new_revno is None:
474
# Keep existing behaviour around ghosts
476
self.branch.set_last_revision_info(new_revno, self.rev_id)
479
self._process_pre_hooks(old_revno, new_revno)
480
except BaseException:
481
# The commit builder will already have updated the branch,
483
self.branch.set_last_revision_info(old_revno, old_revid)
486
# Merge local tags to remote
487
if self.bound_branch:
488
self._set_progress_stage("Merging tags to master branch")
489
tag_updates, tag_conflicts = self.branch.tags.merge_to(
490
self.master_branch.tags)
492
warning_lines = [' ' + name for name, _, _ in tag_conflicts]
493
note(gettext("Conflicting tags in bound branch:\n{0}".format(
494
"\n".join(warning_lines))))
496
def _select_reporter(self):
497
"""Select the CommitReporter to use."""
499
return NullCommitReporter()
500
return ReportCommitToLog()
502
def _check_pointless(self):
503
if self.allow_pointless:
505
# A merge with no effect on files
506
if len(self.parents) > 1:
508
if self.builder.any_changes():
510
raise PointlessCommit()
512
def _check_bound_branch(self, stack, possible_master_transports=None):
354
513
"""Check to see if the local branch is bound.
356
515
If it is bound, then most of the commit will actually be
371
531
# If the master branch is bound, we must fail
372
532
master_bound_location = self.master_branch.get_bound_location()
373
533
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
534
raise errors.CommitToDoubleBoundBranch(
535
self.branch, self.master_branch, master_bound_location)
377
537
# TODO: jam 20051230 We could automatically push local
378
538
# commits to the remote branch if they would fit.
379
539
# But for now, just require remote to be identical
382
542
# 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:
543
master_revid = self.master_branch.last_revision()
544
local_revid = self.branch.last_revision()
545
if local_revid != master_revid:
386
546
raise errors.BoundBranchOutOfDate(self.branch,
389
549
# Now things are ready to change the master branch
390
550
# so grab the lock
391
551
self.bound_branch = self.branch
392
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
552
stack.enter_context(self.master_branch.lock_write())
554
def _check_out_of_date_tree(self):
555
"""Check that the working tree is up to date.
557
:return: old_revision_number, old_revision_id, new_revision_number
561
first_tree_parent = self.work_tree.get_parent_ids()[0]
563
# if there are no parents, treat our parent as 'None'
564
# this is so that we still consider the master branch
565
# - in a checkout scenario the tree may have no
566
# parents but the branch may do.
567
first_tree_parent = breezy.revision.NULL_REVISION
568
if (self.master_branch._format.stores_revno() or
569
self.config_stack.get('calculate_revnos')):
571
old_revno, master_last = self.master_branch.last_revision_info()
572
except errors.UnsupportedOperation:
573
master_last = self.master_branch.last_revision()
574
old_revno = self.branch.revision_id_to_revno(master_last)
576
master_last = self.master_branch.last_revision()
578
if master_last != first_tree_parent:
579
if master_last != breezy.revision.NULL_REVISION:
580
raise errors.OutOfDateTree(self.work_tree)
581
if (old_revno is not None and
582
self.branch.repository.has_revision(first_tree_parent)):
583
new_revno = old_revno + 1
585
# ghost parents never appear in revision history.
587
return old_revno, master_last, new_revno
589
def _process_pre_hooks(self, old_revno, new_revno):
590
"""Process any registered pre commit hooks."""
591
self._set_progress_stage("Running pre_commit hooks")
592
self._process_hooks("pre_commit", old_revno, new_revno)
594
def _process_post_hooks(self, old_revno, new_revno):
595
"""Process any registered post commit hooks."""
596
# Process the post commit hooks, if any
597
self._set_progress_stage("Running post_commit hooks")
598
# old style commit hooks - should be deprecated ? (obsoleted in
599
# 0.15^H^H^H^H 2.5.0)
600
post_commit = self.config_stack.get('post_commit')
601
if post_commit is not None:
602
hooks = post_commit.split(' ')
603
# this would be nicer with twisted.python.reflect.namedAny
605
result = eval(hook + '(branch, rev_id)',
606
{'branch': self.branch,
608
'rev_id': self.rev_id})
609
# process new style post commit hooks
610
self._process_hooks("post_commit", old_revno, new_revno)
612
def _process_hooks(self, hook_name, old_revno, new_revno):
613
if not Branch.hooks[hook_name]:
616
# new style commit hooks:
410
617
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)
618
hook_master = self.branch
621
hook_master = self.master_branch
622
hook_local = self.branch
623
# With bound branches, when the master is behind the local branch,
624
# the 'old_revno' and old_revid values here are incorrect.
625
# XXX: FIXME ^. RBC 20060206
627
old_revid = self.parents[0]
629
old_revid = breezy.revision.NULL_REVISION
631
if hook_name == "pre_commit":
632
future_tree = self.builder.revision_tree()
633
tree_delta = future_tree.changes_from(self.basis_tree,
636
for hook in Branch.hooks[hook_name]:
637
# show the running hook in the progress bar. As hooks may
638
# end up doing nothing (e.g. because they are not configured by
639
# the user) this is still showing progress, not showing overall
640
# actions - its up to each plugin to show a UI if it want's to
641
# (such as 'Emailing diff to foo@example.com').
642
self.pb_stage_name = "Running %s hooks [%s]" % \
643
(hook_name, Branch.hooks.get_hook_name(hook))
644
self._emit_progress()
645
if 'hooks' in debug.debug_flags:
646
mutter("Invoking commit hook: %r", hook)
647
if hook_name == "post_commit":
648
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
650
elif hook_name == "pre_commit":
651
hook(hook_local, hook_master,
652
old_revno, old_revid, new_revno, self.rev_id,
653
tree_delta, future_tree)
655
def _update_builder_with_changes(self):
656
"""Update the commit builder with the data about what has changed.
658
specific_files = self.specific_files
659
mutter("Selecting files for commit with filter %r", specific_files)
662
iter_changes = self.work_tree.iter_changes(
663
self.basis_tree, specific_files=specific_files)
665
iter_changes = filter_excluded(iter_changes, self.exclude)
666
iter_changes = self._filter_iter_changes(iter_changes)
667
for path, fs_hash in self.builder.record_iter_changes(
668
self.work_tree, self.basis_revid, iter_changes):
669
self.work_tree._observed_sha1(path, fs_hash)
671
def _filter_iter_changes(self, iter_changes):
672
"""Process iter_changes.
674
This method reports on the changes in iter_changes to the user, and
675
converts 'missing' entries in the iter_changes iterator to 'deleted'
676
entries. 'missing' entries have their
678
:param iter_changes: An iter_changes to process.
679
:return: A generator of changes.
681
reporter = self.reporter
682
report_changes = reporter.is_verbose()
684
for change in iter_changes:
686
old_path = change.path[0]
687
new_path = change.path[1]
688
versioned = change.versioned[1]
689
kind = change.kind[1]
690
versioned = change.versioned[1]
691
if kind is None and versioned:
694
reporter.missing(new_path)
695
if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
696
trace.warning('Ignoring "%s" as symlinks are not '
697
'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))
699
deleted_paths.append(change.path[1])
700
# Reset the new path (None) and new versioned flag (False)
701
change = change.discard_new()
702
new_path = change.path[1]
704
elif kind == 'tree-reference':
705
if self.recursive == 'down':
706
self._commit_nested_tree(change.path[1])
707
if change.versioned[0] or change.versioned[1]:
711
reporter.deleted(old_path)
712
elif old_path is None:
713
reporter.snapshot_change(gettext('added'), new_path)
714
elif old_path != new_path:
715
reporter.renamed(gettext('renamed'),
719
or self.work_tree.branch.repository._format.rich_root_data):
720
# Don't report on changes to '' in non rich root
722
reporter.snapshot_change(
723
gettext('modified'), new_path)
724
self._next_progress_entry()
725
# Unversion files that were found to be deleted
726
self.deleted_paths = deleted_paths
728
def _check_strict(self):
729
# XXX: when we use iter_changes this would likely be faster if
730
# iter_changes would check for us (even in the presence of
733
# raise an exception as soon as we find a single unknown.
734
for unknown in self.work_tree.unknowns():
735
raise StrictCommitFailed()
737
def _commit_nested_tree(self, path):
738
"Commit a nested tree."
739
sub_tree = self.work_tree.get_nested_tree(path)
740
# FIXME: be more comprehensive here:
741
# this works when both trees are in --trees repository,
742
# but when both are bound to a different repository,
743
# it fails; a better way of approaching this is to
744
# finally implement the explicit-caches approach design
745
# a while back - RBC 20070306.
746
if sub_tree.branch.repository.has_same_location(
747
self.work_tree.branch.repository):
748
sub_tree.branch.repository = \
749
self.work_tree.branch.repository
751
return sub_tree.commit(message=None, revprops=self.revprops,
752
recursive=self.recursive,
753
message_callback=self.message_callback,
754
timestamp=self.timestamp,
755
timezone=self.timezone,
756
committer=self.committer,
757
allow_pointless=self.allow_pointless,
758
strict=self.strict, verbose=self.verbose,
759
local=self.local, reporter=self.reporter)
760
except PointlessCommit:
761
return self.work_tree.get_reference_revision(path)
763
def _set_progress_stage(self, name, counter=False):
764
"""Set the progress stage and emit an update to the progress bar."""
765
self.pb_stage_name = name
766
self.pb_stage_count += 1
768
self.pb_entries_count = 0
770
self.pb_entries_count = None
771
self._emit_progress()
773
def _next_progress_entry(self):
774
"""Emit an update to the progress bar and increment the entry count."""
775
self.pb_entries_count += 1
776
self._emit_progress()
778
def _emit_progress(self):
779
if self.pb_entries_count is not None:
780
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
781
self.pb_entries_count)
783
text = gettext("%s - Stage") % (self.pb_stage_name, )
784
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
