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.
60
from .branch import Branch
61
from .cleanup import OperationWithCleanups
63
from .errors import (BzrError,
67
from .osutils import (get_user_encoding,
69
minimum_path_selection,
72
from .trace import mutter, note, is_quiet
73
from .bzr.inventory import Inventory, InventoryEntry, make_entry
74
from .urlutils import unescape_for_display
75
from .i18n import gettext
78
class PointlessCommit(BzrError):
80
_fmt = "No changes to commit"
83
class CannotCommitSelectedFileMerge(BzrError):
85
_fmt = 'Selected-file commit of merges is not supported yet:'\
86
' files %(files_str)s'
88
def __init__(self, files):
89
files_str = ', '.join(files)
90
BzrError.__init__(self, files=files, files_str=files_str)
93
def filter_excluded(iter_changes, exclude):
94
"""Filter exclude filenames.
96
:param iter_changes: iter_changes function
97
:param exclude: List of paths to exclude
98
:return: iter_changes function
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
100
for change in iter_changes:
101
old_path = change[1][0]
102
new_path = change[1][1]
104
new_excluded = (new_path is not None and
105
is_inside_any(exclude, new_path))
107
old_excluded = (old_path is not None and
108
is_inside_any(exclude, old_path))
110
if old_excluded and new_excluded:
113
if old_excluded or new_excluded:
114
# TODO(jelmer): Perhaps raise an error here instead?
109
120
class NullCommitReporter(object):
110
121
"""I report on progress of a commit."""
123
def started(self, revno, revid, location):
112
126
def snapshot_change(self, change, path):
115
129
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
132
def deleted(self, path):
124
135
def missing(self, path):
138
def renamed(self, change, old_path, new_path):
141
def is_verbose(self):
128
145
class ReportCommitToLog(NullCommitReporter):
147
def _note(self, format, *args):
150
Subclasses may choose to override this method.
130
154
def snapshot_change(self, change, path):
131
if change == 'unchanged':
155
if path == '' and change in (gettext('added'), gettext('modified')):
133
note("%s %s", change, path)
157
self._note("%s %s", change, path)
159
def started(self, revno, rev_id, location):
161
gettext('Committing to: %s'),
162
unescape_for_display(location, 'utf-8'))
135
164
def completed(self, revno, rev_id):
136
note('Committed revision %d.', revno)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
165
self._note(gettext('Committed revision %d.'), revno)
166
# self._note goes to the console too; so while we want to log the
167
# rev_id, we can't trivially only log it. (See bug 526425). Long
168
# term we should rearrange the reporting structure, but for now
169
# we just mutter seperately. We mutter the revid and revno together
170
# so that concurrent bzr invocations won't lead to confusion.
171
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)
173
def deleted(self, path):
174
self._note(gettext('deleted %s'), path)
144
176
def missing(self, path):
145
note('missing %s', path)
177
self._note(gettext('missing %s'), path)
179
def renamed(self, change, old_path, new_path):
180
self._note('%s %s => %s', change, old_path, new_path)
182
def is_verbose(self):
148
186
class Commit(object):
183
243
working_tree=None,
247
message_callback=None,
250
possible_master_transports=None,
187
252
"""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.
254
:param message: the commit message (it or message_callback is required)
255
:param message_callback: A callback: message = message_callback(cmt_obj)
257
:param timestamp: if not None, seconds-since-epoch for a
258
postdated/predated commit.
260
:param specific_files: If not None, commit only those files. An empty
261
list means 'commit no files'.
263
:param rev_id: If set, use this as the new revision id.
200
264
Useful for test or import commands that need to tightly
201
265
control what revisions are assigned. If you duplicate
202
266
a revision id that exists elsewhere it is your own fault.
203
267
If null (default), a time/random revision id is generated.
205
allow_pointless -- If true (default), commit even if nothing
269
:param allow_pointless: If true (default), commit even if nothing
206
270
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
272
:param strict: If true, don't allow a commit if the working tree
209
273
contains unknown files.
211
revprops -- Properties for new revision
275
:param revprops: Properties for new revision
212
276
:param local: Perform a local only commit.
277
:param reporter: the reporter to use or None for the default
278
:param verbose: if True and the reporter is not None, report everything
279
:param recursive: If set to 'down', commit in any subtrees that have
280
pending changes of any sort during this commit.
281
:param exclude: None or a list of relative paths to exclude from the
282
commit. Pending changes to excluded files will be ignored by the
284
:param lossy: When committing to a foreign VCS, ignore any
285
data that can not be natively represented.
287
operation = OperationWithCleanups(self._commit)
288
self.revprops = revprops or {}
289
# XXX: Can be set on __init__ or passed in - this is a bit ugly.
290
self.config_stack = config or self.config_stack
291
return operation.run(
296
specific_files=specific_files,
298
allow_pointless=allow_pointless,
301
working_tree=working_tree,
304
message_callback=message_callback,
307
possible_master_transports=possible_master_transports,
310
def _commit(self, operation, message, timestamp, timezone, committer,
311
specific_files, rev_id, allow_pointless, strict, verbose,
312
working_tree, local, reporter, message_callback, recursive,
313
exclude, possible_master_transports, lossy):
214
314
mutter('preparing to commit')
216
if deprecated_passed(branch):
217
warn("Commit.commit (branch, ...): The branch parameter is "
218
"deprecated as of bzr 0.8. Please use working_tree= instead.",
219
DeprecationWarning, stacklevel=2)
221
self.work_tree = self.branch.bzrdir.open_workingtree()
222
elif working_tree is None:
223
raise BzrError("One of branch and working_tree must be passed into commit().")
316
if working_tree is None:
317
raise BzrError("working_tree must be passed into commit().")
225
319
self.work_tree = working_tree
226
320
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
321
if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
322
if not self.branch.repository.supports_rich_root():
323
raise errors.RootNotRich()
324
if message_callback is None:
325
if message is not None:
326
if isinstance(message, bytes):
327
message = message.decode(get_user_encoding())
328
message_callback = lambda x: message
330
raise BzrError("The message or message_callback keyword"
331
" parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
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(self.parents,
416
self.config_stack, timestamp, timezone, committer, self.revprops,
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)
452
except Exception as e:
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)
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
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
590
old_revno, master_last = self.master_branch.last_revision_info()
591
if master_last != first_tree_parent:
592
if master_last != breezy.revision.NULL_REVISION:
593
raise errors.OutOfDateTree(self.work_tree)
594
if self.branch.repository.has_revision(first_tree_parent):
595
new_revno = old_revno + 1
597
# ghost parents never appear in revision history.
599
return old_revno, master_last, new_revno
601
def _process_pre_hooks(self, old_revno, new_revno):
602
"""Process any registered pre commit hooks."""
603
self._set_progress_stage("Running pre_commit hooks")
604
self._process_hooks("pre_commit", old_revno, new_revno)
606
def _process_post_hooks(self, old_revno, new_revno):
607
"""Process any registered post commit hooks."""
608
# Process the post commit hooks, if any
609
self._set_progress_stage("Running post_commit hooks")
610
# old style commit hooks - should be deprecated ? (obsoleted in
611
# 0.15^H^H^H^H 2.5.0)
612
post_commit = self.config_stack.get('post_commit')
613
if post_commit is not None:
614
hooks = post_commit.split(' ')
615
# this would be nicer with twisted.python.reflect.namedAny
617
result = eval(hook + '(branch, rev_id)',
618
{'branch':self.branch,
620
'rev_id':self.rev_id})
621
# process new style post commit hooks
622
self._process_hooks("post_commit", old_revno, new_revno)
624
def _process_hooks(self, hook_name, old_revno, new_revno):
625
if not Branch.hooks[hook_name]:
628
# new style commit hooks:
410
629
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))
630
hook_master = self.branch
633
hook_master = self.master_branch
634
hook_local = self.branch
635
# With bound branches, when the master is behind the local branch,
636
# the 'old_revno' and old_revid values here are incorrect.
637
# XXX: FIXME ^. RBC 20060206
639
old_revid = self.parents[0]
641
old_revid = breezy.revision.NULL_REVISION
643
if hook_name == "pre_commit":
644
future_tree = self.builder.revision_tree()
645
tree_delta = future_tree.changes_from(self.basis_tree,
648
for hook in Branch.hooks[hook_name]:
649
# show the running hook in the progress bar. As hooks may
650
# end up doing nothing (e.g. because they are not configured by
651
# the user) this is still showing progress, not showing overall
652
# actions - its up to each plugin to show a UI if it want's to
653
# (such as 'Emailing diff to foo@example.com').
654
self.pb_stage_name = "Running %s hooks [%s]" % \
655
(hook_name, Branch.hooks.get_hook_name(hook))
656
self._emit_progress()
657
if 'hooks' in debug.debug_flags:
658
mutter("Invoking commit hook: %r", hook)
659
if hook_name == "post_commit":
660
hook(hook_local, hook_master, old_revno, old_revid, new_revno,
662
elif hook_name == "pre_commit":
663
hook(hook_local, hook_master,
664
old_revno, old_revid, new_revno, self.rev_id,
665
tree_delta, future_tree)
667
def _update_builder_with_changes(self):
668
"""Update the commit builder with the data about what has changed.
670
specific_files = self.specific_files
671
mutter("Selecting files for commit with filter %r", specific_files)
674
iter_changes = self.work_tree.iter_changes(self.basis_tree,
675
specific_files=specific_files)
677
iter_changes = filter_excluded(iter_changes, self.exclude)
678
iter_changes = self._filter_iter_changes(iter_changes)
679
for file_id, path, fs_hash in self.builder.record_iter_changes(
680
self.work_tree, self.basis_revid, iter_changes):
681
self.work_tree._observed_sha1(file_id, path, fs_hash)
683
def _filter_iter_changes(self, iter_changes):
684
"""Process iter_changes.
686
This method reports on the changes in iter_changes to the user, and
687
converts 'missing' entries in the iter_changes iterator to 'deleted'
688
entries. 'missing' entries have their
690
:param iter_changes: An iter_changes to process.
691
:return: A generator of changes.
693
reporter = self.reporter
694
report_changes = reporter.is_verbose()
696
for change in iter_changes:
698
old_path = change[1][0]
699
new_path = change[1][1]
700
versioned = change[3][1]
702
versioned = change[3][1]
703
if kind is None and versioned:
706
reporter.missing(new_path)
707
deleted_paths.append(change[1][1])
708
# Reset the new path (None) and new versioned flag (False)
709
change = (change[0], (change[1][0], None), change[2],
710
(change[3][0], False)) + change[4:]
711
new_path = change[1][1]
713
elif kind == 'tree-reference':
714
if self.recursive == 'down':
715
self._commit_nested_tree(change[0], change[1][1])
716
if change[3][0] or change[3][1]:
720
reporter.deleted(old_path)
721
elif old_path is None:
722
reporter.snapshot_change(gettext('added'), new_path)
723
elif old_path != new_path:
724
reporter.renamed(gettext('renamed'), old_path, new_path)
727
self.work_tree.branch.repository._format.rich_root_data):
728
# Don't report on changes to '' in non rich root
730
reporter.snapshot_change(gettext('modified'), new_path)
731
self._next_progress_entry()
732
# Unversion files that were found to be deleted
733
self.deleted_paths = deleted_paths
735
def _check_strict(self):
736
# XXX: when we use iter_changes this would likely be faster if
737
# iter_changes would check for us (even in the presence of
740
# raise an exception as soon as we find a single unknown.
741
for unknown in self.work_tree.unknowns():
742
raise StrictCommitFailed()
744
def _commit_nested_tree(self, file_id, path):
745
"Commit a nested tree."
746
sub_tree = self.work_tree.get_nested_tree(path, file_id)
747
# FIXME: be more comprehensive here:
748
# this works when both trees are in --trees repository,
749
# but when both are bound to a different repository,
750
# it fails; a better way of approaching this is to
751
# finally implement the explicit-caches approach design
752
# a while back - RBC 20070306.
753
if sub_tree.branch.repository.has_same_location(
754
self.work_tree.branch.repository):
755
sub_tree.branch.repository = \
756
self.work_tree.branch.repository
758
return sub_tree.commit(message=None, revprops=self.revprops,
759
recursive=self.recursive,
760
message_callback=self.message_callback,
761
timestamp=self.timestamp, timezone=self.timezone,
762
committer=self.committer,
763
allow_pointless=self.allow_pointless,
764
strict=self.strict, verbose=self.verbose,
765
local=self.local, reporter=self.reporter)
766
except PointlessCommit:
767
return self.work_tree.get_reference_revision(path, file_id)
769
def _set_progress_stage(self, name, counter=False):
770
"""Set the progress stage and emit an update to the progress bar."""
771
self.pb_stage_name = name
772
self.pb_stage_count += 1
774
self.pb_entries_count = 0
776
self.pb_entries_count = None
777
self._emit_progress()
779
def _next_progress_entry(self):
780
"""Emit an update to the progress bar and increment the entry count."""
781
self.pb_entries_count += 1
782
self._emit_progress()
784
def _emit_progress(self):
785
if self.pb_entries_count is not None:
786
text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
787
self.pb_entries_count)
789
text = gettext("%s - Stage") % (self.pb_stage_name, )
790
self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
added
removed
breezy/commit.py
