72
66
from binascii import hexlify
73
67
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
69
from bzrlib.osutils import (local_time_offset,
77
70
rand_bytes, compact_date,
78
71
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
72
sha_string, sha_strings, sha_file, isdir, isfile,
74
from bzrlib.branch import gen_file_id
81
75
import bzrlib.config
82
import bzrlib.errors as errors
83
76
from bzrlib.errors import (BzrError, PointlessCommit,
88
80
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
81
from bzrlib.trace import mutter, note, warning
91
82
from bzrlib.xml5 import serializer_v5
92
83
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.symbol_versioning import *
94
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
84
from bzrlib.weave import Weave
85
from bzrlib.weavefile import read_weave, write_weave_v5
86
from bzrlib.atomicfile import AtomicFile
98
89
def commit(*args, **kwargs):
99
90
"""Commit a new revision to a branch.
205
178
allow_pointless -- If true (default), commit even if nothing
206
179
has changed and no merges are recorded.
208
strict -- If true, don't allow a commit if the working tree
209
contains unknown files.
211
181
revprops -- Properties for new revision
212
:param local: Perform a local only commit.
214
183
mutter('preparing to commit')
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
186
self.weave_store = branch.weave_store
235
187
self.rev_id = rev_id
236
188
self.specific_files = specific_files
237
189
self.allow_pointless = allow_pointless
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()
190
self.revprops = revprops
192
if timestamp is None:
193
self.timestamp = time.time()
195
self.timestamp = long(timestamp)
198
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
202
if committer is None:
203
self.committer = bzrlib.config.username(self.branch)
205
assert isinstance(committer, basestring), type(committer)
206
self.committer = committer
209
self.timezone = local_time_offset()
211
self.timezone = int(timezone)
213
assert isinstance(message, basestring), type(message)
214
self.message = message
215
self._escape_commit_message()
217
self.branch.lock_write()
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()
219
self.work_tree = self.branch.working_tree()
293
220
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
221
self.basis_tree = self.branch.basis_tree()
295
222
self.basis_inv = self.basis_tree.inventory
297
224
self._gather_parents()
309
236
or self.new_inv != self.basis_inv):
310
237
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
239
if len(list(self.work_tree.iter_conflicts()))>0:
313
240
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
242
self._record_inventory()
320
243
self._make_revision()
321
# revision data is in the local branch now.
323
# upload revision data to the master.
324
# this will propogate merged revisions too if needed.
325
if self.bound_branch:
326
self.master_branch.repository.fetch(self.branch.repository,
327
revision_id=self.rev_id)
328
# now the master has the revision data
329
# 'commit' to the master first so a timeout here causes the local
330
# branch to be out of date
331
self.master_branch.append_revision(self.rev_id)
333
# and now do the commit locally.
244
self.reporter.completed(self.branch.revno()+1, self.rev_id)
334
245
self.branch.append_revision(self.rev_id)
336
self.work_tree.set_pending_merges([])
337
self.work_tree.set_last_revision(self.rev_id)
338
# now the work tree is up to date with the branch
340
self.reporter.completed(self.branch.revno(), self.rev_id)
341
if self.config.post_commit() is not None:
342
hooks = self.config.post_commit().split(' ')
343
# this would be nicer with twisted.python.reflect.namedAny
345
result = eval(hook + '(branch, rev_id)',
346
{'branch':self.branch,
348
'rev_id':self.rev_id})
246
self.branch.set_pending_merges([])
350
self._cleanup_bound_branch()
351
self.work_tree.unlock()
353
def _check_bound_branch(self):
354
"""Check to see if the local branch is bound.
356
If it is bound, then most of the commit will actually be
357
done using the remote branch as the target branch.
358
Only at the end will the local branch be updated.
360
if self.local and not self.branch.get_bound_location():
361
raise errors.LocalRequiresBoundBranch()
364
self.master_branch = self.branch.get_master_branch()
366
if not self.master_branch:
367
# make this branch the reference branch for out of date checks.
368
self.master_branch = self.branch
371
# If the master branch is bound, we must fail
372
master_bound_location = self.master_branch.get_bound_location()
373
if master_bound_location:
374
raise errors.CommitToDoubleBoundBranch(self.branch,
375
self.master_branch, master_bound_location)
377
# TODO: jam 20051230 We could automatically push local
378
# commits to the remote branch if they would fit.
379
# But for now, just require remote to be identical
382
# Make sure the local branch is identical to the master
383
master_rh = self.master_branch.revision_history()
384
local_rh = self.branch.revision_history()
385
if local_rh != master_rh:
386
raise errors.BoundBranchOutOfDate(self.branch,
389
# Now things are ready to change the master branch
391
self.bound_branch = self.branch
392
self.master_branch.lock_write()
393
self.master_locked = True
395
#### # Check to see if we have any pending merges. If we do
396
#### # those need to be pushed into the master branch
397
#### pending_merges = self.work_tree.pending_merges()
398
#### if pending_merges:
399
#### for revision_id in pending_merges:
400
#### self.master_branch.repository.fetch(self.bound_branch.repository,
401
#### revision_id=revision_id)
403
def _cleanup_bound_branch(self):
404
"""Executed at the end of a try/finally to cleanup a bound branch.
406
If the branch wasn't bound, this is a no-op.
407
If it was, it resents self.branch to the local branch, instead
410
if not self.bound_branch:
412
if self.master_locked:
413
self.master_branch.unlock()
250
def _record_inventory(self):
251
"""Store the inventory for the new revision."""
252
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
253
self.inv_sha1 = sha_string(inv_text)
254
s = self.branch.control_weaves
255
s.add_text('inventory', self.rev_id,
256
split_lines(inv_text), self.present_parents,
257
self.branch.get_transaction())
415
259
def _escape_commit_message(self):
416
260
"""Replace xml-incompatible control characters."""
417
# FIXME: RBC 20060419 this should be done by the revision
418
# serialiser not by commit. Then we can also add an unescaper
419
# in the deserializer and start roundtripping revision messages
420
# precisely. See repository_implementations/test_repository.py
422
261
# Python strings can include characters that can't be
423
262
# represented in well-formed XML; escape characters that
424
263
# aren't listed in the XML specification
425
264
# (http://www.w3.org/TR/REC-xml/#NT-Char).
265
if isinstance(self.message, unicode):
266
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
268
# Use a regular 'str' as pattern to avoid having re.subn
269
# return 'unicode' results.
270
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
426
271
self.message, escape_count = re.subn(
427
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
428
273
lambda match: match.group(0).encode('unicode_escape'),
441
286
self.parents.append(precursor_id)
442
287
self.parents += pending_merges
443
288
for revision in self.parents:
444
if self.branch.repository.has_revision(revision):
445
inventory = self.branch.repository.get_inventory(revision)
446
self.parent_invs.append(inventory)
289
if self.branch.has_revision(revision):
290
self.parent_invs.append(self.branch.get_inventory(revision))
447
291
self.present_parents.append(revision)
449
293
def _check_parents_present(self):
450
294
for parent_id in self.parents:
451
295
mutter('commit parent revision {%s}', parent_id)
452
if not self.branch.repository.has_revision(parent_id):
296
if not self.branch.has_revision(parent_id):
453
297
if parent_id == self.branch.last_revision():
454
298
warning("parent is missing %r", parent_id)
455
299
raise HistoryMissing(self.branch, 'revision', parent_id)
459
303
def _make_revision(self):
460
304
"""Record a new revision object for this commit."""
461
rev = Revision(timestamp=self.timestamp,
462
timezone=self.timezone,
463
committer=self.committer,
464
message=self.message,
465
inventory_sha1=self.inv_sha1,
466
revision_id=self.rev_id,
467
properties=self.revprops)
468
rev.parent_ids = self.parents
469
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
305
self.rev = Revision(timestamp=self.timestamp,
306
timezone=self.timezone,
307
committer=self.committer,
308
message=self.message,
309
inventory_sha1=self.inv_sha1,
310
revision_id=self.rev_id,
311
properties=self.revprops)
312
self.rev.parent_ids = self.parents
314
serializer_v5.write_revision(self.rev, rev_tmp)
316
self.branch.revision_store.add(rev_tmp, self.rev_id)
317
mutter('new revision_id is {%s}', self.rev_id)
471
319
def _remove_deleted(self):
472
320
"""Remove deleted files from the working inventories.
added
removed
bzrlib/commit.py
