~bzr-pqm/bzr/bzr.dev

485 by Martin Pool
- move commit code into its own module
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
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
18
## XXX: Can we do any better about making interrupted commits change
19
## nothing?
20
21
## XXX: If we merged two versions of a file then we still need to
22
## create a new version representing that merge, even if it didn't
23
## change from the parent.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
24
25
## TODO: Read back the just-generated changeset, and make sure it
26
## applies and recreates the right state.
27
28
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
29
30
1189 by Martin Pool
- BROKEN: partial support for commit into weave
31
import os
32
import sys
1188 by Martin Pool
- clean up imports in commit code
33
import time
34
import tempfile
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
35
import sha
36
1188 by Martin Pool
- clean up imports in commit code
37
from binascii import hexlify
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
38
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
39
40
from bzrlib.osutils import (local_time_offset, username,
41
                            rand_bytes, compact_date, user_email,
42
                            kind_marker, is_inside_any, quotefn,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
43
                            sha_string, sha_file, isdir, isfile)
1223 by Martin Pool
- store inventories in weave
44
from bzrlib.branch import gen_file_id, INVENTORY_FILEID
1188 by Martin Pool
- clean up imports in commit code
45
from bzrlib.errors import BzrError, PointlessCommit
46
from bzrlib.revision import Revision, RevisionReference
47
from bzrlib.trace import mutter, note
1189 by Martin Pool
- BROKEN: partial support for commit into weave
48
from bzrlib.xml5 import serializer_v5
1188 by Martin Pool
- clean up imports in commit code
49
from bzrlib.inventory import Inventory
1189 by Martin Pool
- BROKEN: partial support for commit into weave
50
from bzrlib.delta import compare_trees
51
from bzrlib.weave import Weave
52
from bzrlib.weavefile import read_weave, write_weave_v5
53
from bzrlib.atomicfile import AtomicFile
54
55
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
56
def commit(*args, **kwargs):
57
    """Commit a new revision to a branch.
58
59
    Function-style interface for convenience of old callers.
60
61
    New code should use the Commit class instead.
62
    """
63
    Commit().commit(*args, **kwargs)
64
65
1189 by Martin Pool
- BROKEN: partial support for commit into weave
66
class NullCommitReporter(object):
67
    """I report on progress of a commit."""
68
    def added(self, path):
69
        pass
70
71
    def removed(self, path):
72
        pass
73
74
    def renamed(self, old_path, new_path):
75
        pass
76
77
78
class ReportCommitToLog(NullCommitReporter):
79
    def added(self, path):
80
        note('added %s', path)
81
82
    def removed(self, path):
83
        note('removed %s', path)
84
85
    def renamed(self, old_path, new_path):
86
        note('renamed %s => %s', old_path, new_path)
87
88
89
class Commit(object):
90
    """Task of committing a new revision.
91
92
    This is a MethodObject: it accumulates state as the commit is
93
    prepared, and then it is discarded.  It doesn't represent
94
    historical revisions, just the act of recording a new one.
95
96
            missing_ids
97
            Modified to hold a list of files that have been deleted from
98
            the working directory; these should be removed from the
99
            working inventory.
485 by Martin Pool
- move commit code into its own module
100
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
101
    def __init__(self,
102
                 reporter=None):
103
        if reporter is not None:
104
            self.reporter = reporter
105
        else:
106
            self.reporter = NullCommitReporter()
107
108
        
109
    def commit(self,
110
               branch, message,
111
               timestamp=None,
112
               timezone=None,
113
               committer=None,
114
               specific_files=None,
115
               rev_id=None,
116
               allow_pointless=True):
117
        """Commit working copy as a new revision.
118
119
        The basic approach is to add all the file texts into the
120
        store, then the inventory, then make a new revision pointing
121
        to that inventory and store that.
122
123
        This is not quite safe if the working copy changes during the
124
        commit; for the moment that is simply not allowed.  A better
125
        approach is to make a temporary copy of the files before
126
        computing their hashes, and then add those hashes in turn to
127
        the inventory.  This should mean at least that there are no
128
        broken hash pointers.  There is no way we can get a snapshot
129
        of the whole directory at an instant.  This would also have to
130
        be robust against files disappearing, moving, etc.  So the
131
        whole thing is a bit hard.
132
133
        This raises PointlessCommit if there are no changes, no new merges,
134
        and allow_pointless  is false.
