1
# Copyright (C) 2005 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.osutils import (local_time_offset,
76
rand_bytes, compact_date,
77
kind_marker, is_inside_any, quotefn,
78
sha_string, sha_strings, sha_file, isdir, isfile,
80
from bzrlib.branch import gen_file_id
82
from bzrlib.errors import (BzrError, PointlessCommit,
87
import bzrlib.gpg as gpg
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
93
from bzrlib.weave import Weave
94
from bzrlib.weavefile import read_weave, write_weave_v5
95
from bzrlib.atomicfile import AtomicFile
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
class ReportCommitToLog(NullCommitReporter):
129
def snapshot_change(self, change, path):
130
note("%s %s", change, path)
132
def completed(self, revno, rev_id):
133
note('committed r%d {%s}', revno, rev_id)
135
def deleted(self, file_id):
136
note('deleted %s', file_id)
138
def escaped(self, escape_count, message):
139
note("replaced %d control characters in message", escape_count)
141
def missing(self, path):
142
note('missing %s', path)
144
class Commit(object):
145
"""Task of committing a new revision.
147
This is a MethodObject: it accumulates state as the commit is
148
prepared, and then it is discarded. It doesn't represent
149
historical revisions, just the act of recording a new one.
152
Modified to hold a list of files that have been deleted from
153
the working directory; these should be removed from the
159
if reporter is not None:
160
self.reporter = reporter
162
self.reporter = NullCommitReporter()
163
if config is not None:
175
allow_pointless=True,
179
"""Commit working copy as a new revision.
181
timestamp -- if not None, seconds-since-epoch for a
182
postdated/predated commit.
184
specific_files -- If true, commit only those files.
186
rev_id -- If set, use this as the new revision id.
187
Useful for test or import commands that need to tightly
188
control what revisions are assigned. If you duplicate
189
a revision id that exists elsewhere it is your own fault.
190
If null (default), a time/random revision id is generated.
192
allow_pointless -- If true (default), commit even if nothing
193
has changed and no merges are recorded.
195
strict -- If true, don't allow a commit if the working tree
196
contains unknown files.
198
revprops -- Properties for new revision
200
mutter('preparing to commit')
203
self.weave_store = branch.weave_store
205
self.specific_files = specific_files
206
self.allow_pointless = allow_pointless
207
self.revprops = {'branch-nick': branch.nick}
209
self.revprops.update(revprops)
212
# raise an exception as soon as we find a single unknown.
213
for unknown in branch.unknowns():
214
raise StrictCommitFailed()
216
if timestamp is None:
217
self.timestamp = time.time()
219
self.timestamp = long(timestamp)
221
if self.config is None:
222
self.config = bzrlib.config.BranchConfig(self.branch)
225
self.rev_id = _gen_revision_id(self.config, self.timestamp)
229
if committer is None:
230
self.committer = self.config.username()
232
assert isinstance(committer, basestring), type(committer)
233
self.committer = committer
236
self.timezone = local_time_offset()
238
self.timezone = int(timezone)
240
assert isinstance(message, basestring), type(message)
241
self.message = message
242
self._escape_commit_message()
244
self.branch.lock_write()
246
self.work_tree = self.branch.working_tree()
247
self.work_inv = self.work_tree.inventory
248
self.basis_tree = self.branch.basis_tree()
249
self.basis_inv = self.basis_tree.inventory
251
self._gather_parents()
252
if len(self.parents) > 1 and self.specific_files:
253
raise NotImplementedError('selected-file commit of merges is not supported yet')
254
self._check_parents_present()
256
self._remove_deleted()
257
self._populate_new_inv()
258
self._store_snapshot()
259
self._report_deletes()
261
if not (self.allow_pointless
262
or len(self.parents) > 1
263
or self.new_inv != self.basis_inv):
264
raise PointlessCommit()
266
if len(list(self.work_tree.iter_conflicts()))>0:
267
raise ConflictsInTree
269
self._record_inventory()
270
self._make_revision()
271
self.branch.append_revision(self.rev_id)
272
self.work_tree.set_pending_merges([])
273
self.reporter.completed(self.branch.revno()+1, self.rev_id)
274
if self.config.post_commit() is not None:
275
hooks = self.config.post_commit().split(' ')
276
# this would be nicer with twisted.python.reflect.namedAny
278
result = eval(hook + '(branch, rev_id)',
279
{'branch':self.branch,
281
'rev_id':self.rev_id})
285
def _record_inventory(self):
286
"""Store the inventory for the new revision."""
287
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
288
self.inv_sha1 = sha_string(inv_text)
289
s = self.branch.control_weaves
290
s.add_text('inventory', self.rev_id,
291
split_lines(inv_text), self.present_parents,
292
self.branch.get_transaction())
294
def _escape_commit_message(self):
295
"""Replace xml-incompatible control characters."""
296
# Python strings can include characters that can't be
297
# represented in well-formed XML; escape characters that
298
# aren't listed in the XML specification
299
# (http://www.w3.org/TR/REC-xml/#NT-Char).
300
if isinstance(self.message, unicode):
301
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
303
# Use a regular 'str' as pattern to avoid having re.subn
304
# return 'unicode' results.
305
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
306
self.message, escape_count = re.subn(
308
lambda match: match.group(0).encode('unicode_escape'),
311
self.reporter.escaped(escape_count, self.message)
313
def _gather_parents(self):
314
"""Record the parents of a merge for merge detection."""
315
pending_merges = self.work_tree.pending_merges()
317
self.parent_invs = []
318
self.present_parents = []
319
precursor_id = self.branch.last_revision()
321
self.parents.append(precursor_id)
322
self.parents += pending_merges
323
for revision in self.parents:
324
if self.branch.has_revision(revision):
325
self.parent_invs.append(self.branch.get_inventory(revision))
326
self.present_parents.append(revision)
328
def _check_parents_present(self):
329
for parent_id in self.parents:
330
mutter('commit parent revision {%s}', parent_id)
331
if not self.branch.has_revision(parent_id):
332
if parent_id == self.branch.last_revision():
333
warning("parent is missing %r", parent_id)
334
raise HistoryMissing(self.branch, 'revision', parent_id)
336
mutter("commit will ghost revision %r", parent_id)
338
def _make_revision(self):
339
"""Record a new revision object for this commit."""
340
self.rev = Revision(timestamp=self.timestamp,
341
timezone=self.timezone,
342
committer=self.committer,
343
message=self.message,
344
inventory_sha1=self.inv_sha1,
345
revision_id=self.rev_id,
346
properties=self.revprops)
347
self.rev.parent_ids = self.parents
349
serializer_v5.write_revision(self.rev, rev_tmp)
351
if self.config.signature_needed():
352
plaintext = Testament(self.rev, self.new_inv).as_short_text()
353
self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
354
plaintext, self.rev_id)
355
self.branch.revision_store.add(rev_tmp, self.rev_id)
356
mutter('new revision_id is {%s}', self.rev_id)
358
def _remove_deleted(self):
359
"""Remove deleted files from the working inventories.
361
This is done prior to taking the working inventory as the
362
basis for the new committed inventory.
364
This returns true if any files
365
*that existed in the basis inventory* were deleted.
366
Files that were added and deleted
367
in the working copy don't matter.
369
specific = self.specific_files
371
for path, ie in self.work_inv.iter_entries():
372
if specific and not is_inside_any(specific, path):
374
if not self.work_tree.has_filename(path):
375
self.reporter.missing(path)
376
deleted_ids.append((path, ie.file_id))
378
deleted_ids.sort(reverse=True)
379
for path, file_id in deleted_ids:
380
del self.work_inv[file_id]
381
self.work_tree._write_inventory(self.work_inv)
383
def _store_snapshot(self):
384
"""Pass over inventory and record a snapshot.
386
Entries get a new revision when they are modified in
387
any way, which includes a merge with a new set of
388
parents that have the same entry.
390
# XXX: Need to think more here about when the user has
391
# made a specific decision on a particular value -- c.f.
393
for path, ie in self.new_inv.iter_entries():
394
previous_entries = ie.find_previous_heads(
396
self.weave_store.get_weave_or_empty(ie.file_id,
397
self.branch.get_transaction()))
398
if ie.revision is None:
399
change = ie.snapshot(self.rev_id, path, previous_entries,
400
self.work_tree, self.weave_store,
401
self.branch.get_transaction())
404
self.reporter.snapshot_change(change, path)
406
def _populate_new_inv(self):
407
"""Build revision inventory.
409
This creates a new empty inventory. Depending on
410
which files are selected for commit, and what is present in the
411
current tree, the new inventory is populated. inventory entries
412
which are candidates for modification have their revision set to
413
None; inventory entries that are carried over untouched have their
414
revision set to their prior value.
416
mutter("Selecting files for commit with filter %s", self.specific_files)
417
self.new_inv = Inventory()
418
for path, new_ie in self.work_inv.iter_entries():
419
file_id = new_ie.file_id
420
mutter('check %s {%s}', path, new_ie.file_id)
421
if self.specific_files:
422
if not is_inside_any(self.specific_files, path):
423
mutter('%s not selected for commit', path)
424
self._carry_entry(file_id)
427
# this is selected, ensure its parents are too.
428
parent_id = new_ie.parent_id
429
while parent_id != ROOT_ID:
430
if not self.new_inv.has_id(parent_id):
431
ie = self._select_entry(self.work_inv[parent_id])
432
mutter('%s selected for commit because of %s',
433
self.new_inv.id2path(parent_id), path)
435
ie = self.new_inv[parent_id]
436
if ie.revision is not None:
438
mutter('%s selected for commit because of %s',
439
self.new_inv.id2path(parent_id), path)
440
parent_id = ie.parent_id
441
mutter('%s selected for commit', path)
442
self._select_entry(new_ie)
444
def _select_entry(self, new_ie):
445
"""Make new_ie be considered for committing."""
451
def _carry_entry(self, file_id):
452
"""Carry the file unchanged from the basis revision."""
453
if self.basis_inv.has_id(file_id):
454
self.new_inv.add(self.basis_inv[file_id].copy())
456
def _report_deletes(self):
457
for file_id in self.basis_inv:
458
if file_id not in self.new_inv:
459
self.reporter.deleted(self.basis_inv.id2path(file_id))
461
def _gen_revision_id(config, when):
462
"""Return new revision-id."""
463
s = '%s-%s-' % (config.user_email(), compact_date(when))
464
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
