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
19
# FIXME: "bzr commit doc/format" commits doc/format.txt!
21
def commit(branch, message,
28
"""Commit working copy as a new revision.
30
The basic approach is to add all the file texts into the
31
store, then the inventory, then make a new revision pointing
32
to that inventory and store that.
34
This is not quite safe if the working copy changes during the
35
commit; for the moment that is simply not allowed. A better
36
approach is to make a temporary copy of the files before
37
computing their hashes, and then add those hashes in turn to
38
the inventory. This should mean at least that there are no
39
broken hash pointers. There is no way we can get a snapshot
40
of the whole directory at an instant. This would also have to
41
be robust against files disappearing, moving, etc. So the
42
whole thing is a bit hard.
44
timestamp -- if not None, seconds-since-epoch for a
45
postdated/predated commit.
48
If true, commit only those files.
51
If set, use this as the new revision id.
52
Useful for test or import commands that need to tightly
53
control what revisions are assigned. If you duplicate
54
a revision id that exists elsewhere it is your own fault.
55
If null (default), a time/random revision id is generated.
60
from bzrlib.osutils import local_time_offset, username
61
from bzrlib.branch import gen_file_id
62
from bzrlib.errors import BzrError
63
from bzrlib.revision import Revision, RevisionReference
64
from bzrlib.trace import mutter, note
65
from bzrlib.xml import pack_xml
70
# First walk over the working inventory; and both update that
71
# and also build a new revision inventory. The revision
72
# inventory needs to hold the text-id, sha1 and size of the
73
# actual file versions committed in the revision. (These are
74
# not present in the working inventory.) We also need to
75
# detect missing/deleted files, and remove them from the
78
work_tree = branch.working_tree()
79
work_inv = work_tree.inventory
80
basis = branch.basis_tree()
81
basis_inv = basis.inventory
84
note('looking for changes...')
86
pending_merges = branch.pending_merges()
88
missing_ids, new_inv = _gather_commit(branch,
95
for file_id in missing_ids:
96
# Any files that have been deleted are now removed from the
97
# working inventory. Files that were not selected for commit
98
# are left as they were in the working inventory and ommitted
99
# from the revision inventory.
101
# have to do this later so we don't mess up the iterator.
102
# since parents may be removed before their children we
105
# FIXME: There's probably a better way to do this; perhaps
106
# the workingtree should know how to filter itbranch.
107
if work_inv.has_id(file_id):
108
del work_inv[file_id]
112
rev_id = _gen_revision_id(time.time())
115
inv_tmp = tempfile.TemporaryFile()
116
pack_xml(new_inv, inv_tmp)
118
branch.inventory_store.add(inv_tmp, inv_id)
119
mutter('new inventory_id is {%s}' % inv_id)
121
# We could also just sha hash the inv_tmp file
122
# however, in the case that branch.inventory_store.add()
123
# ever actually does anything special
124
inv_sha1 = branch.get_inventory_sha1(inv_id)
126
branch._write_inventory(work_inv)
128
if timestamp == None:
129
timestamp = time.time()
131
if committer == None:
132
committer = username()
135
timezone = local_time_offset()
137
mutter("building commit log message")
138
rev = Revision(timestamp=timestamp,
143
inventory_sha1=inv_sha1,
147
precursor_id = branch.last_patch()
149
precursor_sha1 = branch.get_revision_sha1(precursor_id)
150
rev.parents.append(RevisionReference(precursor_id, precursor_sha1))
151
for merge_rev in pending_merges:
152
rev.parents.append(RevisionReference(merge_rev))
154
rev_tmp = tempfile.TemporaryFile()
155
pack_xml(rev, rev_tmp)
157
branch.revision_store.add(rev_tmp, rev_id)
158
mutter("new revision_id is {%s}" % rev_id)
160
## XXX: Everything up to here can simply be orphaned if we abort
161
## the commit; it will leave junk files behind but that doesn't
164
## TODO: Read back the just-generated changeset, and make sure it
165
## applies and recreates the right state.
167
## TODO: Also calculate and store the inventory SHA1
168
mutter("committing patch r%d" % (branch.revno() + 1))
170
branch.append_revision(rev_id)
172
branch.set_pending_merges([])
175
note("commited r%d" % branch.revno())
181
def _gen_revision_id(when):
182
"""Return new revision-id."""
183
from binascii import hexlify
184
from osutils import rand_bytes, compact_date, user_email
186
s = '%s-%s-' % (user_email(), compact_date(when))
187
s += hexlify(rand_bytes(8))
191
def _gather_commit(branch, work_tree, work_inv, basis_inv, specific_files,
193
"""Build inventory preparatory to commit.
195
This adds any changed files into the text store, and sets their
196
test-id, sha and size in the returned inventory appropriately.
199
Modified to hold a list of files that have been deleted from
200
the working directory; these should be removed from the
203
from bzrlib.inventory import Inventory
204
from osutils import isdir, isfile, sha_string, quotefn, \
205
local_time_offset, username, kind_marker, is_inside_any
207
from branch import gen_file_id
208
from errors import BzrError
209
from revision import Revision
210
from bzrlib.trace import mutter, note
215
for path, entry in work_inv.iter_entries():
216
## TODO: Check that the file kind has not changed from the previous
217
## revision of this file (if any).
219
p = branch.abspath(path)
220
file_id = entry.file_id
221
mutter('commit prep file %s, id %r ' % (p, file_id))
223
if specific_files and not is_inside_any(specific_files, path):
224
mutter(' skipping file excluded from commit')
225
if basis_inv.has_id(file_id):
226
# carry over with previous state
227
inv.add(basis_inv[file_id].copy())
229
# omit this from committed inventory
233
if not work_tree.has_id(file_id):
235
print('deleted %s%s' % (path, kind_marker(entry.kind)))
236
mutter(" file is missing, removing from inventory")
237
missing_ids.append(file_id)
240
# this is present in the new inventory; may be new, modified or
242
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
248
old_kind = old_ie.kind
249
if old_kind != entry.kind:
250
raise BzrError("entry %r changed kind from %r to %r"
251
% (file_id, old_kind, entry.kind))
253
if entry.kind == 'directory':
255
raise BzrError("%s is entered as directory but not a directory"
257
elif entry.kind == 'file':
259
raise BzrError("%s is entered as file but is not a file" % quotefn(p))
261
new_sha1 = work_tree.get_file_sha1(file_id)
264
and old_ie.text_sha1 == new_sha1):
265
## assert content == basis.get_file(file_id).read()
266
entry.text_id = old_ie.text_id
267
entry.text_sha1 = new_sha1
268
entry.text_size = old_ie.text_size
269
mutter(' unchanged from previous text_id {%s}' %
272
content = file(p, 'rb').read()
274
# calculate the sha again, just in case the file contents
275
# changed since we updated the cache
276
entry.text_sha1 = sha_string(content)
277
entry.text_size = len(content)
279
entry.text_id = gen_file_id(entry.name)
280
branch.text_store.add(content, entry.text_id)
281
mutter(' stored with text_id {%s}' % entry.text_id)
284
marked = path + kind_marker(entry.kind)
286
print 'added', marked
287
elif old_ie == entry:
289
elif (old_ie.name == entry.name
290
and old_ie.parent_id == entry.parent_id):
291
print 'modified', marked
293
print 'renamed', marked
295
return missing_ids, inv
added
removed
bzrlib/commit.py
