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,
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
208
:param local: Perform a local only commit.
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
227
self.bound_branch = None
229
self.master_branch = None
230
self.master_locked = False
232
self.specific_files = specific_files
233
self.allow_pointless = allow_pointless
235
if revprops is not None:
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
# check for out of date working trees
244
# if we are bound, then self.branch is the master branch and this
245
# test is thus all we need.
246
if self.work_tree.last_revision() != self.master_branch.last_revision():
247
raise errors.OutOfDateTree(self.work_tree)
250
# raise an exception as soon as we find a single unknown.
251
for unknown in self.work_tree.unknowns():
252
raise StrictCommitFailed()
254
if timestamp is None:
255
self.timestamp = time.time()
257
self.timestamp = long(timestamp)
259
if self.config is None:
260
self.config = bzrlib.config.BranchConfig(self.branch)
263
self.rev_id = _gen_revision_id(self.config, self.timestamp)
267
if committer is None:
268
self.committer = self.config.username()
270
assert isinstance(committer, basestring), type(committer)
271
self.committer = committer
274
self.timezone = local_time_offset()
276
self.timezone = int(timezone)
278
if isinstance(message, str):
279
message = message.decode(bzrlib.user_encoding)
280
assert isinstance(message, unicode), type(message)
281
self.message = message
282
self._escape_commit_message()
284
self.work_inv = self.work_tree.inventory
285
self.basis_tree = self.work_tree.basis_tree()
286
self.basis_inv = self.basis_tree.inventory
288
self._gather_parents()
289
if len(self.parents) > 1 and self.specific_files:
290
raise NotImplementedError('selected-file commit of merges is not supported yet')
291
self._check_parents_present()
293
self._remove_deleted()
294
self._populate_new_inv()
295
self._store_snapshot()
296
self._report_deletes()
298
if not (self.allow_pointless
299
or len(self.parents) > 1
300
or self.new_inv != self.basis_inv):
301
raise PointlessCommit()
303
if len(list(self.work_tree.iter_conflicts()))>0:
304
raise ConflictsInTree
306
self.inv_sha1 = self.branch.repository.add_inventory(
311
self._make_revision()
312
# revision data is in the local branch now.
314
# upload revision data to the master.
315
# this will propogate merged revisions too if needed.
316
if self.bound_branch:
317
self.master_branch.repository.fetch(self.branch.repository,
318
revision_id=self.rev_id)
319
# now the master has the revision data
320
# 'commit' to the master first so a timeout here causes the local
321
# branch to be out of date
322
self.master_branch.append_revision(self.rev_id)
324
# and now do the commit locally.
325
self.branch.append_revision(self.rev_id)
327
self.work_tree.set_pending_merges([])
328
if len(self.parents):
329
precursor = self.parents[0]
332
self.work_tree.set_last_revision(self.rev_id, precursor)
333
# now the work tree is up to date with the branch
335
self.reporter.completed(self.branch.revno()+1, self.rev_id)
336
if self.config.post_commit() is not None:
337
hooks = self.config.post_commit().split(' ')
338
# this would be nicer with twisted.python.reflect.namedAny
340
result = eval(hook + '(branch, rev_id)',
341
{'branch':self.branch,
343
'rev_id':self.rev_id})
345
self._cleanup_bound_branch()
346
self.work_tree.unlock()
348
def _check_bound_branch(self):
349
"""Check to see if the local branch is bound.
351
If it is bound, then most of the commit will actually be
352
done using the remote branch as the target branch.
353
Only at the end will the local branch be updated.
355
if self.local and not self.branch.get_bound_location():
356
raise errors.LocalRequiresBoundBranch()
359
self.master_branch = self.branch.get_master_branch()
361
if not self.master_branch:
362
# make this branch the reference branch for out of date checks.
363
self.master_branch = self.branch
366
# If the master branch is bound, we must fail
367
master_bound_location = self.master_branch.get_bound_location()
368
if master_bound_location:
369
raise errors.CommitToDoubleBoundBranch(self.branch,
370
self.master_branch, master_bound_location)
372
# TODO: jam 20051230 We could automatically push local
373
# commits to the remote branch if they would fit.
374
# But for now, just require remote to be identical
377
# Make sure the local branch is identical to the master
378
master_rh = self.master_branch.revision_history()
379
local_rh = self.branch.revision_history()
380
if local_rh != master_rh:
381
raise errors.BoundBranchOutOfDate(self.branch,
384
# Now things are ready to change the master branch
386
self.bound_branch = self.branch
387
self.master_branch.lock_write()
388
self.master_locked = True
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
if self.master_locked:
408
self.master_branch.unlock()
410
def _escape_commit_message(self):
411
"""Replace xml-incompatible control characters."""
412
# Python strings can include characters that can't be
413
# represented in well-formed XML; escape characters that
414
# aren't listed in the XML specification
415
# (http://www.w3.org/TR/REC-xml/#NT-Char).
416
self.message, escape_count = re.subn(
417
u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
418
lambda match: match.group(0).encode('unicode_escape'),
421
self.reporter.escaped(escape_count, self.message)
423
def _gather_parents(self):
424
"""Record the parents of a merge for merge detection."""
425
pending_merges = self.work_tree.pending_merges()
427
self.parent_invs = []
428
self.present_parents = []
429
precursor_id = self.branch.last_revision()
431
self.parents.append(precursor_id)
432
self.parents += pending_merges
433
for revision in self.parents:
434
if self.branch.repository.has_revision(revision):
435
inventory = self.branch.repository.get_inventory(revision)
436
self.parent_invs.append(inventory)
437
self.present_parents.append(revision)
439
def _check_parents_present(self):
440
for parent_id in self.parents:
441
mutter('commit parent revision {%s}', parent_id)
442
if not self.branch.repository.has_revision(parent_id):
443
if parent_id == self.branch.last_revision():
444
warning("parent is missing %r", parent_id)
445
raise HistoryMissing(self.branch, 'revision', parent_id)
447
mutter("commit will ghost revision %r", parent_id)
449
def _make_revision(self):
450
"""Record a new revision object for this commit."""
451
rev = Revision(timestamp=self.timestamp,
452
timezone=self.timezone,
453
committer=self.committer,
454
message=self.message,
455
inventory_sha1=self.inv_sha1,
456
revision_id=self.rev_id,
457
properties=self.revprops)
458
rev.parent_ids = self.parents
459
self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
461
def _remove_deleted(self):
462
"""Remove deleted files from the working inventories.
464
This is done prior to taking the working inventory as the
465
basis for the new committed inventory.
467
This returns true if any files
468
*that existed in the basis inventory* were deleted.
469
Files that were added and deleted
470
in the working copy don't matter.
472
specific = self.specific_files
474
for path, ie in self.work_inv.iter_entries():
475
if specific and not is_inside_any(specific, path):
477
if not self.work_tree.has_filename(path):
478
self.reporter.missing(path)
479
deleted_ids.append((path, ie.file_id))
481
deleted_ids.sort(reverse=True)
482
for path, file_id in deleted_ids:
483
del self.work_inv[file_id]
484
self.work_tree._write_inventory(self.work_inv)
486
def _store_snapshot(self):
487
"""Pass over inventory and record a snapshot.
489
Entries get a new revision when they are modified in
490
any way, which includes a merge with a new set of
491
parents that have the same entry.
493
# XXX: Need to think more here about when the user has
494
# made a specific decision on a particular value -- c.f.
496
for path, ie in self.new_inv.iter_entries():
497
previous_entries = ie.find_previous_heads(
499
self.weave_store.get_weave_or_empty(ie.file_id,
500
self.branch.get_transaction()))
501
if ie.revision is None:
502
change = ie.snapshot(self.rev_id, path, previous_entries,
503
self.work_tree, self.weave_store,
504
self.branch.get_transaction())
507
self.reporter.snapshot_change(change, path)
509
def _populate_new_inv(self):
510
"""Build revision inventory.
512
This creates a new empty inventory. Depending on
513
which files are selected for commit, and what is present in the
514
current tree, the new inventory is populated. inventory entries
515
which are candidates for modification have their revision set to
516
None; inventory entries that are carried over untouched have their
517
revision set to their prior value.
519
mutter("Selecting files for commit with filter %s", self.specific_files)
520
self.new_inv = Inventory()
521
for path, new_ie in self.work_inv.iter_entries():
522
file_id = new_ie.file_id
523
mutter('check %s {%s}', path, new_ie.file_id)
524
if self.specific_files:
525
if not is_inside_any(self.specific_files, path):
526
mutter('%s not selected for commit', path)
527
self._carry_entry(file_id)
530
# this is selected, ensure its parents are too.
531
parent_id = new_ie.parent_id
532
while parent_id != ROOT_ID:
533
if not self.new_inv.has_id(parent_id):
534
ie = self._select_entry(self.work_inv[parent_id])
535
mutter('%s selected for commit because of %s',
536
self.new_inv.id2path(parent_id), path)
538
ie = self.new_inv[parent_id]
539
if ie.revision is not None:
541
mutter('%s selected for commit because of %s',
542
self.new_inv.id2path(parent_id), path)
543
parent_id = ie.parent_id
544
mutter('%s selected for commit', path)
545
self._select_entry(new_ie)
547
def _select_entry(self, new_ie):
548
"""Make new_ie be considered for committing."""
554
def _carry_entry(self, file_id):
555
"""Carry the file unchanged from the basis revision."""
556
if self.basis_inv.has_id(file_id):
557
self.new_inv.add(self.basis_inv[file_id].copy())
559
def _report_deletes(self):
560
for file_id in self.basis_inv:
561
if file_id not in self.new_inv:
562
self.reporter.deleted(self.basis_inv.id2path(file_id))
564
def _gen_revision_id(config, when):
565
"""Return new revision-id."""
566
s = '%s-%s-' % (config.user_email(), compact_date(when))
567
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
