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
def commit(branch, message, timestamp=None, timezone=None,
24
"""Commit working copy as a new revision.
26
The basic approach is to add all the file texts into the
27
store, then the inventory, then make a new revision pointing
28
to that inventory and store that.
30
This is not quite safe if the working copy changes during the
31
commit; for the moment that is simply not allowed. A better
32
approach is to make a temporary copy of the files before
33
computing their hashes, and then add those hashes in turn to
34
the inventory. This should mean at least that there are no
35
broken hash pointers. There is no way we can get a snapshot
36
of the whole directory at an instant. This would also have to
37
be robust against files disappearing, moving, etc. So the
38
whole thing is a bit hard.
40
timestamp -- if not None, seconds-since-epoch for a
41
postdated/predated commit.
44
If true, commit only those files.
47
import os, time, tempfile
49
from inventory import Inventory
50
from osutils import isdir, isfile, sha_string, quotefn, \
51
local_time_offset, username, kind_marker, is_inside_any
53
from branch import gen_file_id
54
from errors import BzrError
55
from revision import Revision
56
from trace import mutter, note
58
branch._need_writelock()
60
## TODO: Show branch names
62
# TODO: Don't commit if there are no changes, unless forced?
64
# First walk over the working inventory; and both update that
65
# and also build a new revision inventory. The revision
66
# inventory needs to hold the text-id, sha1 and size of the
67
# actual file versions committed in the revision. (These are
68
# not present in the working inventory.) We also need to
69
# detect missing/deleted files, and remove them from the
72
work_tree = branch.working_tree()
73
work_inv = work_tree.inventory
75
basis = branch.basis_tree()
76
basis_inv = basis.inventory
80
note('looking for changes...')
82
for path, entry in work_inv.iter_entries():
83
## TODO: Check that the file kind has not changed from the previous
84
## revision of this file (if any).
88
p = branch.abspath(path)
89
file_id = entry.file_id
90
mutter('commit prep file %s, id %r ' % (p, file_id))
92
if specific_files and not is_inside_any(specific_files, path):
93
if basis_inv.has_id(file_id):
94
# carry over with previous state
95
inv.add(basis_inv[file_id].copy())
97
# omit this from committed inventory
101
if not work_tree.has_id(file_id):
103
print('deleted %s%s' % (path, kind_marker(entry.kind)))
104
mutter(" file is missing, removing from inventory")
105
missing_ids.append(file_id)
110
if basis_inv.has_id(file_id):
111
old_kind = basis_inv[file_id].kind
112
if old_kind != entry.kind:
113
raise BzrError("entry %r changed kind from %r to %r"
114
% (file_id, old_kind, entry.kind))
116
if entry.kind == 'directory':
118
raise BzrError("%s is entered as directory but not a directory"
120
elif entry.kind == 'file':
122
raise BzrError("%s is entered as file but is not a file" % quotefn(p))
124
new_sha1 = work_tree.get_file_sha1(file_id)
126
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
128
and old_ie.text_sha1 == new_sha1):
129
## assert content == basis.get_file(file_id).read()
130
entry.text_id = old_ie.text_id
131
entry.text_sha1 = new_sha1
132
entry.text_size = old_ie.text_size
133
mutter(' unchanged from previous text_id {%s}' %
136
content = file(p, 'rb').read()
138
entry.text_sha1 = sha_string(content)
139
entry.text_size = len(content)
141
entry.text_id = gen_file_id(entry.name)
142
branch.text_store.add(content, entry.text_id)
143
mutter(' stored with text_id {%s}' % entry.text_id)
146
note('added %s' % path)
147
elif (old_ie.name == entry.name
148
and old_ie.parent_id == entry.parent_id):
149
note('modified %s' % path)
151
note('renamed %s' % path)
154
for file_id in missing_ids:
155
# Any files that have been deleted are now removed from the
156
# working inventory. Files that were not selected for commit
157
# are left as they were in the working inventory and ommitted
158
# from the revision inventory.
160
# have to do this later so we don't mess up the iterator.
161
# since parents may be removed before their children we
164
# FIXME: There's probably a better way to do this; perhaps
165
# the workingtree should know how to filter itbranch.
166
if work_inv.has_id(file_id):
167
del work_inv[file_id]
171
rev_id = _gen_revision_id(time.time())
174
inv_tmp = tempfile.TemporaryFile()
175
inv.write_xml(inv_tmp)
177
branch.inventory_store.add(inv_tmp, inv_id)
178
mutter('new inventory_id is {%s}' % inv_id)
180
branch._write_inventory(work_inv)
182
if timestamp == None:
183
timestamp = time.time()
185
if committer == None:
186
committer = username()
189
timezone = local_time_offset()
191
mutter("building commit log message")
192
rev = Revision(timestamp=timestamp,
195
precursor = branch.last_patch(),
200
rev_tmp = tempfile.TemporaryFile()
201
rev.write_xml(rev_tmp)
203
branch.revision_store.add(rev_tmp, rev_id)
204
mutter("new revision_id is {%s}" % rev_id)
206
## XXX: Everything up to here can simply be orphaned if we abort
207
## the commit; it will leave junk files behind but that doesn't
210
## TODO: Read back the just-generated changeset, and make sure it
211
## applies and recreates the right state.
213
## TODO: Also calculate and store the inventory SHA1
214
mutter("committing patch r%d" % (branch.revno() + 1))
216
branch.append_revision(rev_id)
219
note("commited r%d" % branch.revno())
223
def _gen_revision_id(when):
224
"""Return new revision-id."""
225
from binascii import hexlify
226
from osutils import rand_bytes, compact_date, user_email
228
s = '%s-%s-' % (user_email(), compact_date(when))
229
s += hexlify(rand_bytes(8))
added
removed
bzrlib/commit.py
