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.weave import Weave
95
from bzrlib.weavefile import read_weave, write_weave_v5
96
from bzrlib.workingtree import WorkingTree
99
@deprecated_function(zero_seven)
100
def commit(*args, **kwargs):
101
"""Commit a new revision to a branch.
103
Function-style interface for convenience of old callers.
105
New code should use the Commit class instead.
107
## XXX: Remove this in favor of Branch.commit?
108
Commit().commit(*args, **kwargs)
111
class NullCommitReporter(object):
112
"""I report on progress of a commit."""
114
def snapshot_change(self, change, path):
117
def completed(self, revno, rev_id):
120
def deleted(self, file_id):
123
def escaped(self, escape_count, message):
126
def missing(self, path):
130
class ReportCommitToLog(NullCommitReporter):
132
def snapshot_change(self, change, path):
133
note("%s %s", change, path)
135
def completed(self, revno, rev_id):
136
note('committed r%d {%s}', revno, rev_id)
138
def deleted(self, file_id):
139
note('deleted %s', file_id)
141
def escaped(self, escape_count, message):
142
note("replaced %d control characters in message", escape_count)
144
def missing(self, path):
145
note('missing %s', path)
148
class Commit(object):
149
"""Task of committing a new revision.
151
This is a MethodObject: it accumulates state as the commit is
152
prepared, and then it is discarded. It doesn't represent
153
historical revisions, just the act of recording a new one.
156
Modified to hold a list of files that have been deleted from
157
the working directory; these should be removed from the
163
if reporter is not None:
164
self.reporter = reporter
166
self.reporter = NullCommitReporter()
167
if config is not None:
173
branch=DEPRECATED_PARAMETER, message=None,
179
allow_pointless=True,
184
"""Commit working copy as a new revision.
186
branch -- the deprecated branch to commit to. New callers should pass in
189
message -- the commit message, a mandatory parameter
191
timestamp -- if not None, seconds-since-epoch for a
192
postdated/predated commit.
194
specific_files -- If true, commit only those files.
196
rev_id -- If set, use this as the new revision id.
197
Useful for test or import commands that need to tightly
198
control what revisions are assigned. If you duplicate
199
a revision id that exists elsewhere it is your own fault.
200
If null (default), a time/random revision id is generated.
202
allow_pointless -- If true (default), commit even if nothing
203
has changed and no merges are recorded.
205
strict -- If true, don't allow a commit if the working tree
206
contains unknown files.
208
revprops -- Properties for new revision
210
mutter('preparing to commit')
212
if deprecated_passed(branch):
213
warn("Commit.commit (branch, ...): The branch parameter is "
214
"deprecated as of bzr 0.8. Please use working_tree= instead.",
215
DeprecationWarning, stacklevel=2)
217
self.work_tree = self.branch.bzrdir.open_workingtree()
218
elif working_tree is None:
219
raise BzrError("One of branch and working_tree must be passed into commit().")
221
self.work_tree = working_tree
222
self.branch = self.work_tree.branch
224
raise BzrError("The message keyword parameter is required for commit().")
226
self.weave_store = self.branch.repository.weave_store
228
self.specific_files = specific_files
229
self.allow_pointless = allow_pointless
230
self.revprops = {'branch-nick': self.branch.nick}
232
self.revprops.update(revprops)
234
# check for out of date working trees
235
if self.work_tree.last_revision() != self.branch.last_revision():
236
raise errors.OutOfDateTree(self.work_tree)
239
# raise an exception as soon as we find a single unknown.
240
for unknown in self.work_tree.unknowns():
241
raise StrictCommitFailed()
243
if timestamp is None:
244
self.timestamp = time.time()
246
self.timestamp = long(timestamp)
248
if self.config is None:
249
self.config = bzrlib.config.BranchConfig(self.branch)
252
self.rev_id = _gen_revision_id(self.config, self.timestamp)
256
if committer is None:
257
self.committer = self.config.username()
259
assert isinstance(committer, basestring), type(committer)
260
self.committer = committer
263
self.timezone = local_time_offset()
265
self.timezone = int(timezone)
267
if isinstance(message, str):
268
message = message.decode(bzrlib.user_encoding)
269
assert isinstance(message, unicode), type(message)
270
self.message = message
271
self._escape_commit_message()
273
self.branch.lock_write()
275
self.work_inv = self.work_tree.inventory
276
self.basis_tree = self.work_tree.basis_tree()
277
self.basis_inv = self.basis_tree.inventory
279
self._gather_parents()
280
if len(self.parents) > 1 and self.specific_files:
281
raise NotImplementedError('selected-file commit of merges is not supported yet')
282
self._check_parents_present()
284
self._remove_deleted()
285
self._populate_new_inv()
286
self._store_snapshot()
287
self._report_deletes()
289
if not (self.allow_pointless
290
or len(self.parents) > 1
291
or self.new_inv != self.basis_inv):
292
raise PointlessCommit()
294
if len(list(self.work_tree.iter_conflicts()))>0:
295
raise ConflictsInTree
297
self.inv_sha1 = self.branch.repository.add_inventory(
302
self._make_revision()
303
self.work_tree.set_pending_merges([])
304
self.branch.append_revision(self.rev_id)
305
if len(self.parents):
306
precursor = self.parents[0]
309
self.work_tree.set_last_revision(self.rev_id, precursor)
310
self.reporter.completed(self.branch.revno()+1, self.rev_id)
311
if self.config.post_commit() is not None:
312
hooks = self.config.post_commit().split(' ')
313
# this would be nicer with twisted.python.reflect.namedAny
315
result = eval(hook + '(branch, rev_id)',
316
{'branch':self.branch,
318
'rev_id':self.rev_id})
322
def _escape_commit_message(self):
323
"""Replace xml-incompatible control characters."""
324
# Python strings can include characters that can't be
325
# represented in well-formed XML; escape characters that
326
# aren't listed in the XML specification
327
# (http://www.w3.org/TR/REC-xml/#NT-Char).
328
self.message, escape_count = re.subn(
329
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
330
lambda match: match.group(0).encode('unicode_escape'),
333
self.reporter.escaped(escape_count, self.message)
335
def _gather_parents(self):
336
"""Record the parents of a merge for merge detection."""
337
pending_merges = self.work_tree.pending_merges()
339
self.parent_invs = []
340
self.present_parents = []
341
precursor_id = self.branch.last_revision()
343
self.parents.append(precursor_id)
344
self.parents += pending_merges
345
for revision in self.parents:
346
if self.branch.repository.has_revision(revision):
347
inventory = self.branch.repository.get_inventory(revision)
348
self.parent_invs.append(inventory)
349
self.present_parents.append(revision)
351
def _check_parents_present(self):
352
for parent_id in self.parents:
353
mutter('commit parent revision {%s}', parent_id)
354
if not self.branch.repository.has_revision(parent_id):
355
if parent_id == self.branch.last_revision():
356
warning("parent is missing %r", parent_id)
357
raise HistoryMissing(self.branch, 'revision', parent_id)
359
mutter("commit will ghost revision %r", parent_id)
361
def _make_revision(self):
362
"""Record a new revision object for this commit."""
363
rev = Revision(timestamp=self.timestamp,
364
timezone=self.timezone,
365
committer=self.committer,
366
message=self.message,
367
inventory_sha1=self.inv_sha1,
368
revision_id=self.rev_id,
369
properties=self.revprops)
370
rev.parent_ids = self.parents
371
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
373
def _remove_deleted(self):
374
"""Remove deleted files from the working inventories.
376
This is done prior to taking the working inventory as the
377
basis for the new committed inventory.
379
This returns true if any files
380
*that existed in the basis inventory* were deleted.
381
Files that were added and deleted
382
in the working copy don't matter.
384
specific = self.specific_files
386
for path, ie in self.work_inv.iter_entries():
387
if specific and not is_inside_any(specific, path):
389
if not self.work_tree.has_filename(path):
390
self.reporter.missing(path)
391
deleted_ids.append((path, ie.file_id))
393
deleted_ids.sort(reverse=True)
394
for path, file_id in deleted_ids:
395
del self.work_inv[file_id]
396
self.work_tree._write_inventory(self.work_inv)
398
def _store_snapshot(self):
399
"""Pass over inventory and record a snapshot.
401
Entries get a new revision when they are modified in
402
any way, which includes a merge with a new set of
403
parents that have the same entry.
405
# XXX: Need to think more here about when the user has
406
# made a specific decision on a particular value -- c.f.
408
for path, ie in self.new_inv.iter_entries():
409
previous_entries = ie.find_previous_heads(
411
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
412
self.branch.get_transaction()))
413
if ie.revision is None:
414
change = ie.snapshot(self.rev_id, path, previous_entries,
415
self.work_tree, self.weave_store,
416
self.branch.get_transaction())
419
self.reporter.snapshot_change(change, path)
421
def _populate_new_inv(self):
422
"""Build revision inventory.
424
This creates a new empty inventory. Depending on
425
which files are selected for commit, and what is present in the
426
current tree, the new inventory is populated. inventory entries
427
which are candidates for modification have their revision set to
428
None; inventory entries that are carried over untouched have their
429
revision set to their prior value.
431
mutter("Selecting files for commit with filter %s", self.specific_files)
432
self.new_inv = Inventory()
433
for path, new_ie in self.work_inv.iter_entries():
434
file_id = new_ie.file_id
435
mutter('check %s {%s}', path, new_ie.file_id)
436
if self.specific_files:
437
if not is_inside_any(self.specific_files, path):
438
mutter('%s not selected for commit', path)
439
self._carry_entry(file_id)
442
# this is selected, ensure its parents are too.
443
parent_id = new_ie.parent_id
444
while parent_id != ROOT_ID:
445
if not self.new_inv.has_id(parent_id):
446
ie = self._select_entry(self.work_inv[parent_id])
447
mutter('%s selected for commit because of %s',
448
self.new_inv.id2path(parent_id), path)
450
ie = self.new_inv[parent_id]
451
if ie.revision is not None:
453
mutter('%s selected for commit because of %s',
454
self.new_inv.id2path(parent_id), path)
455
parent_id = ie.parent_id
456
mutter('%s selected for commit', path)
457
self._select_entry(new_ie)
459
def _select_entry(self, new_ie):
460
"""Make new_ie be considered for committing."""
466
def _carry_entry(self, file_id):
467
"""Carry the file unchanged from the basis revision."""
468
if self.basis_inv.has_id(file_id):
469
self.new_inv.add(self.basis_inv[file_id].copy())
471
def _report_deletes(self):
472
for file_id in self.basis_inv:
473
if file_id not in self.new_inv:
474
self.reporter.deleted(self.basis_inv.id2path(file_id))
476
def _gen_revision_id(config, when):
477
"""Return new revision-id."""
478
s = '%s-%s-' % (config.user_email(), compact_date(when))
479
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
