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