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.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_string, sha_strings, sha_file, isdir, isfile,
82
import bzrlib.errors as errors
83
from bzrlib.errors import (BzrError, PointlessCommit,
88
import bzrlib.gpg as gpg
89
from bzrlib.revision import Revision
90
from bzrlib.testament import Testament
91
from bzrlib.trace import mutter, note, warning
92
from bzrlib.xml5 import serializer_v5
93
from bzrlib.inventory import Inventory, ROOT_ID
94
from bzrlib.symbol_versioning import *
95
from bzrlib.workingtree import WorkingTree
98
@deprecated_function(zero_seven)
99
def commit(*args, **kwargs):
100
"""Commit a new revision to a branch.
102
Function-style interface for convenience of old callers.
104
New code should use the Commit class instead.
106
## XXX: Remove this in favor of Branch.commit?
107
Commit().commit(*args, **kwargs)
110
class NullCommitReporter(object):
111
"""I report on progress of a commit."""
113
def snapshot_change(self, change, path):
116
def completed(self, revno, rev_id):
119
def deleted(self, file_id):
122
def escaped(self, escape_count, message):
125
def missing(self, path):
129
class ReportCommitToLog(NullCommitReporter):
131
def snapshot_change(self, change, path):
132
note("%s %s", change, path)
134
def completed(self, revno, rev_id):
135
note('committed r%d {%s}', revno, rev_id)
137
def deleted(self, file_id):
138
note('deleted %s', file_id)
140
def escaped(self, escape_count, message):
141
note("replaced %d control characters in message", escape_count)
143
def missing(self, path):
144
note('missing %s', path)
147
class Commit(object):
148
"""Task of committing a new revision.
150
This is a MethodObject: it accumulates state as the commit is
151
prepared, and then it is discarded. It doesn't represent
152
historical revisions, just the act of recording a new one.
155
Modified to hold a list of files that have been deleted from
156
the working directory; these should be removed from the
162
if reporter is not None:
163
self.reporter = reporter
165
self.reporter = NullCommitReporter()
166
if config is not None:
172
branch=DEPRECATED_PARAMETER, message=None,
178
allow_pointless=True,
183
"""Commit working copy as a new revision.
185
branch -- the deprecated branch to commit to. New callers should pass in
188
message -- the commit message, a mandatory parameter
190
timestamp -- if not None, seconds-since-epoch for a
191
postdated/predated commit.
193
specific_files -- If true, commit only those files.
195
rev_id -- If set, use this as the new revision id.
196
Useful for test or import commands that need to tightly
197
control what revisions are assigned. If you duplicate
198
a revision id that exists elsewhere it is your own fault.
199
If null (default), a time/random revision id is generated.
201
allow_pointless -- If true (default), commit even if nothing
202
has changed and no merges are recorded.
204
strict -- If true, don't allow a commit if the working tree
205
contains unknown files.
207
revprops -- Properties for new revision
209
mutter('preparing to commit')
211
if deprecated_passed(branch):
212
warn("Commit.commit (branch, ...): The branch parameter is "
213
"deprecated as of bzr 0.8. Please use working_tree= instead.",
214
DeprecationWarning, stacklevel=2)
216
self.work_tree = self.branch.bzrdir.open_workingtree()
217
elif working_tree is None:
218
raise BzrError("One of branch and working_tree must be passed into commit().")
220
self.work_tree = working_tree
221
self.branch = self.work_tree.branch
223
raise BzrError("The message keyword parameter is required for commit().")
225
self.weave_store = self.branch.repository.weave_store
227
self.specific_files = specific_files
228
self.allow_pointless = allow_pointless
229
self.revprops = {'branch-nick': self.branch.nick}
231
self.revprops.update(revprops)
233
# check for out of date working trees
234
if self.work_tree.last_revision() != self.branch.last_revision():
235
raise errors.OutOfDateTree(self.work_tree)
238
# raise an exception as soon as we find a single unknown.
239
for unknown in self.work_tree.unknowns():
240
raise StrictCommitFailed()
242
if timestamp is None:
243
self.timestamp = time.time()
245
self.timestamp = long(timestamp)
247
if self.config is None:
248
self.config = bzrlib.config.BranchConfig(self.branch)
251
self.rev_id = _gen_revision_id(self.config, self.timestamp)
255
if committer is None:
256
self.committer = self.config.username()
258
assert isinstance(committer, basestring), type(committer)
259
self.committer = committer
262
self.timezone = local_time_offset()
264
self.timezone = int(timezone)
266
if isinstance(message, str):
267
message = message.decode(bzrlib.user_encoding)
268
assert isinstance(message, unicode), type(message)
269
self.message = message
270
self._escape_commit_message()
272
self.branch.lock_write()
274
self.work_inv = self.work_tree.inventory
275
self.basis_tree = self.work_tree.basis_tree()
276
self.basis_inv = self.basis_tree.inventory
278
self._gather_parents()
279
if len(self.parents) > 1 and self.specific_files:
280
raise NotImplementedError('selected-file commit of merges is not supported yet')
281
self._check_parents_present()
283
self._remove_deleted()
284
self._populate_new_inv()
285
self._store_snapshot()
286
self._report_deletes()
288
if not (self.allow_pointless
289
or len(self.parents) > 1
290
or self.new_inv != self.basis_inv):
291
raise PointlessCommit()
293
if len(list(self.work_tree.iter_conflicts()))>0:
294
raise ConflictsInTree
296
self._record_inventory()
297
self._make_revision()
298
self.work_tree.set_pending_merges([])
299
self.branch.append_revision(self.rev_id)
300
if len(self.parents):
301
precursor = self.parents[0]
304
self.work_tree.set_last_revision(self.rev_id, precursor)
305
self.reporter.completed(self.branch.revno()+1, self.rev_id)
306
if self.config.post_commit() is not None:
307
hooks = self.config.post_commit().split(' ')
308
# this would be nicer with twisted.python.reflect.namedAny
310
result = eval(hook + '(branch, rev_id)',
311
{'branch':self.branch,
313
'rev_id':self.rev_id})
317
def _record_inventory(self):
318
"""Store the inventory for the new revision."""
319
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
320
self.inv_sha1 = sha_string(inv_text)
321
s = self.branch.repository.control_weaves
322
inv_versioned_file = s.get_weave('inventory',
323
self.branch.repository.get_transaction())
324
inv_versioned_file.add_lines(self.rev_id,
325
self.present_parents,
326
split_lines(inv_text))
328
def _escape_commit_message(self):
329
"""Replace xml-incompatible control characters."""
330
# Python strings can include characters that can't be
331
# represented in well-formed XML; escape characters that
332
# aren't listed in the XML specification
333
# (http://www.w3.org/TR/REC-xml/#NT-Char).
334
self.message, escape_count = re.subn(
335
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
336
lambda match: match.group(0).encode('unicode_escape'),
339
self.reporter.escaped(escape_count, self.message)
341
def _gather_parents(self):
342
"""Record the parents of a merge for merge detection."""
343
pending_merges = self.work_tree.pending_merges()
345
self.parent_invs = []
346
self.present_parents = []
347
precursor_id = self.branch.last_revision()
349
self.parents.append(precursor_id)
350
self.parents += pending_merges
351
for revision in self.parents:
352
if self.branch.repository.has_revision(revision):
353
inventory = self.branch.repository.get_inventory(revision)
354
self.parent_invs.append(inventory)
355
self.present_parents.append(revision)
357
def _check_parents_present(self):
358
for parent_id in self.parents:
359
mutter('commit parent revision {%s}', parent_id)
360
if not self.branch.repository.has_revision(parent_id):
361
if parent_id == self.branch.last_revision():
362
warning("parent is missing %r", parent_id)
363
raise HistoryMissing(self.branch, 'revision', parent_id)
365
mutter("commit will ghost revision %r", parent_id)
367
def _make_revision(self):
368
"""Record a new revision object for this commit."""
369
self.rev = Revision(timestamp=self.timestamp,
370
timezone=self.timezone,
371
committer=self.committer,
372
message=self.message,
373
inventory_sha1=self.inv_sha1,
374
revision_id=self.rev_id,
375
properties=self.revprops)
376
self.rev.parent_ids = self.parents
378
serializer_v5.write_revision(self.rev, rev_tmp)
380
if self.config.signature_needed():
381
plaintext = Testament(self.rev, self.new_inv).as_short_text()
382
self.branch.repository.store_revision_signature(
383
gpg.GPGStrategy(self.config), plaintext, self.rev_id)
384
self.branch.repository.revision_store.add(rev_tmp, self.rev_id)
385
mutter('new revision_id is {%s}', self.rev_id)
387
def _remove_deleted(self):
388
"""Remove deleted files from the working inventories.
390
This is done prior to taking the working inventory as the
391
basis for the new committed inventory.
393
This returns true if any files
394
*that existed in the basis inventory* were deleted.
395
Files that were added and deleted
396
in the working copy don't matter.
398
specific = self.specific_files
400
for path, ie in self.work_inv.iter_entries():
401
if specific and not is_inside_any(specific, path):
403
if not self.work_tree.has_filename(path):
404
self.reporter.missing(path)
405
deleted_ids.append((path, ie.file_id))
407
deleted_ids.sort(reverse=True)
408
for path, file_id in deleted_ids:
409
del self.work_inv[file_id]
410
self.work_tree._write_inventory(self.work_inv)
412
def _store_snapshot(self):
413
"""Pass over inventory and record a snapshot.
415
Entries get a new revision when they are modified in
416
any way, which includes a merge with a new set of
417
parents that have the same entry.
419
# XXX: Need to think more here about when the user has
420
# made a specific decision on a particular value -- c.f.
422
for path, ie in self.new_inv.iter_entries():
423
previous_entries = ie.find_previous_heads(
425
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
426
self.branch.get_transaction()))
427
if ie.revision is None:
428
change = ie.snapshot(self.rev_id, path, previous_entries,
429
self.work_tree, self.weave_store,
430
self.branch.get_transaction())
433
self.reporter.snapshot_change(change, path)
435
def _populate_new_inv(self):
436
"""Build revision inventory.
438
This creates a new empty inventory. Depending on
439
which files are selected for commit, and what is present in the
440
current tree, the new inventory is populated. inventory entries
441
which are candidates for modification have their revision set to
442
None; inventory entries that are carried over untouched have their
443
revision set to their prior value.
445
mutter("Selecting files for commit with filter %s", self.specific_files)
446
self.new_inv = Inventory()
447
for path, new_ie in self.work_inv.iter_entries():
448
file_id = new_ie.file_id
449
mutter('check %s {%s}', path, new_ie.file_id)
450
if self.specific_files:
451
if not is_inside_any(self.specific_files, path):
452
mutter('%s not selected for commit', path)
453
self._carry_entry(file_id)
456
# this is selected, ensure its parents are too.
457
parent_id = new_ie.parent_id
458
while parent_id != ROOT_ID:
459
if not self.new_inv.has_id(parent_id):
460
ie = self._select_entry(self.work_inv[parent_id])
461
mutter('%s selected for commit because of %s',
462
self.new_inv.id2path(parent_id), path)
464
ie = self.new_inv[parent_id]
465
if ie.revision is not None:
467
mutter('%s selected for commit because of %s',
468
self.new_inv.id2path(parent_id), path)
469
parent_id = ie.parent_id
470
mutter('%s selected for commit', path)
471
self._select_entry(new_ie)
473
def _select_entry(self, new_ie):
474
"""Make new_ie be considered for committing."""
480
def _carry_entry(self, file_id):
481
"""Carry the file unchanged from the basis revision."""
482
if self.basis_inv.has_id(file_id):
483
self.new_inv.add(self.basis_inv[file_id].copy())
485
def _report_deletes(self):
486
for file_id in self.basis_inv:
487
if file_id not in self.new_inv:
488
self.reporter.deleted(self.basis_inv.id2path(file_id))
490
def _gen_revision_id(config, when):
491
"""Return new revision-id."""
492
s = '%s-%s-' % (config.user_email(), compact_date(when))
493
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
