56
56
# merges from, then it should still be reported as newly added
57
57
# 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.
66
from binascii import hexlify
72
67
from cStringIO import StringIO
74
from bzrlib.atomicfile import AtomicFile
76
import bzrlib.errors as errors
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
77
75
from bzrlib.errors import (BzrError, PointlessCommit,
81
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
82
is_inside_or_parent_of_any,
83
quotefn, sha_file, split_lines)
84
from bzrlib.testament import Testament
79
from bzrlib.revision import Revision
85
80
from bzrlib.trace import mutter, note, warning
86
81
from bzrlib.xml5 import serializer_v5
87
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
88
from bzrlib.symbol_versioning import (deprecated_passed,
92
from bzrlib.workingtree import WorkingTree
95
@deprecated_function(zero_seven)
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
96
88
def commit(*args, **kwargs):
97
89
"""Commit a new revision to a branch.
214
176
allow_pointless -- If true (default), commit even if nothing
215
177
has changed and no merges are recorded.
217
strict -- If true, don't allow a commit if the working tree
218
contains unknown files.
220
revprops -- Properties for new revision
221
:param local: Perform a local only commit.
223
179
mutter('preparing to commit')
225
if deprecated_passed(branch):
226
warnings.warn("Commit.commit (branch, ...): The branch parameter is "
227
"deprecated as of bzr 0.8. Please use working_tree= instead.",
228
DeprecationWarning, stacklevel=2)
230
self.work_tree = self.branch.bzrdir.open_workingtree()
231
elif working_tree is None:
232
raise BzrError("One of branch and working_tree must be passed into commit().")
234
self.work_tree = working_tree
235
self.branch = self.work_tree.branch
237
raise BzrError("The message keyword parameter is required for commit().")
239
self.bound_branch = None
241
self.master_branch = None
242
self.master_locked = False
182
self.weave_store = branch.weave_store
244
184
self.specific_files = specific_files
245
185
self.allow_pointless = allow_pointless
247
if reporter is None and self.reporter is None:
248
self.reporter = NullCommitReporter()
249
elif reporter is not None:
250
self.reporter = reporter
252
self.work_tree.lock_write()
253
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()
255
# Cannot commit with conflicts present.
256
if len(self.work_tree.conflicts())>0:
257
raise ConflictsInTree
259
# setup the bound branch variables as needed.
260
self._check_bound_branch()
262
# check for out of date working trees
263
# if we are bound, then self.branch is the master branch and this
264
# test is thus all we need.
265
if self.work_tree.last_revision() != self.master_branch.last_revision():
266
raise errors.OutOfDateTree(self.work_tree)
269
# raise an exception as soon as we find a single unknown.
270
for unknown in self.work_tree.unknowns():
271
raise StrictCommitFailed()
273
if self.config is None:
274
self.config = self.branch.get_config()
276
if isinstance(message, str):
277
message = message.decode(bzrlib.user_encoding)
278
assert isinstance(message, unicode), type(message)
279
self.message = message
280
self._escape_commit_message()
214
self.work_tree = self.branch.working_tree()
282
215
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
216
self.basis_tree = self.branch.basis_tree()
284
217
self.basis_inv = self.basis_tree.inventory
285
# one to finish, one for rev and inventory, and one for each
286
# inventory entry, and the same for the new inventory.
287
# note that this estimate is too long when we do a partial tree
288
# commit which excludes some new files from being considered.
289
# The estimate is corrected when we populate the new inv.
290
self.pb_total = len(self.work_inv) + 5
293
219
self._gather_parents()
294
220
if len(self.parents) > 1 and self.specific_files:
295
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
221
raise NotImplementedError('selected-file commit of merges is not supported yet')
297
222
self._check_parents_present()
298
self.builder = self.branch.get_commit_builder(self.parents,
299
self.config, timestamp, timezone, committer, revprops, rev_id)
301
224
self._remove_deleted()
302
225
self._populate_new_inv()
226
self._store_snapshot()
303
227
self._report_deletes()
305
229
if not (self.allow_pointless
306
230
or len(self.parents) > 1
307
or self.builder.new_inventory != self.basis_inv):
231
or self.new_inv != self.basis_inv):
308
232
raise PointlessCommit()
310
self._emit_progress_update()
311
# TODO: Now the new inventory is known, check for conflicts and prompt the
312
# user for a commit message.
313
self.builder.finish_inventory()
314
self._emit_progress_update()
315
self.rev_id = self.builder.commit(self.message)
316
self._emit_progress_update()
317
# revision data is in the local branch now.
319
# upload revision data to the master.
320
# this will propagate merged revisions too if needed.
321
if self.bound_branch:
322
self.master_branch.repository.fetch(self.branch.repository,
323
revision_id=self.rev_id)
324
# now the master has the revision data
325
# 'commit' to the master first so a timeout here causes the local
326
# branch to be out of date
327
self.master_branch.append_revision(self.rev_id)
234
if len(list(self.work_tree.iter_conflicts()))>0:
235
raise ConflictsInTree
329
# and now do the commit locally.
237
self._record_inventory()
238
self._make_revision()
239
self.reporter.completed(self.branch.revno()+1, self.rev_id)
330
240
self.branch.append_revision(self.rev_id)
332
self.work_tree.set_pending_merges([])
333
self.work_tree.set_last_revision(self.rev_id)
334
# now the work tree is up to date with the branch
336
self.reporter.completed(self.branch.revno(), self.rev_id)
337
if self.config.post_commit() is not None:
338
hooks = self.config.post_commit().split(' ')
339
# this would be nicer with twisted.python.reflect.namedAny
341
result = eval(hook + '(branch, rev_id)',
342
{'branch':self.branch,
344
'rev_id':self.rev_id})
345
self._emit_progress_update()
241
self.branch.set_pending_merges([])
350
def _check_bound_branch(self):
351
"""Check to see if the local branch is bound.
353
If it is bound, then most of the commit will actually be
354
done using the remote branch as the target branch.
355
Only at the end will the local branch be updated.
357
if self.local and not self.branch.get_bound_location():
358
raise errors.LocalRequiresBoundBranch()
361
self.master_branch = self.branch.get_master_branch()
363
if not self.master_branch:
364
# make this branch the reference branch for out of date checks.
365
self.master_branch = self.branch
368
# If the master branch is bound, we must fail
369
master_bound_location = self.master_branch.get_bound_location()
370
if master_bound_location:
371
raise errors.CommitToDoubleBoundBranch(self.branch,
372
self.master_branch, master_bound_location)
374
# TODO: jam 20051230 We could automatically push local
375
# commits to the remote branch if they would fit.
376
# But for now, just require remote to be identical
379
# Make sure the local branch is identical to the master
380
master_rh = self.master_branch.revision_history()
381
local_rh = self.branch.revision_history()
382
if local_rh != master_rh:
383
raise errors.BoundBranchOutOfDate(self.branch,
386
# Now things are ready to change the master branch
388
self.bound_branch = self.branch
389
self.master_branch.lock_write()
390
self.master_locked = True
393
"""Cleanup any open locks, progress bars etc."""
394
cleanups = [self._cleanup_bound_branch,
395
self.work_tree.unlock,
397
found_exception = None
398
for cleanup in cleanups:
401
# we want every cleanup to run no matter what.
402
# so we have a catchall here, but we will raise the
403
# last encountered exception up the stack: and
404
# typically this will be useful enough.
407
if found_exception is not None:
408
# don't do a plan raise, because the last exception may have been
409
# trashed, e is our sure-to-work exception even though it loses the
410
# full traceback. XXX: RBC 20060421 perhaps we could check the
411
# exc_info and if its the same one do a plain raise otherwise
412
# 'raise e' as we do now.
415
def _cleanup_bound_branch(self):
416
"""Executed at the end of a try/finally to cleanup a bound branch.
418
If the branch wasn't bound, this is a no-op.
419
If it was, it resents self.branch to the local branch, instead
422
if not self.bound_branch:
424
if self.master_locked:
425
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,
252
self.branch.get_transaction())
427
254
def _escape_commit_message(self):
428
255
"""Replace xml-incompatible control characters."""
429
# FIXME: RBC 20060419 this should be done by the revision
430
# serialiser not by commit. Then we can also add an unescaper
431
# in the deserializer and start roundtripping revision messages
432
# precisely. See repository_implementations/test_repository.py
434
256
# Python strings can include characters that can't be
435
257
# represented in well-formed XML; escape characters that
436
258
# aren't listed in the XML specification
437
259
# (http://www.w3.org/TR/REC-xml/#NT-Char).
260
if isinstance(self.message, unicode):
261
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
263
# Use a regular 'str' as pattern to avoid having re.subn
264
# return 'unicode' results.
265
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
438
266
self.message, escape_count = re.subn(
439
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
440
268
lambda match: match.group(0).encode('unicode_escape'),
445
273
def _gather_parents(self):
446
274
"""Record the parents of a merge for merge detection."""
447
# TODO: Make sure that this list doesn't contain duplicate
448
# entries and the order is preserved when doing this.
449
self.parents = self.work_tree.get_parent_ids()
275
pending_merges = self.branch.pending_merges()
450
277
self.parent_invs = []
278
self.present_parents = []
279
precursor_id = self.branch.last_revision()
281
self.parents.append(precursor_id)
282
self.parents += pending_merges
451
283
for revision in self.parents:
452
if self.branch.repository.has_revision(revision):
453
inventory = self.branch.repository.get_inventory(revision)
454
self.parent_invs.append(inventory)
284
if self.branch.has_revision(revision):
285
self.parent_invs.append(self.branch.get_inventory(revision))
286
self.present_parents.append(revision)
456
288
def _check_parents_present(self):
457
289
for parent_id in self.parents:
458
290
mutter('commit parent revision {%s}', parent_id)
459
if not self.branch.repository.has_revision(parent_id):
291
if not self.branch.has_revision(parent_id):
460
292
if parent_id == self.branch.last_revision():
461
293
warning("parent is missing %r", parent_id)
462
raise BzrCheckError("branch %s is missing revision {%s}"
463
% (self.branch, parent_id))
294
raise HistoryMissing(self.branch, 'revision', parent_id)
296
mutter("commit will ghost revision %r", parent_id)
298
def _make_revision(self):
299
"""Record a new revision object for this commit."""
300
self.rev = Revision(timestamp=self.timestamp,
301
timezone=self.timezone,
302
committer=self.committer,
303
message=self.message,
304
inventory_sha1=self.inv_sha1,
305
revision_id=self.rev_id)
306
self.rev.parent_ids = self.parents
308
serializer_v5.write_revision(self.rev, rev_tmp)
310
self.branch.revision_store.add(rev_tmp, self.rev_id)
311
mutter('new revision_id is {%s}', self.rev_id)
465
313
def _remove_deleted(self):
466
314
"""Remove deleted files from the working inventories.
497
368
None; inventory entries that are carried over untouched have their
498
369
revision set to their prior value.
500
# ESEPARATIONOFCONCERNS: this function is diffing and using the diff
501
# results to create a new inventory at the same time, which results
502
# in bugs like #46635. Any reason not to use/enhance Tree.changes_from?
504
371
mutter("Selecting files for commit with filter %s", self.specific_files)
505
# at this point we dont copy the root entry:
506
entries = self.work_inv.iter_entries()
508
self._emit_progress_update()
509
for path, new_ie in entries:
510
self._emit_progress_update()
372
self.new_inv = Inventory()
373
for path, new_ie in self.work_inv.iter_entries():
511
374
file_id = new_ie.file_id
512
# mutter('check %s {%s}', path, file_id)
513
if (not self.specific_files or
514
is_inside_or_parent_of_any(self.specific_files, path)):
515
# mutter('%s selected for commit', path)
519
# mutter('%s not selected for commit', path)
520
if self.basis_inv.has_id(file_id):
521
ie = self.basis_inv[file_id].copy()
523
# this entry is new and not being committed
375
mutter('check %s {%s}', path, new_ie.file_id)
376
if self.specific_files:
377
if not is_inside_any(self.specific_files, path):
378
mutter('%s not selected for commit', path)
379
self._carry_entry(file_id)
526
self.builder.record_entry_contents(ie, self.parent_invs,
527
path, self.work_tree)
528
# describe the nature of the change that has occurred relative to
529
# the basis inventory.
530
if (self.basis_inv.has_id(ie.file_id)):
531
basis_ie = self.basis_inv[ie.file_id]
534
change = ie.describe_change(basis_ie, ie)
535
if change in (InventoryEntry.RENAMED,
536
InventoryEntry.MODIFIED_AND_RENAMED):
537
old_path = self.basis_inv.id2path(ie.file_id)
538
self.reporter.renamed(change, old_path, path)
540
self.reporter.snapshot_change(change, path)
542
if not self.specific_files:
545
# ignore removals that don't match filespec
546
for path, new_ie in self.basis_inv.iter_entries():
547
if new_ie.file_id in self.work_inv:
549
if is_inside_any(self.specific_files, path):
553
self.builder.record_entry_contents(ie, self.parent_invs, path,
556
def _emit_progress_update(self):
557
"""Emit an update to the progress bar."""
558
self.pb.update("Committing", self.pb_count, self.pb_total)
382
# this is selected, ensure its parents are too.
383
parent_id = new_ie.parent_id
384
while parent_id != ROOT_ID:
385
if not self.new_inv.has_id(parent_id):
386
ie = self._select_entry(self.work_inv[parent_id])
387
mutter('%s selected for commit because of %s',
388
self.new_inv.id2path(parent_id), path)
390
ie = self.new_inv[parent_id]
391
if ie.revision is not None:
393
mutter('%s selected for commit because of %s',
394
self.new_inv.id2path(parent_id), path)
395
parent_id = ie.parent_id
396
mutter('%s selected for commit', path)
397
self._select_entry(new_ie)
399
def _select_entry(self, new_ie):
400
"""Make new_ie be considered for committing."""
406
def _carry_entry(self, file_id):
407
"""Carry the file unchanged from the basis revision."""
408
if self.basis_inv.has_id(file_id):
409
self.new_inv.add(self.basis_inv[file_id].copy())
561
411
def _report_deletes(self):
562
for path, ie in self.basis_inv.iter_entries():
563
if ie.file_id not in self.builder.new_inventory:
564
self.reporter.deleted(path)
412
for file_id in self.basis_inv:
413
if file_id not in self.new_inv:
414
self.reporter.deleted(self.basis_inv.id2path(file_id))
416
def _gen_revision_id(branch, when):
417
"""Return new revision-id."""
418
s = '%s-%s-' % (user_email(branch), compact_date(when))
419
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
