72
70
from binascii import hexlify
73
71
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
73
from bzrlib.osutils import (local_time_offset, username,
74
rand_bytes, compact_date, user_email,
78
75
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
76
sha_string, sha_strings, sha_file, isdir, isfile,
82
import bzrlib.errors as errors
78
from bzrlib.branch import gen_file_id
83
79
from bzrlib.errors import (BzrError, PointlessCommit,
88
82
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
83
from bzrlib.trace import mutter, note, warning
91
84
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)
85
from bzrlib.inventory import Inventory
86
from bzrlib.weave import Weave
87
from bzrlib.weavefile import read_weave, write_weave_v5
88
from bzrlib.atomicfile import AtomicFile
98
91
def commit(*args, **kwargs):
99
92
"""Commit a new revision to a branch.
205
167
allow_pointless -- If true (default), commit even if nothing
206
168
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
170
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
173
self.weave_store = branch.weave_store
235
174
self.rev_id = rev_id
236
175
self.specific_files = specific_files
237
176
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()
178
if timestamp is None:
179
self.timestamp = time.time()
181
self.timestamp = long(timestamp)
184
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
188
if committer is None:
189
self.committer = username(self.branch)
191
assert isinstance(committer, basestring), type(committer)
192
self.committer = committer
195
self.timezone = local_time_offset()
197
self.timezone = int(timezone)
199
assert isinstance(message, basestring), type(message)
200
self.message = message
202
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()
204
self.work_tree = self.branch.working_tree()
293
205
self.work_inv = self.work_tree.inventory
294
self.basis_tree = self.work_tree.basis_tree()
206
self.basis_tree = self.branch.basis_tree()
295
207
self.basis_inv = self.basis_tree.inventory
297
209
self._gather_parents()
300
212
self._check_parents_present()
302
214
self._remove_deleted()
303
self._populate_new_inv()
304
self._store_snapshot()
215
self.new_inv = Inventory()
216
self._store_entries()
305
217
self._report_deletes()
218
self._set_name_versions()
307
220
if not (self.allow_pointless
308
221
or len(self.parents) > 1
309
222
or self.new_inv != self.basis_inv):
310
223
raise PointlessCommit()
312
if len(self.work_tree.conflicts())>0:
313
raise ConflictsInTree
315
self.inv_sha1 = self.branch.repository.add_inventory(
225
self._record_inventory()
226
self._record_ancestry()
320
227
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.
228
note('committed r%d {%s}', (self.branch.revno() + 1),
334
230
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})
231
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()
415
def _escape_commit_message(self):
416
"""Replace xml-incompatible control characters."""
417
# Python strings can include characters that can't be
418
# represented in well-formed XML; escape characters that
419
# aren't listed in the XML specification
420
# (http://www.w3.org/TR/REC-xml/#NT-Char).
421
self.message, escape_count = re.subn(
422
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
423
lambda match: match.group(0).encode('unicode_escape'),
426
self.reporter.escaped(escape_count, self.message)
237
def _record_inventory(self):
238
"""Store the inventory for the new revision."""
239
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
240
self.inv_sha1 = sha_string(inv_text)
241
s = self.branch.control_weaves
242
s.add_text('inventory', self.rev_id,
243
split_lines(inv_text), self.parents)
246
def _record_ancestry(self):
247
"""Append merged revision ancestry to the ancestry file.
249
This should be the merged ancestry of all parents, plus the
251
s = self.branch.control_weaves
252
w = s.get_weave_or_empty('ancestry')
253
lines = self._make_ancestry(w)
254
w.add(self.rev_id, self.parents, lines)
255
s.put_weave('ancestry', w)
258
def _make_ancestry(self, ancestry_weave):
259
"""Return merged ancestry lines.
261
The lines are revision-ids followed by newlines."""
262
parent_ancestries = [ancestry_weave.get(p) for p in self.parents]
263
new_lines = merge_ancestry_lines(self.rev_id, parent_ancestries)
264
mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(new_lines))
428
268
def _gather_parents(self):
429
"""Record the parents of a merge for merge detection."""
430
pending_merges = self.work_tree.pending_merges()
269
pending_merges = self.branch.pending_merges()
431
270
self.parents = []
432
self.parent_invs = []
433
self.present_parents = []
271
self.parent_trees = []
434
272
precursor_id = self.branch.last_revision()
436
274
self.parents.append(precursor_id)
275
self.parent_trees.append(self.basis_tree)
437
276
self.parents += pending_merges
438
for revision in self.parents:
439
if self.branch.repository.has_revision(revision):
440
inventory = self.branch.repository.get_inventory(revision)
441
self.parent_invs.append(inventory)
442
self.present_parents.append(revision)
277
self.parent_trees.extend(map(self.branch.revision_tree, pending_merges))
444
280
def _check_parents_present(self):
445
281
for parent_id in self.parents:
446
282
mutter('commit parent revision {%s}', parent_id)
447
if not self.branch.repository.has_revision(parent_id):
448
if parent_id == self.branch.last_revision():
449
warning("parent is missing %r", parent_id)
450
raise HistoryMissing(self.branch, 'revision', parent_id)
452
mutter("commit will ghost revision %r", parent_id)
283
if not self.branch.has_revision(parent_id):
284
warning("can't commit a merge from an absent parent")
285
raise HistoryMissing(self.branch, 'revision', parent_id)
454
288
def _make_revision(self):
455
289
"""Record a new revision object for this commit."""
456
rev = Revision(timestamp=self.timestamp,
457
timezone=self.timezone,
458
committer=self.committer,
459
message=self.message,
460
inventory_sha1=self.inv_sha1,
461
revision_id=self.rev_id,
462
properties=self.revprops)
463
rev.parent_ids = self.parents
464
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
290
self.rev = Revision(timestamp=self.timestamp,
291
timezone=self.timezone,
292
committer=self.committer,
293
message=self.message,
294
inventory_sha1=self.inv_sha1,
295
revision_id=self.rev_id)
296
self.rev.parent_ids = self.parents
298
serializer_v5.write_revision(self.rev, rev_tmp)
300
self.branch.revision_store.add(rev_tmp, self.rev_id, compressed=False)
301
mutter('new revision_id is {%s}', self.rev_id)
466
304
def _remove_deleted(self):
467
305
"""Remove deleted files from the working inventories.
480
318
if specific and not is_inside_any(specific, path):
482
320
if not self.work_tree.has_filename(path):
483
self.reporter.missing(path)
484
deleted_ids.append((path, ie.file_id))
321
note('missing %s', path)
322
deleted_ids.append(ie.file_id)
486
deleted_ids.sort(reverse=True)
487
for path, file_id in deleted_ids:
324
for file_id in deleted_ids:
488
325
del self.work_inv[file_id]
489
self.work_tree._write_inventory(self.work_inv)
491
def _store_snapshot(self):
492
"""Pass over inventory and record a snapshot.
494
Entries get a new revision when they are modified in
495
any way, which includes a merge with a new set of
496
parents that have the same entry.
326
self.branch._write_inventory(self.work_inv)
329
def _find_file_parents(self, file_id):
330
"""Return the text versions and hashes for all file parents.
332
Returned as a map from text version to inventory entry.
334
This is a set containing the file versions in all parents
335
revisions containing the file. If the file is new, the set
338
for tree in self.parent_trees:
339
if file_id in tree.inventory:
340
ie = tree.inventory[file_id]
341
assert ie.kind == 'file'
342
assert ie.file_id == file_id
343
if ie.text_version in r:
344
assert r[ie.text_version] == ie
346
r[ie.text_version] = ie
350
def _set_name_versions(self):
351
"""Pass over inventory and mark new entry version as needed.
353
Files get a new name version when they are new, have a
354
different parent, or a different name from in the
355
basis inventory, or if the file is in a different place
356
to any of the parents."""
498
357
# XXX: Need to think more here about when the user has
499
358
# made a specific decision on a particular value -- c.f.
501
360
for path, ie in self.new_inv.iter_entries():
502
previous_entries = ie.find_previous_heads(
505
self.branch.repository.get_transaction())
506
if ie.revision is None:
507
change = ie.snapshot(self.rev_id, path, previous_entries,
508
self.work_tree, self.weave_store,
509
self.branch.get_transaction())
363
for parent_tree in self.parent_trees:
364
parent_inv = parent_tree.inventory
365
if file_id not in parent_inv:
367
parent_ie = parent_inv[file_id]
368
if parent_ie.parent_id != ie.parent_id:
371
elif parent_ie.name != ie.name:
374
elif old_version is None:
375
old_version = parent_ie.name_version
376
elif old_version != parent_ie.name_version:
380
pass # so far so good
381
if old_version is None:
382
mutter('new name_version for {%s}', file_id)
383
ie.name_version = self.rev_id
512
self.reporter.snapshot_change(change, path)
514
def _populate_new_inv(self):
515
"""Build revision inventory.
517
This creates a new empty inventory. Depending on
518
which files are selected for commit, and what is present in the
519
current tree, the new inventory is populated. inventory entries
520
which are candidates for modification have their revision set to
521
None; inventory entries that are carried over untouched have their
522
revision set to their prior value.
385
mutter('name_version for {%s} inherited as {%s}',
386
file_id, old_version)
387
ie.name_version = old_version
390
def _store_entries(self):
391
"""Build revision inventory and store modified files.
393
This is called with new_inv a new empty inventory. Depending on
394
which files are selected for commit, and which ones have
395
been modified or merged, new inventory entries are built
396
based on the working and parent inventories.
398
As a side-effect this stores new text versions for committed
399
files with text changes or merges.
401
Each entry can have one of several things happen:
403
carry_file -- carried from the previous version (if not
406
commit_nonfile -- no text to worry about
408
commit_old_text -- same text, may have moved
410
commit_file -- new text version
524
mutter("Selecting files for commit with filter %s", self.specific_files)
525
self.new_inv = Inventory(revision_id=self.rev_id)
526
412
for path, new_ie in self.work_inv.iter_entries():
527
413
file_id = new_ie.file_id
528
414
mutter('check %s {%s}', path, new_ie.file_id)
529
415
if self.specific_files:
530
416
if not is_inside_any(self.specific_files, path):
531
417
mutter('%s not selected for commit', path)
532
self._carry_entry(file_id)
535
# this is selected, ensure its parents are too.
536
parent_id = new_ie.parent_id
537
while parent_id != ROOT_ID:
538
if not self.new_inv.has_id(parent_id):
539
ie = self._select_entry(self.work_inv[parent_id])
540
mutter('%s selected for commit because of %s',
541
self.new_inv.id2path(parent_id), path)
543
ie = self.new_inv[parent_id]
544
if ie.revision is not None:
546
mutter('%s selected for commit because of %s',
547
self.new_inv.id2path(parent_id), path)
548
parent_id = ie.parent_id
549
mutter('%s selected for commit', path)
550
self._select_entry(new_ie)
552
def _select_entry(self, new_ie):
553
"""Make new_ie be considered for committing."""
559
def _carry_entry(self, file_id):
418
self._carry_file(file_id)
420
if new_ie.kind != 'file':
421
self._commit_nonfile(file_id)
424
file_parents = self._find_file_parents(file_id)
425
mutter('parents of %s are %r', path, file_parents)
426
if len(file_parents) == 1:
427
parent_ie = file_parents.values()[0]
428
wc_sha1 = self.work_tree.get_file_sha1(file_id)
429
if parent_ie.text_sha1 == wc_sha1:
430
# text not changed or merged
431
self._commit_old_text(file_id, parent_ie)
433
# file is either new, or a file merge; need to record
435
if len(file_parents) > 1:
436
note('merged %s', path)
437
elif len(file_parents) == 0:
438
note('added %s', path)
440
note('modified %s', path)
441
self._commit_file(new_ie, file_id, file_parents)
444
def _commit_nonfile(self, file_id):
445
self.new_inv.add(self.work_inv[file_id].copy())
448
def _carry_file(self, file_id):
560
449
"""Carry the file unchanged from the basis revision."""
561
450
if self.basis_inv.has_id(file_id):
562
451
self.new_inv.add(self.basis_inv[file_id].copy())
454
def _commit_old_text(self, file_id, parent_ie):
455
"""Keep the same text as last time, but possibly a different name."""
456
ie = self.work_inv[file_id].copy()
457
ie.text_version = parent_ie.text_version
458
ie.text_size = parent_ie.text_size
459
ie.text_sha1 = parent_ie.text_sha1
564
463
def _report_deletes(self):
565
464
for file_id in self.basis_inv:
566
465
if file_id not in self.new_inv:
567
self.reporter.deleted(self.basis_inv.id2path(file_id))
569
def _gen_revision_id(config, when):
466
note('deleted %s', self.basis_inv.id2path(file_id))
469
def _commit_file(self, new_ie, file_id, file_parents):
470
mutter('store new text for {%s} in revision {%s}',
471
file_id, self.rev_id)
472
new_lines = self.work_tree.get_file(file_id).readlines()
473
self._add_text_to_weave(file_id, new_lines, file_parents)
474
new_ie.text_version = self.rev_id
475
new_ie.text_sha1 = sha_strings(new_lines)
476
new_ie.text_size = sum(map(len, new_lines))
477
self.new_inv.add(new_ie)
480
def _add_text_to_weave(self, file_id, new_lines, parents):
481
self.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
484
def _gen_revision_id(branch, when):
570
485
"""Return new revision-id."""
571
s = '%s-%s-' % (config.user_email(), compact_date(when))
486
s = '%s-%s-' % (user_email(branch), compact_date(when))
572
487
s += hexlify(rand_bytes(8))
493
def merge_ancestry_lines(rev_id, ancestries):
494
"""Return merged ancestry lines.
496
rev_id -- id of the new revision
498
ancestries -- a sequence of ancestries for parent revisions,
499
as newline-terminated line lists.
501
if len(ancestries) == 0:
502
return [rev_id + '\n']
503
seen = set(ancestries[0])
504
ancs = ancestries[0][:]
505
for parent_ancestry in ancestries[1:]:
506
for line in parent_ancestry:
507
assert line[-1] == '\n'
added
removed
bzrlib/commit.py
