~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-05-13 00:57:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050513005732-26b0a3042cbb57d1
- more notes on tagging

Show diffs side-by-side

added added

removed removed

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