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
54
from binascii import hexlify
55
from cStringIO import StringIO
57
from bzrlib.osutils import (local_time_offset, username,
58
rand_bytes, compact_date, user_email,
59
kind_marker, is_inside_any, quotefn,
60
sha_string, sha_strings, sha_file, isdir, isfile,
62
from bzrlib.branch import gen_file_id, INVENTORY_FILEID, ANCESTRY_FILEID
63
from bzrlib.errors import BzrError, PointlessCommit
64
from bzrlib.revision import Revision, RevisionReference
65
from bzrlib.trace import mutter, note
66
from bzrlib.xml5 import serializer_v5
67
from bzrlib.inventory import Inventory
68
from bzrlib.weave import Weave
69
from bzrlib.weavefile import read_weave, write_weave_v5
70
from bzrlib.atomicfile import AtomicFile
73
def commit(*args, **kwargs):
74
"""Commit a new revision to a branch.
76
Function-style interface for convenience of old callers.
78
New code should use the Commit class instead.
80
Commit().commit(*args, **kwargs)
83
class NullCommitReporter(object):
84
"""I report on progress of a commit."""
85
def added(self, path):
88
def removed(self, path):
91
def renamed(self, old_path, new_path):
95
class ReportCommitToLog(NullCommitReporter):
96
def added(self, path):
97
note('added %s', path)
99
def removed(self, path):
100
note('removed %s', path)
102
def renamed(self, old_path, new_path):
103
note('renamed %s => %s', old_path, new_path)
106
class Commit(object):
107
"""Task of committing a new revision.
109
This is a MethodObject: it accumulates state as the commit is
110
prepared, and then it is discarded. It doesn't represent
111
historical revisions, just the act of recording a new one.
114
Modified to hold a list of files that have been deleted from
115
the working directory; these should be removed from the
120
if reporter is not None:
121
self.reporter = reporter
123
self.reporter = NullCommitReporter()
133
allow_pointless=True):
134
"""Commit working copy as a new revision.
136
The basic approach is to add all the file texts into the
137
store, then the inventory, then make a new revision pointing
138
to that inventory and store that.
140
This raises PointlessCommit if there are no changes, no new merges,
141
and allow_pointless is false.
143
timestamp -- if not None, seconds-since-epoch for a
144
postdated/predated commit.
147
If true, commit only those files.
150
If set, use this as the new revision id.
151
Useful for test or import commands that need to tightly
152
control what revisions are assigned. If you duplicate
153
a revision id that exists elsewhere it is your own fault.
154
If null (default), a time/random revision id is generated.
158
self.weave_store = branch.weave_store
160
self.specific_files = specific_files
161
self.allow_pointless = allow_pointless
163
if timestamp is None:
164
self.timestamp = time.time()
166
self.timestamp = long(timestamp)
169
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
173
if committer is None:
174
self.committer = username(self.branch)
176
assert isinstance(committer, basestring), type(committer)
177
self.committer = committer
180
self.timezone = local_time_offset()
182
self.timezone = int(timezone)
184
assert isinstance(message, basestring), type(message)
185
self.message = message
187
self.branch.lock_write()
189
self.work_tree = self.branch.working_tree()
190
self.work_inv = self.work_tree.inventory
191
self.basis_tree = self.branch.basis_tree()
192
self.basis_inv = self.basis_tree.inventory
194
self._gather_parents()
196
any_deletions = self._remove_deleted()
197
self.new_inv = self.work_inv.copy()
198
any_changes = self._store_files()
199
self._report_deletes()
201
# TODO: update hashcache
202
if not (self.allow_pointless
205
or len(self.parents) != 1):
206
raise PointlessCommit()
209
self.branch._write_inventory(self.work_inv)
210
self._record_inventory()
211
self._record_ancestry()
212
self._make_revision()
213
note('committted r%d {%s}', (self.branch.revno() + 1),
215
self.branch.append_revision(self.rev_id)
216
self.branch.set_pending_merges([])
222
def _record_inventory(self):
223
"""Store the inventory for the new revision."""
224
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
225
self.inv_sha1 = sha_string(inv_text)
226
self.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
227
split_lines(inv_text), self.parents)
230
def _record_ancestry(self):
231
"""Append merged revision ancestry to the ancestry file."""
232
w = self.weave_store.get_weave_or_empty(ANCESTRY_FILEID)
234
lines = w.get(w.lookup(self.parents[0]))
237
lines.append(self.rev_id + '\n')
238
parent_idxs = map(w.lookup, self.parents)
239
w.add(self.rev_id, parent_idxs, lines)
240
self.weave_store.put_weave(ANCESTRY_FILEID, w)
243
def _gather_parents(self):
244
pending_merges = self.branch.pending_merges()
246
precursor_id = self.branch.last_revision()
248
self.parents.append(precursor_id)
249
self.parents += pending_merges
250
self.parent_trees = map(self.branch.revision_tree, self.parents)
253
def _make_revision(self):
254
"""Record a new revision object for this commit."""
255
self.rev = Revision(timestamp=self.timestamp,
256
timezone=self.timezone,
257
committer=self.committer,
258
message=self.message,
259
inventory_sha1=self.inv_sha1,
260
revision_id=self.rev_id)
261
self.rev.parents = map(RevisionReference, self.parents)
263
serializer_v5.write_revision(self.rev, rev_tmp)
265
self.branch.revision_store.add(rev_tmp, self.rev_id)
266
mutter('new revision_id is {%s}', self.rev_id)
269
def _remove_deleted(self):
270
"""Remove deleted files from the working inventories.
272
This is done prior to taking the working inventory as the
273
basis for the new committed inventory.
275
This returns true if any files
276
*that existed in the basis inventory* were deleted.
277
Files that were added and deleted
278
in the working copy don't matter.
281
for file_id in list(iter(self.work_inv)): # snapshot for deletion
282
if not self.work_tree.has_id(file_id):
283
note('missing %s', self.work_inv.id2path(file_id))
284
del self.work_inv[file_id]
285
if self.basis_inv.has_id(file_id):
290
def _find_file_parents(self, file_id):
291
"""Return the text versions and hashes for all file parents.
293
Returned as a map from text version to text sha1.
295
This is a set containing the file versions in all parents
296
revisions containing the file. If the file is new, the set
299
for tree in self.parent_trees:
300
if file_id in tree.inventory:
301
ie = tree.inventory[file_id]
302
assert ie.kind == 'file'
303
assert ie.file_id == file_id
304
if ie.text_version in r:
305
assert r[ie.text_version] == ie.text_sha1
307
r[ie.text_version] = ie.text_sha1
311
def _store_files(self):
312
"""Store new texts of modified/added files.
314
This is called with new_inv set to a copy of the working
315
inventory, with deleted/removed files already cut out. So
316
this code only needs to deal with setting text versions, and
317
possibly recording new file texts."""
319
for path, new_ie in self.new_inv.iter_entries():
320
if self.specific_files:
321
if not is_inside_any(self.specific_files, path):
324
mutter('check %s {%s}', path, new_ie.file_id)
325
if new_ie.kind != 'file':
326
# only regular files have texts to update
328
file_id = new_ie.file_id
329
file_parents = self._find_file_parents(file_id)
330
wc_sha1 = self.work_tree.get_file_sha1(file_id)
331
wc_len = self.work_tree.get_file_size(file_id)
332
if (len(file_parents) == 1
333
and file_parents.values()[0] == wc_sha1):
334
# same as the single previous version, can reuse that
335
text_version = file_parents.keys()[0]
337
# file is either new, or a file merge; need to record
339
if len(file_parents) > 1:
340
note('merged %s', path)
341
elif len(file_parents) == 0:
342
note('added %s', path)
344
note('modified %s', path)
345
self._store_text(file_id, file_parents)
346
text_version = self.rev_id
348
new_ie.text_version = text_version
349
new_ie.text_sha1 = wc_sha1
350
new_ie.text_size = wc_len
354
def _report_deletes(self):
355
for file_id in self.basis_inv:
356
if file_id not in self.new_inv:
357
note('deleted %s', self.basis_inv.id2path(file_id))
360
def _store_text(self, file_id, file_parents):
361
mutter('store new text for {%s} in revision {%s}',
362
file_id, self.rev_id)
363
new_lines = self.work_tree.get_file(file_id).readlines()
364
self._add_text_to_weave(file_id, new_lines, file_parents)
367
def _add_text_to_weave(self, file_id, new_lines, parents):
368
if file_id.startswith('__'):
369
raise ValueError('illegal file-id %r for text file' % file_id)
370
self.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
373
def _gen_revision_id(branch, when):
374
"""Return new revision-id."""
375
s = '%s-%s-' % (user_email(branch), compact_date(when))
376
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
