46
56
# merges from, then it should still be reported as newly added
47
57
# relative to the basis revision.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
66
from binascii import hexlify
57
67
from cStringIO import StringIO
69
from bzrlib.osutils import (local_time_offset, username,
70
rand_bytes, compact_date, user_email,
71
kind_marker, is_inside_any, quotefn,
72
sha_string, sha_strings, sha_file, isdir, isfile,
74
from bzrlib.branch import gen_file_id
64
75
from bzrlib.errors import (BzrError, PointlessCommit,
68
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
69
is_inside_or_parent_of_any,
70
quotefn, sha_file, split_lines)
71
from bzrlib.testament import Testament
79
from bzrlib.revision import Revision
72
80
from bzrlib.trace import mutter, note, warning
73
81
from bzrlib.xml5 import serializer_v5
74
from bzrlib.inventory import Inventory, InventoryEntry
75
from bzrlib import symbol_versioning
76
from bzrlib.symbol_versioning import (deprecated_passed,
79
from bzrlib.workingtree import WorkingTree
82
from bzrlib.inventory import Inventory, ROOT_ID
83
from bzrlib.weave import Weave
84
from bzrlib.weavefile import read_weave, write_weave_v5
85
from bzrlib.atomicfile import AtomicFile
88
def commit(*args, **kwargs):
89
"""Commit a new revision to a branch.
91
Function-style interface for convenience of old callers.
93
New code should use the Commit class instead.
95
## XXX: Remove this in favor of Branch.commit?
96
Commit().commit(*args, **kwargs)
83
99
class NullCommitReporter(object):
193
176
allow_pointless -- If true (default), commit even if nothing
194
177
has changed and no merges are recorded.
196
strict -- If true, don't allow a commit if the working tree
197
contains unknown files.
199
revprops -- Properties for new revision
200
:param local: Perform a local only commit.
202
179
mutter('preparing to commit')
204
if deprecated_passed(branch):
205
symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
206
"deprecated as of bzr 0.8. Please use working_tree= instead.",
207
DeprecationWarning, stacklevel=2)
209
self.work_tree = self.branch.bzrdir.open_workingtree()
210
elif working_tree is None:
211
raise BzrError("One of branch and working_tree must be passed into commit().")
213
self.work_tree = working_tree
214
self.branch = self.work_tree.branch
215
if message_callback is None:
216
if message is not None:
217
if isinstance(message, str):
218
message = message.decode(bzrlib.user_encoding)
219
message_callback = lambda x: message
221
raise BzrError("The message or message_callback keyword"
222
" parameter is required for commit().")
224
self.bound_branch = None
226
self.master_branch = None
227
self.master_locked = False
182
self.weave_store = branch.weave_store
229
184
self.specific_files = specific_files
230
185
self.allow_pointless = allow_pointless
232
if reporter is None and self.reporter is None:
233
self.reporter = NullCommitReporter()
234
elif reporter is not None:
235
self.reporter = reporter
237
self.work_tree.lock_write()
238
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
187
if timestamp is None:
188
self.timestamp = time.time()
190
self.timestamp = long(timestamp)
193
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
197
if committer is None:
198
self.committer = username(self.branch)
200
assert isinstance(committer, basestring), type(committer)
201
self.committer = committer
204
self.timezone = local_time_offset()
206
self.timezone = int(timezone)
208
assert isinstance(message, basestring), type(message)
209
self.message = message
210
self._escape_commit_message()
212
self.branch.lock_write()
240
# Cannot commit with conflicts present.
241
if len(self.work_tree.conflicts())>0:
242
raise ConflictsInTree
244
# setup the bound branch variables as needed.
245
self._check_bound_branch()
247
# check for out of date working trees
249
first_tree_parent = self.work_tree.get_parent_ids()[0]
251
# if there are no parents, treat our parent as 'None'
252
# this is so that we still consier the master branch
253
# - in a checkout scenario the tree may have no
254
# parents but the branch may do.
255
first_tree_parent = None
256
master_last = self.master_branch.last_revision()
257
if (master_last is not None and
258
master_last != first_tree_parent):
259
raise errors.OutOfDateTree(self.work_tree)
262
# raise an exception as soon as we find a single unknown.
263
for unknown in self.work_tree.unknowns():
264
raise StrictCommitFailed()
266
if self.config is None:
267
self.config = self.branch.get_config()
214
self.work_tree = self.branch.working_tree()
269
215
self.work_inv = self.work_tree.inventory
270
self.basis_tree = self.work_tree.basis_tree()
216
self.basis_tree = self.branch.basis_tree()
271
217
self.basis_inv = self.basis_tree.inventory
272
if specific_files is not None:
273
# Ensure specified files are versioned
274
# (We don't actually need the ids here)
275
tree.find_ids_across_trees(specific_files,
276
[self.basis_tree, self.work_tree])
277
# one to finish, one for rev and inventory, and one for each
278
# inventory entry, and the same for the new inventory.
279
# note that this estimate is too long when we do a partial tree
280
# commit which excludes some new files from being considered.
281
# The estimate is corrected when we populate the new inv.
282
self.pb_total = len(self.work_inv) + 5
285
219
self._gather_parents()
286
220
if len(self.parents) > 1 and self.specific_files:
287
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
290
self.builder = self.branch.get_commit_builder(self.parents,
291
self.config, timestamp, timezone, committer, revprops, rev_id)
221
raise NotImplementedError('selected-file commit of merges is not supported yet')
222
self._check_parents_present()
293
224
self._remove_deleted()
294
225
self._populate_new_inv()
226
self._store_snapshot()
295
227
self._report_deletes()
297
self._check_pointless()
299
self._emit_progress_update()
300
# TODO: Now the new inventory is known, check for conflicts and
301
# prompt the user for a commit message.
302
# ADHB 2006-08-08: If this is done, populate_new_inv should not add
303
# weave lines, because nothing should be recorded until it is known
304
# that commit will succeed.
305
self.builder.finish_inventory()
306
self._emit_progress_update()
307
message = message_callback(self)
308
assert isinstance(message, unicode), type(message)
309
self.message = message
310
self._escape_commit_message()
312
self.rev_id = self.builder.commit(self.message)
313
self._emit_progress_update()
314
# revision data is in the local branch now.
316
# upload revision data to the master.
317
# this will propagate merged revisions too if needed.
318
if self.bound_branch:
319
self.master_branch.repository.fetch(self.branch.repository,
320
revision_id=self.rev_id)
321
# now the master has the revision data
322
# 'commit' to the master first so a timeout here causes the local
323
# branch to be out of date
324
self.master_branch.append_revision(self.rev_id)
326
# and now do the commit locally.
229
if not (self.allow_pointless
230
or len(self.parents) > 1
231
or self.new_inv != self.basis_inv):
232
raise PointlessCommit()
234
if len(list(self.work_tree.iter_conflicts()))>0:
235
raise ConflictsInTree
237
self._record_inventory()
238
self._make_revision()
239
self.reporter.completed(self.branch.revno()+1, self.rev_id)
327
240
self.branch.append_revision(self.rev_id)
329
rev_tree = self.builder.revision_tree()
330
self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
331
# now the work tree is up to date with the branch
333
self.reporter.completed(self.branch.revno(), self.rev_id)
334
if self.config.post_commit() is not None:
335
hooks = self.config.post_commit().split(' ')
336
# this would be nicer with twisted.python.reflect.namedAny
338
result = eval(hook + '(branch, rev_id)',
339
{'branch':self.branch,
341
'rev_id':self.rev_id})
342
self._emit_progress_update()
241
self.branch.set_pending_merges([])
347
def _any_real_changes(self):
348
"""Are there real changes between new_inventory and basis?
350
For trees without rich roots, inv.root.revision changes every commit.
351
But if that is the only change, we want to treat it as though there
354
new_entries = self.builder.new_inventory.iter_entries()
355
basis_entries = self.basis_inv.iter_entries()
356
new_path, new_root_ie = new_entries.next()
357
basis_path, basis_root_ie = basis_entries.next()
359
# This is a copy of InventoryEntry.__eq__ only leaving out .revision
360
def ie_equal_no_revision(this, other):
361
return ((this.file_id == other.file_id)
362
and (this.name == other.name)
363
and (this.symlink_target == other.symlink_target)
364
and (this.text_sha1 == other.text_sha1)
365
and (this.text_size == other.text_size)
366
and (this.text_id == other.text_id)
367
and (this.parent_id == other.parent_id)
368
and (this.kind == other.kind)
369
and (this.executable == other.executable)
371
if not ie_equal_no_revision(new_root_ie, basis_root_ie):
374
for new_ie, basis_ie in zip(new_entries, basis_entries):
375
if new_ie != basis_ie:
378
# No actual changes present
381
def _check_pointless(self):
382
if self.allow_pointless:
384
# A merge with no effect on files
385
if len(self.parents) > 1:
387
# work around the fact that a newly-initted tree does differ from its
389
if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
390
raise PointlessCommit()
391
# Shortcut, if the number of entries changes, then we obviously have
393
if len(self.builder.new_inventory) != len(self.basis_inv):
395
# If length == 1, then we only have the root entry. Which means
396
# that there is no real difference (only the root could be different)
397
if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
399
raise PointlessCommit()
401
def _check_bound_branch(self):
402
"""Check to see if the local branch is bound.
404
If it is bound, then most of the commit will actually be
405
done using the remote branch as the target branch.
406
Only at the end will the local branch be updated.
408
if self.local and not self.branch.get_bound_location():
409
raise errors.LocalRequiresBoundBranch()
412
self.master_branch = self.branch.get_master_branch()
414
if not self.master_branch:
415
# make this branch the reference branch for out of date checks.
416
self.master_branch = self.branch
419
# If the master branch is bound, we must fail
420
master_bound_location = self.master_branch.get_bound_location()
421
if master_bound_location:
422
raise errors.CommitToDoubleBoundBranch(self.branch,
423
self.master_branch, master_bound_location)
425
# TODO: jam 20051230 We could automatically push local
426
# commits to the remote branch if they would fit.
427
# But for now, just require remote to be identical
430
# Make sure the local branch is identical to the master
431
master_rh = self.master_branch.revision_history()
432
local_rh = self.branch.revision_history()
433
if local_rh != master_rh:
434
raise errors.BoundBranchOutOfDate(self.branch,
437
# Now things are ready to change the master branch
439
self.bound_branch = self.branch
440
self.master_branch.lock_write()
441
self.master_locked = True
444
"""Cleanup any open locks, progress bars etc."""
445
cleanups = [self._cleanup_bound_branch,
446
self.work_tree.unlock,
448
found_exception = None
449
for cleanup in cleanups:
452
# we want every cleanup to run no matter what.
453
# so we have a catchall here, but we will raise the
454
# last encountered exception up the stack: and
455
# typically this will be useful enough.
458
if found_exception is not None:
459
# don't do a plan raise, because the last exception may have been
460
# trashed, e is our sure-to-work exception even though it loses the
461
# full traceback. XXX: RBC 20060421 perhaps we could check the
462
# exc_info and if its the same one do a plain raise otherwise
463
# 'raise e' as we do now.
466
def _cleanup_bound_branch(self):
467
"""Executed at the end of a try/finally to cleanup a bound branch.
469
If the branch wasn't bound, this is a no-op.
470
If it was, it resents self.branch to the local branch, instead
473
if not self.bound_branch:
475
if self.master_locked:
476
self.master_branch.unlock()
245
def _record_inventory(self):
246
"""Store the inventory for the new revision."""
247
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
248
self.inv_sha1 = sha_string(inv_text)
249
s = self.branch.control_weaves
250
s.add_text('inventory', self.rev_id,
251
split_lines(inv_text), self.present_parents)
478
253
def _escape_commit_message(self):
479
254
"""Replace xml-incompatible control characters."""
480
# FIXME: RBC 20060419 this should be done by the revision
481
# serialiser not by commit. Then we can also add an unescaper
482
# in the deserializer and start roundtripping revision messages
483
# precisely. See repository_implementations/test_repository.py
485
255
# Python strings can include characters that can't be
486
256
# represented in well-formed XML; escape characters that
487
257
# aren't listed in the XML specification
488
258
# (http://www.w3.org/TR/REC-xml/#NT-Char).
259
if isinstance(self.message, unicode):
260
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
262
# Use a regular 'str' as pattern to avoid having re.subn
263
# return 'unicode' results.
264
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
489
265
self.message, escape_count = re.subn(
490
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
491
267
lambda match: match.group(0).encode('unicode_escape'),
543
365
None; inventory entries that are carried over untouched have their
544
366
revision set to their prior value.
546
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
547
# results to create a new inventory at the same time, which results
548
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
550
368
mutter("Selecting files for commit with filter %s", self.specific_files)
551
assert self.work_inv.root is not None
552
entries = self.work_inv.iter_entries()
553
if not self.builder.record_root_entry:
554
symbol_versioning.warn('CommitBuilders should support recording'
555
' the root entry as of bzr 0.10.', DeprecationWarning,
557
self.builder.new_inventory.add(self.basis_inv.root.copy())
559
self._emit_progress_update()
560
for path, new_ie in entries:
561
self._emit_progress_update()
369
self.new_inv = Inventory()
370
for path, new_ie in self.work_inv.iter_entries():
562
371
file_id = new_ie.file_id
563
# mutter('check %s {%s}', path, file_id)
564
if (not self.specific_files or
565
is_inside_or_parent_of_any(self.specific_files, path)):
566
# mutter('%s selected for commit', path)
570
# mutter('%s not selected for commit', path)
571
if self.basis_inv.has_id(file_id):
572
ie = self.basis_inv[file_id].copy()
574
# this entry is new and not being committed
372
mutter('check %s {%s}', path, new_ie.file_id)
373
if self.specific_files:
374
if not is_inside_any(self.specific_files, path):
375
mutter('%s not selected for commit', path)
376
self._carry_entry(file_id)
576
self.builder.record_entry_contents(ie, self.parent_invs,
577
path, self.work_tree)
578
# describe the nature of the change that has occurred relative to
579
# the basis inventory.
580
if (self.basis_inv.has_id(ie.file_id)):
581
basis_ie = self.basis_inv[ie.file_id]
584
change = ie.describe_change(basis_ie, ie)
585
if change in (InventoryEntry.RENAMED,
586
InventoryEntry.MODIFIED_AND_RENAMED):
587
old_path = self.basis_inv.id2path(ie.file_id)
588
self.reporter.renamed(change, old_path, path)
590
self.reporter.snapshot_change(change, path)
592
if not self.specific_files:
595
# ignore removals that don't match filespec
596
for path, new_ie in self.basis_inv.iter_entries():
597
if new_ie.file_id in self.work_inv:
599
if is_inside_any(self.specific_files, path):
603
self.builder.record_entry_contents(ie, self.parent_invs, path,
606
def _emit_progress_update(self):
607
"""Emit an update to the progress bar."""
608
self.pb.update("Committing", self.pb_count, self.pb_total)
379
# this is selected, ensure its parents are too.
380
parent_id = new_ie.parent_id
381
while parent_id != ROOT_ID:
382
if not self.new_inv.has_id(parent_id):
383
ie = self._select_entry(self.work_inv[parent_id])
384
mutter('%s selected for commit because of %s',
385
self.new_inv.id2path(parent_id), path)
387
ie = self.new_inv[parent_id]
388
if ie.revision is not None:
390
mutter('%s selected for commit because of %s',
391
self.new_inv.id2path(parent_id), path)
392
parent_id = ie.parent_id
393
mutter('%s selected for commit', path)
394
self._select_entry(new_ie)
396
def _select_entry(self, new_ie):
397
"""Make new_ie be considered for committing."""
403
def _carry_entry(self, file_id):
404
"""Carry the file unchanged from the basis revision."""
405
if self.basis_inv.has_id(file_id):
406
self.new_inv.add(self.basis_inv[file_id].copy())
611
408
def _report_deletes(self):
612
for path, ie in self.basis_inv.iter_entries():
613
if ie.file_id not in self.builder.new_inventory:
614
self.reporter.deleted(path)
409
for file_id in self.basis_inv:
410
if file_id not in self.new_inv:
411
self.reporter.deleted(self.basis_inv.id2path(file_id))
413
def _gen_revision_id(branch, when):
414
"""Return new revision-id."""
415
s = '%s-%s-' % (user_email(branch), compact_date(when))
416
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
