72
from binascii import hexlify
73
72
from cStringIO import StringIO
75
from bzrlib.osutils import (local_time_offset,
76
rand_bytes, compact_date,
77
kind_marker, is_inside_any, quotefn,
78
sha_string, sha_strings, sha_file, isdir, isfile,
80
from bzrlib.branch import gen_file_id
74
from bzrlib.atomicfile import AtomicFile
81
75
import bzrlib.config
76
import bzrlib.errors as errors
82
77
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
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)
89
84
from bzrlib.testament import Testament
90
85
from bzrlib.trace import mutter, note, warning
91
86
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
95
from bzrlib.atomicfile import AtomicFile
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)
98
96
def commit(*args, **kwargs):
99
97
"""Commit a new revision to a branch.
196
218
contains unknown files.
198
220
revprops -- Properties for new revision
221
:param local: Perform a local only commit.
200
223
mutter('preparing to commit')
203
self.weave_store = branch.weave_store
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
205
244
self.specific_files = specific_files
206
245
self.allow_pointless = allow_pointless
207
self.revprops = revprops
209
if strict and branch.unknowns():
210
raise StrictCommitFailed()
212
if timestamp is None:
213
self.timestamp = time.time()
215
self.timestamp = long(timestamp)
217
if self.config is None:
218
self.config = bzrlib.config.BranchConfig(self.branch)
221
self.rev_id = _gen_revision_id(self.config, self.timestamp)
225
if committer is None:
226
self.committer = self.config.username()
228
assert isinstance(committer, basestring), type(committer)
229
self.committer = committer
232
self.timezone = local_time_offset()
234
self.timezone = int(timezone)
236
assert isinstance(message, basestring), type(message)
237
self.message = message
238
self._escape_commit_message()
240
self.branch.lock_write()
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()
242
self.work_tree = self.branch.working_tree()
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()
243
282
self.work_inv = self.work_tree.inventory
244
self.basis_tree = self.branch.basis_tree()
283
self.basis_tree = self.work_tree.basis_tree()
245
284
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
247
293
self._gather_parents()
248
294
if len(self.parents) > 1 and self.specific_files:
249
raise NotImplementedError('selected-file commit of merges is not supported yet')
295
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
250
297
self._check_parents_present()
298
self.builder = self.branch.get_commit_builder(self.parents,
299
self.config, timestamp, timezone, committer, revprops, rev_id)
252
301
self._remove_deleted()
253
302
self._populate_new_inv()
254
self._store_snapshot()
255
303
self._report_deletes()
257
305
if not (self.allow_pointless
258
306
or len(self.parents) > 1
259
or self.new_inv != self.basis_inv):
307
or self.builder.new_inventory != self.basis_inv):
260
308
raise PointlessCommit()
262
if len(list(self.work_tree.iter_conflicts()))>0:
263
raise ConflictsInTree
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)
265
self._record_inventory()
266
self._make_revision()
267
self.reporter.completed(self.branch.revno()+1, self.rev_id)
329
# and now do the commit locally.
268
330
self.branch.append_revision(self.rev_id)
269
self.branch.set_pending_merges([])
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()
273
def _record_inventory(self):
274
"""Store the inventory for the new revision."""
275
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
276
self.inv_sha1 = sha_string(inv_text)
277
s = self.branch.control_weaves
278
s.add_text('inventory', self.rev_id,
279
split_lines(inv_text), self.present_parents,
280
self.branch.get_transaction())
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()
282
427
def _escape_commit_message(self):
283
428
"""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
284
434
# Python strings can include characters that can't be
285
435
# represented in well-formed XML; escape characters that
286
436
# aren't listed in the XML specification
287
437
# (http://www.w3.org/TR/REC-xml/#NT-Char).
288
if isinstance(self.message, unicode):
289
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
291
# Use a regular 'str' as pattern to avoid having re.subn
292
# return 'unicode' results.
293
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
294
438
self.message, escape_count = re.subn(
439
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
296
440
lambda match: match.group(0).encode('unicode_escape'),
301
445
def _gather_parents(self):
302
446
"""Record the parents of a merge for merge detection."""
303
pending_merges = self.branch.pending_merges()
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()
305
450
self.parent_invs = []
306
self.present_parents = []
307
precursor_id = self.branch.last_revision()
309
self.parents.append(precursor_id)
310
self.parents += pending_merges
311
451
for revision in self.parents:
312
if self.branch.has_revision(revision):
313
self.parent_invs.append(self.branch.get_inventory(revision))
314
self.present_parents.append(revision)
452
if self.branch.repository.has_revision(revision):
453
inventory = self.branch.repository.get_inventory(revision)
454
self.parent_invs.append(inventory)
316
456
def _check_parents_present(self):
317
457
for parent_id in self.parents:
318
458
mutter('commit parent revision {%s}', parent_id)
319
if not self.branch.has_revision(parent_id):
459
if not self.branch.repository.has_revision(parent_id):
320
460
if parent_id == self.branch.last_revision():
321
461
warning("parent is missing %r", parent_id)
322
raise HistoryMissing(self.branch, 'revision', parent_id)
324
mutter("commit will ghost revision %r", parent_id)
462
raise BzrCheckError("branch %s is missing revision {%s}"
463
% (self.branch, parent_id))
326
def _make_revision(self):
327
"""Record a new revision object for this commit."""
328
self.rev = Revision(timestamp=self.timestamp,
329
timezone=self.timezone,
330
committer=self.committer,
331
message=self.message,
332
inventory_sha1=self.inv_sha1,
333
revision_id=self.rev_id,
334
properties=self.revprops)
335
self.rev.parent_ids = self.parents
337
serializer_v5.write_revision(self.rev, rev_tmp)
339
if self.config.signature_needed():
340
plaintext = Testament(self.rev, self.new_inv).as_short_text()
341
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
342
plaintext, self.rev_id)
343
self.branch.revision_store.add(rev_tmp, self.rev_id)
344
mutter('new revision_id is {%s}', self.rev_id)
346
465
def _remove_deleted(self):
347
466
"""Remove deleted files from the working inventories.
401
497
None; inventory entries that are carried over untouched have their
402
498
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?
404
504
mutter("Selecting files for commit with filter %s", self.specific_files)
405
self.new_inv = Inventory()
406
for path, new_ie in self.work_inv.iter_entries():
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()
407
511
file_id = new_ie.file_id
408
mutter('check %s {%s}', path, new_ie.file_id)
409
if self.specific_files:
410
if not is_inside_any(self.specific_files, path):
411
mutter('%s not selected for commit', path)
412
self._carry_entry(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
415
# this is selected, ensure its parents are too.
416
parent_id = new_ie.parent_id
417
while parent_id != ROOT_ID:
418
if not self.new_inv.has_id(parent_id):
419
ie = self._select_entry(self.work_inv[parent_id])
420
mutter('%s selected for commit because of %s',
421
self.new_inv.id2path(parent_id), path)
423
ie = self.new_inv[parent_id]
424
if ie.revision is not None:
426
mutter('%s selected for commit because of %s',
427
self.new_inv.id2path(parent_id), path)
428
parent_id = ie.parent_id
429
mutter('%s selected for commit', path)
430
self._select_entry(new_ie)
432
def _select_entry(self, new_ie):
433
"""Make new_ie be considered for committing."""
439
def _carry_entry(self, file_id):
440
"""Carry the file unchanged from the basis revision."""
441
if self.basis_inv.has_id(file_id):
442
self.new_inv.add(self.basis_inv[file_id].copy())
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)
444
561
def _report_deletes(self):
445
for file_id in self.basis_inv:
446
if file_id not in self.new_inv:
447
self.reporter.deleted(self.basis_inv.id2path(file_id))
449
def _gen_revision_id(config, when):
450
"""Return new revision-id."""
451
s = '%s-%s-' % (config.user_email(), compact_date(when))
452
s += hexlify(rand_bytes(8))
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)
added
removed
bzrlib/commit.py
