~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-06-20 03:29:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050620032921-240d0ade23545055
- remove redundant precursor check

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
 
 
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.
 
7
 
 
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.
 
12
 
 
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
 
16
 
 
17
 
 
18
 
 
19
def commit(branch, message,
 
20
           timestamp=None,
 
21
           timezone=None,
 
22
           committer=None,
 
23
           verbose=True,
 
24
           specific_files=None,
 
25
           rev_id=None):
 
26
    """Commit working copy as a new revision.
 
27
 
 
28
    The basic approach is to add all the file texts into the
 
29
    store, then the inventory, then make a new revision pointing
 
30
    to that inventory and store that.
 
31
 
 
32
    This is not quite safe if the working copy changes during the
 
33
    commit; for the moment that is simply not allowed.  A better
 
34
    approach is to make a temporary copy of the files before
 
35
    computing their hashes, and then add those hashes in turn to
 
36
    the inventory.  This should mean at least that there are no
 
37
    broken hash pointers.  There is no way we can get a snapshot
 
38
    of the whole directory at an instant.  This would also have to
 
39
    be robust against files disappearing, moving, etc.  So the
 
40
    whole thing is a bit hard.
 
41
 
 
42
    timestamp -- if not None, seconds-since-epoch for a
 
43
         postdated/predated commit.
 
44
 
 
45
    specific_files
 
46
        If true, commit only those files.
 
47
 
 
48
    rev_id
 
49
        If set, use this as the new revision id.
 
50
        Useful for test or import commands that need to tightly
 
51
        control what revisions are assigned.  If you duplicate
 
52
        a revision id that exists elsewhere it is your own fault.
 
53
        If null (default), a time/random revision id is generated.
 
54
    """
 
55
 
 
56
    import time, tempfile
 
57
 
 
58
    from bzrlib.osutils import local_time_offset, username
 
59
    from bzrlib.branch import gen_file_id
 
60
    from bzrlib.errors import BzrError
 
61
    from bzrlib.revision import Revision, RevisionReference
 
62
    from bzrlib.trace import mutter, note
 
63
 
 
64
    branch.lock_write()
 
65
 
 
66
    try:
 
67
        # First walk over the working inventory; and both update that
 
68
        # and also build a new revision inventory.  The revision
 
69
        # inventory needs to hold the text-id, sha1 and size of the
 
70
        # actual file versions committed in the revision.  (These are
 
71
        # not present in the working inventory.)  We also need to
 
72
        # detect missing/deleted files, and remove them from the
 
73
        # working inventory.
 
74
 
 
75
        work_tree = branch.working_tree()
 
76
        work_inv = work_tree.inventory
 
77
        basis = branch.basis_tree()
 
78
        basis_inv = basis.inventory
 
79
 
 
80
        if verbose:
 
81
            note('looking for changes...')
 
82
 
 
83
        missing_ids, new_inv = _gather_commit(branch,
 
84
                                              work_tree,
 
85
                                              work_inv,
 
86
                                              basis_inv,
 
87
                                              specific_files,
 
88
                                              verbose)
 
89
 
 
90
        for file_id in missing_ids:
 
91
            # Any files that have been deleted are now removed from the
 
92
            # working inventory.  Files that were not selected for commit
 
93
            # are left as they were in the working inventory and ommitted
 
94
            # from the revision inventory.
 
95
 
 
96
            # have to do this later so we don't mess up the iterator.
 
97
            # since parents may be removed before their children we
 
98
            # have to test.
 
99
 
 
100
            # FIXME: There's probably a better way to do this; perhaps
 
101
            # the workingtree should know how to filter itbranch.
 
102
            if work_inv.has_id(file_id):
 
103
                del work_inv[file_id]
 
104
 
 
105
 
 
106
        if rev_id is None:
 
107
            rev_id = _gen_revision_id(time.time())
 
108
        inv_id = rev_id
 
109
 
 
110
        inv_tmp = tempfile.TemporaryFile()
 
111
        new_inv.write_xml(inv_tmp)
 
112
        inv_tmp.seek(0)
 
113
        branch.inventory_store.add(inv_tmp, inv_id)
 
114
        mutter('new inventory_id is {%s}' % inv_id)
 
115
 
 
116
        # We could also just sha hash the inv_tmp file
 
117
        # however, in the case that branch.inventory_store.add()
 
118
        # ever actually does anything special
 
119
        inv_sha1 = branch.get_inventory_sha1(inv_id)
 
120
 
 
121
        precursor_id = branch.last_patch()
 
122
        if precursor_id:
 
123
            precursor_sha1 = branch.get_revision_sha1(precursor_id)
 
124
        else:
 
125
            precursor_sha1 = None
 
126
        parent = RevisionReference(precursor_id, precursor_sha1)
 
127
 
 
128
        branch._write_inventory(work_inv)
 
129
 
 
130
        if timestamp == None:
 
131
            timestamp = time.time()
 
132
 
 
133
        if committer == None:
 
134
            committer = username()
 
135
 
 
136
        if timezone == None:
 
137
            timezone = local_time_offset()
 
138
 
 
139
        mutter("building commit log message")
 
140
        rev = Revision(timestamp=timestamp,
 
141
                       timezone=timezone,
 
142
                       committer=committer,
 
143
                       message = message,
 
144
                       inventory_id=inv_id,
 
145
                       inventory_sha1=inv_sha1,
 
146
                       revision_id=rev_id)
 
147
        rev.parents = [parent]
 
148
 
 
149
        rev_tmp = tempfile.TemporaryFile()
 
150
        rev.write_xml(rev_tmp)
 
