72
from binascii import hexlify
72
73
from cStringIO import StringIO
74
from bzrlib.atomicfile import AtomicFile
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
75
81
import bzrlib.config
76
import bzrlib.errors as errors
77
82
from bzrlib.errors import (BzrError, PointlessCommit,
82
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
83
is_inside_or_parent_of_any,
84
quotefn, sha_file, split_lines)
87
import bzrlib.gpg as gpg
88
from bzrlib.revision import Revision
85
89
from bzrlib.testament import Testament
86
90
from bzrlib.trace import mutter, note, warning
87
91
from bzrlib.xml5 import serializer_v5
88
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
89
from bzrlib.symbol_versioning import *
90
from bzrlib.workingtree import WorkingTree
93
@deprecated_function(zero_seven)
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
94
98
def commit(*args, **kwargs):
95
99
"""Commit a new revision to a branch.
120
124
def missing(self, path):
123
def renamed(self, change, old_path, new_path):
127
127
class ReportCommitToLog(NullCommitReporter):
129
# this may be more useful if 'note' was replaced by an overridable
130
# method on self, which would allow more trivial subclassing.
131
# alternative, a callable could be passed in, allowing really trivial
132
# reuse for some uis. RBC 20060511
134
129
def snapshot_change(self, change, path):
135
if change == 'unchanged':
137
130
note("%s %s", change, path)
139
132
def completed(self, revno, rev_id):
140
note('Committed revision %d.', revno)
133
note('committed r%d {%s}', revno, rev_id)
142
135
def deleted(self, file_id):
143
136
note('deleted %s', file_id)
216
196
contains unknown files.
218
198
revprops -- Properties for new revision
219
:param local: Perform a local only commit.
221
200
mutter('preparing to commit')
223
if deprecated_passed(branch):
224
warn("Commit.commit (branch, ...): The branch parameter is "
225
"deprecated as of bzr 0.8. Please use working_tree= instead.",
226
DeprecationWarning, stacklevel=2)
228
self.work_tree = self.branch.bzrdir.open_workingtree()
229
elif working_tree is None:
230
raise BzrError("One of branch and working_tree must be passed into commit().")
232
self.work_tree = working_tree
233
self.branch = self.work_tree.branch
235
raise BzrError("The message keyword parameter is required for commit().")
237
self.bound_branch = None
239
self.master_branch = None
240
self.master_locked = False
203
self.weave_store = branch.weave_store
242
205
self.specific_files = specific_files
243
206
self.allow_pointless = allow_pointless
245
if reporter is None and self.reporter is None:
246
self.reporter = NullCommitReporter()
247
elif reporter is not None:
248
self.reporter = reporter
250
self.work_tree.lock_write()
251
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
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()
253
# Cannot commit with conflicts present.
254
if len(self.work_tree.conflicts())>0:
255
raise ConflictsInTree
257
# setup the bound branch variables as needed.
258
self._check_bound_branch()
260
# check for out of date working trees
261
# if we are bound, then self.branch is the master branch and this
262
# test is thus all we need.
263
if self.work_tree.last_revision() != self.master_branch.last_revision():
264
raise errors.OutOfDateTree(self.work_tree)
267
# raise an exception as soon as we find a single unknown.
268
for unknown in self.work_tree.unknowns():
269
raise StrictCommitFailed()
271
if self.config is None:
272
self.config = bzrlib.config.BranchConfig(self.branch)
274
if isinstance(message, str):
275
message = message.decode(bzrlib.user_encoding)
276
assert isinstance(message, unicode), type(message)
277
self.message = message
278
self._escape_commit_message()
242
self.work_tree = self.branch.working_tree()
280
243
self.work_inv = self.work_tree.inventory
281
self.basis_tree = self.work_tree.basis_tree()
244
self.basis_tree = self.branch.basis_tree()
282
245
self.basis_inv = self.basis_tree.inventory
283
# one to finish, one for rev and inventory, and one for each
284
# inventory entry, and the same for the new inventory.
285
# note that this estimate is too long when we do a partial tree
286
# commit which excludes some new files from being considered.
287
# The estimate is corrected when we populate the new inv.
288
self.pb_total = len(self.work_inv) + 5
291
247
self._gather_parents()
292
248
if len(self.parents) > 1 and self.specific_files:
293
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
249
raise NotImplementedError('selected-file commit of merges is not supported yet')
295
250
self._check_parents_present()
296
self.builder = self.branch.get_commit_builder(self.parents,
297
self.config, timestamp, timezone, committer, revprops, rev_id)
299
252
self._remove_deleted()
300
253
self._populate_new_inv()
254
self._store_snapshot()
301
255
self._report_deletes()
303
257
if not (self.allow_pointless
304
258
or len(self.parents) > 1
305
or self.builder.new_inventory != self.basis_inv):
259
or self.new_inv != self.basis_inv):
306
260
raise PointlessCommit()
308
self._emit_progress_update()
309
# TODO: Now the new inventory is known, check for conflicts and prompt the
310
# user for a commit message.
311
self.builder.finish_inventory()
312
self._emit_progress_update()
313
self.rev_id = self.builder.commit(self.message)
314
self._emit_progress_update()
315
# revision data is in the local branch now.
317
# upload revision data to the master.
318
# this will propagate merged revisions too if needed.
319
if self.bound_branch:
320
self.master_branch.repository.fetch(self.branch.repository,
321
revision_id=self.rev_id)
322
# now the master has the revision data
323
# 'commit' to the master first so a timeout here causes the local
324
# branch to be out of date
325
self.master_branch.append_revision(self.rev_id)
262
if len(list(self.work_tree.iter_conflicts()))>0:
263
raise ConflictsInTree
327
# and now do the commit locally.
265
self._record_inventory()
266
self._make_revision()
328
267
self.branch.append_revision(self.rev_id)
330
self.work_tree.set_pending_merges([])
331
self.work_tree.set_last_revision(self.rev_id)
332
# now the work tree is up to date with the branch
334
self.reporter.completed(self.branch.revno(), self.rev_id)
268
self.branch.set_pending_merges([])
269
self.reporter.completed(self.branch.revno()+1, self.rev_id)
335
270
if self.config.post_commit() is not None:
336
271
hooks = self.config.post_commit().split(' ')
337
272
# this would be nicer with twisted.python.reflect.namedAny
340
275
{'branch':self.branch,
342
277
'rev_id':self.rev_id})
343
self._emit_progress_update()
347
def _check_bound_branch(self):
348
"""Check to see if the local branch is bound.
350
If it is bound, then most of the commit will actually be
351
done using the remote branch as the target branch.
352
Only at the end will the local branch be updated.
354
if self.local and not self.branch.get_bound_location():
355
raise errors.LocalRequiresBoundBranch()
358
self.master_branch = self.branch.get_master_branch()
360
if not self.master_branch:
361
# make this branch the reference branch for out of date checks.
362
self.master_branch = self.branch
365
# If the master branch is bound, we must fail
366
master_bound_location = self.master_branch.get_bound_location()
367
if master_bound_location:
368
raise errors.CommitToDoubleBoundBranch(self.branch,
369
self.master_branch, master_bound_location)
371
# TODO: jam 20051230 We could automatically push local
372
# commits to the remote branch if they would fit.
373
# But for now, just require remote to be identical
376
# Make sure the local branch is identical to the master
377
master_rh = self.master_branch.revision_history()
378
local_rh = self.branch.revision_history()
379
if local_rh != master_rh:
380
raise errors.BoundBranchOutOfDate(self.branch,
383
# Now things are ready to change the master branch
385
self.bound_branch = self.branch
386
self.master_branch.lock_write()
387
self.master_locked = True
389
#### # Check to see if we have any pending merges. If we do
390
#### # those need to be pushed into the master branch
391
#### pending_merges = self.work_tree.pending_merges()
392
#### if pending_merges:
393
#### for revision_id in pending_merges:
394
#### self.master_branch.repository.fetch(self.bound_branch.repository,
395
#### revision_id=revision_id)
398
"""Cleanup any open locks, progress bars etc."""
399
cleanups = [self._cleanup_bound_branch,
400
self.work_tree.unlock,
402
found_exception = None
403
for cleanup in cleanups:
406
# we want every cleanup to run no matter what.
407
# so we have a catchall here, but we will raise the
408
# last encountered exception up the stack: and
409
# typically this will be useful enough.
412
if found_exception is not None:
413
# don't do a plan raise, because the last exception may have been
414
# trashed, e is our sure-to-work exception even though it loses the
415
# full traceback. XXX: RBC 20060421 perhaps we could check the
416
# exc_info and if its the same one do a plain raise otherwise
417
# 'raise e' as we do now.
420
def _cleanup_bound_branch(self):
421
"""Executed at the end of a try/finally to cleanup a bound branch.
423
If the branch wasn't bound, this is a no-op.
424
If it was, it resents self.branch to the local branch, instead
427
if not self.bound_branch:
429
if self.master_locked:
430
self.master_branch.unlock()
281
def _record_inventory(self):
282
"""Store the inventory for the new revision."""
283
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
284
self.inv_sha1 = sha_string(inv_text)
285
s = self.branch.control_weaves
286
s.add_text('inventory', self.rev_id,
287
split_lines(inv_text), self.present_parents,
288
self.branch.get_transaction())
432
290
def _escape_commit_message(self):
433
291
"""Replace xml-incompatible control characters."""
434
# FIXME: RBC 20060419 this should be done by the revision
435
# serialiser not by commit. Then we can also add an unescaper
436
# in the deserializer and start roundtripping revision messages
437
# precisely. See repository_implementations/test_repository.py
439
292
# Python strings can include characters that can't be
440
293
# represented in well-formed XML; escape characters that
441
294
# aren't listed in the XML specification
442
295
# (http://www.w3.org/TR/REC-xml/#NT-Char).
296
if isinstance(self.message, unicode):
297
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
299
# Use a regular 'str' as pattern to avoid having re.subn
300
# return 'unicode' results.
301
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
443
302
self.message, escape_count = re.subn(
444
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
445
304
lambda match: match.group(0).encode('unicode_escape'),
450
309
def _gather_parents(self):
451
310
"""Record the parents of a merge for merge detection."""
452
# TODO: Make sure that this list doesn't contain duplicate
453
# entries and the order is preserved when doing this.
454
pending_merges = self.work_tree.pending_merges()
311
pending_merges = self.branch.pending_merges()
455
312
self.parents = []
456
313
self.parent_invs = []
314
self.present_parents = []
457
315
precursor_id = self.branch.last_revision()
459
317
self.parents.append(precursor_id)
460
318
self.parents += pending_merges
461
319
for revision in self.parents:
462
if self.branch.repository.has_revision(revision):
463
inventory = self.branch.repository.get_inventory(revision)
464
self.parent_invs.append(inventory)
320
if self.branch.has_revision(revision):
321
self.parent_invs.append(self.branch.get_inventory(revision))
322
self.present_parents.append(revision)
466
324
def _check_parents_present(self):
467
325
for parent_id in self.parents:
468
326
mutter('commit parent revision {%s}', parent_id)
469
if not self.branch.repository.has_revision(parent_id):
327
if not self.branch.has_revision(parent_id):
470
328
if parent_id == self.branch.last_revision():
471
329
warning("parent is missing %r", parent_id)
472
330
raise HistoryMissing(self.branch, 'revision', parent_id)
474
332
mutter("commit will ghost revision %r", parent_id)
334
def _make_revision(self):
335
"""Record a new revision object for this commit."""
336
self.rev = Revision(timestamp=self.timestamp,
337
timezone=self.timezone,
338
committer=self.committer,
339
message=self.message,
340
inventory_sha1=self.inv_sha1,
341
revision_id=self.rev_id,
342
properties=self.revprops)
343
self.rev.parent_ids = self.parents
345
serializer_v5.write_revision(self.rev, rev_tmp)
347
if self.config.signature_needed():
348
plaintext = Testament(self.rev, self.new_inv).as_short_text()
349
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
350
plaintext, self.rev_id)
351
self.branch.revision_store.add(rev_tmp, self.rev_id)
352
mutter('new revision_id is {%s}', self.rev_id)
476
354
def _remove_deleted(self):
477
355
"""Remove deleted files from the working inventories.
496
374
deleted_ids.sort(reverse=True)
497
375
for path, file_id in deleted_ids:
498
376
del self.work_inv[file_id]
499
self.work_tree._write_inventory(self.work_inv)
377
self.branch._write_inventory(self.work_inv)
379
def _store_snapshot(self):
380
"""Pass over inventory and record a snapshot.
382
Entries get a new revision when they are modified in
383
any way, which includes a merge with a new set of
384
parents that have the same entry.
386
# XXX: Need to think more here about when the user has
387
# made a specific decision on a particular value -- c.f.
389
for path, ie in self.new_inv.iter_entries():
390
previous_entries = ie.find_previous_heads(
392
self.weave_store.get_weave_or_empty(ie.file_id,
393
self.branch.get_transaction()))
394
if ie.revision is None:
395
change = ie.snapshot(self.rev_id, path, previous_entries,
396
self.work_tree, self.weave_store,
397
self.branch.get_transaction())
400
self.reporter.snapshot_change(change, path)
501
402
def _populate_new_inv(self):
502
403
"""Build revision inventory.
509
410
revision set to their prior value.
511
412
mutter("Selecting files for commit with filter %s", self.specific_files)
512
# iter_entries does not visit the ROOT_ID node so we need to call
513
# self._emit_progress_update once by hand.
514
self._emit_progress_update()
413
self.new_inv = Inventory()
515
414
for path, new_ie in self.work_inv.iter_entries():
516
self._emit_progress_update()
517
415
file_id = new_ie.file_id
518
mutter('check %s {%s}', path, file_id)
519
if (not self.specific_files or
520
is_inside_or_parent_of_any(self.specific_files, path)):
521
mutter('%s selected for commit', path)
525
mutter('%s not selected for commit', path)
526
if self.basis_inv.has_id(file_id):
527
ie = self.basis_inv[file_id].copy()
529
# this entry is new and not being committed
416
mutter('check %s {%s}', path, new_ie.file_id)
417
if self.specific_files:
418
if not is_inside_any(self.specific_files, path):
419
mutter('%s not selected for commit', path)
420
self._carry_entry(file_id)
532
self.builder.record_entry_contents(ie, self.parent_invs,
533
path, self.work_tree)
534
# describe the nature of the change that has occurred relative to
535
# the basis inventory.
536
if (self.basis_inv.has_id(ie.file_id)):
537
basis_ie = self.basis_inv[ie.file_id]
540
change = ie.describe_change(basis_ie, ie)
541
if change in (InventoryEntry.RENAMED,
542
InventoryEntry.MODIFIED_AND_RENAMED):
543
old_path = self.basis_inv.id2path(ie.file_id)
544
self.reporter.renamed(change, old_path, path)
546
self.reporter.snapshot_change(change, path)
548
def _emit_progress_update(self):
549
"""Emit an update to the progress bar."""
550
self.pb.update("Committing", self.pb_count, self.pb_total)
423
# this is selected, ensure its parents are too.
424
parent_id = new_ie.parent_id
425
while parent_id != ROOT_ID:
426
if not self.new_inv.has_id(parent_id):
427
ie = self._select_entry(self.work_inv[parent_id])
428
mutter('%s selected for commit because of %s',
429
self.new_inv.id2path(parent_id), path)
431
ie = self.new_inv[parent_id]
432
if ie.revision is not None:
434
mutter('%s selected for commit because of %s',
435
self.new_inv.id2path(parent_id), path)
436
parent_id = ie.parent_id
437
mutter('%s selected for commit', path)
438
self._select_entry(new_ie)
440
def _select_entry(self, new_ie):
441
"""Make new_ie be considered for committing."""
447
def _carry_entry(self, file_id):
448
"""Carry the file unchanged from the basis revision."""
449
if self.basis_inv.has_id(file_id):
450
self.new_inv.add(self.basis_inv[file_id].copy())
553
452
def _report_deletes(self):
554
for path, ie in self.basis_inv.iter_entries():
555
if ie.file_id not in self.builder.new_inventory:
556
self.reporter.deleted(path)
453
for file_id in self.basis_inv:
454
if file_id not in self.new_inv:
455
self.reporter.deleted(self.basis_inv.id2path(file_id))
457
def _gen_revision_id(config, when):
458
"""Return new revision-id."""
459
s = '%s-%s-' % (config.user_email(), compact_date(when))
460
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
