72
72
from binascii import hexlify
73
73
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
75
76
from bzrlib.osutils import (local_time_offset,
76
77
rand_bytes, compact_date,
77
78
kind_marker, is_inside_any, quotefn,
78
sha_string, sha_strings, sha_file, isdir, isfile,
79
sha_file, isdir, isfile,
80
from bzrlib.branch import gen_file_id
81
81
import bzrlib.config
82
import bzrlib.errors as errors
82
83
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
88
88
from bzrlib.revision import Revision
89
89
from bzrlib.testament import Testament
90
90
from bzrlib.trace import mutter, note, warning
91
91
from bzrlib.xml5 import serializer_v5
92
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
93
from bzrlib.symbol_versioning import *
94
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
98
98
def commit(*args, **kwargs):
99
99
"""Commit a new revision to a branch.
196
209
contains unknown files.
198
211
revprops -- Properties for new revision
212
:param local: Perform a local only commit.
200
214
mutter('preparing to commit')
203
self.weave_store = branch.weave_store
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().")
225
self.work_tree = working_tree
226
self.branch = self.work_tree.branch
228
raise BzrError("The message keyword parameter is required for commit().")
230
self.weave_store = self.branch.repository.weave_store
231
self.bound_branch = None
233
self.master_branch = None
234
self.master_locked = False
204
235
self.rev_id = rev_id
205
236
self.specific_files = specific_files
206
237
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()
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
247
self.work_tree.lock_write()
242
self.work_tree = self.branch.working_tree()
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)
290
self.message = message
291
self._escape_commit_message()
243
293
self.work_inv = self.work_tree.inventory
244
self.basis_tree = self.branch.basis_tree()
294
self.basis_tree = self.work_tree.basis_tree()
245
295
self.basis_inv = self.basis_tree.inventory
247
297
self._gather_parents()
248
298
if len(self.parents) > 1 and self.specific_files:
249
raise NotImplementedError('selected-file commit of merges is not supported yet')
299
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
250
301
self._check_parents_present()
252
303
self._remove_deleted()
259
310
or self.new_inv != self.basis_inv):
260
311
raise PointlessCommit()
262
if len(list(self.work_tree.iter_conflicts()))>0:
313
if len(self.work_tree.conflicts())>0:
263
314
raise ConflictsInTree
265
self._record_inventory()
316
self.inv_sha1 = self.branch.repository.add_inventory(
266
321
self._make_revision()
267
self.reporter.completed(self.branch.revno()+1, self.rev_id)
322
# revision data is in the local branch now.
324
# upload revision data to the master.
325
# this will propogate merged revisions too if needed.
326
if self.bound_branch:
327
self.master_branch.repository.fetch(self.branch.repository,
328
revision_id=self.rev_id)
329
# now the master has the revision data
330
# 'commit' to the master first so a timeout here causes the local
331
# branch to be out of date
332
self.master_branch.append_revision(self.rev_id)
334
# and now do the commit locally.
268
335
self.branch.append_revision(self.rev_id)
269
self.branch.set_pending_merges([])
337
self.work_tree.set_pending_merges([])
338
self.work_tree.set_last_revision(self.rev_id)
339
# now the work tree is up to date with the branch
341
self.reporter.completed(self.branch.revno(), self.rev_id)
342
if self.config.post_commit() is not None:
343
hooks = self.config.post_commit().split(' ')
344
# this would be nicer with twisted.python.reflect.namedAny
346
result = eval(hook + '(branch, rev_id)',
347
{'branch':self.branch,
349
'rev_id':self.rev_id})
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())
351
self._cleanup_bound_branch()
352
self.work_tree.unlock()
354
def _check_bound_branch(self):
355
"""Check to see if the local branch is bound.
357
If it is bound, then most of the commit will actually be
358
done using the remote branch as the target branch.
359
Only at the end will the local branch be updated.
361
if self.local and not self.branch.get_bound_location():
362
raise errors.LocalRequiresBoundBranch()
365
self.master_branch = self.branch.get_master_branch()
367
if not self.master_branch:
368
# make this branch the reference branch for out of date checks.
369
self.master_branch = self.branch
372
# If the master branch is bound, we must fail
373
master_bound_location = self.master_branch.get_bound_location()
374
if master_bound_location:
375
raise errors.CommitToDoubleBoundBranch(self.branch,
376
self.master_branch, master_bound_location)
378
# TODO: jam 20051230 We could automatically push local
379
# commits to the remote branch if they would fit.
380
# But for now, just require remote to be identical
383
# Make sure the local branch is identical to the master
384
master_rh = self.master_branch.revision_history()
385
local_rh = self.branch.revision_history()
386
if local_rh != master_rh:
387
raise errors.BoundBranchOutOfDate(self.branch,
390
# Now things are ready to change the master branch
392
self.bound_branch = self.branch
393
self.master_branch.lock_write()
394
self.master_locked = True
396
#### # Check to see if we have any pending merges. If we do
397
#### # those need to be pushed into the master branch
398
#### pending_merges = self.work_tree.pending_merges()
399
#### if pending_merges:
400
#### for revision_id in pending_merges:
401
#### self.master_branch.repository.fetch(self.bound_branch.repository,
402
#### revision_id=revision_id)
404
def _cleanup_bound_branch(self):
405
"""Executed at the end of a try/finally to cleanup a bound branch.
407
If the branch wasn't bound, this is a no-op.
408
If it was, it resents self.branch to the local branch, instead
411
if not self.bound_branch:
413
if self.master_locked:
414
self.master_branch.unlock()
282
416
def _escape_commit_message(self):
283
417
"""Replace xml-incompatible control characters."""
418
# FIXME: RBC 20060419 this should be done by the revision
419
# serialiser not by commit. Then we can also add an unescaper
420
# in the deserializer and start roundtripping revision messages
421
# precisely. See repository_implementations/test_repository.py
284
423
# Python strings can include characters that can't be
285
424
# represented in well-formed XML; escape characters that
286
425
# aren't listed in the XML specification
287
426
# (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
427
self.message, escape_count = re.subn(
428
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
296
429
lambda match: match.group(0).encode('unicode_escape'),
309
442
self.parents.append(precursor_id)
310
443
self.parents += pending_merges
311
444
for revision in self.parents:
312
if self.branch.has_revision(revision):
313
self.parent_invs.append(self.branch.get_inventory(revision))
445
if self.branch.repository.has_revision(revision):
446
inventory = self.branch.repository.get_inventory(revision)
447
self.parent_invs.append(inventory)
314
448
self.present_parents.append(revision)
316
450
def _check_parents_present(self):
317
451
for parent_id in self.parents:
318
452
mutter('commit parent revision {%s}', parent_id)
319
if not self.branch.has_revision(parent_id):
453
if not self.branch.repository.has_revision(parent_id):
320
454
if parent_id == self.branch.last_revision():
321
455
warning("parent is missing %r", parent_id)
322
456
raise HistoryMissing(self.branch, 'revision', parent_id)
326
460
def _make_revision(self):
327
461
"""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)
462
rev = Revision(timestamp=self.timestamp,
463
timezone=self.timezone,
464
committer=self.committer,
465
message=self.message,
466
inventory_sha1=self.inv_sha1,
467
revision_id=self.rev_id,
468
properties=self.revprops)
469
rev.parent_ids = self.parents
470
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
346
472
def _remove_deleted(self):
347
473
"""Remove deleted files from the working inventories.
added
removed
bzrlib/commit.py