151
        rev_tmp.seek(0)
 
152
        branch.revision_store.add(rev_tmp, rev_id)
 
153
        mutter("new revision_id is {%s}" % rev_id)
 
154
 
 
155
        ## XXX: Everything up to here can simply be orphaned if we abort
 
156
        ## the commit; it will leave junk files behind but that doesn't
 
157
        ## matter.
 
158
 
 
159
        ## TODO: Read back the just-generated changeset, and make sure it
 
160
        ## applies and recreates the right state.
 
161
 
 
162
        ## TODO: Also calculate and store the inventory SHA1
 
163
        mutter("committing patch r%d" % (branch.revno() + 1))
 
164
 
 
165
        branch.append_revision(rev_id)
 
166
 
 
167
        if verbose:
 
168
            note("commited r%d" % branch.revno())
 
169
    finally:
 
170
        branch.unlock()
 
171
 
 
172
 
 
173
 
 
174
def _gen_revision_id(when):
 
175
    """Return new revision-id."""
 
176
    from binascii import hexlify
 
177
    from osutils import rand_bytes, compact_date, user_email
 
178
 
 
179
    s = '%s-%s-' % (user_email(), compact_date(when))
 
180
    s += hexlify(rand_bytes(8))
 
181
    return s
 
182
 
 
183
 
 
184
def _gather_commit(branch, work_tree, work_inv, basis_inv, specific_files,
 
185
                   verbose):
 
186
    """Build inventory preparatory to commit.
 
187
 
 
188
    This adds any changed files into the text store, and sets their
 
189
    test-id, sha and size in the returned inventory appropriately.
 
190
 
 
191
    missing_ids
 
192
        Modified to hold a list of files that have been deleted from
 
193
        the working directory; these should be removed from the
 
194
        working inventory.
 
195
    """
 
196
    from bzrlib.inventory import Inventory
 
197
    from osutils import isdir, isfile, sha_string, quotefn, \
 
198
         local_time_offset, username, kind_marker, is_inside_any
 
199
    
 
200
    from branch import gen_file_id
 
201
    from errors import BzrError
 
202
    from revision import Revision
 
203
    from bzrlib.trace import mutter, note
 
204
 
 
205
    inv = Inventory()
 
206
    missing_ids = []
 
207
    
 
208
    for path, entry in work_inv.iter_entries():
 
209
        ## TODO: Check that the file kind has not changed from the previous
 
210
        ## revision of this file (if any).
 
211
 
 
212
        p = branch.abspath(path)
 
213
        file_id = entry.file_id
 
214
        mutter('commit prep file %s, id %r ' % (p, file_id))
 
215
 
 
216
        if specific_files and not is_inside_any(specific_files, path):
 
217
            if basis_inv.has_id(file_id):
 
218
                # carry over with previous state
 
219
                inv.add(basis_inv[file_id].copy())
 
220
            else:
 
221
                # omit this from committed inventory
 
222
                pass
 
223
            continue
 
224
 
 
225
        if not work_tree.has_id(file_id):
 
226
            if verbose:
 
227
                print('deleted %s%s' % (path, kind_marker(entry.kind)))
 
228
            mutter("    file is missing, removing from inventory")
 
229
            missing_ids.append(file_id)
 
230
            continue
 
231
 
 
232
        # this is present in the new inventory; may be new, modified or
 
233
        # unchanged.
 
234
        old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
235
        
 
236
        entry = entry.copy()
 
237
        inv.add(entry)
 
238
 
 
239
        if old_ie:
 
240
            old_kind = old_ie.kind
 
241
            if old_kind != entry.kind:
 
242
                raise BzrError("entry %r changed kind from %r to %r"
 
243
                        % (file_id, old_kind, entry.kind))
 
244
 
 
245
        if entry.kind == 'directory':
 
246
            if not isdir(p):
 
247
                raise BzrError("%s is entered as directory but not a directory"
 
248
                               % quotefn(p))
 
249
        elif entry.kind == 'file':
 
250
            if not isfile(p):
 
251
                raise BzrError("%s is entered as file but is not a file" % quotefn(p))
 
252
 
 
253
            new_sha1 = work_tree.get_file_sha1(file_id)
 
254
 
 
255
            if (old_ie
 
256
                and old_ie.text_sha1 == new_sha1):
 
257
                ## assert content == basis.get_file(file_id).read()
 
258
                entry.text_id = old_ie.text_id
 
259
                entry.text_sha1 = new_sha1
 
260
                entry.text_size = old_ie.text_size
 
261
                mutter('    unchanged from previous text_id {%s}' %
 
262
                       entry.text_id)
 
263
            else:
 
264
                content = file(p, 'rb').read()
 
265
 
 
266
                # calculate the sha again, just in case the file contents
 
267
                # changed since we updated the cache
 
268
                entry.text_sha1 = sha_string(content)
 
269
                entry.text_size = len(content)
 
270
 
 
271
                entry.text_id = gen_file_id(entry.name)
 
272
                branch.text_store.add(content, entry.text_id)
 
273
                mutter('    stored with text_id {%s}' % entry.text_id)
 
274
 
 
275
        if verbose:
 
276
            marked = path + kind_marker(entry.kind)
 
277
            if not old_ie:
 
278
                print 'added', marked
 
279
            elif old_ie == entry:
 
280
                pass                    # unchanged
 
281
            elif (old_ie.name == entry.name
 
282
                  and old_ie.parent_id == entry.parent_id):
 
283
                print 'modified', marked
 
284
            else:
 
285
                print 'renamed', marked
 
286
                        
 
287
    return missing_ids, inv
 
288
 
 
289