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)
198
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
202
if committer is None:
203
self.committer = bzrlib.config.username(self.branch)
205
assert isinstance(committer, basestring), type(committer)
206
self.committer = committer
209
self.timezone = local_time_offset()
211
self.timezone = int(timezone)
213
assert isinstance(message, basestring), type(message)
214
self.message = message
215
self._escape_commit_message()
217
self.branch.lock_write()
219
self.work_tree = self.branch.working_tree()
220
self.work_inv = self.work_tree.inventory
221
self.basis_tree = self.branch.basis_tree()
222
self.basis_inv = self.basis_tree.inventory
224
self._gather_parents()
225
if len(self.parents) > 1 and self.specific_files:
226
raise NotImplementedError('selected-file commit of merges is not supported yet')
227
self._check_parents_present()
229
self._remove_deleted()
230
self._populate_new_inv()
231
self._store_snapshot()
232
self._report_deletes()
234
if not (self.allow_pointless
235
or len(self.parents) > 1
236
or self.new_inv != self.basis_inv):
237
raise PointlessCommit()
239
if len(list(self.work_tree.iter_conflicts()))>0:
240
raise ConflictsInTree
242
self._record_inventory()
243
self._make_revision()
244
self.reporter.completed(self.branch.revno()+1, self.rev_id)
245
self.branch.append_revision(self.rev_id)
246
self.branch.set_pending_merges([])
250
def _record_inventory(self):
251
"""Store the inventory for the new revision."""
252
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
253
self.inv_sha1 = sha_string(inv_text)
254
s = self.branch.control_weaves
255
s.add_text('inventory', self.rev_id,
256
split_lines(inv_text), self.present_parents,
257
self.branch.get_transaction())
259
def _escape_commit_message(self):
260
"""Replace xml-incompatible control characters."""
261
# Python strings can include characters that can't be
262
# represented in well-formed XML; escape characters that
263
# aren't listed in the XML specification
264
# (http://www.w3.org/TR/REC-xml/#NT-Char).
265
if isinstance(self.message, unicode):
266
char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
268
# Use a regular 'str' as pattern to avoid having re.subn
269
# return 'unicode' results.
270
char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
271
self.message, escape_count = re.subn(
273
lambda match: match.group(0).encode('unicode_escape'),
276
self.reporter.escaped(escape_count, self.message)
278
def _gather_parents(self):
279
"""Record the parents of a merge for merge detection."""
280
pending_merges = self.branch.pending_merges()
282
self.parent_invs = []
283
self.present_parents = []
284
precursor_id = self.branch.last_revision()
286
self.parents.append(precursor_id)
287
self.parents += pending_merges
288
for revision in self.parents:
289
if self.branch.has_revision(revision):
290
self.parent_invs.append(self.branch.get_inventory(revision))
291
self.present_parents.append(revision)
293
def _check_parents_present(self):
294
for parent_id in self.parents:
295
mutter('commit parent revision {%s}', parent_id)
296
if not self.branch.has_revision(parent_id):
297
if parent_id == self.branch.last_revision():
298
warning("parent is missing %r", parent_id)
299
raise HistoryMissing(self.branch, 'revision', parent_id)
301
mutter("commit will ghost revision %r", parent_id)
303
def _make_revision(self):
304
"""Record a new revision object for this commit."""
305
self.rev = Revision(timestamp=self.timestamp,
306
timezone=self.timezone,
307
committer=self.committer,
308
message=self.message,
309
inventory_sha1=self.inv_sha1,
310
revision_id=self.rev_id,
311
properties=self.revprops)
312
self.rev.parent_ids = self.parents
314
serializer_v5.write_revision(self.rev, rev_tmp)
316
self.branch.revision_store.add(rev_tmp, self.rev_id)
317
mutter('new revision_id is {%s}', self.rev_id)
319
def _remove_deleted(self):
320
"""Remove deleted files from the working inventories.
322
This is done prior to taking the working inventory as the
323
basis for the new committed inventory.
325
This returns true if any files
326
*that existed in the basis inventory* were deleted.
327
Files that were added and deleted
328
in the working copy don't matter.
330
specific = self.specific_files
332
for path, ie in self.work_inv.iter_entries():
333
if specific and not is_inside_any(specific, path):
335
if not self.work_tree.has_filename(path):
336
self.reporter.missing(path)
337
deleted_ids.append((path, ie.file_id))
339
deleted_ids.sort(reverse=True)
340
for path, file_id in deleted_ids:
341
del self.work_inv[file_id]
342
self.branch._write_inventory(self.work_inv)
344
def _store_snapshot(self):
345
"""Pass over inventory and record a snapshot.
347
Entries get a new revision when they are modified in
348
any way, which includes a merge with a new set of
349
parents that have the same entry.
351
# XXX: Need to think more here about when the user has
352
# made a specific decision on a particular value -- c.f.
354
for path, ie in self.new_inv.iter_entries():
355
previous_entries = ie.find_previous_heads(
357
self.weave_store.get_weave_or_empty(ie.file_id,
358
self.branch.get_transaction()))
359
if ie.revision is None:
360
change = ie.snapshot(self.rev_id, path, previous_entries,
361
self.work_tree, self.weave_store,
362
self.branch.get_transaction())
365
self.reporter.snapshot_change(change, path)
367
def _populate_new_inv(self):
368
"""Build revision inventory.
370
This creates a new empty inventory. Depending on
371
which files are selected for commit, and what is present in the
372
current tree, the new inventory is populated. inventory entries
373
which are candidates for modification have their revision set to
374
None; inventory entries that are carried over untouched have their
375
revision set to their prior value.
377
mutter("Selecting files for commit with filter %s", self.specific_files)
378
self.new_inv = Inventory()
379
for path, new_ie in self.work_inv.iter_entries():
380
file_id = new_ie.file_id
381
mutter('check %s {%s}', path, new_ie.file_id)
382
if self.specific_files:
383
if not is_inside_any(self.specific_files, path):
384
mutter('%s not selected for commit', path)
385
self._carry_entry(file_id)
388
# this is selected, ensure its parents are too.
389
parent_id = new_ie.parent_id
390
while parent_id != ROOT_ID:
391
if not self.new_inv.has_id(parent_id):
392
ie = self._select_entry(self.work_inv[parent_id])
393
mutter('%s selected for commit because of %s',
394
self.new_inv.id2path(parent_id), path)
396
ie = self.new_inv[parent_id]
397
if ie.revision is not None:
399
mutter('%s selected for commit because of %s',
400
self.new_inv.id2path(parent_id), path)
401
parent_id = ie.parent_id
402
mutter('%s selected for commit', path)
403
self._select_entry(new_ie)
405
def _select_entry(self, new_ie):
406
"""Make new_ie be considered for committing."""
412
def _carry_entry(self, file_id):
413
"""Carry the file unchanged from the basis revision."""
414
if self.basis_inv.has_id(file_id):
415
self.new_inv.add(self.basis_inv[file_id].copy())
417
def _report_deletes(self):
418
for file_id in self.basis_inv:
419
if file_id not in self.new_inv:
420
self.reporter.deleted(self.basis_inv.id2path(file_id))
422
def _gen_revision_id(branch, when):
423
"""Return new revision-id."""
424
s = '%s-%s-' % (bzrlib.config.user_email(branch), compact_date(when))
425
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
