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.
66
from binascii import hexlify
67
from cStringIO import StringIO
69
from bzrlib.osutils import (local_time_offset,
70
rand_bytes, compact_date,
71
kind_marker, is_inside_any, quotefn,
72
sha_string, sha_strings, sha_file, isdir, isfile,
74
from bzrlib.branch import gen_file_id
76
from bzrlib.errors import (BzrError, PointlessCommit,
80
import bzrlib.gpg as gpg
81
from bzrlib.revision import Revision
82
from bzrlib.trace import mutter, note, warning
83
from bzrlib.xml5 import serializer_v5
84
from bzrlib.inventory import Inventory, ROOT_ID
85
from bzrlib.weave import Weave
86
from bzrlib.weavefile import read_weave, write_weave_v5
87
from bzrlib.atomicfile import AtomicFile
90
def commit(*args, **kwargs):
91
"""Commit a new revision to a branch.
93
Function-style interface for convenience of old callers.
95
New code should use the Commit class instead.
97
## XXX: Remove this in favor of Branch.commit?
98
Commit().commit(*args, **kwargs)
101
class NullCommitReporter(object):
102
"""I report on progress of a commit."""
104
def snapshot_change(self, change, path):
107
def completed(self, revno, rev_id):
110
def deleted(self, file_id):
113
def escaped(self, escape_count, message):
116
def missing(self, path):
119
class ReportCommitToLog(NullCommitReporter):
121
def snapshot_change(self, change, path):
122
note("%s %s", change, path)
124
def completed(self, revno, rev_id):
125
note('committed r%d {%s}', revno, rev_id)
127
def deleted(self, file_id):
128
note('deleted %s', file_id)
130
def escaped(self, escape_count, message):
131
note("replaced %d control characters in message", escape_count)
133
def missing(self, path):
134
note('missing %s', path)
136
class Commit(object):
137
"""Task of committing a new revision.
139
This is a MethodObject: it accumulates state as the commit is
140
prepared, and then it is discarded. It doesn't represent
141
historical revisions, just the act of recording a new one.
144
Modified to hold a list of files that have been deleted from
145
the working directory; these should be removed from the
151
if reporter is not None:
152
self.reporter = reporter
154
self.reporter = NullCommitReporter()
155
if config is not None:
167
allow_pointless=True,
170
"""Commit working copy as a new revision.
172
timestamp -- if not None, seconds-since-epoch for a
173
postdated/predated commit.
175
specific_files -- If true, commit only those files.
177
rev_id -- If set, use this as the new revision id.
178
Useful for test or import commands that need to tightly
179
control what revisions are assigned. If you duplicate
180
a revision id that exists elsewhere it is your own fault.
181
If null (default), a time/random revision id is generated.
183
allow_pointless -- If true (default), commit even if nothing
184
has changed and no merges are recorded.
186
revprops -- Properties for new revision
188
mutter('preparing to commit')
191
self.weave_store = branch.weave_store
193
self.specific_files = specific_files
194
self.allow_pointless = allow_pointless
195
self.revprops = revprops
197
if timestamp is None:
198
self.timestamp = time.time()
200
self.timestamp = long(timestamp)
202
if self.config is None:
203
self.config = bzrlib.config.BranchConfig(self.branch)
206
self.rev_id = _gen_revision_id(self.config, self.timestamp)
210
if committer is None:
211
self.committer = self.config.username()
213
assert isinstance(committer, basestring), type(committer)
214
self.committer = committer
217
self.timezone = local_time_offset()
219
self.timezone = int(timezone)
221
assert isinstance(message, basestring), type(message)
222
self.message = message
223
self._escape_commit_message()
225
self.branch.lock_write()
227
self.work_tree = self.branch.working_tree()
228
self.work_inv = self.work_tree.inventory
229
self.basis_tree = self.branch.basis_tree()
230
self.basis_inv = self.basis_tree.inventory
232
self._gather_parents()
233
if len(self.parents) > 1 and self.specific_files:
234
raise NotImplementedError('selected-file commit of merges is not supported yet')
235
self._check_parents_present()
237
self._remove_deleted()
238
self._populate_new_inv()
239
self._store_snapshot()
240
self._report_deletes()
242
if not (self.allow_pointless
243
or len(self.parents) > 1
244
or self.new_inv != self.basis_inv):
245
raise PointlessCommit()
247
if len(list(self.work_tree.iter_conflicts()))>0:
248
raise ConflictsInTree
250
self._record_inventory()
251
self._make_revision()
252
self.reporter.completed(self.branch.revno()+1, self.rev_id)
253
self.branch.append_revision(self.rev_id)
254
self.branch.set_pending_merges([])
258
def _record_inventory(self):
259
"""Store the inventory for the new revision."""
260
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
261
self.inv_sha1 = sha_string(inv_text)
262
s = self.branch.control_weaves
263
s.add_text('inventory', self.rev_id,
264
split_lines(inv_text), self.present_parents,
265
self.branch.get_transaction())
267
def _escape_commit_message(self):
268
"""Replace xml-incompatible control characters."""
269
# Python strings can include characters that can't be
270
# represented in well-formed XML; escape characters that
271
# aren't listed in the XML specification
272
# (http://www.w3.org/TR/REC-xml/#NT-Char).
273
if isinstance(self.message, unicode):
274
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
276
# Use a regular 'str' as pattern to avoid having re.subn
277
# return 'unicode' results.
278
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
279
self.message, escape_count = re.subn(
281
lambda match: match.group(0).encode('unicode_escape'),
284
self.reporter.escaped(escape_count, self.message)
286
def _gather_parents(self):
287
"""Record the parents of a merge for merge detection."""
288
pending_merges = self.branch.pending_merges()
290
self.parent_invs = []
291
self.present_parents = []
292
precursor_id = self.branch.last_revision()
294
self.parents.append(precursor_id)
295
self.parents += pending_merges
296
for revision in self.parents:
297
if self.branch.has_revision(revision):
298
self.parent_invs.append(self.branch.get_inventory(revision))
299
self.present_parents.append(revision)
301
def _check_parents_present(self):
302
for parent_id in self.parents:
303
mutter('commit parent revision {%s}', parent_id)
304
if not self.branch.has_revision(parent_id):
305
if parent_id == self.branch.last_revision():
306
warning("parent is missing %r", parent_id)
307
raise HistoryMissing(self.branch, 'revision', parent_id)
309
mutter("commit will ghost revision %r", parent_id)
311
def _make_revision(self):
312
"""Record a new revision object for this commit."""
313
self.rev = Revision(timestamp=self.timestamp,
314
timezone=self.timezone,
315
committer=self.committer,
316
message=self.message,
317
inventory_sha1=self.inv_sha1,
318
revision_id=self.rev_id,
319
properties=self.revprops)
320
self.rev.parent_ids = self.parents
322
serializer_v5.write_revision(self.rev, rev_tmp)
324
self.branch.revision_store.add(rev_tmp, self.rev_id)
325
if self.config.signature_needed():
326
self.branch.sign_revision(self.rev_id, gpg.GPGStrategy(self.config))
327
mutter('new revision_id is {%s}', self.rev_id)
329
def _remove_deleted(self):
330
"""Remove deleted files from the working inventories.
332
This is done prior to taking the working inventory as the
333
basis for the new committed inventory.
335
This returns true if any files
336
*that existed in the basis inventory* were deleted.
337
Files that were added and deleted
338
in the working copy don't matter.
340
specific = self.specific_files
342
for path, ie in self.work_inv.iter_entries():
343
if specific and not is_inside_any(specific, path):
345
if not self.work_tree.has_filename(path):
346
self.reporter.missing(path)
347
deleted_ids.append((path, ie.file_id))
349
deleted_ids.sort(reverse=True)
350
for path, file_id in deleted_ids:
351
del self.work_inv[file_id]
352
self.branch._write_inventory(self.work_inv)
354
def _store_snapshot(self):
355
"""Pass over inventory and record a snapshot.
357
Entries get a new revision when they are modified in
358
any way, which includes a merge with a new set of
359
parents that have the same entry.
361
# XXX: Need to think more here about when the user has
362
# made a specific decision on a particular value -- c.f.
364
for path, ie in self.new_inv.iter_entries():
365
previous_entries = ie.find_previous_heads(
367
self.weave_store.get_weave_or_empty(ie.file_id,
368
self.branch.get_transaction()))
369
if ie.revision is None:
370
change = ie.snapshot(self.rev_id, path, previous_entries,
371
self.work_tree, self.weave_store,
372
self.branch.get_transaction())
375
self.reporter.snapshot_change(change, path)
377
def _populate_new_inv(self):
378
"""Build revision inventory.
380
This creates a new empty inventory. Depending on
381
which files are selected for commit, and what is present in the
382
current tree, the new inventory is populated. inventory entries
383
which are candidates for modification have their revision set to
384
None; inventory entries that are carried over untouched have their
385
revision set to their prior value.
387
mutter("Selecting files for commit with filter %s", self.specific_files)
388
self.new_inv = Inventory()
389
for path, new_ie in self.work_inv.iter_entries():
390
file_id = new_ie.file_id
391
mutter('check %s {%s}', path, new_ie.file_id)
392
if self.specific_files:
393
if not is_inside_any(self.specific_files, path):
394
mutter('%s not selected for commit', path)
395
self._carry_entry(file_id)
398
# this is selected, ensure its parents are too.
399
parent_id = new_ie.parent_id
400
while parent_id != ROOT_ID:
401
if not self.new_inv.has_id(parent_id):
402
ie = self._select_entry(self.work_inv[parent_id])
403
mutter('%s selected for commit because of %s',
404
self.new_inv.id2path(parent_id), path)
406
ie = self.new_inv[parent_id]
407
if ie.revision is not None:
409
mutter('%s selected for commit because of %s',
410
self.new_inv.id2path(parent_id), path)
411
parent_id = ie.parent_id
412
mutter('%s selected for commit', path)
413
self._select_entry(new_ie)
415
def _select_entry(self, new_ie):
416
"""Make new_ie be considered for committing."""
422
def _carry_entry(self, file_id):
423
"""Carry the file unchanged from the basis revision."""
424
if self.basis_inv.has_id(file_id):
425
self.new_inv.add(self.basis_inv[file_id].copy())
427
def _report_deletes(self):
428
for file_id in self.basis_inv:
429
if file_id not in self.new_inv:
430
self.reporter.deleted(self.basis_inv.id2path(file_id))
432
def _gen_revision_id(config, when):
433
"""Return new revision-id."""
434
s = '%s-%s-' % (config.user_email(), compact_date(when))
435
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
