~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-05-12 02:14:35 UTC
  • Revision ID: mbp@sourcefrog.net-20050512021435-87fa19f051842647
- new helper function kind_marker()

Show diffs side-by-side

added added

removed removed

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