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
from bzrlib.revision import Revision
81
from bzrlib.trace import mutter, note, warning
82
from bzrlib.xml5 import serializer_v5
83
from bzrlib.inventory import Inventory, ROOT_ID
84
from bzrlib.weave import Weave
85
from bzrlib.weavefile import read_weave, write_weave_v5
86
from bzrlib.atomicfile import AtomicFile
89
def commit(*args, **kwargs):
90
"""Commit a new revision to a branch.
92
Function-style interface for convenience of old callers.
94
New code should use the Commit class instead.
96
## XXX: Remove this in favor of Branch.commit?
97
Commit().commit(*args, **kwargs)
100
class NullCommitReporter(object):
101
"""I report on progress of a commit."""
103
def snapshot_change(self, change, path):
106
def completed(self, revno, rev_id):
109
def deleted(self, file_id):
112
def escaped(self, escape_count, message):
115
def missing(self, path):
118
class ReportCommitToLog(NullCommitReporter):
120
def snapshot_change(self, change, path):
121
note("%s %s", change, path)
123
def completed(self, revno, rev_id):
124
note('committed r%d {%s}', revno, rev_id)
126
def deleted(self, file_id):
127
note('deleted %s', file_id)
129
def escaped(self, escape_count, message):
130
note("replaced %d control characters in message", escape_count)
132
def missing(self, path):
133
note('missing %s', path)
135
class Commit(object):
136
"""Task of committing a new revision.
138
This is a MethodObject: it accumulates state as the commit is
139
prepared, and then it is discarded. It doesn't represent
140
historical revisions, just the act of recording a new one.
143
Modified to hold a list of files that have been deleted from
144
the working directory; these should be removed from the
149
if reporter is not None:
150
self.reporter = reporter
152
self.reporter = NullCommitReporter()
162
allow_pointless=True,
165
"""Commit working copy as a new revision.
167
timestamp -- if not None, seconds-since-epoch for a
168
postdated/predated commit.
170
specific_files -- If true, commit only those files.
172
rev_id -- If set, use this as the new revision id.
173
Useful for test or import commands that need to tightly
174
control what revisions are assigned. If you duplicate
175
a revision id that exists elsewhere it is your own fault.
176
If null (default), a time/random revision id is generated.
178
allow_pointless -- If true (default), commit even if nothing
179
has changed and no merges are recorded.
181
revprops -- Properties for new revision
183
mutter('preparing to commit')
186
self.weave_store = branch.weave_store
188
self.specific_files = specific_files
189
self.allow_pointless = allow_pointless
190
self.revprops = revprops
192
if timestamp is None:
193
self.timestamp = time.time()
195
self.timestamp = long(timestamp)
197
config = bzrlib.config.BranchConfig(self.branch)
199
self.rev_id = _gen_revision_id(config, self.timestamp)
203
if committer is None:
204
self.committer = config.username()
206
assert isinstance(committer, basestring), type(committer)
207
self.committer = committer
210
self.timezone = local_time_offset()
212
self.timezone = int(timezone)
214
assert isinstance(message, basestring), type(message)
215
self.message = message
216
self._escape_commit_message()
218
self.branch.lock_write()
220
self.work_tree = self.branch.working_tree()
221
self.work_inv = self.work_tree.inventory
222
self.basis_tree = self.branch.basis_tree()
223
self.basis_inv = self.basis_tree.inventory
225
self._gather_parents()
226
if len(self.parents) > 1 and self.specific_files:
227
raise NotImplementedError('selected-file commit of merges is not supported yet')
228
self._check_parents_present()
230
self._remove_deleted()
231
self._populate_new_inv()
232
self._store_snapshot()
233
self._report_deletes()
235
if not (self.allow_pointless
236
or len(self.parents) > 1
237
or self.new_inv != self.basis_inv):
238
raise PointlessCommit()
240
if len(list(self.work_tree.iter_conflicts()))>0:
241
raise ConflictsInTree
243
self._record_inventory()
244
self._make_revision()
245
self.reporter.completed(self.branch.revno()+1, self.rev_id)
246
self.branch.append_revision(self.rev_id)
247
self.branch.set_pending_merges([])
251
def _record_inventory(self):
252
"""Store the inventory for the new revision."""
253
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
254
self.inv_sha1 = sha_string(inv_text)
255
s = self.branch.control_weaves
256
s.add_text('inventory', self.rev_id,
257
split_lines(inv_text), self.present_parents,
258
self.branch.get_transaction())
260
def _escape_commit_message(self):
261
"""Replace xml-incompatible control characters."""
262
# Python strings can include characters that can't be
263
# represented in well-formed XML; escape characters that
264
# aren't listed in the XML specification
265
# (http://www.w3.org/TR/REC-xml/#NT-Char).
266
if isinstance(self.message, unicode):
267
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
269
# Use a regular 'str' as pattern to avoid having re.subn
270
# return 'unicode' results.
271
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
272
self.message, escape_count = re.subn(
274
lambda match: match.group(0).encode('unicode_escape'),
277
self.reporter.escaped(escape_count, self.message)
279
def _gather_parents(self):
280
"""Record the parents of a merge for merge detection."""
281
pending_merges = self.branch.pending_merges()
283
self.parent_invs = []
284
self.present_parents = []
285
precursor_id = self.branch.last_revision()
287
self.parents.append(precursor_id)
288
self.parents += pending_merges
289
for revision in self.parents:
290
if self.branch.has_revision(revision):
291
self.parent_invs.append(self.branch.get_inventory(revision))
292
self.present_parents.append(revision)
294
def _check_parents_present(self):
295
for parent_id in self.parents:
296
mutter('commit parent revision {%s}', parent_id)
297
if not self.branch.has_revision(parent_id):
298
if parent_id == self.branch.last_revision():
299
warning("parent is missing %r", parent_id)
300
raise HistoryMissing(self.branch, 'revision', parent_id)
302
mutter("commit will ghost revision %r", parent_id)
304
def _make_revision(self):
305
"""Record a new revision object for this commit."""
306
self.rev = Revision(timestamp=self.timestamp,
307
timezone=self.timezone,
308
committer=self.committer,
309
message=self.message,
310
inventory_sha1=self.inv_sha1,
311
revision_id=self.rev_id,
312
properties=self.revprops)
313
self.rev.parent_ids = self.parents
315
serializer_v5.write_revision(self.rev, rev_tmp)
317
self.branch.revision_store.add(rev_tmp, self.rev_id)
318
mutter('new revision_id is {%s}', self.rev_id)
320
def _remove_deleted(self):
321
"""Remove deleted files from the working inventories.
323
This is done prior to taking the working inventory as the
324
basis for the new committed inventory.
326
This returns true if any files
327
*that existed in the basis inventory* were deleted.
328
Files that were added and deleted
329
in the working copy don't matter.
331
specific = self.specific_files
333
for path, ie in self.work_inv.iter_entries():
334
if specific and not is_inside_any(specific, path):
336
if not self.work_tree.has_filename(path):
337
self.reporter.missing(path)
338
deleted_ids.append((path, ie.file_id))
340
deleted_ids.sort(reverse=True)
341
for path, file_id in deleted_ids:
342
del self.work_inv[file_id]
343
self.branch._write_inventory(self.work_inv)
345
def _store_snapshot(self):
346
"""Pass over inventory and record a snapshot.
348
Entries get a new revision when they are modified in
349
any way, which includes a merge with a new set of
350
parents that have the same entry.
352
# XXX: Need to think more here about when the user has
353
# made a specific decision on a particular value -- c.f.
355
for path, ie in self.new_inv.iter_entries():
356
previous_entries = ie.find_previous_heads(
358
self.weave_store.get_weave_or_empty(ie.file_id,
359
self.branch.get_transaction()))
360
if ie.revision is None:
361
change = ie.snapshot(self.rev_id, path, previous_entries,
362
self.work_tree, self.weave_store,
363
self.branch.get_transaction())
366
self.reporter.snapshot_change(change, path)
368
def _populate_new_inv(self):
369
"""Build revision inventory.
371
This creates a new empty inventory. Depending on
372
which files are selected for commit, and what is present in the
373
current tree, the new inventory is populated. inventory entries
374
which are candidates for modification have their revision set to
375
None; inventory entries that are carried over untouched have their
376
revision set to their prior value.
378
mutter("Selecting files for commit with filter %s", self.specific_files)
379
self.new_inv = Inventory()
380
for path, new_ie in self.work_inv.iter_entries():
381
file_id = new_ie.file_id
382
mutter('check %s {%s}', path, new_ie.file_id)
383
if self.specific_files:
384
if not is_inside_any(self.specific_files, path):
385
mutter('%s not selected for commit', path)
386
self._carry_entry(file_id)
389
# this is selected, ensure its parents are too.
390
parent_id = new_ie.parent_id
391
while parent_id != ROOT_ID:
392
if not self.new_inv.has_id(parent_id):
393
ie = self._select_entry(self.work_inv[parent_id])
394
mutter('%s selected for commit because of %s',
395
self.new_inv.id2path(parent_id), path)
397
ie = self.new_inv[parent_id]
398
if ie.revision is not None:
400
mutter('%s selected for commit because of %s',
401
self.new_inv.id2path(parent_id), path)
402
parent_id = ie.parent_id
403
mutter('%s selected for commit', path)
404
self._select_entry(new_ie)
406
def _select_entry(self, new_ie):
407
"""Make new_ie be considered for committing."""
413
def _carry_entry(self, file_id):
414
"""Carry the file unchanged from the basis revision."""
415
if self.basis_inv.has_id(file_id):
416
self.new_inv.add(self.basis_inv[file_id].copy())
418
def _report_deletes(self):
419
for file_id in self.basis_inv:
420
if file_id not in self.new_inv:
421
self.reporter.deleted(self.basis_inv.id2path(file_id))
423
def _gen_revision_id(config, when):
424
"""Return new revision-id."""
425
s = '%s-%s-' % (config.user_email(), compact_date(when))
426
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
