1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# XXX: Can we do any better about making interrupted commits change
19
# nothing? Perhaps the best approach is to integrate commit of
20
# AtomicFiles with releasing the lock on the Branch.
22
# TODO: Separate 'prepare' phase where we find a list of potentially
23
# committed files. We then can then pause the commit to prompt for a
24
# commit message, knowing the summary will be the same as what's
25
# actually used for the commit. (But perhaps simpler to simply get
26
# the tree status, then use that for a selective commit?)
28
# The newly committed revision is going to have a shape corresponding
29
# to that of the working inventory. Files that are not in the
30
# working tree and that were in the predecessor are reported as
31
# removed --- this can include files that were either removed from the
32
# inventory or deleted in the working tree. If they were only
33
# deleted from disk, they are removed from the working inventory.
35
# We then consider the remaining entries, which will be in the new
36
# version. Directory entries are simply copied across. File entries
37
# must be checked to see if a new version of the file should be
38
# recorded. For each parent revision inventory, we check to see what
39
# version of the file was present. If the file was present in at
40
# least one tree, and if it was the same version in all the trees,
41
# then we can just refer to that version. Otherwise, a new version
42
# representing the merger of the file versions must be added.
44
# TODO: Update hashcache before and after - or does the WorkingTree
47
# TODO: Rather than mashing together the ancestry and storing it back,
48
# perhaps the weave should have single method which does it all in one
49
# go, avoiding a lot of redundant work.
51
# TODO: Perhaps give a warning if one of the revisions marked as
52
# merged is already in the ancestry, and then don't record it as a
55
# TODO: If the file is newly merged but unchanged from the version it
56
# merges from, then it should still be reported as newly added
57
# relative to the basis revision.
59
# TODO: Do checks that the tree can be committed *before* running the
60
# editor; this should include checks for a pointless commit and for
61
# unknown or missing files.
63
# TODO: If commit fails, leave the message in a file somewhere.
72
from binascii import hexlify
73
from cStringIO import StringIO
75
from bzrlib.atomicfile import AtomicFile
76
from bzrlib.osutils import (local_time_offset,
77
rand_bytes, compact_date,
78
kind_marker, is_inside_any, quotefn,
79
sha_file, isdir, isfile,
82
import bzrlib.errors as errors
83
from bzrlib.errors import (BzrError, PointlessCommit,
88
from bzrlib.revision import Revision
89
from bzrlib.testament import Testament
90
from bzrlib.trace import mutter, note, warning
91
from bzrlib.xml5 import serializer_v5
92
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
93
from bzrlib.symbol_versioning import *
94
from bzrlib.workingtree import WorkingTree
97
@deprecated_function(zero_seven)
98
def commit(*args, **kwargs):
99
"""Commit a new revision to a branch.
101
Function-style interface for convenience of old callers.
103
New code should use the Commit class instead.
105
## XXX: Remove this in favor of Branch.commit?
106
Commit().commit(*args, **kwargs)
109
class NullCommitReporter(object):
110
"""I report on progress of a commit."""
112
def snapshot_change(self, change, path):
115
def completed(self, revno, rev_id):
118
def deleted(self, file_id):
121
def escaped(self, escape_count, message):
124
def missing(self, path):
127
def renamed(self, change, old_path, new_path):
131
class ReportCommitToLog(NullCommitReporter):
133
# this may be more useful if 'note' was replaced by an overridable
134
# method on self, which would allow more trivial subclassing.
135
# alternative, a callable could be passed in, allowing really trivial
136
# reuse for some uis. RBC 20060511
138
def snapshot_change(self, change, path):
139
if change == 'unchanged':
141
note("%s %s", change, path)
143
def completed(self, revno, rev_id):
144
note('Committed revision %d.', revno)
146
def deleted(self, file_id):
147
note('deleted %s', file_id)
149
def escaped(self, escape_count, message):
150
note("replaced %d control characters in message", escape_count)
152
def missing(self, path):
153
note('missing %s', path)
155
def renamed(self, change, old_path, new_path):
156
note('%s %s => %s', change, old_path, new_path)
159
class Commit(object):
160
"""Task of committing a new revision.
162
This is a MethodObject: it accumulates state as the commit is
163
prepared, and then it is discarded. It doesn't represent
164
historical revisions, just the act of recording a new one.
167
Modified to hold a list of files that have been deleted from
168
the working directory; these should be removed from the
174
if reporter is not None:
175
self.reporter = reporter
177
self.reporter = NullCommitReporter()
178
if config is not None:
184
branch=DEPRECATED_PARAMETER, message=None,
190
allow_pointless=True,
198
"""Commit working copy as a new revision.
200
branch -- the deprecated branch to commit to. New callers should pass in
203
message -- the commit message, a mandatory parameter
205
timestamp -- if not None, seconds-since-epoch for a
206
postdated/predated commit.
208
specific_files -- If true, commit only those files.
210
rev_id -- If set, use this as the new revision id.
211
Useful for test or import commands that need to tightly
212
control what revisions are assigned. If you duplicate
213
a revision id that exists elsewhere it is your own fault.
214
If null (default), a time/random revision id is generated.
216
allow_pointless -- If true (default), commit even if nothing
217
has changed and no merges are recorded.
219
strict -- If true, don't allow a commit if the working tree
220
contains unknown files.
222
revprops -- Properties for new revision
223
:param local: Perform a local only commit.
225
mutter('preparing to commit')
227
if deprecated_passed(branch):
228
warn("Commit.commit (branch, ...): The branch parameter is "
229
"deprecated as of bzr 0.8. Please use working_tree= instead.",
230
DeprecationWarning, stacklevel=2)
232
self.work_tree = self.branch.bzrdir.open_workingtree()
233
elif working_tree is None:
234
raise BzrError("One of branch and working_tree must be passed into commit().")
236
self.work_tree = working_tree
237
self.branch = self.work_tree.branch
239
raise BzrError("The message keyword parameter is required for commit().")
241
self.weave_store = self.branch.repository.weave_store
242
self.bound_branch = None
244
self.master_branch = None
245
self.master_locked = False
247
self.specific_files = specific_files
248
self.allow_pointless = allow_pointless
250
if revprops is not None:
251
self.revprops.update(revprops)
253
if reporter is None and self.reporter is None:
254
self.reporter = NullCommitReporter()
255
elif reporter is not None:
256
self.reporter = reporter
258
self.work_tree.lock_write()
260
# setup the bound branch variables as needed.
261
self._check_bound_branch()
263
# check for out of date working trees
264
# if we are bound, then self.branch is the master branch and this
265
# test is thus all we need.
266
if self.work_tree.last_revision() != self.master_branch.last_revision():
267
raise errors.OutOfDateTree(self.work_tree)
270
# raise an exception as soon as we find a single unknown.
271
for unknown in self.work_tree.unknowns():
272
raise StrictCommitFailed()
274
if timestamp is None:
275
self.timestamp = time.time()
277
self.timestamp = long(timestamp)
279
if self.config is None:
280
self.config = bzrlib.config.BranchConfig(self.branch)
283
self.rev_id = _gen_revision_id(self.config, self.timestamp)
287
if committer is None:
288
self.committer = self.config.username()
290
assert isinstance(committer, basestring), type(committer)
291
self.committer = committer
294
self.timezone = local_time_offset()
296
self.timezone = int(timezone)
298
if isinstance(message, str):
299
message = message.decode(bzrlib.user_encoding)
300
assert isinstance(message, unicode), type(message)
301
self.message = message
302
self._escape_commit_message()
304
self.work_inv = self.work_tree.inventory
305
self.basis_tree = self.work_tree.basis_tree()
306
self.basis_inv = self.basis_tree.inventory
308
self._gather_parents()
309
if len(self.parents) > 1 and self.specific_files:
310
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
312
self._check_parents_present()
314
self._remove_deleted()
315
self._populate_new_inv()
316
self._store_snapshot()
317
self._report_deletes()
319
if not (self.allow_pointless
320
or len(self.parents) > 1
321
or self.new_inv != self.basis_inv):
322
raise PointlessCommit()
324
if len(self.work_tree.conflicts())>0:
325
raise ConflictsInTree
327
self.inv_sha1 = self.branch.repository.add_inventory(
332
self._make_revision()
333
# revision data is in the local branch now.
335
# upload revision data to the master.
336
# this will propogate merged revisions too if needed.
337
if self.bound_branch:
338
self.master_branch.repository.fetch(self.branch.repository,
339
revision_id=self.rev_id)
340
# now the master has the revision data
341
# 'commit' to the master first so a timeout here causes the local
342
# branch to be out of date
343
self.master_branch.append_revision(self.rev_id)
345
# and now do the commit locally.
346
self.branch.append_revision(self.rev_id)
348
self.work_tree.set_pending_merges([])
349
self.work_tree.set_last_revision(self.rev_id)
350
# now the work tree is up to date with the branch
352
self.reporter.completed(self.branch.revno(), self.rev_id)
353
if self.config.post_commit() is not None:
354
hooks = self.config.post_commit().split(' ')
355
# this would be nicer with twisted.python.reflect.namedAny
357
result = eval(hook + '(branch, rev_id)',
358
{'branch':self.branch,
360
'rev_id':self.rev_id})
362
self._cleanup_bound_branch()
363
self.work_tree.unlock()
365
def _check_bound_branch(self):
366
"""Check to see if the local branch is bound.
368
If it is bound, then most of the commit will actually be
369
done using the remote branch as the target branch.
370
Only at the end will the local branch be updated.
372
if self.local and not self.branch.get_bound_location():
373
raise errors.LocalRequiresBoundBranch()
376
self.master_branch = self.branch.get_master_branch()
378
if not self.master_branch:
379
# make this branch the reference branch for out of date checks.
380
self.master_branch = self.branch
383
# If the master branch is bound, we must fail
384
master_bound_location = self.master_branch.get_bound_location()
385
if master_bound_location:
386
raise errors.CommitToDoubleBoundBranch(self.branch,
387
self.master_branch, master_bound_location)
389
# TODO: jam 20051230 We could automatically push local
390
# commits to the remote branch if they would fit.
391
# But for now, just require remote to be identical
394
# Make sure the local branch is identical to the master
395
master_rh = self.master_branch.revision_history()
396
local_rh = self.branch.revision_history()
397
if local_rh != master_rh:
398
raise errors.BoundBranchOutOfDate(self.branch,
401
# Now things are ready to change the master branch
403
self.bound_branch = self.branch
404
self.master_branch.lock_write()
405
self.master_locked = True
407
#### # Check to see if we have any pending merges. If we do
408
#### # those need to be pushed into the master branch
409
#### pending_merges = self.work_tree.pending_merges()
410
#### if pending_merges:
411
#### for revision_id in pending_merges:
412
#### self.master_branch.repository.fetch(self.bound_branch.repository,
413
#### revision_id=revision_id)
415
def _cleanup_bound_branch(self):
416
"""Executed at the end of a try/finally to cleanup a bound branch.
418
If the branch wasn't bound, this is a no-op.
419
If it was, it resents self.branch to the local branch, instead
422
if not self.bound_branch:
424
if self.master_locked:
425
self.master_branch.unlock()
427
def _escape_commit_message(self):
428
"""Replace xml-incompatible control characters."""
429
# FIXME: RBC 20060419 this should be done by the revision
430
# serialiser not by commit. Then we can also add an unescaper
431
# in the deserializer and start roundtripping revision messages
432
# precisely. See repository_implementations/test_repository.py
434
# Python strings can include characters that can't be
435
# represented in well-formed XML; escape characters that
436
# aren't listed in the XML specification
437
# (http://www.w3.org/TR/REC-xml/#NT-Char).
438
self.message, escape_count = re.subn(
439
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
440
lambda match: match.group(0).encode('unicode_escape'),
443
self.reporter.escaped(escape_count, self.message)
445
def _gather_parents(self):
446
"""Record the parents of a merge for merge detection."""
447
pending_merges = self.work_tree.pending_merges()
449
self.parent_invs = []
450
self.present_parents = []
451
precursor_id = self.branch.last_revision()
453
self.parents.append(precursor_id)
454
self.parents += pending_merges
455
for revision in self.parents:
456
if self.branch.repository.has_revision(revision):
457
inventory = self.branch.repository.get_inventory(revision)
458
self.parent_invs.append(inventory)
459
self.present_parents.append(revision)
461
def _check_parents_present(self):
462
for parent_id in self.parents:
463
mutter('commit parent revision {%s}', parent_id)
464
if not self.branch.repository.has_revision(parent_id):
465
if parent_id == self.branch.last_revision():
466
warning("parent is missing %r", parent_id)
467
raise HistoryMissing(self.branch, 'revision', parent_id)
469
mutter("commit will ghost revision %r", parent_id)
471
def _make_revision(self):
472
"""Record a new revision object for this commit."""
473
rev = Revision(timestamp=self.timestamp,
474
timezone=self.timezone,
475
committer=self.committer,
476
message=self.message,
477
inventory_sha1=self.inv_sha1,
478
revision_id=self.rev_id,
479
properties=self.revprops)
480
rev.parent_ids = self.parents
481
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
483
def _remove_deleted(self):
484
"""Remove deleted files from the working inventories.
486
This is done prior to taking the working inventory as the
487
basis for the new committed inventory.
489
This returns true if any files
490
*that existed in the basis inventory* were deleted.
491
Files that were added and deleted
492
in the working copy don't matter.
494
specific = self.specific_files
496
for path, ie in self.work_inv.iter_entries():
497
if specific and not is_inside_any(specific, path):
499
if not self.work_tree.has_filename(path):
500
self.reporter.missing(path)
501
deleted_ids.append((path, ie.file_id))
503
deleted_ids.sort(reverse=True)
504
for path, file_id in deleted_ids:
505
del self.work_inv[file_id]
506
self.work_tree._write_inventory(self.work_inv)
508
def _store_snapshot(self):
509
"""Pass over inventory and record a snapshot.
511
Entries get a new revision when they are modified in
512
any way, which includes a merge with a new set of
513
parents that have the same entry.
515
# XXX: Need to think more here about when the user has
516
# made a specific decision on a particular value -- c.f.
518
for path, ie in self.new_inv.iter_entries():
519
previous_entries = ie.find_previous_heads(
522
self.branch.repository.get_transaction())
523
if ie.revision is None:
524
# we are creating a new revision for ie in the history store
526
ie.snapshot(self.rev_id, path, previous_entries,
527
self.work_tree, self.weave_store,
528
self.branch.repository.get_transaction())
529
# describe the nature of the change that has occured relative to
530
# the basis inventory.
531
if (self.basis_inv.has_id(ie.file_id)):
532
basis_ie = self.basis_inv[ie.file_id]
535
change = ie.describe_change(basis_ie, ie)
536
if change in (InventoryEntry.RENAMED,
537
InventoryEntry.MODIFIED_AND_RENAMED):
538
old_path = self.basis_inv.id2path(ie.file_id)
539
self.reporter.renamed(change, old_path, path)
541
self.reporter.snapshot_change(change, path)
543
def _populate_new_inv(self):
544
"""Build revision inventory.
546
This creates a new empty inventory. Depending on
547
which files are selected for commit, and what is present in the
548
current tree, the new inventory is populated. inventory entries
549
which are candidates for modification have their revision set to
550
None; inventory entries that are carried over untouched have their
551
revision set to their prior value.
553
mutter("Selecting files for commit with filter %s", self.specific_files)
554
self.new_inv = Inventory(revision_id=self.rev_id)
555
for path, new_ie in self.work_inv.iter_entries():
556
file_id = new_ie.file_id
557
mutter('check %s {%s}', path, new_ie.file_id)
558
if self.specific_files:
559
if not is_inside_any(self.specific_files, path):
560
mutter('%s not selected for commit', path)
561
self._carry_entry(file_id)
564
# this is selected, ensure its parents are too.
565
parent_id = new_ie.parent_id
566
while parent_id != ROOT_ID:
567
if not self.new_inv.has_id(parent_id):
568
ie = self._select_entry(self.work_inv[parent_id])
569
mutter('%s selected for commit because of %s',
570
self.new_inv.id2path(parent_id), path)
572
ie = self.new_inv[parent_id]
573
if ie.revision is not None:
575
mutter('%s selected for commit because of %s',
576
self.new_inv.id2path(parent_id), path)
577
parent_id = ie.parent_id
578
mutter('%s selected for commit', path)
579
self._select_entry(new_ie)
581
def _select_entry(self, new_ie):
582
"""Make new_ie be considered for committing."""
588
def _carry_entry(self, file_id):
589
"""Carry the file unchanged from the basis revision."""
590
if self.basis_inv.has_id(file_id):
591
self.new_inv.add(self.basis_inv[file_id].copy())
593
def _report_deletes(self):
594
for path, ie in self.basis_inv.iter_entries():
595
if ie.file_id not in self.new_inv:
596
self.reporter.deleted(path)
598
def _gen_revision_id(config, when):
599
"""Return new revision-id."""
600
s = '%s-%s-' % (config.user_email(), compact_date(when))
601
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
