72
71
from binascii import hexlify
73
72
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
74
from bzrlib.osutils import (local_time_offset, username,
75
rand_bytes, compact_date, user_email,
78
76
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
77
sha_string, sha_strings, sha_file, isdir, isfile,
82
import bzrlib.errors as errors
79
from bzrlib.branch import gen_file_id
83
80
from bzrlib.errors import (BzrError, PointlessCommit,
88
83
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
84
from bzrlib.trace import mutter, note, warning
91
85
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID
93
from bzrlib.symbol_versioning import *
94
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
86
from bzrlib.inventory import Inventory
87
from bzrlib.weave import Weave
88
from bzrlib.weavefile import read_weave, write_weave_v5
89
from bzrlib.atomicfile import AtomicFile
98
92
def commit(*args, **kwargs):
99
93
"""Commit a new revision to a branch.
205
168
allow_pointless -- If true (default), commit even if nothing
206
169
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
revprops -- Properties for new revision
212
:param local: Perform a local only commit.
214
171
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
174
self.weave_store = branch.weave_store
235
175
self.rev_id = rev_id
236
176
self.specific_files = specific_files
237
177
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()
179
if timestamp is None:
180
self.timestamp = time.time()
182
self.timestamp = long(timestamp)
185
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
189
if committer is None:
190
self.committer = username(self.branch)
192
assert isinstance(committer, basestring), type(committer)
193
self.committer = committer
196
self.timezone = local_time_offset()
198
self.timezone = int(timezone)
200
assert isinstance(message, basestring), type(message)
201
self.message = message
202
self._escape_commit_message()
204
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()
206
self.work_tree = self.branch.working_tree()
293
207
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
208
self.basis_tree = self.branch.basis_tree()
295
209
self.basis_inv = self.basis_tree.inventory
297
211
self._gather_parents()
309
223
or self.new_inv != self.basis_inv):
310
224
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
313
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
226
self._record_inventory()
227
self._record_ancestry()
320
228
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.
229
note('committed r%d {%s}', (self.branch.revno() + 1),
334
231
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})
232
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()
236
def _record_inventory(self):
237
"""Store the inventory for the new revision."""
238
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
239
self.inv_sha1 = sha_string(inv_text)
240
s = self.branch.control_weaves
241
s.add_text('inventory', self.rev_id,
242
split_lines(inv_text), self.present_parents)
415
244
def _escape_commit_message(self):
416
245
"""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
246
# Python strings can include characters that can't be
423
247
# represented in well-formed XML; escape characters that
424
248
# aren't listed in the XML specification
425
249
# (http://www.w3.org/TR/REC-xml/#NT-Char).
250
if isinstance(self.message, unicode):
251
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
253
# Use a regular 'str' as pattern to avoid having re.subn
254
# return 'unicode' results.
255
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
426
256
self.message, escape_count = re.subn(
427
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
428
258
lambda match: match.group(0).encode('unicode_escape'),
431
self.reporter.escaped(escape_count, self.message)
261
note("replaced %d control characters in message", escape_count)
263
def _record_ancestry(self):
264
"""Append merged revision ancestry to the ancestry file.
266
This should be the merged ancestry of all parents, plus the
268
s = self.branch.control_weaves
269
w = s.get_weave_or_empty('ancestry')
270
lines = self._make_ancestry(w)
271
w.add(self.rev_id, self.present_parents, lines)
272
s.put_weave('ancestry', w)
274
def _make_ancestry(self, ancestry_weave):
275
"""Return merged ancestry lines.
277
The lines are revision-ids followed by newlines."""
278
parent_ancestries = [ancestry_weave.get(p) for p in self.present_parents]
279
new_lines = merge_ancestry_lines(self.rev_id, parent_ancestries)
280
mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(new_lines))
433
283
def _gather_parents(self):
434
284
"""Record the parents of a merge for merge detection."""
435
pending_merges = self.work_tree.pending_merges()
285
pending_merges = self.branch.pending_merges()
436
286
self.parents = []
437
self.parent_invs = []
287
self.parent_trees = []
438
288
self.present_parents = []
439
289
precursor_id = self.branch.last_revision()
441
291
self.parents.append(precursor_id)
442
292
self.parents += pending_merges
443
293
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)
294
if self.branch.has_revision(revision):
295
self.parent_trees.append(self.branch.revision_tree(revision))
447
296
self.present_parents.append(revision)
449
298
def _check_parents_present(self):
450
299
for parent_id in self.parents:
451
300
mutter('commit parent revision {%s}', parent_id)
452
if not self.branch.repository.has_revision(parent_id):
301
if not self.branch.has_revision(parent_id):
453
302
if parent_id == self.branch.last_revision():
454
warning("parent is missing %r", parent_id)
303
warning("parent is pissing %r", parent_id)
455
304
raise HistoryMissing(self.branch, 'revision', parent_id)
457
306
mutter("commit will ghost revision %r", parent_id)
459
308
def _make_revision(self):
460
309
"""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)
310
self.rev = Revision(timestamp=self.timestamp,
311
timezone=self.timezone,
312
committer=self.committer,
313
message=self.message,
314
inventory_sha1=self.inv_sha1,
315
revision_id=self.rev_id)
316
self.rev.parent_ids = self.parents
318
serializer_v5.write_revision(self.rev, rev_tmp)
320
self.branch.revision_store.add(rev_tmp, self.rev_id)
321
mutter('new revision_id is {%s}', self.rev_id)
471
324
def _remove_deleted(self):
472
325
"""Remove deleted files from the working inventories.
485
338
if specific and not is_inside_any(specific, path):
487
340
if not self.work_tree.has_filename(path):
488
self.reporter.missing(path)
489
deleted_ids.append((path, ie.file_id))
341
note('missing %s', path)
342
deleted_ids.append(ie.file_id)
491
deleted_ids.sort(reverse=True)
492
for path, file_id in deleted_ids:
493
del self.work_inv[file_id]
494
self.work_tree._write_inventory(self.work_inv)
344
for file_id in deleted_ids:
345
if file_id in self.work_inv:
346
del self.work_inv[file_id]
347
self.branch._write_inventory(self.work_inv)
350
def _find_entry_parents(self, file_id):
351
"""Return the text versions and hashes for all file parents.
353
Returned as a map from text version to inventory entry.
355
This is a set containing the file versions in all parents
356
revisions containing the file. If the file is new, the set
359
for tree in self.parent_trees:
360
if file_id in tree.inventory:
361
ie = tree.inventory[file_id]
362
assert ie.file_id == file_id
364
assert r[ie.revision] == ie
496
369
def _store_snapshot(self):
497
370
"""Pass over inventory and record a snapshot.
499
372
Entries get a new revision when they are modified in
500
373
any way, which includes a merge with a new set of
501
parents that have the same entry.
374
parents that have the same entry. Currently we do not
375
check for that set being ancestors of each other - and
376
we should - only parallel children should count for this
377
test see find_entry_parents to correct this. FIXME <---
378
I.e. if we are merging in revision FOO, and our
379
copy of file id BAR is identical to FOO.BAR, we should
380
generate a new revision of BAR IF and only IF FOO is
381
neither a child of our current tip, nor an ancestor of
382
our tip. The presence of FOO in our store should not
383
affect this logic UNLESS we are doing a merge of FOO,
503
386
# XXX: Need to think more here about when the user has
504
387
# made a specific decision on a particular value -- c.f.
506
389
for path, ie in self.new_inv.iter_entries():
507
previous_entries = ie.find_previous_heads(
510
self.branch.repository.get_transaction())
390
previous_entries = self._find_entry_parents(ie. file_id)
511
391
if ie.revision is None:
512
392
change = ie.snapshot(self.rev_id, path, previous_entries,
513
self.work_tree, self.weave_store,
514
self.branch.get_transaction())
393
self.work_tree, self.weave_store)
516
395
change = "unchanged"
517
self.reporter.snapshot_change(change, path)
396
note("%s %s", change, path)
519
398
def _populate_new_inv(self):
520
399
"""Build revision inventory.
527
406
revision set to their prior value.
529
408
mutter("Selecting files for commit with filter %s", self.specific_files)
530
self.new_inv = Inventory(revision_id=self.rev_id)
409
self.new_inv = Inventory()
531
410
for path, new_ie in self.work_inv.iter_entries():
532
411
file_id = new_ie.file_id
533
412
mutter('check %s {%s}', path, new_ie.file_id)
534
413
if self.specific_files:
535
414
if not is_inside_any(self.specific_files, path):
536
415
mutter('%s not selected for commit', path)
537
self._carry_entry(file_id)
416
self._carry_file(file_id)
540
# this is selected, ensure its parents are too.
541
parent_id = new_ie.parent_id
542
while parent_id != ROOT_ID:
543
if not self.new_inv.has_id(parent_id):
544
ie = self._select_entry(self.work_inv[parent_id])
545
mutter('%s selected for commit because of %s',
546
self.new_inv.id2path(parent_id), path)
548
ie = self.new_inv[parent_id]
549
if ie.revision is not None:
551
mutter('%s selected for commit because of %s',
552
self.new_inv.id2path(parent_id), path)
553
parent_id = ie.parent_id
554
418
mutter('%s selected for commit', path)
555
self._select_entry(new_ie)
557
def _select_entry(self, new_ie):
558
"""Make new_ie be considered for committing."""
564
def _carry_entry(self, file_id):
423
def _carry_file(self, file_id):
565
424
"""Carry the file unchanged from the basis revision."""
566
425
if self.basis_inv.has_id(file_id):
567
426
self.new_inv.add(self.basis_inv[file_id].copy())
added
removed
bzrlib/commit.py
