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
# This code requires all merge parents to be present in the branch.
48
# We could relax this but for the sake of simplicity the constraint is
49
# here for now. It's not totally clear to me how we'd know which file
50
# need new text versions if some parents are absent. -- mbp 20050915
52
# TODO: Rather than mashing together the ancestry and storing it back,
53
# perhaps the weave should have single method which does it all in one
54
# go, avoiding a lot of redundant work.
56
# TODO: Perhaps give a warning if one of the revisions marked as
57
# merged is already in the ancestry, and then don't record it as a
60
# TODO: If the file is newly merged but unchanged from the version it
61
# merges from, then it should still be reported as newly added
62
# relative to the basis revision.
71
from binascii import hexlify
72
from cStringIO import StringIO
74
from bzrlib.osutils import (local_time_offset, username,
75
rand_bytes, compact_date, user_email,
76
kind_marker, is_inside_any, quotefn,
77
sha_string, sha_strings, sha_file, isdir, isfile,
79
from bzrlib.branch import gen_file_id
80
from bzrlib.errors import (BzrError, PointlessCommit,
84
from bzrlib.revision import Revision
85
from bzrlib.trace import mutter, note, warning
86
from bzrlib.xml5 import serializer_v5
87
from bzrlib.inventory import Inventory
88
from bzrlib.weave import Weave
89
from bzrlib.weavefile import read_weave, write_weave_v5
90
from bzrlib.atomicfile import AtomicFile
93
def commit(*args, **kwargs):
94
"""Commit a new revision to a branch.
96
Function-style interface for convenience of old callers.
98
New code should use the Commit class instead.
100
## XXX: Remove this in favor of Branch.commit?
101
Commit().commit(*args, **kwargs)
104
class NullCommitReporter(object):
105
"""I report on progress of a commit."""
106
def added(self, path):
109
def removed(self, path):
112
def renamed(self, old_path, new_path):
116
class ReportCommitToLog(NullCommitReporter):
117
def added(self, path):
118
note('added %s', path)
120
def removed(self, path):
121
note('removed %s', path)
123
def renamed(self, old_path, new_path):
124
note('renamed %s => %s', old_path, new_path)
127
class Commit(object):
128
"""Task of committing a new revision.
130
This is a MethodObject: it accumulates state as the commit is
131
prepared, and then it is discarded. It doesn't represent
132
historical revisions, just the act of recording a new one.
135
Modified to hold a list of files that have been deleted from
136
the working directory; these should be removed from the
141
if reporter is not None:
142
self.reporter = reporter
144
self.reporter = NullCommitReporter()
154
allow_pointless=True,
156
"""Commit working copy as a new revision.
158
timestamp -- if not None, seconds-since-epoch for a
159
postdated/predated commit.
161
specific_files -- If true, commit only those files.
163
rev_id -- If set, use this as the new revision id.
164
Useful for test or import commands that need to tightly
165
control what revisions are assigned. If you duplicate
166
a revision id that exists elsewhere it is your own fault.
167
If null (default), a time/random revision id is generated.
169
allow_pointless -- If true (default), commit even if nothing
170
has changed and no merges are recorded.
172
mutter('preparing to commit')
175
self.weave_store = branch.weave_store
177
self.specific_files = specific_files
178
self.allow_pointless = allow_pointless
180
if timestamp is None:
181
self.timestamp = time.time()
183
self.timestamp = long(timestamp)
186
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
190
if committer is None:
191
self.committer = username(self.branch)
193
assert isinstance(committer, basestring), type(committer)
194
self.committer = committer
197
self.timezone = local_time_offset()
199
self.timezone = int(timezone)
201
assert isinstance(message, basestring), type(message)
202
self.message = message
203
self._escape_commit_message()
205
self.branch.lock_write()
207
self.work_tree = self.branch.working_tree()
208
self.work_inv = self.work_tree.inventory
209
self.basis_tree = self.branch.basis_tree()
210
self.basis_inv = self.basis_tree.inventory
212
self._gather_parents()
213
if len(self.parents) > 1 and self.specific_files:
214
raise NotImplementedError('selected-file commit of merges is not supported yet')
215
self._check_parents_present()
217
self._remove_deleted()
218
self._populate_new_inv()
219
self._store_snapshot()
220
self._report_deletes()
222
if not (self.allow_pointless
223
or len(self.parents) > 1
224
or self.new_inv != self.basis_inv):
225
raise PointlessCommit()
227
if len(list(self.work_tree.iter_conflicts()))>0:
228
raise ConflictsInTree
230
self._record_inventory()
231
self._record_ancestry()
232
self._make_revision()
233
note('committed r%d {%s}', (self.branch.revno() + 1),
235
self.branch.append_revision(self.rev_id)
236
self.branch.set_pending_merges([])
240
def _record_inventory(self):
241
"""Store the inventory for the new revision."""
242
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
243
self.inv_sha1 = sha_string(inv_text)
244
s = self.branch.control_weaves
245
s.add_text('inventory', self.rev_id,
246
split_lines(inv_text), self.present_parents)
248
def _escape_commit_message(self):
249
"""Replace xml-incompatible control characters."""
250
# Python strings can include characters that can't be
251
# represented in well-formed XML; escape characters that
252
# aren't listed in the XML specification
253
# (http://www.w3.org/TR/REC-xml/#NT-Char).
254
if isinstance(self.message, unicode):
255
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
257
# Use a regular 'str' as pattern to avoid having re.subn
258
# return 'unicode' results.
259
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
260
self.message, escape_count = re.subn(
262
lambda match: match.group(0).encode('unicode_escape'),
265
note("replaced %d control characters in message", escape_count)
267
def _record_ancestry(self):
268
"""Append merged revision ancestry to the ancestry file.
270
This should be the merged ancestry of all parents, plus the
272
s = self.branch.control_weaves
273
w = s.get_weave_or_empty('ancestry')
274
lines = self._make_ancestry(w)
275
w.add(self.rev_id, self.present_parents, lines)
276
s.put_weave('ancestry', w)
278
def _make_ancestry(self, ancestry_weave):
279
"""Return merged ancestry lines.
281
The lines are revision-ids followed by newlines."""
282
parent_ancestries = [ancestry_weave.get(p) for p in self.present_parents]
283
new_lines = merge_ancestry_lines(self.rev_id, parent_ancestries)
284
mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(new_lines))
287
def _gather_parents(self):
288
"""Record the parents of a merge for merge detection."""
289
pending_merges = self.branch.pending_merges()
291
self.parent_trees = []
292
self.present_parents = []
293
precursor_id = self.branch.last_revision()
295
self.parents.append(precursor_id)
296
self.parents += pending_merges
297
for revision in self.parents:
298
if self.branch.has_revision(revision):
299
self.parent_trees.append(self.branch.revision_tree(revision))
300
self.present_parents.append(revision)
302
def _check_parents_present(self):
303
for parent_id in self.parents:
304
mutter('commit parent revision {%s}', parent_id)
305
if not self.branch.has_revision(parent_id):
306
if parent_id == self.branch.last_revision():
307
warning("parent is pissing %r", parent_id)
308
raise HistoryMissing(self.branch, 'revision', parent_id)
310
mutter("commit will ghost revision %r", parent_id)
312
def _make_revision(self):
313
"""Record a new revision object for this commit."""
314
self.rev = Revision(timestamp=self.timestamp,
315
timezone=self.timezone,
316
committer=self.committer,
317
message=self.message,
318
inventory_sha1=self.inv_sha1,
319
revision_id=self.rev_id)
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
mutter('new revision_id is {%s}', self.rev_id)
328
def _remove_deleted(self):
329
"""Remove deleted files from the working inventories.
331
This is done prior to taking the working inventory as the
332
basis for the new committed inventory.
334
This returns true if any files
335
*that existed in the basis inventory* were deleted.
336
Files that were added and deleted
337
in the working copy don't matter.
339
specific = self.specific_files
341
for path, ie in self.work_inv.iter_entries():
342
if specific and not is_inside_any(specific, path):
344
if not self.work_tree.has_filename(path):
345
note('missing %s', path)
346
deleted_ids.append((path, ie.file_id))
348
deleted_ids.sort(reverse=True)
349
for path, file_id in deleted_ids:
350
del self.work_inv[file_id]
351
self.branch._write_inventory(self.work_inv)
354
def _find_entry_parents(self, file_id):
355
"""Return the text versions and hashes for all file parents.
357
Returned as a map from text version to inventory entry.
359
This is a set containing the file versions in all parents
360
revisions containing the file. If the file is new, the set
363
for tree in self.parent_trees:
364
if file_id in tree.inventory:
365
ie = tree.inventory[file_id]
366
assert ie.file_id == file_id
368
assert r[ie.revision] == ie
373
def _store_snapshot(self):
374
"""Pass over inventory and record a snapshot.
376
Entries get a new revision when they are modified in
377
any way, which includes a merge with a new set of
378
parents that have the same entry. Currently we do not
379
check for that set being ancestors of each other - and
380
we should - only parallel children should count for this
381
test see find_entry_parents to correct this. FIXME <---
382
I.e. if we are merging in revision FOO, and our
383
copy of file id BAR is identical to FOO.BAR, we should
384
generate a new revision of BAR IF and only IF FOO is
385
neither a child of our current tip, nor an ancestor of
386
our tip. The presence of FOO in our store should not
387
affect this logic UNLESS we are doing a merge of FOO,
390
# XXX: Need to think more here about when the user has
391
# made a specific decision on a particular value -- c.f.
393
for path, ie in self.new_inv.iter_entries():
394
previous_entries = self._find_entry_parents(ie. file_id)
395
if ie.revision is None:
396
change = ie.snapshot(self.rev_id, path, previous_entries,
397
self.work_tree, self.weave_store)
400
note("%s %s", change, path)
402
def _populate_new_inv(self):
403
"""Build revision inventory.
405
This creates a new empty inventory. Depending on
406
which files are selected for commit, and what is present in the
407
current tree, the new inventory is populated. inventory entries
408
which are candidates for modification have their revision set to
409
None; inventory entries that are carried over untouched have their
410
revision set to their prior value.
412
mutter("Selecting files for commit with filter %s", self.specific_files)
413
self.new_inv = Inventory()
414
for path, new_ie in self.work_inv.iter_entries():
415
file_id = new_ie.file_id
416
mutter('check %s {%s}', path, new_ie.file_id)
417
if self.specific_files:
418
if not is_inside_any(self.specific_files, path):
419
mutter('%s not selected for commit', path)
420
self._carry_file(file_id)
422
mutter('%s selected for commit', path)
427
def _carry_file(self, file_id):
428
"""Carry the file unchanged from the basis revision."""
429
if self.basis_inv.has_id(file_id):
430
self.new_inv.add(self.basis_inv[file_id].copy())
432
def _report_deletes(self):
433
for file_id in self.basis_inv:
434
if file_id not in self.new_inv:
435
note('deleted %s', self.basis_inv.id2path(file_id))
439
def _gen_revision_id(branch, when):
440
"""Return new revision-id."""
441
s = '%s-%s-' % (user_email(branch), compact_date(when))
442
s += hexlify(rand_bytes(8))
448
def merge_ancestry_lines(rev_id, ancestries):
449
"""Return merged ancestry lines.
451
rev_id -- id of the new revision
453
ancestries -- a sequence of ancestries for parent revisions,
454
as newline-terminated line lists.
456
if len(ancestries) == 0:
457
return [rev_id + '\n']
458
seen = set(ancestries[0])
459
ancs = ancestries[0][:]
460
for parent_ancestry in ancestries[1:]:
461
for line in parent_ancestry:
462
assert line[-1] == '\n'
added
removed
bzrlib/commit.py