135
136
        timestamp -- if not None, seconds-since-epoch for a
137
             postdated/predated commit.
138
139
        specific_files
140
            If true, commit only those files.
141
142
        rev_id
143
            If set, use this as the new revision id.
144
            Useful for test or import commands that need to tightly
145
            control what revisions are assigned.  If you duplicate
146
            a revision id that exists elsewhere it is your own fault.
147
            If null (default), a time/random revision id is generated.
148
        """
149
150
        self.branch = branch
151
        self.branch.lock_write()
152
        self.rev_id = rev_id
153
        self.specific_files = specific_files
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
154
        self.allow_pointless = allow_pointless
1189 by Martin Pool
- BROKEN: partial support for commit into weave
155
156
        if timestamp is None:
157
            self.timestamp = time.time()
158
        else:
159
            self.timestamp = long(timestamp)
160
            
161
        if committer is None:
162
            self.committer = username(self.branch)
163
        else:
164
            assert isinstance(committer, basestring), type(committer)
165
            self.committer = committer
166
167
        if timezone is None:
168
            self.timezone = local_time_offset()
169
        else:
170
            self.timezone = int(timezone)
171
172
        assert isinstance(message, basestring), type(message)
173
        self.message = message
174
175
        try:
176
            # First walk over the working inventory; and both update that
177
            # and also build a new revision inventory.  The revision
178
            # inventory needs to hold the text-id, sha1 and size of the
179
            # actual file versions committed in the revision.  (These are
180
            # not present in the working inventory.)  We also need to
181
            # detect missing/deleted files, and remove them from the
182
            # working inventory.
183
184
            self.work_tree = self.branch.working_tree()
185
            self.work_inv = self.work_tree.inventory
186
            self.basis_tree = self.branch.basis_tree()
187
            self.basis_inv = self.basis_tree.inventory
188
1223 by Martin Pool
- store inventories in weave
189
            self._gather_parents()
190
1189 by Martin Pool
- BROKEN: partial support for commit into weave
191
            if self.rev_id is None:
192
                self.rev_id = _gen_revision_id(self.branch, time.time())
193
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
194
            # todo: update hashcache
1189 by Martin Pool
- BROKEN: partial support for commit into weave
195
            self.delta = compare_trees(self.basis_tree, self.work_tree,
196
                                       specific_files=self.specific_files)
197
198
            if not (self.delta.has_changed()
199
                    or self.allow_pointless
1223 by Martin Pool
- store inventories in weave
200
                    or len(self.parents) != 1):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
201
                raise PointlessCommit()
202
203
            self.new_inv = self.basis_inv.copy()
204
205
            self.delta.show(sys.stdout)
206
207
            self._remove_deleted()
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
208
            self._store_files()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
209
210
            self.branch._write_inventory(self.work_inv)
211
            self._record_inventory()
212
213
            self._make_revision()
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
214
            note('committted r%d {%s}', (self.branch.revno() + 1),
215
                 self.rev_id)
216
            self.branch.append_revision(self.rev_id)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
217
            self.branch.set_pending_merges([])
218
        finally:
219
            self.branch.unlock()
220
221
222
    def _record_inventory(self):
1223 by Martin Pool
- store inventories in weave
223
        """Store the inventory for the new revision."""
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
224
        inv_tmp = StringIO()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
225
        serializer_v5.write_inventory(self.new_inv, inv_tmp)
1223 by Martin Pool
- store inventories in weave
226
        inv_tmp.seek(0)
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
227
        self.inv_sha1 = sha_string(inv_tmp.getvalue())
1223 by Martin Pool
- store inventories in weave
228
        inv_lines = inv_tmp.readlines()
229
        self.branch.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
230
                                         inv_lines, self.parents)
231
232
233
    def _gather_parents(self):
234
        pending_merges = self.branch.pending_merges()
235
        if pending_merges:
236
            raise NotImplementedError("sorry, can't commit merges to the weave format yet")
237
        self.parents = []
238
        precursor_id = self.branch.last_patch()
239
        if precursor_id:
240
            self.parents.append(precursor_id)
241
        self.parents += pending_merges
1189 by Martin Pool
- BROKEN: partial support for commit into weave
242
243
244
    def _make_revision(self):
245
        """Record a new revision object for this commit."""
246
        self.rev = Revision(timestamp=self.timestamp,
247
                            timezone=self.timezone,
248
                            committer=self.committer,
249
                            message=self.message,
250
                            inventory_sha1=self.inv_sha1,
251
                            revision_id=self.rev_id)
1223 by Martin Pool
- store inventories in weave
252
        self.rev.parents = map(RevisionReference, self.parents)
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
253
        rev_tmp = tempfile.TemporaryFile()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
254
        serializer_v5.write_revision(self.rev, rev_tmp)
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
255
        rev_tmp.seek(0)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
256
        self.branch.revision_store.add(rev_tmp, self.rev_id)
257
        mutter('new revision_id is {%s}', self.rev_id)
258
259
260
    def _remove_deleted(self):
261
        """Remove deleted files from the working and stored inventories."""
262
        for path, id, kind in self.delta.removed:
263
            if self.work_inv.has_id(id):
264
                del self.work_inv[id]
265
            if self.new_inv.has_id(id):
266
                del self.new_inv[id]
267
268
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
269
270
    def _store_files(self):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
271
        """Store new texts of modified/added files."""
1207 by Martin Pool
- fix bugs in adding files in subdirectories
272
        # We must make sure that directories are added before anything
273
        # inside them is added.  the files within the delta report are
274
        # sorted by path so we know the directory will come before its
275
        # contents. 
276
        for path, file_id, kind in self.delta.added:
277
            if kind != 'file':
278
                ie = self.work_inv[file_id].copy()
279
                self.new_inv.add(ie)
280
            else:
281
                self._store_file_text(file_id)
282
283
        for path, file_id, kind in self.delta.modified:
284
            if kind != 'file':
285
                continue
286
            self._store_file_text(file_id)
287
288
        for old_path, new_path, file_id, kind, text_modified in self.delta.renamed:
1189 by Martin Pool
- BROKEN: partial support for commit into weave
289
            if kind != 'file':
290
                continue
291
            if not text_modified:
292
                continue
1207 by Martin Pool
- fix bugs in adding files in subdirectories
293
            self._store_file_text(file_id)
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
294
295
296
    def _store_file_text(self, file_id):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
297
        """Store updated text for one modified or added file."""
1199 by Martin Pool
- weave commit records per-file ancestors
298
        note('store new text for {%s} in revision {%s}',
299
             file_id, self.rev_id)
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
300
        new_lines = self.work_tree.get_file(file_id).readlines()
1199 by Martin Pool
- weave commit records per-file ancestors
301
        if file_id in self.new_inv:     # was in basis inventory
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
302
            ie = self.new_inv[file_id]
303
            assert ie.file_id == file_id
1199 by Martin Pool
- weave commit records per-file ancestors
304
            assert file_id in self.basis_inv
305
            assert self.basis_inv[file_id].kind == 'file'
306
            old_version = self.basis_inv[file_id].text_version
307
            file_parents = [old_version]
308
        else:                           # new in this revision
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
309
            ie = self.work_inv[file_id].copy()
310
            self.new_inv.add(ie)
1199 by Martin Pool
- weave commit records per-file ancestors
311
            assert file_id not in self.basis_inv
312
            file_parents = []
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
313
        assert ie.kind == 'file'
1199 by Martin Pool
- weave commit records per-file ancestors
314
        self._add_text_to_weave(file_id, new_lines, file_parents)
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
315
        # make a new inventory entry for this file, using whatever
316
        # it had in the working copy, plus details on the new text
317
        ie.text_sha1 = _sha_strings(new_lines)
318
        ie.text_size = sum(map(len, new_lines))
319
        ie.text_version = self.rev_id
320
        ie.entry_version = self.rev_id
321
322
1199 by Martin Pool
- weave commit records per-file ancestors
323
    def _add_text_to_weave(self, file_id, new_lines, parents):
1223 by Martin Pool
- store inventories in weave
324
        if file_id.startswith('__'):
325
            raise ValueError('illegal file-id %r for text file' % file_id)
326
        self.branch.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
327
328
329
def _gen_revision_id(branch, when):
330
    """Return new revision-id."""
331
    s = '%s-%s-' % (user_email(branch), compact_date(when))
332
    s += hexlify(rand_bytes(8))
333
    return s
633 by Martin Pool
- Show added/renamed/modified messages from commit for non-file
334
335
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
336
def _sha_strings(strings):
337
    """Return the sha-1 of concatenation of strings"""
338
    s = sha.new()
339
    map(s.update, strings)
340
    return s.hexdigest()