1
# Copyright (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
# FIXME: "bzr commit doc/format" commits doc/format.txt!
21
def commit(branch, message,
28
allow_pointless=True):
29
"""Commit working copy as a new revision.
31
The basic approach is to add all the file texts into the
32
store, then the inventory, then make a new revision pointing
33
to that inventory and store that.
35
This is not quite safe if the working copy changes during the
36
commit; for the moment that is simply not allowed. A better
37
approach is to make a temporary copy of the files before
38
computing their hashes, and then add those hashes in turn to
39
the inventory. This should mean at least that there are no
40
broken hash pointers. There is no way we can get a snapshot
41
of the whole directory at an instant. This would also have to
42
be robust against files disappearing, moving, etc. So the
43
whole thing is a bit hard.
45
This raises PointlessCommit if there are no changes, no new merges,
46
and allow_pointless is false.
48
timestamp -- if not None, seconds-since-epoch for a
49
postdated/predated commit.
52
If true, commit only those files.
55
If set, use this as the new revision id.
56
Useful for test or import commands that need to tightly
57
control what revisions are assigned. If you duplicate
58
a revision id that exists elsewhere it is your own fault.
59
If null (default), a time/random revision id is generated.
64
from bzrlib.osutils import local_time_offset, username
65
from bzrlib.branch import gen_file_id
66
from bzrlib.errors import BzrError, PointlessCommit
67
from bzrlib.revision import Revision, RevisionReference
68
from bzrlib.trace import mutter, note
69
from bzrlib.xml import pack_xml
74
# First walk over the working inventory; and both update that
75
# and also build a new revision inventory. The revision
76
# inventory needs to hold the text-id, sha1 and size of the
77
# actual file versions committed in the revision. (These are
78
# not present in the working inventory.) We also need to
79
# detect missing/deleted files, and remove them from the
82
work_tree = branch.working_tree()
83
work_inv = work_tree.inventory
84
basis = branch.basis_tree()
85
basis_inv = basis.inventory
88
note('looking for changes...')
90
pending_merges = branch.pending_merges()
92
missing_ids, new_inv, any_changes = \
93
_gather_commit(branch,
100
if not (any_changes or allow_pointless or pending_merges):
101
raise PointlessCommit()
103
for file_id in missing_ids:
104
# Any files that have been deleted are now removed from the
105
# working inventory. Files that were not selected for commit
106
# are left as they were in the working inventory and ommitted
107
# from the revision inventory.
109
# have to do this later so we don't mess up the iterator.
110
# since parents may be removed before their children we
113
# FIXME: There's probably a better way to do this; perhaps
114
# the workingtree should know how to filter itbranch.
115
if work_inv.has_id(file_id):
116
del work_inv[file_id]
120
rev_id = _gen_revision_id(time.time())
123
inv_tmp = tempfile.TemporaryFile()
124
pack_xml(new_inv, inv_tmp)
126
branch.inventory_store.add(inv_tmp, inv_id)
127
mutter('new inventory_id is {%s}' % inv_id)
129
# We could also just sha hash the inv_tmp file
130
# however, in the case that branch.inventory_store.add()
131
# ever actually does anything special
132
inv_sha1 = branch.get_inventory_sha1(inv_id)
134
branch._write_inventory(work_inv)
136
if timestamp == None:
137
timestamp = time.time()
139
if committer == None:
140
committer = username()
143
timezone = local_time_offset()
145
mutter("building commit log message")
146
rev = Revision(timestamp=timestamp,
151
inventory_sha1=inv_sha1,
155
precursor_id = branch.last_patch()
157
precursor_sha1 = branch.get_revision_sha1(precursor_id)
158
rev.parents.append(RevisionReference(precursor_id, precursor_sha1))
159
for merge_rev in pending_merges:
160
rev.parents.append(RevisionReference(merge_rev))
162
rev_tmp = tempfile.TemporaryFile()
163
pack_xml(rev, rev_tmp)
165
branch.revision_store.add(rev_tmp, rev_id)
166
mutter("new revision_id is {%s}" % rev_id)
168
## XXX: Everything up to here can simply be orphaned if we abort
169
## the commit; it will leave junk files behind but that doesn't
172
## TODO: Read back the just-generated changeset, and make sure it
173
## applies and recreates the right state.
175
## TODO: Also calculate and store the inventory SHA1
176
mutter("committing patch r%d" % (branch.revno() + 1))
178
branch.append_revision(rev_id)
180
branch.set_pending_merges([])
183
note("commited r%d" % branch.revno())
189
def _gen_revision_id(when):
190
"""Return new revision-id."""
191
from binascii import hexlify
192
from osutils import rand_bytes, compact_date, user_email
194
s = '%s-%s-' % (user_email(), compact_date(when))
195
s += hexlify(rand_bytes(8))
199
def _gather_commit(branch, work_tree, work_inv, basis_inv, specific_files,
201
"""Build inventory preparatory to commit.
203
Returns missing_ids, new_inv, any_changes.
205
This adds any changed files into the text store, and sets their
206
test-id, sha and size in the returned inventory appropriately.
209
Modified to hold a list of files that have been deleted from
210
the working directory; these should be removed from the
213
from bzrlib.inventory import Inventory
214
from bzrlib.osutils import isdir, isfile, sha_string, quotefn, \
215
local_time_offset, username, kind_marker, is_inside_any
217
from bzrlib.branch import gen_file_id
218
from bzrlib.errors import BzrError
219
from bzrlib.revision import Revision
220
from bzrlib.trace import mutter, note
223
inv = Inventory(work_inv.root.file_id)
226
for path, entry in work_inv.iter_entries():
227
## TODO: Check that the file kind has not changed from the previous
228
## revision of this file (if any).
230
p = branch.abspath(path)
231
file_id = entry.file_id
232
mutter('commit prep file %s, id %r ' % (p, file_id))
234
if specific_files and not is_inside_any(specific_files, path):
235
mutter(' skipping file excluded from commit')
236
if basis_inv.has_id(file_id):
237
# carry over with previous state
238
inv.add(basis_inv[file_id].copy())
240
# omit this from committed inventory
244
if not work_tree.has_id(file_id):
246
print('deleted %s%s' % (path, kind_marker(entry.kind)))
248
mutter(" file is missing, removing from inventory")
249
missing_ids.append(file_id)
252
# this is present in the new inventory; may be new, modified or
254
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
260
old_kind = old_ie.kind
261
if old_kind != entry.kind:
262
raise BzrError("entry %r changed kind from %r to %r"
263
% (file_id, old_kind, entry.kind))
265
if entry.kind == 'directory':
267
raise BzrError("%s is entered as directory but not a directory"
269
elif entry.kind == 'file':
271
raise BzrError("%s is entered as file but is not a file" % quotefn(p))
273
new_sha1 = work_tree.get_file_sha1(file_id)
276
and old_ie.text_sha1 == new_sha1):
277
## assert content == basis.get_file(file_id).read()
278
entry.text_id = old_ie.text_id
279
entry.text_sha1 = new_sha1
280
entry.text_size = old_ie.text_size
281
mutter(' unchanged from previous text_id {%s}' %
284
content = file(p, 'rb').read()
286
# calculate the sha again, just in case the file contents
287
# changed since we updated the cache
288
entry.text_sha1 = sha_string(content)
289
entry.text_size = len(content)
291
entry.text_id = gen_file_id(entry.name)
292
branch.text_store.add(content, entry.text_id)
293
mutter(' stored with text_id {%s}' % entry.text_id)
296
marked = path + kind_marker(entry.kind)
298
print 'added', marked
300
elif old_ie == entry:
302
elif (old_ie.name == entry.name
303
and old_ie.parent_id == entry.parent_id):
304
print 'modified', marked
307
print 'renamed', marked
310
return missing_ids, inv, any_changes
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 cStringIO import StringIO
74
from bzrlib.atomicfile import AtomicFile
76
import bzrlib.errors as errors
77
from bzrlib.errors import (BzrError, PointlessCommit,
81
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
82
is_inside_or_parent_of_any,
83
quotefn, sha_file, split_lines)
84
from bzrlib.testament import Testament
85
from bzrlib.trace import mutter, note, warning
86
from bzrlib.xml5 import serializer_v5
87
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
88
from bzrlib.symbol_versioning import (deprecated_passed,
92
from bzrlib.workingtree import WorkingTree
95
@deprecated_function(zero_seven)
96
def commit(*args, **kwargs):
97
"""Commit a new revision to a branch.
99
Function-style interface for convenience of old callers.
101
New code should use the Commit class instead.
103
## XXX: Remove this in favor of WorkingTree.commit?
104
Commit().commit(*args, **kwargs)
107
class NullCommitReporter(object):
108
"""I report on progress of a commit."""
110
def snapshot_change(self, change, path):
113
def completed(self, revno, rev_id):
116
def deleted(self, file_id):
119
def escaped(self, escape_count, message):
122
def missing(self, path):
125
def renamed(self, change, old_path, new_path):
129
class ReportCommitToLog(NullCommitReporter):
131
# this may be more useful if 'note' was replaced by an overridable
132
# method on self, which would allow more trivial subclassing.
133
# alternative, a callable could be passed in, allowing really trivial
134
# reuse for some uis. RBC 20060511
136
def snapshot_change(self, change, path):
137
if change == 'unchanged':
139
note("%s %s", change, path)
141
def completed(self, revno, rev_id):
142
note('Committed revision %d.', revno)
144
def deleted(self, file_id):
145
note('deleted %s', file_id)
147
def escaped(self, escape_count, message):
148
note("replaced %d control characters in message", escape_count)
150
def missing(self, path):
151
note('missing %s', path)
153
def renamed(self, change, old_path, new_path):
154
note('%s %s => %s', change, old_path, new_path)
157
class Commit(object):
158
"""Task of committing a new revision.
160
This is a MethodObject: it accumulates state as the commit is
161
prepared, and then it is discarded. It doesn't represent
162
historical revisions, just the act of recording a new one.
165
Modified to hold a list of files that have been deleted from
166
the working directory; these should be removed from the
172
if reporter is not None:
173
self.reporter = reporter
175
self.reporter = NullCommitReporter()
176
if config is not None:
182
branch=DEPRECATED_PARAMETER, message=None,
188
allow_pointless=True,
196
"""Commit working copy as a new revision.
198
branch -- the deprecated branch to commit to. New callers should pass in
201
message -- the commit message, a mandatory parameter
203
timestamp -- if not None, seconds-since-epoch for a
204
postdated/predated commit.
206
specific_files -- If true, commit only those files.
208
rev_id -- If set, use this as the new revision id.
209
Useful for test or import commands that need to tightly
210
control what revisions are assigned. If you duplicate
211
a revision id that exists elsewhere it is your own fault.
212
If null (default), a time/random revision id is generated.
214
allow_pointless -- If true (default), commit even if nothing
215
has changed and no merges are recorded.
217
strict -- If true, don't allow a commit if the working tree
218
contains unknown files.
220
revprops -- Properties for new revision
221
:param local: Perform a local only commit.
223
mutter('preparing to commit')
225
if deprecated_passed(branch):
226
warnings.warn("Commit.commit (branch, ...): The branch parameter is "
227
"deprecated as of bzr 0.8. Please use working_tree= instead.",
228
DeprecationWarning, stacklevel=2)
230
self.work_tree = self.branch.bzrdir.open_workingtree()
231
elif working_tree is None:
232
raise BzrError("One of branch and working_tree must be passed into commit().")
234
self.work_tree = working_tree
235
self.branch = self.work_tree.branch
237
raise BzrError("The message keyword parameter is required for commit().")
239
self.bound_branch = None
241
self.master_branch = None
242
self.master_locked = False
244
self.specific_files = specific_files
245
self.allow_pointless = allow_pointless
247
if reporter is None and self.reporter is None:
248
self.reporter = NullCommitReporter()
249
elif reporter is not None:
250
self.reporter = reporter
252
self.work_tree.lock_write()
253
self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
255
# Cannot commit with conflicts present.
256
if len(self.work_tree.conflicts())>0:
257
raise ConflictsInTree
259
# setup the bound branch variables as needed.
260
self._check_bound_branch()
262
# check for out of date working trees
263
# if we are bound, then self.branch is the master branch and this
264
# test is thus all we need.
265
if self.work_tree.last_revision() != self.master_branch.last_revision():
266
raise errors.OutOfDateTree(self.work_tree)
269
# raise an exception as soon as we find a single unknown.
270
for unknown in self.work_tree.unknowns():
271
raise StrictCommitFailed()
273
if self.config is None:
274
self.config = self.branch.get_config()
276
if isinstance(message, str):
277
message = message.decode(bzrlib.user_encoding)
278
assert isinstance(message, unicode), type(message)
279
self.message = message
280
self._escape_commit_message()
282
self.work_inv = self.work_tree.inventory
283
self.basis_tree = self.work_tree.basis_tree()
284
self.basis_inv = self.basis_tree.inventory
285
# one to finish, one for rev and inventory, and one for each
286
# inventory entry, and the same for the new inventory.
287
# note that this estimate is too long when we do a partial tree
288
# commit which excludes some new files from being considered.
289
# The estimate is corrected when we populate the new inv.
290
self.pb_total = len(self.work_inv) + 5
293
self._gather_parents()
294
if len(self.parents) > 1 and self.specific_files:
295
raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
297
self._check_parents_present()
298
self.builder = self.branch.get_commit_builder(self.parents,
299
self.config, timestamp, timezone, committer, revprops, rev_id)
301
self._remove_deleted()
302
self._populate_new_inv()
303
self._report_deletes()
305
if not (self.allow_pointless
306
or len(self.parents) > 1
307
or self.builder.new_inventory != self.basis_inv):
308
raise PointlessCommit()
310
self._emit_progress_update()
311
# TODO: Now the new inventory is known, check for conflicts and prompt the
312
# user for a commit message.
313
self.builder.finish_inventory()
314
self._emit_progress_update()
315
self.rev_id = self.builder.commit(self.message)
316
self._emit_progress_update()
317
# revision data is in the local branch now.
319
# upload revision data to the master.
320
# this will propagate merged revisions too if needed.
321
if self.bound_branch:
322
self.master_branch.repository.fetch(self.branch.repository,
323
revision_id=self.rev_id)
324
# now the master has the revision data
325
# 'commit' to the master first so a timeout here causes the local
326
# branch to be out of date
327
self.master_branch.append_revision(self.rev_id)
329
# and now do the commit locally.
330
self.branch.append_revision(self.rev_id)
332
self.work_tree.set_pending_merges([])
333
self.work_tree.set_last_revision(self.rev_id)
334
# now the work tree is up to date with the branch
336
self.reporter.completed(self.branch.revno(), self.rev_id)
337
if self.config.post_commit() is not None:
338
hooks = self.config.post_commit().split(' ')
339
# this would be nicer with twisted.python.reflect.namedAny
341
result = eval(hook + '(branch, rev_id)',
342
{'branch':self.branch,
344
'rev_id':self.rev_id})
345
self._emit_progress_update()
350
def _check_bound_branch(self):
351
"""Check to see if the local branch is bound.
353
If it is bound, then most of the commit will actually be
354
done using the remote branch as the target branch.
355
Only at the end will the local branch be updated.
357
if self.local and not self.branch.get_bound_location():
358
raise errors.LocalRequiresBoundBranch()
361
self.master_branch = self.branch.get_master_branch()
363
if not self.master_branch:
364
# make this branch the reference branch for out of date checks.
365
self.master_branch = self.branch
368
# If the master branch is bound, we must fail
369
master_bound_location = self.master_branch.get_bound_location()
370
if master_bound_location:
371
raise errors.CommitToDoubleBoundBranch(self.branch,
372
self.master_branch, master_bound_location)
374
# TODO: jam 20051230 We could automatically push local
375
# commits to the remote branch if they would fit.
376
# But for now, just require remote to be identical
379
# Make sure the local branch is identical to the master
380
master_rh = self.master_branch.revision_history()
381
local_rh = self.branch.revision_history()
382
if local_rh != master_rh:
383
raise errors.BoundBranchOutOfDate(self.branch,
386
# Now things are ready to change the master branch
388
self.bound_branch = self.branch
389
self.master_branch.lock_write()
390
self.master_locked = True
393
"""Cleanup any open locks, progress bars etc."""
394
cleanups = [self._cleanup_bound_branch,
395
self.work_tree.unlock,
397
found_exception = None
398
for cleanup in cleanups:
401
# we want every cleanup to run no matter what.
402
# so we have a catchall here, but we will raise the
403
# last encountered exception up the stack: and
404
# typically this will be useful enough.
407
if found_exception is not None:
408
# don't do a plan raise, because the last exception may have been
409
# trashed, e is our sure-to-work exception even though it loses the
410
# full traceback. XXX: RBC 20060421 perhaps we could check the
411
# exc_info and if its the same one do a plain raise otherwise
412
# 'raise e' as we do now.
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
# TODO: Make sure that this list doesn't contain duplicate
448
# entries and the order is preserved when doing this.
449
self.parents = self.work_tree.get_parent_ids()
450
self.parent_invs = []
451
for revision in self.parents:
452
if self.branch.repository.has_revision(revision):
453
inventory = self.branch.repository.get_inventory(revision)
454
self.parent_invs.append(inventory)
456
def _check_parents_present(self):
457
for parent_id in self.parents:
458
mutter('commit parent revision {%s}', parent_id)
459
if not self.branch.repository.has_revision(parent_id):
460
if parent_id == self.branch.last_revision():
461
warning("parent is missing %r", parent_id)
462
raise BzrCheckError("branch %s is missing revision {%s}"
463
% (self.branch, parent_id))
465
def _remove_deleted(self):
466
"""Remove deleted files from the working inventories.
468
This is done prior to taking the working inventory as the
469
basis for the new committed inventory.
471
This returns true if any files
472
*that existed in the basis inventory* were deleted.
473
Files that were added and deleted
474
in the working copy don't matter.
476
specific = self.specific_files
478
for path, ie in self.work_inv.iter_entries():
479
if specific and not is_inside_any(specific, path):
481
if not self.work_tree.has_filename(path):
482
self.reporter.missing(path)
483
deleted_ids.append((path, ie.file_id))
485
deleted_ids.sort(reverse=True)
486
for path, file_id in deleted_ids:
487
del self.work_inv[file_id]
488
self.work_tree._write_inventory(self.work_inv)
490
def _populate_new_inv(self):
491
"""Build revision inventory.
493
This creates a new empty inventory. Depending on
494
which files are selected for commit, and what is present in the
495
current tree, the new inventory is populated. inventory entries
496
which are candidates for modification have their revision set to
497
None; inventory entries that are carried over untouched have their
498
revision set to their prior value.
500
mutter("Selecting files for commit with filter %s", self.specific_files)
501
# iter_entries does not visit the ROOT_ID node so we need to call
502
# self._emit_progress_update once by hand.
503
self._emit_progress_update()
504
for path, new_ie in self.work_inv.iter_entries():
505
self._emit_progress_update()
506
file_id = new_ie.file_id
507
mutter('check %s {%s}', path, file_id)
508
if (not self.specific_files or
509
is_inside_or_parent_of_any(self.specific_files, path)):
510
mutter('%s selected for commit', path)
514
mutter('%s not selected for commit', path)
515
if self.basis_inv.has_id(file_id):
516
ie = self.basis_inv[file_id].copy()
518
# this entry is new and not being committed
521
self.builder.record_entry_contents(ie, self.parent_invs,
522
path, self.work_tree)
523
# describe the nature of the change that has occurred relative to
524
# the basis inventory.
525
if (self.basis_inv.has_id(ie.file_id)):
526
basis_ie = self.basis_inv[ie.file_id]
529
change = ie.describe_change(basis_ie, ie)
530
if change in (InventoryEntry.RENAMED,
531
InventoryEntry.MODIFIED_AND_RENAMED):
532
old_path = self.basis_inv.id2path(ie.file_id)
533
self.reporter.renamed(change, old_path, path)
535
self.reporter.snapshot_change(change, path)
537
def _emit_progress_update(self):
538
"""Emit an update to the progress bar."""
539
self.pb.update("Committing", self.pb_count, self.pb_total)
542
def _report_deletes(self):
543
for path, ie in self.basis_inv.iter_entries():
544
if ie.file_id not in self.builder.new_inventory:
545
self.reporter.deleted(path)
added
removed
bzrlib/commit.py
