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.
156
self.any_changes = False
159
self.weave_store = branch.weave_store
161
self.specific_files = specific_files
162
self.allow_pointless = allow_pointless
164
if timestamp is None:
165
self.timestamp = time.time()
167
self.timestamp = long(timestamp)
170
self.rev_id = _gen_revision_id(self.branch, self.timestamp)
174
if committer is None:
175
self.committer = username(self.branch)
177
assert isinstance(committer, basestring), type(committer)
178
self.committer = committer
181
self.timezone = local_time_offset()
183
self.timezone = int(timezone)
185
assert isinstance(message, basestring), type(message)
186
self.message = message
188
self.branch.lock_write()
190
self.work_tree = self.branch.working_tree()
191
self.work_inv = self.work_tree.inventory
192
self.basis_tree = self.branch.basis_tree()
193
self.basis_inv = self.basis_tree.inventory
195
self._gather_parents()
197
self.new_inv = Inventory()
199
self._report_deletes()
201
if not (self.allow_pointless
202
or len(self.parents) != 1
203
or self.new_inv != self.basis_inv):
204
raise PointlessCommit()
206
self._record_inventory()
207
self._record_ancestry()
208
self._make_revision()
209
note('committted r%d {%s}', (self.branch.revno() + 1),
211
self.branch.append_revision(self.rev_id)
212
self.branch.set_pending_merges([])
218
def _record_inventory(self):
219
"""Store the inventory for the new revision."""
220
inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
221
self.inv_sha1 = sha_string(inv_text)
222
self.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
223
split_lines(inv_text), self.parents)
226
def _record_ancestry(self):
227
"""Append merged revision ancestry to the ancestry file."""
228
w = self.weave_store.get_weave_or_empty(ANCESTRY_FILEID)
230
lines = w.get(w.lookup(self.parents[0]))
233
lines.append(self.rev_id + '\n')
234
parent_idxs = map(w.lookup, self.parents)
235
w.add(self.rev_id, parent_idxs, lines)
236
self.weave_store.put_weave(ANCESTRY_FILEID, w)
239
def _gather_parents(self):
240
pending_merges = self.branch.pending_merges()
242
precursor_id = self.branch.last_revision()
244
self.parents.append(precursor_id)
245
self.parents += pending_merges
246
self.parent_trees = map(self.branch.revision_tree, self.parents)
249
def _make_revision(self):
250
"""Record a new revision object for this commit."""
251
self.rev = Revision(timestamp=self.timestamp,
252
timezone=self.timezone,
253
committer=self.committer,
254
message=self.message,
255
inventory_sha1=self.inv_sha1,
256
revision_id=self.rev_id)
257
self.rev.parents = map(RevisionReference, self.parents)
259
serializer_v5.write_revision(self.rev, rev_tmp)
261
self.branch.revision_store.add(rev_tmp, self.rev_id)
262
mutter('new revision_id is {%s}', self.rev_id)
265
def _remove_deleted(self):
266
"""Remove deleted files from the working inventories.
268
This is done prior to taking the working inventory as the
269
basis for the new committed inventory.
271
This returns true if any files
272
*that existed in the basis inventory* were deleted.
273
Files that were added and deleted
274
in the working copy don't matter.
277
for file_id in list(iter(self.work_inv)): # snapshot for deletion
278
if not self.work_tree.has_id(file_id):
279
note('missing %s', self.work_inv.id2path(file_id))
280
del self.work_inv[file_id]
283
self.branch._write_inventory(self.work_inv)
286
def _find_file_parents(self, file_id):
287
"""Return the text versions and hashes for all file parents.
289
Returned as a map from text version to text sha1.
291
This is a set containing the file versions in all parents
292
revisions containing the file. If the file is new, the set
295
for tree in self.parent_trees:
296
if file_id in tree.inventory:
297
ie = tree.inventory[file_id]
298
assert ie.kind == 'file'
299
assert ie.file_id == file_id
300
if ie.text_version in r:
301
assert r[ie.text_version] == ie.text_sha1
303
r[ie.text_version] = ie.text_sha1
307
def _store_files(self):
308
"""Store new texts of modified/added files.
310
This is called with new_inv set to a copy of the working
311
inventory, with deleted/removed files already cut out. So
312
this code only needs to deal with setting text versions, and
313
possibly recording new file texts."""
314
for path, new_ie in self.work_inv.iter_entries():
315
file_id = new_ie.file_id
316
mutter('check %s {%s}', path, new_ie.file_id)
317
if self.specific_files:
318
if not is_inside_any(self.specific_files, path):
319
mutter('%s not selected for commit', path)
320
self._carry_file(file_id)
322
if new_ie.kind != 'file':
323
self._commit_nonfile(file_id)
325
file_parents = self._find_file_parents(file_id)
326
wc_sha1 = self.work_tree.get_file_sha1(file_id)
327
if (len(file_parents) == 1
328
and file_parents.values()[0] == wc_sha1):
329
# not changed or merged
330
self._carry_file(file_id)
333
mutter('parents of %s are %r', path, file_parents)
335
# file is either new, or a file merge; need to record
337
if len(file_parents) > 1:
338
note('merged %s', path)
339
elif len(file_parents) == 0:
340
note('added %s', path)
342
note('modified %s', path)
343
self._commit_file(new_ie, file_id, file_parents)
346
def _commit_nonfile(self, file_id):
347
self.new_inv.add(self.work_inv[file_id].copy())
350
def _carry_file(self, file_id):
351
"""Keep a file in the same state as in the basis."""
352
if self.basis_inv.has_id(file_id):
353
self.new_inv.add(self.basis_inv[file_id].copy())
356
def _report_deletes(self):
357
for file_id in self.basis_inv:
358
if file_id not in self.new_inv:
359
note('deleted %s', self.basis_inv.id2path(file_id))
362
def _commit_file(self, new_ie, file_id, file_parents):
363
mutter('store new text for {%s} in revision {%s}',
364
file_id, self.rev_id)
365
new_lines = self.work_tree.get_file(file_id).readlines()
366
self._add_text_to_weave(file_id, new_lines, file_parents)
367
new_ie.text_version = self.rev_id
368
new_ie.text_sha1 = sha_strings(new_lines)
369
new_ie.text_size = sum(map(len, new_lines))
370
self.new_inv.add(new_ie)
373
def _add_text_to_weave(self, file_id, new_lines, parents):
374
if file_id.startswith('__'):
375
raise ValueError('illegal file-id %r for text file' % file_id)
376
self.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
379
def _gen_revision_id(branch, when):
380
"""Return new revision-id."""
381
s = '%s-%s-' % (user_email(branch), compact_date(when))
382
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
