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_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
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):
128
class ReportCommitToLog(NullCommitReporter):
130
def snapshot_change(self, change, path):
131
note("%s %s", change, path)
133
def completed(self, revno, rev_id):
134
note('committed r%d {%s}', revno, rev_id)
136
def deleted(self, file_id):
137
note('deleted %s', file_id)
139
def escaped(self, escape_count, message):
140
note("replaced %d control characters in message", escape_count)
142
def missing(self, path):
143
note('missing %s', path)
146
class Commit(object):
147
"""Task of committing a new revision.
149
This is a MethodObject: it accumulates state as the commit is
150
prepared, and then it is discarded. It doesn't represent
151
historical revisions, just the act of recording a new one.
154
Modified to hold a list of files that have been deleted from
155
the working directory; these should be removed from the
161
if reporter is not None:
162
self.reporter = reporter
164
self.reporter = NullCommitReporter()
165
if config is not None:
171
branch=DEPRECATED_PARAMETER, message=None,
177
allow_pointless=True,
182
"""Commit working copy as a new revision.
184
branch -- the deprecated branch to commit to. New callers should pass in
187
message -- the commit message, a mandatory parameter
189
timestamp -- if not None, seconds-since-epoch for a
190
postdated/predated commit.
192
specific_files -- If true, commit only those files.
194
rev_id -- If set, use this as the new revision id.
195
Useful for test or import commands that need to tightly
196
control what revisions are assigned. If you duplicate
197
a revision id that exists elsewhere it is your own fault.
198
If null (default), a time/random revision id is generated.
200
allow_pointless -- If true (default), commit even if nothing
201
has changed and no merges are recorded.
203
strict -- If true, don't allow a commit if the working tree
204
contains unknown files.
206
revprops -- Properties for new revision
208
mutter('preparing to commit')
210
if deprecated_passed(branch):
211
warn("Commit.commit (branch, ...): The branch parameter is "
212
"deprecated as of bzr 0.8. Please use working_tree= instead.",
213
DeprecationWarning, stacklevel=2)
215
self.work_tree = self.branch.bzrdir.open_workingtree()
216
elif working_tree is None:
217
raise BzrError("One of branch and working_tree must be passed into commit().")
219
self.work_tree = working_tree
220
self.branch = self.work_tree.branch
222
raise BzrError("The message keyword parameter is required for commit().")
224
self.weave_store = self.branch.repository.weave_store
226
self.specific_files = specific_files
227
self.allow_pointless = allow_pointless
228
self.revprops = {'branch-nick': self.branch.nick}
230
self.revprops.update(revprops)
232
# check for out of date working trees
233
if self.work_tree.last_revision() != self.branch.last_revision():
234
raise errors.OutOfDateTree(self.work_tree)
237
# raise an exception as soon as we find a single unknown.
238
for unknown in self.work_tree.unknowns():
239
raise StrictCommitFailed()
241
if timestamp is None:
242
self.timestamp = time.time()
244
self.timestamp = long(timestamp)
246
if self.config is None:
247
self.config = bzrlib.config.BranchConfig(self.branch)
250
self.rev_id = _gen_revision_id(self.config, self.timestamp)
254
if committer is None:
255
self.committer = self.config.username()
257
assert isinstance(committer, basestring), type(committer)
258
self.committer = committer
261
self.timezone = local_time_offset()
263
self.timezone = int(timezone)
265
if isinstance(message, str):
266
message = message.decode(bzrlib.user_encoding)
267
assert isinstance(message, unicode), type(message)
268
self.message = message
269
self._escape_commit_message()
271
self.branch.lock_write()
273
self.work_inv = self.work_tree.inventory
274
self.basis_tree = self.work_tree.basis_tree()
275
self.basis_inv = self.basis_tree.inventory
277
self._gather_parents()
278
if len(self.parents) > 1 and self.specific_files:
279
raise NotImplementedError('selected-file commit of merges is not supported yet')
280
self._check_parents_present()
282
self._remove_deleted()
283
self._populate_new_inv()
284
self._store_snapshot()
285
self._report_deletes()
287
if not (self.allow_pointless
288
or len(self.parents) > 1
289
or self.new_inv != self.basis_inv):
290
raise PointlessCommit()
292
if len(list(self.work_tree.iter_conflicts()))>0:
293
raise ConflictsInTree
295
self.inv_sha1 = self.branch.repository.add_inventory(
300
self._make_revision()
301
self.work_tree.set_pending_merges([])
302
self.branch.append_revision(self.rev_id)
303
if len(self.parents):
304
precursor = self.parents[0]
307
self.work_tree.set_last_revision(self.rev_id, precursor)
308
self.reporter.completed(self.branch.revno()+1, self.rev_id)
309
if self.config.post_commit() is not None:
310
hooks = self.config.post_commit().split(' ')
311
# this would be nicer with twisted.python.reflect.namedAny
313
result = eval(hook + '(branch, rev_id)',
314
{'branch':self.branch,
316
'rev_id':self.rev_id})
320
def _escape_commit_message(self):
321
"""Replace xml-incompatible control characters."""
322
# Python strings can include characters that can't be
323
# represented in well-formed XML; escape characters that
324
# aren't listed in the XML specification
325
# (http://www.w3.org/TR/REC-xml/#NT-Char).
326
self.message, escape_count = re.subn(
327
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
328
lambda match: match.group(0).encode('unicode_escape'),
331
self.reporter.escaped(escape_count, self.message)
333
def _gather_parents(self):
334
"""Record the parents of a merge for merge detection."""
335
pending_merges = self.work_tree.pending_merges()
337
self.parent_invs = []
338
self.present_parents = []
339
precursor_id = self.branch.last_revision()
341
self.parents.append(precursor_id)
342
self.parents += pending_merges
343
for revision in self.parents:
344
if self.branch.repository.has_revision(revision):
345
inventory = self.branch.repository.get_inventory(revision)
346
self.parent_invs.append(inventory)
347
self.present_parents.append(revision)
349
def _check_parents_present(self):
350
for parent_id in self.parents:
351
mutter('commit parent revision {%s}', parent_id)
352
if not self.branch.repository.has_revision(parent_id):
353
if parent_id == self.branch.last_revision():
354
warning("parent is missing %r", parent_id)
355
raise HistoryMissing(self.branch, 'revision', parent_id)
357
mutter("commit will ghost revision %r", parent_id)
359
def _make_revision(self):
360
"""Record a new revision object for this commit."""
361
rev = Revision(timestamp=self.timestamp,
362
timezone=self.timezone,
363
committer=self.committer,
364
message=self.message,
365
inventory_sha1=self.inv_sha1,
366
revision_id=self.rev_id,
367
properties=self.revprops)
368
rev.parent_ids = self.parents
369
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
371
def _remove_deleted(self):
372
"""Remove deleted files from the working inventories.
374
This is done prior to taking the working inventory as the
375
basis for the new committed inventory.
377
This returns true if any files
378
*that existed in the basis inventory* were deleted.
379
Files that were added and deleted
380
in the working copy don't matter.
382
specific = self.specific_files
384
for path, ie in self.work_inv.iter_entries():
385
if specific and not is_inside_any(specific, path):
387
if not self.work_tree.has_filename(path):
388
self.reporter.missing(path)
389
deleted_ids.append((path, ie.file_id))
391
deleted_ids.sort(reverse=True)
392
for path, file_id in deleted_ids:
393
del self.work_inv[file_id]
394
self.work_tree._write_inventory(self.work_inv)
396
def _store_snapshot(self):
397
"""Pass over inventory and record a snapshot.
399
Entries get a new revision when they are modified in
400
any way, which includes a merge with a new set of
401
parents that have the same entry.
403
# XXX: Need to think more here about when the user has
404
# made a specific decision on a particular value -- c.f.
406
for path, ie in self.new_inv.iter_entries():
407
previous_entries = ie.find_previous_heads(
409
self.weave_store.get_weave_or_empty(ie.file_id,
410
self.branch.get_transaction()))
411
if ie.revision is None:
412
change = ie.snapshot(self.rev_id, path, previous_entries,
413
self.work_tree, self.weave_store,
414
self.branch.get_transaction())
417
self.reporter.snapshot_change(change, path)
419
def _populate_new_inv(self):
420
"""Build revision inventory.
422
This creates a new empty inventory. Depending on
423
which files are selected for commit, and what is present in the
424
current tree, the new inventory is populated. inventory entries
425
which are candidates for modification have their revision set to
426
None; inventory entries that are carried over untouched have their
427
revision set to their prior value.
429
mutter("Selecting files for commit with filter %s", self.specific_files)
430
self.new_inv = Inventory()
431
for path, new_ie in self.work_inv.iter_entries():
432
file_id = new_ie.file_id
433
mutter('check %s {%s}', path, new_ie.file_id)
434
if self.specific_files:
435
if not is_inside_any(self.specific_files, path):
436
mutter('%s not selected for commit', path)
437
self._carry_entry(file_id)
440
# this is selected, ensure its parents are too.
441
parent_id = new_ie.parent_id
442
while parent_id != ROOT_ID:
443
if not self.new_inv.has_id(parent_id):
444
ie = self._select_entry(self.work_inv[parent_id])
445
mutter('%s selected for commit because of %s',
446
self.new_inv.id2path(parent_id), path)
448
ie = self.new_inv[parent_id]
449
if ie.revision is not None:
451
mutter('%s selected for commit because of %s',
452
self.new_inv.id2path(parent_id), path)
453
parent_id = ie.parent_id
454
mutter('%s selected for commit', path)
455
self._select_entry(new_ie)
457
def _select_entry(self, new_ie):
458
"""Make new_ie be considered for committing."""
464
def _carry_entry(self, file_id):
465
"""Carry the file unchanged from the basis revision."""
466
if self.basis_inv.has_id(file_id):
467
self.new_inv.add(self.basis_inv[file_id].copy())
469
def _report_deletes(self):
470
for file_id in self.basis_inv:
471
if file_id not in self.new_inv:
472
self.reporter.deleted(self.basis_inv.id2path(file_id))
474
def _gen_revision_id(config, when):
475
"""Return new revision-id."""
476
s = '%s-%s-' % (config.user_email(), compact_date(when))
477
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
