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,
185
"""Commit working copy as a new revision.
187
branch -- the deprecated branch to commit to. New callers should pass in
190
message -- the commit message, a mandatory parameter
192
timestamp -- if not None, seconds-since-epoch for a
193
postdated/predated commit.
195
specific_files -- If true, commit only those files.
197
rev_id -- If set, use this as the new revision id.
198
Useful for test or import commands that need to tightly
199
control what revisions are assigned. If you duplicate
200
a revision id that exists elsewhere it is your own fault.
201
If null (default), a time/random revision id is generated.
203
allow_pointless -- If true (default), commit even if nothing
204
has changed and no merges are recorded.
206
strict -- If true, don't allow a commit if the working tree
207
contains unknown files.
209
revprops -- Properties for new revision
210
:param local: Perform a local only commit.
212
mutter('preparing to commit')
214
if deprecated_passed(branch):
215
warn("Commit.commit (branch, ...): The branch parameter is "
216
"deprecated as of bzr 0.8. Please use working_tree= instead.",
217
DeprecationWarning, stacklevel=2)
219
self.work_tree = self.branch.bzrdir.open_workingtree()
220
elif working_tree is None:
221
raise BzrError("One of branch and working_tree must be passed into commit().")
223
self.work_tree = working_tree
224
self.branch = self.work_tree.branch
226
raise BzrError("The message keyword parameter is required for commit().")
228
self.weave_store = self.branch.repository.weave_store
229
self.bound_branch = None
230
self.master_branch = None
232
self.specific_files = specific_files
233
self.allow_pointless = allow_pointless
234
self.revprops = {'branch-nick': self.branch.nick}
236
self.revprops.update(revprops)
238
self.work_tree.lock_write()
240
# setup the bound branch variables as needed.
241
self._check_bound_branch()
243
if not self.bound_branch and local:
244
raise errors.LocalRequiresBoundBranch()
246
# check for out of date working trees
247
# if we are bound, then self.branch is the master branch and this
248
# test is thus all we need.
249
if self.work_tree.last_revision() != self.master_branch.last_revision():
250
raise errors.OutOfDateTree(self.work_tree)
253
# raise an exception as soon as we find a single unknown.
254
for unknown in self.work_tree.unknowns():
255
raise StrictCommitFailed()
257
if timestamp is None:
258
self.timestamp = time.time()
260
self.timestamp = long(timestamp)
262
if self.config is None:
263
self.config = bzrlib.config.BranchConfig(self.branch)
266
self.rev_id = _gen_revision_id(self.config, self.timestamp)
270
if committer is None:
271
self.committer = self.config.username()
273
assert isinstance(committer, basestring), type(committer)
274
self.committer = committer
277
self.timezone = local_time_offset()
279
self.timezone = int(timezone)
281
if isinstance(message, str):
282
message = message.decode(bzrlib.user_encoding)
283
assert isinstance(message, unicode), type(message)
284
self.message = message
285
self._escape_commit_message()
287
self.work_inv = self.work_tree.inventory
288
self.basis_tree = self.work_tree.basis_tree()
289
self.basis_inv = self.basis_tree.inventory
291
self._gather_parents()
292
if len(self.parents) > 1 and self.specific_files:
293
raise NotImplementedError('selected-file commit of merges is not supported yet')
294
self._check_parents_present()
296
self._remove_deleted()
297
self._populate_new_inv()
298
self._store_snapshot()
299
self._report_deletes()
301
if not (self.allow_pointless
302
or len(self.parents) > 1
303
or self.new_inv != self.basis_inv):
304
raise PointlessCommit()
306
if len(list(self.work_tree.iter_conflicts()))>0:
307
raise ConflictsInTree
309
self.inv_sha1 = self.branch.repository.add_inventory(
314
self._make_revision()
315
# revision data is in the local branch now.
317
# upload revision data to the master.
318
# this will propogate merged revisions too if needed.
319
if self.bound_branch:
320
self.master_branch.repository.fetch(self.branch.repository,
321
revision_id=self.rev_id)
322
# now the master has the revision data
323
# 'commit' to the master first so a timeout here causes the local
324
# branch to be out of date
325
self.master_branch.append_revision(self.rev_id)
327
# and now do the commit locally.
328
self.branch.append_revision(self.rev_id)
330
self.work_tree.set_pending_merges([])
331
if len(self.parents):
332
precursor = self.parents[0]
335
self.work_tree.set_last_revision(self.rev_id, precursor)
336
# now the work tree is up to date with the branch
338
self.reporter.completed(self.branch.revno()+1, self.rev_id)
339
if self.config.post_commit() is not None:
340
hooks = self.config.post_commit().split(' ')
341
# this would be nicer with twisted.python.reflect.namedAny
343
result = eval(hook + '(branch, rev_id)',
344
{'branch':self.branch,
346
'rev_id':self.rev_id})
348
self._cleanup_bound_branch()
349
self.work_tree.unlock()
351
def _check_bound_branch(self):
352
"""Check to see if the local branch is bound.
354
If it is bound, then most of the commit will actually be
355
done using the remote branch as the target branch.
356
Only at the end will the local branch be updated.
358
# TODO: jam 20051230 Consider a special error for the case
359
# where the local branch is bound, and can't access the
361
self.master_branch = self.branch.get_master_branch()
362
if not self.master_branch:
363
# make this branch the reference branch for out of date checks.
364
self.master_branch = self.branch
367
# If the master branch is bound, we must fail
368
master_bound_location = self.master_branch.get_bound_location()
369
if master_bound_location:
370
raise errors.CommitToDoubleBoundBranch(self.branch,
371
self.master_branch, master_bound_location)
373
# TODO: jam 20051230 We could automatically push local
374
# commits to the remote branch if they would fit.
375
# But for now, just require remote to be identical
378
# Make sure the local branch is identical to the master
379
master_rh = self.master_branch.revision_history()
380
local_rh = self.branch.revision_history()
381
if local_rh != master_rh:
382
raise errors.BoundBranchOutOfDate(self.branch,
385
# Now things are ready to change the master branch
387
self.bound_branch = self.branch
388
self.master_branch.lock_write()
390
#### # Check to see if we have any pending merges. If we do
391
#### # those need to be pushed into the master branch
392
#### pending_merges = self.work_tree.pending_merges()
393
#### if pending_merges:
394
#### for revision_id in pending_merges:
395
#### self.master_branch.repository.fetch(self.bound_branch.repository,
396
#### revision_id=revision_id)
398
def _cleanup_bound_branch(self):
399
"""Executed at the end of a try/finally to cleanup a bound branch.
401
If the branch wasn't bound, this is a no-op.
402
If it was, it resents self.branch to the local branch, instead
405
if not self.bound_branch:
407
self.master_branch.unlock()
409
def _escape_commit_message(self):
410
"""Replace xml-incompatible control characters."""
411
# Python strings can include characters that can't be
412
# represented in well-formed XML; escape characters that
413
# aren't listed in the XML specification
414
# (http://www.w3.org/TR/REC-xml/#NT-Char).
415
self.message, escape_count = re.subn(
416
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
417
lambda match: match.group(0).encode('unicode_escape'),
420
self.reporter.escaped(escape_count, self.message)
422
def _gather_parents(self):
423
"""Record the parents of a merge for merge detection."""
424
pending_merges = self.work_tree.pending_merges()
426
self.parent_invs = []
427
self.present_parents = []
428
precursor_id = self.branch.last_revision()
430
self.parents.append(precursor_id)
431
self.parents += pending_merges
432
for revision in self.parents:
433
if self.branch.repository.has_revision(revision):
434
inventory = self.branch.repository.get_inventory(revision)
435
self.parent_invs.append(inventory)
436
self.present_parents.append(revision)
438
def _check_parents_present(self):
439
for parent_id in self.parents:
440
mutter('commit parent revision {%s}', parent_id)
441
if not self.branch.repository.has_revision(parent_id):
442
if parent_id == self.branch.last_revision():
443
warning("parent is missing %r", parent_id)
444
raise HistoryMissing(self.branch, 'revision', parent_id)
446
mutter("commit will ghost revision %r", parent_id)
448
def _make_revision(self):
449
"""Record a new revision object for this commit."""
450
rev = Revision(timestamp=self.timestamp,
451
timezone=self.timezone,
452
committer=self.committer,
453
message=self.message,
454
inventory_sha1=self.inv_sha1,
455
revision_id=self.rev_id,
456
properties=self.revprops)
457
rev.parent_ids = self.parents
458
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
460
def _remove_deleted(self):
461
"""Remove deleted files from the working inventories.
463
This is done prior to taking the working inventory as the
464
basis for the new committed inventory.
466
This returns true if any files
467
*that existed in the basis inventory* were deleted.
468
Files that were added and deleted
469
in the working copy don't matter.
471
specific = self.specific_files
473
for path, ie in self.work_inv.iter_entries():
474
if specific and not is_inside_any(specific, path):
476
if not self.work_tree.has_filename(path):
477
self.reporter.missing(path)
478
deleted_ids.append((path, ie.file_id))
480
deleted_ids.sort(reverse=True)
481
for path, file_id in deleted_ids:
482
del self.work_inv[file_id]
483
self.work_tree._write_inventory(self.work_inv)
485
def _store_snapshot(self):
486
"""Pass over inventory and record a snapshot.
488
Entries get a new revision when they are modified in
489
any way, which includes a merge with a new set of
490
parents that have the same entry.
492
# XXX: Need to think more here about when the user has
493
# made a specific decision on a particular value -- c.f.
495
for path, ie in self.new_inv.iter_entries():
496
previous_entries = ie.find_previous_heads(
498
self.weave_store.get_weave_prelude_or_empty(ie.file_id,
499
self.branch.get_transaction()))
500
if ie.revision is None:
501
change = ie.snapshot(self.rev_id, path, previous_entries,
502
self.work_tree, self.weave_store,
503
self.branch.get_transaction())
506
self.reporter.snapshot_change(change, path)
508
def _populate_new_inv(self):
509
"""Build revision inventory.
511
This creates a new empty inventory. Depending on
512
which files are selected for commit, and what is present in the
513
current tree, the new inventory is populated. inventory entries
514
which are candidates for modification have their revision set to
515
None; inventory entries that are carried over untouched have their
516
revision set to their prior value.
518
mutter("Selecting files for commit with filter %s", self.specific_files)
519
self.new_inv = Inventory()
520
for path, new_ie in self.work_inv.iter_entries():
521
file_id = new_ie.file_id
522
mutter('check %s {%s}', path, new_ie.file_id)
523
if self.specific_files:
524
if not is_inside_any(self.specific_files, path):
525
mutter('%s not selected for commit', path)
526
self._carry_entry(file_id)
529
# this is selected, ensure its parents are too.
530
parent_id = new_ie.parent_id
531
while parent_id != ROOT_ID:
532
if not self.new_inv.has_id(parent_id):
533
ie = self._select_entry(self.work_inv[parent_id])
534
mutter('%s selected for commit because of %s',
535
self.new_inv.id2path(parent_id), path)
537
ie = self.new_inv[parent_id]
538
if ie.revision is not None:
540
mutter('%s selected for commit because of %s',
541
self.new_inv.id2path(parent_id), path)
542
parent_id = ie.parent_id
543
mutter('%s selected for commit', path)
544
self._select_entry(new_ie)
546
def _select_entry(self, new_ie):
547
"""Make new_ie be considered for committing."""
553
def _carry_entry(self, file_id):
554
"""Carry the file unchanged from the basis revision."""
555
if self.basis_inv.has_id(file_id):
556
self.new_inv.add(self.basis_inv[file_id].copy())
558
def _report_deletes(self):
559
for file_id in self.basis_inv:
560
if file_id not in self.new_inv:
561
self.reporter.deleted(self.basis_inv.id2path(file_id))
563
def _gen_revision_id(config, when):
564
"""Return new revision-id."""
565
s = '%s-%s-' % (config.user_email(), compact_date(when))
566
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
