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, InventoryEntry
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):
127
def renamed(self, change, old_path, new_path):
131
class ReportCommitToLog(NullCommitReporter):
133
# this may be more useful if 'note' was replaced by an overridable
134
# method on self, which would allow more trivial subclassing.
135
# alternative, a callable could be passed in, allowing really trivial
136
# reuse for some uis. RBC 20060511
138
def snapshot_change(self, change, path):
139
if change == 'unchanged':
141
note("%s %s", change, path)
143
def completed(self, revno, rev_id):
144
note('Committed revision %d.', revno)
146
def deleted(self, file_id):
147
note('deleted %s', file_id)
149
def escaped(self, escape_count, message):
150
note("replaced %d control characters in message", escape_count)
152
def missing(self, path):
153
note('missing %s', path)
155
def renamed(self, change, old_path, new_path):
156
note('%s %s => %s', change, old_path, new_path)
159
class Commit(object):
160
"""Task of committing a new revision.
162
This is a MethodObject: it accumulates state as the commit is
163
prepared, and then it is discarded. It doesn't represent
164
historical revisions, just the act of recording a new one.
167
Modified to hold a list of files that have been deleted from
168
the working directory; these should be removed from the
174
if reporter is not None:
175
self.reporter = reporter
177
self.reporter = NullCommitReporter()
178
if config is not None:
184
branch=DEPRECATED_PARAMETER, message=None,
190
allow_pointless=True,
198
"""Commit working copy as a new revision.
200
branch -- the deprecated branch to commit to. New callers should pass in
203
message -- the commit message, a mandatory parameter
205
timestamp -- if not None, seconds-since-epoch for a
206
postdated/predated commit.
208
specific_files -- If true, commit only those files.
210
rev_id -- If set, use this as the new revision id.
211
Useful for test or import commands that need to tightly
212
control what revisions are assigned. If you duplicate
213
a revision id that exists elsewhere it is your own fault.
214
If null (default), a time/random revision id is generated.
216
allow_pointless -- If true (default), commit even if nothing
217
has changed and no merges are recorded.
219
strict -- If true, don't allow a commit if the working tree
220
contains unknown files.
222
revprops -- Properties for new revision
223
:param local: Perform a local only commit.
225
mutter('preparing to commit')
227
if deprecated_passed(branch):
228
warn("Commit.commit (branch, ...): The branch parameter is "
229
"deprecated as of bzr 0.8. Please use working_tree= instead.",
230
DeprecationWarning, stacklevel=2)
232
self.work_tree = self.branch.bzrdir.open_workingtree()
233
elif working_tree is None:
234
raise BzrError("One of branch and working_tree must be passed into commit().")
236
self.work_tree = working_tree
237
self.branch = self.work_tree.branch
239
raise BzrError("The message keyword parameter is required for commit().")
241
self.weave_store = self.branch.repository.weave_store
242
self.bound_branch = None
244
self.master_branch = None
245
self.master_locked = False
247
self.specific_files = specific_files
248
self.allow_pointless = allow_pointless
250
if revprops is not None:
251
self.revprops.update(revprops)
253
if reporter is None and self.reporter is None:
254
self.reporter = NullCommitReporter()
255
elif reporter is not None:
256
self.reporter = reporter
258
self.work_tree.lock_write()
260
# setup the bound branch variables as needed.
261
self._check_bound_branch()
263
# check for out of date working trees
264
# if we are bound, then self.branch is the master branch and this
265
# test is thus all we need.
266
if self.work_tree.last_revision() != self.master_branch.last_revision():
267
raise errors.OutOfDateTree(self.work_tree)
270
# raise an exception as soon as we find a single unknown.
271
for unknown in self.work_tree.unknowns():
272
raise StrictCommitFailed()
274
if timestamp is None:
275
self.timestamp = time.time()
277
self.timestamp = long(timestamp)
279
if self.config is None:
280
self.config = bzrlib.config.BranchConfig(self.branch)
283
self.rev_id = _gen_revision_id(self.config, self.timestamp)
287
if committer is None:
288
self.committer = self.config.username()
290
assert isinstance(committer, basestring), type(committer)
291
self.committer = committer
294
self.timezone = local_time_offset()
296
self.timezone = int(timezone)
298
if isinstance(message, str):
299
message = message.decode(bzrlib.user_encoding)
300
assert isinstance(message, unicode), type(message)
301
self.message = message
302
self._escape_commit_message()
304
self.work_inv = self.work_tree.inventory
305
self.basis_tree = self.work_tree.basis_tree()
306
self.basis_inv = self.basis_tree.inventory
308
self._gather_parents()
309
if len(self.parents) > 1 and self.specific_files:
310
raise NotImplementedError('selected-file commit of merges is not supported yet')
311
self._check_parents_present()
313
self._remove_deleted()
314
self._populate_new_inv()
315
self._store_snapshot()
316
self._report_deletes()
318
if not (self.allow_pointless
319
or len(self.parents) > 1
320
or self.new_inv != self.basis_inv):
321
raise PointlessCommit()
323
if len(self.work_tree.conflicts())>0:
324
raise ConflictsInTree
326
self.inv_sha1 = self.branch.repository.add_inventory(
331
self._make_revision()
332
# revision data is in the local branch now.
334
# upload revision data to the master.
335
# this will propogate merged revisions too if needed.
336
if self.bound_branch:
337
self.master_branch.repository.fetch(self.branch.repository,
338
revision_id=self.rev_id)
339
# now the master has the revision data
340
# 'commit' to the master first so a timeout here causes the local
341
# branch to be out of date
342
self.master_branch.append_revision(self.rev_id)
344
# and now do the commit locally.
345
self.branch.append_revision(self.rev_id)
347
self.work_tree.set_pending_merges([])
348
self.work_tree.set_last_revision(self.rev_id)
349
# now the work tree is up to date with the branch
351
self.reporter.completed(self.branch.revno(), self.rev_id)
352
if self.config.post_commit() is not None:
353
hooks = self.config.post_commit().split(' ')
354
# this would be nicer with twisted.python.reflect.namedAny
356
result = eval(hook + '(branch, rev_id)',
357
{'branch':self.branch,
359
'rev_id':self.rev_id})
361
self._cleanup_bound_branch()
362
self.work_tree.unlock()
364
def _check_bound_branch(self):
365
"""Check to see if the local branch is bound.
367
If it is bound, then most of the commit will actually be
368
done using the remote branch as the target branch.
369
Only at the end will the local branch be updated.
371
if self.local and not self.branch.get_bound_location():
372
raise errors.LocalRequiresBoundBranch()
375
self.master_branch = self.branch.get_master_branch()
377
if not self.master_branch:
378
# make this branch the reference branch for out of date checks.
379
self.master_branch = self.branch
382
# If the master branch is bound, we must fail
383
master_bound_location = self.master_branch.get_bound_location()
384
if master_bound_location:
385
raise errors.CommitToDoubleBoundBranch(self.branch,
386
self.master_branch, master_bound_location)
388
# TODO: jam 20051230 We could automatically push local
389
# commits to the remote branch if they would fit.
390
# But for now, just require remote to be identical
393
# Make sure the local branch is identical to the master
394
master_rh = self.master_branch.revision_history()
395
local_rh = self.branch.revision_history()
396
if local_rh != master_rh:
397
raise errors.BoundBranchOutOfDate(self.branch,
400
# Now things are ready to change the master branch
402
self.bound_branch = self.branch
403
self.master_branch.lock_write()
404
self.master_locked = True
406
#### # Check to see if we have any pending merges. If we do
407
#### # those need to be pushed into the master branch
408
#### pending_merges = self.work_tree.pending_merges()
409
#### if pending_merges:
410
#### for revision_id in pending_merges:
411
#### self.master_branch.repository.fetch(self.bound_branch.repository,
412
#### revision_id=revision_id)
414
def _cleanup_bound_branch(self):
415
"""Executed at the end of a try/finally to cleanup a bound branch.
417
If the branch wasn't bound, this is a no-op.
418
If it was, it resents self.branch to the local branch, instead
421
if not self.bound_branch:
423
if self.master_locked:
424
self.master_branch.unlock()
426
def _escape_commit_message(self):
427
"""Replace xml-incompatible control characters."""
428
# FIXME: RBC 20060419 this should be done by the revision
429
# serialiser not by commit. Then we can also add an unescaper
430
# in the deserializer and start roundtripping revision messages
431
# precisely. See repository_implementations/test_repository.py
433
# Python strings can include characters that can't be
434
# represented in well-formed XML; escape characters that
435
# aren't listed in the XML specification
436
# (http://www.w3.org/TR/REC-xml/#NT-Char).
437
self.message, escape_count = re.subn(
438
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
439
lambda match: match.group(0).encode('unicode_escape'),
442
self.reporter.escaped(escape_count, self.message)
444
def _gather_parents(self):
445
"""Record the parents of a merge for merge detection."""
446
pending_merges = self.work_tree.pending_merges()
448
self.parent_invs = []
449
self.present_parents = []
450
precursor_id = self.branch.last_revision()
452
self.parents.append(precursor_id)
453
self.parents += pending_merges
454
for revision in self.parents:
455
if self.branch.repository.has_revision(revision):
456
inventory = self.branch.repository.get_inventory(revision)
457
self.parent_invs.append(inventory)
458
self.present_parents.append(revision)
460
def _check_parents_present(self):
461
for parent_id in self.parents:
462
mutter('commit parent revision {%s}', parent_id)
463
if not self.branch.repository.has_revision(parent_id):
464
if parent_id == self.branch.last_revision():
465
warning("parent is missing %r", parent_id)
466
raise HistoryMissing(self.branch, 'revision', parent_id)
468
mutter("commit will ghost revision %r", parent_id)
470
def _make_revision(self):
471
"""Record a new revision object for this commit."""
472
rev = Revision(timestamp=self.timestamp,
473
timezone=self.timezone,
474
committer=self.committer,
475
message=self.message,
476
inventory_sha1=self.inv_sha1,
477
revision_id=self.rev_id,
478
properties=self.revprops)
479
rev.parent_ids = self.parents
480
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
482
def _remove_deleted(self):
483
"""Remove deleted files from the working inventories.
485
This is done prior to taking the working inventory as the
486
basis for the new committed inventory.
488
This returns true if any files
489
*that existed in the basis inventory* were deleted.
490
Files that were added and deleted
491
in the working copy don't matter.
493
specific = self.specific_files
495
for path, ie in self.work_inv.iter_entries():
496
if specific and not is_inside_any(specific, path):
498
if not self.work_tree.has_filename(path):
499
self.reporter.missing(path)
500
deleted_ids.append((path, ie.file_id))
502
deleted_ids.sort(reverse=True)
503
for path, file_id in deleted_ids:
504
del self.work_inv[file_id]
505
self.work_tree._write_inventory(self.work_inv)
507
def _store_snapshot(self):
508
"""Pass over inventory and record a snapshot.
510
Entries get a new revision when they are modified in
511
any way, which includes a merge with a new set of
512
parents that have the same entry.
514
# XXX: Need to think more here about when the user has
515
# made a specific decision on a particular value -- c.f.
517
for path, ie in self.new_inv.iter_entries():
518
previous_entries = ie.find_previous_heads(
521
self.branch.repository.get_transaction())
522
if ie.revision is None:
523
# we are creating a new revision for ie in the history store
525
ie.snapshot(self.rev_id, path, previous_entries,
526
self.work_tree, self.weave_store,
527
self.branch.repository.get_transaction())
528
# describe the nature of the change that has occured relative to
529
# the basis inventory.
530
if (self.basis_inv.has_id(ie.file_id)):
531
basis_ie = self.basis_inv[ie.file_id]
534
change = ie.describe_change(basis_ie, ie)
535
if change in (InventoryEntry.RENAMED,
536
InventoryEntry.MODIFIED_AND_RENAMED):
537
old_path = self.basis_inv.id2path(ie.file_id)
538
self.reporter.renamed(change, old_path, path)
540
self.reporter.snapshot_change(change, path)
542
def _populate_new_inv(self):
543
"""Build revision inventory.
545
This creates a new empty inventory. Depending on
546
which files are selected for commit, and what is present in the
547
current tree, the new inventory is populated. inventory entries
548
which are candidates for modification have their revision set to
549
None; inventory entries that are carried over untouched have their
550
revision set to their prior value.
552
mutter("Selecting files for commit with filter %s", self.specific_files)
553
self.new_inv = Inventory(revision_id=self.rev_id)
554
for path, new_ie in self.work_inv.iter_entries():
555
file_id = new_ie.file_id
556
mutter('check %s {%s}', path, new_ie.file_id)
557
if self.specific_files:
558
if not is_inside_any(self.specific_files, path):
559
mutter('%s not selected for commit', path)
560
self._carry_entry(file_id)
563
# this is selected, ensure its parents are too.
564
parent_id = new_ie.parent_id
565
while parent_id != ROOT_ID:
566
if not self.new_inv.has_id(parent_id):
567
ie = self._select_entry(self.work_inv[parent_id])
568
mutter('%s selected for commit because of %s',
569
self.new_inv.id2path(parent_id), path)
571
ie = self.new_inv[parent_id]
572
if ie.revision is not None:
574
mutter('%s selected for commit because of %s',
575
self.new_inv.id2path(parent_id), path)
576
parent_id = ie.parent_id
577
mutter('%s selected for commit', path)
578
self._select_entry(new_ie)
580
def _select_entry(self, new_ie):
581
"""Make new_ie be considered for committing."""
587
def _carry_entry(self, file_id):
588
"""Carry the file unchanged from the basis revision."""
589
if self.basis_inv.has_id(file_id):
590
self.new_inv.add(self.basis_inv[file_id].copy())
592
def _report_deletes(self):
593
for path, ie in self.basis_inv.iter_entries():
594
if ie.file_id not in self.new_inv:
595
self.reporter.deleted(path)
597
def _gen_revision_id(config, when):
598
"""Return new revision-id."""
599
s = '%s-%s-' % (config.user_email(), compact_date(when))
600
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
