/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-09-16 09:43:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050916094355-d1a3d0aebe303f28
- rename entry_version to name_version
  (a better description since it covers the name and path)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
 
 
19
 
# FIXME: "bzr commit doc/format" commits doc/format.txt!
20
 
 
21
 
def commit(branch, message,
22
 
           timestamp=None,
23
 
           timezone=None,
24
 
           committer=None,
25
 
           verbose=True,
26
 
           specific_files=None,
27
 
           rev_id=None,
28
 
           allow_pointless=True):
29
 
    """Commit working copy as a new revision.
30
 
 
31
 
    The basic approach is to add all the file texts into the
32
 
    store, then the inventory, then make a new revision pointing
33
 
    to that inventory and store that.
34
 
 
35
 
    This is not quite safe if the working copy changes during the
36
 
    commit; for the moment that is simply not allowed.  A better
37
 
    approach is to make a temporary copy of the files before
38
 
    computing their hashes, and then add those hashes in turn to
39
 
    the inventory.  This should mean at least that there are no
40
 
    broken hash pointers.  There is no way we can get a snapshot
41
 
    of the whole directory at an instant.  This would also have to
42
 
    be robust against files disappearing, moving, etc.  So the
43
 
    whole thing is a bit hard.
44
 
 
45
 
    This raises PointlessCommit if there are no changes, no new merges,
46
 
    and allow_pointless  is false.
47
 
 
48
 
    timestamp -- if not None, seconds-since-epoch for a
49
 
         postdated/predated commit.
50
 
 
51
 
    specific_files
52
 
        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
 
 
 
18
# XXX: Can we do any better about making interrupted commits change
 
19
# nothing?  Perhaps the best approach is to integrate commit of
 
20
# AtomicFiles with releasing the lock on the Branch.
 
21
 
 
22
# TODO: Separate 'prepare' phase where we find a list of potentially
 
23
# committed files.  We then can then pause the commit to prompt for a
 
24
# commit message, knowing the summary will be the same as what's
 
25
# actually used for the commit.  (But perhaps simpler to simply get
 
26
# the tree status, then use that for a selective commit?)
 
27
 
 
28
# The newly committed revision is going to have a shape corresponding
 
29
# to that of the working inventory.  Files that are not in the
 
30
# working tree and that were in the predecessor are reported as
 
31
# removed --- this can include files that were either removed from the
 
32
# inventory or deleted in the working tree.  If they were only
 
33
# deleted from disk, they are removed from the working inventory.
 
34
 
 
35
# We then consider the remaining entries, which will be in the new
 
36
# version.  Directory entries are simply copied across.  File entries
 
37
# must be checked to see if a new version of the file should be
 
38
# recorded.  For each parent revision inventory, we check to see what
 
39
# version of the file was present.  If the file was present in at
 
40
# least one tree, and if it was the same version in all the trees,
 
41
# then we can just refer to that version.  Otherwise, a new version
 
42
# representing the merger of the file versions must be added.
 
43
 
 
44
# TODO: Update hashcache before and after - or does the WorkingTree
 
45
# look after that?
 
46
 
 
47
# This code requires all merge parents to be present in the branch.
 
48
# We could relax this but for the sake of simplicity the constraint is
 
49
# here for now.  It's not totally clear to me how we'd know which file
 
50
# need new text versions if some parents are absent.  -- mbp 20050915
 
51
 
 
52
 
 
53
import os
 
54
import sys
 
55
import time
 
56
import pdb
 
57
 
 
58
from binascii import hexlify
 
59
from cStringIO import StringIO
 
60
 
 
61
from bzrlib.osutils import (local_time_offset, username,
 
62
                            rand_bytes, compact_date, user_email,
 
63
                            kind_marker, is_inside_any, quotefn,
 
64
                            sha_string, sha_strings, sha_file, isdir, isfile,
 
65
                            split_lines)
 
66
from bzrlib.branch import gen_file_id, INVENTORY_FILEID, ANCESTRY_FILEID
 
67
from bzrlib.errors import (BzrError, PointlessCommit,
 
68
                           HistoryMissing,
 
69
                           )
 
70
from bzrlib.revision import Revision, RevisionReference
 
71
from bzrlib.trace import mutter, note, warning
 
72
from bzrlib.xml5 import serializer_v5
 
73
from bzrlib.inventory import Inventory
 
74
from bzrlib.weave import Weave
 
75
from bzrlib.weavefile import read_weave, write_weave_v5
 
76
from bzrlib.atomicfile import AtomicFile
 
77
 
 
78
 
 
79
def commit(*args, **kwargs):
 
80
    """Commit a new revision to a branch.
 
81
 
 
82
    Function-style interface for convenience of old callers.
 
83
 
 
84
    New code should use the Commit class instead.
 
85
    """
 
86
    ## XXX: Remove this in favor of Branch.commit?
 
87
    Commit().commit(*args, **kwargs)
 
88
 
 
89
 
 
90
class NullCommitReporter(object):
 
91
    """I report on progress of a commit."""
 
92
    def added(self, path):
 
93
        pass
 
94
 
 
95
    def removed(self, path):
 
96
        pass
 
97
 
 
98
    def renamed(self, old_path, new_path):
 
99
        pass
 
100
 
 
101
 
 
102
class ReportCommitToLog(NullCommitReporter):
 
103
    def added(self, path):
 
104
        note('added %s', path)
 
105
 
 
106
    def removed(self, path):
 
107
        note('removed %s', path)
 
108
 
 
109
    def renamed(self, old_path, new_path):
 
110
        note('renamed %s => %s', old_path, new_path)
 
111
 
 
112
 
 
113
class Commit(object):
 
114
    """Task of committing a new revision.
 
115
 
 
116
    This is a MethodObject: it accumulates state as the commit is
 
117
    prepared, and then it is discarded.  It doesn't represent
 
118
    historical revisions, just the act of recording a new one.
 
119
 
 
120
            missing_ids
 
121
            Modified to hold a list of files that have been deleted from
 
122
            the working directory; these should be removed from the
 
123
            working inventory.
 
124
    """
 
125
    def __init__(self,
 
126
                 reporter=None):
 
127
        if reporter is not None:
 
128
            self.reporter = reporter
 
129
        else:
 
130
            self.reporter = NullCommitReporter()
 
131
 
 
132
        
 
133
    def commit(self,
 
134
               branch, message,
 
135
               timestamp=None,
 
136
               timezone=None,
 
137
               committer=None,
 
138
               specific_files=None,
 
139
               rev_id=None,
 
140
               allow_pointless=True,
 
141
               verbose=False):
 
142
        """Commit working copy as a new revision.
 
143
 
 
144
        timestamp -- if not None, seconds-since-epoch for a
 
145
             postdated/predated commit.
 
146
 
 
147
        specific_files -- If true, commit only those files.
 
148
 
 
149
        rev_id -- If set, use this as the new revision id.
 
150
            Useful for test or import commands that need to tightly
 
151
            control what revisions are assigned.  If you duplicate
 
152
            a revision id that exists elsewhere it is your own fault.
 
153
            If null (default), a time/random revision id is generated.
 
154
 
 
155
        allow_pointless -- If true (default), commit even if nothing
 
156
            has changed and no merges are recorded.
 
157
        """
 
158
        mutter('preparing to commit')
 
159
 
 
160
        self.branch = branch
 
161
        self.weave_store = branch.weave_store
 
162
        self.rev_id = rev_id
 
163
        self.specific_files = specific_files
 
164
        self.allow_pointless = allow_pointless
 
165
 
 
166
        if timestamp is None:
 
167
            self.timestamp = time.time()
 
168
        else:
 
169
            self.timestamp = long(timestamp)
 
170
            
119
171
        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()
 
172
            self.rev_id = _gen_revision_id(self.branch, self.timestamp)
 
173
        else:
 
174
            self.rev_id = rev_id
 
175
 
 
176
        if committer is None:
 
177
            self.committer = username(self.branch)
 
178
        else:
 
179
            assert isinstance(committer, basestring), type(committer)
 
180
            self.committer = committer
 
181
 
 
182
        if timezone is None:
 
183
            self.timezone = local_time_offset()
 
184
        else:
 
185
            self.timezone = int(timezone)
 
186
 
 
187
        assert isinstance(message, basestring), type(message)
 
188
        self.message = message
 
189
 
 
190
        self.branch.lock_write()
 
191
        try:
 
192
            self.work_tree = self.branch.working_tree()
 
193
            self.work_inv = self.work_tree.inventory
 
194
            self.basis_tree = self.branch.basis_tree()
 
195
            self.basis_inv = self.basis_tree.inventory
 
196
 
 
197
            self._gather_parents()
 
198
            self._check_parents_present()
 
199
            
 
200
            self._remove_deleted()
 
201
            self.new_inv = Inventory()
 
202
            self._store_entries()
 
203
            self._report_deletes()
 
204
            self._set_name_versions()
 
205
 
 
206
            if not (self.allow_pointless
 
207
                    or len(self.parents) > 1
 
208
                    or self.new_inv != self.basis_inv):
 
209
                raise PointlessCommit()
 
210
 
 
211
            self._record_inventory()
 
212
            self._record_ancestry()
 
213
            self._make_revision()
 
214
            note('committed r%d {%s}', (self.branch.revno() + 1),
 
215
                 self.rev_id)
 
216
            self.branch.append_revision(self.rev_id)
 
217
            self.branch.set_pending_merges([])
 
218
        finally:
 
219
            self.branch.unlock()
 
220
 
 
221
 
 
222
 
 
223
    def _record_inventory(self):
 
224
        """Store the inventory for the new revision."""
 
225
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
226
        self.inv_sha1 = sha_string(inv_text)
 
227
        self.weave_store.add_text(INVENTORY_FILEID, self.rev_id,
 
228
                                         split_lines(inv_text), self.parents)
 
229
 
 
230
 
 
231
    def _record_ancestry(self):
 
232
        """Append merged revision ancestry to the ancestry file.
 
233
 
 
234
        This should be the merged ancestry of all parents, plus the
 
235
        new revision id."""
 
236
        w = self.weave_store.get_weave_or_empty(ANCESTRY_FILEID)
 
237
        lines = self._merge_ancestry_lines(w)
 
238
        w.add(self.rev_id, self.parents, lines)
 
239
        self.weave_store.put_weave(ANCESTRY_FILEID, w)
 
240
 
 
241
 
 
242
    def _merge_ancestry_lines(self, ancestry_weave):
 
243
        """Return merged ancestry lines.
 
244
 
 
245
        The lines are revision-ids followed by newlines."""
 
246
        seen = set()
 
247
        ancs = []
 
248
        for parent_id in self.parents:
 
249
            for line in ancestry_weave.get(parent_id):
 
250
                assert line[-1] == '\n'
 
251
                if line not in seen:
 
252
                    ancs.append(line)
 
253
                    seen.add(line)
 
254
        r = self.rev_id + '\n'
 
255
        assert r not in ancs
 
256
        ancs.append(r)
 
257
        mutter('merged ancestry of {%s}:\n%s', self.rev_id, ''.join(ancs))
 
258
        return ancs
 
259
 
 
260
 
 
261
    def _gather_parents(self):
 
262
        pending_merges = self.branch.pending_merges()
 
263
        self.parents = []
 
264
        self.parent_trees = []
 
265
        precursor_id = self.branch.last_revision()
156
266
        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)
 
267
            self.parents.append(precursor_id)
 
268
            self.parent_trees.append(self.basis_tree)
 
269
        self.parents += pending_merges
 
270
        self.parent_trees.extend(map(self.branch.revision_tree, pending_merges))
 
271
 
 
272
 
 
273
    def _check_parents_present(self):
 
274
        for parent_id in self.parents:
 
275
            mutter('commit parent revision {%s}', parent_id)
 
276
            if not self.branch.has_revision(parent_id):
 
277
                warning("can't commit a merge from an absent parent")
 
278
                raise HistoryMissing(self.branch, 'revision', parent_id)
 
279
 
 
280
            
 
281
    def _make_revision(self):
 
282
        """Record a new revision object for this commit."""
 
283
        self.rev = Revision(timestamp=self.timestamp,
 
284
                            timezone=self.timezone,
 
285
                            committer=self.committer,
 
286
                            message=self.message,
 
287
                            inventory_sha1=self.inv_sha1,
 
288
                            revision_id=self.rev_id)
 
289
        self.rev.parents = map(RevisionReference, self.parents)
 
290
        rev_tmp = StringIO()
 
291
        serializer_v5.write_revision(self.rev, rev_tmp)
164
292
        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):
 
293
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
294
        mutter('new revision_id is {%s}', self.rev_id)
 
295
 
 
296
 
 
297
    def _remove_deleted(self):
 
298
        """Remove deleted files from the working inventories.
 
299
 
 
300
        This is done prior to taking the working inventory as the
 
301
        basis for the new committed inventory.
 
302
 
 
303
        This returns true if any files
 
304
        *that existed in the basis inventory* were deleted.
 
305
        Files that were added and deleted
 
306
        in the working copy don't matter.
 
307
        """
 
308
        specific = self.specific_files
 
309
        deleted_ids = []
 
310
        for path, ie in self.work_inv.iter_entries():
 
311
            if specific and not is_inside_any(specific, path):
 
312
                continue
 
313
            if not self.work_tree.has_filename(path):
 
314
                note('missing %s', path)
 
315
                deleted_ids.append(ie.file_id)
 
316
        if deleted_ids:
 
317
            for file_id in deleted_ids:
 
318
                del self.work_inv[file_id]
 
319
            self.branch._write_inventory(self.work_inv)
 
320
 
 
321
 
 
322
    def _find_file_parents(self, file_id):
 
323
        """Return the text versions and hashes for all file parents.
 
324
 
 
325
        Returned as a map from text version to inventory entry.
 
326
 
 
327
        This is a set containing the file versions in all parents
 
328
        revisions containing the file.  If the file is new, the set
 
329
        will be empty."""
 
330
        r = {}
 
331
        for tree in self.parent_trees:
 
332
            if file_id in tree.inventory:
 
333
                ie = tree.inventory[file_id]
 
334
                assert ie.kind == 'file'
 
335
                assert ie.file_id == file_id
 
336
                if ie.text_version in r:
 
337
                    assert r[ie.text_version] == ie
 
338
                else:
 
339
                    r[ie.text_version] = ie
 
340
        return r
 
341
 
 
342
 
 
343
    def _set_name_versions(self):
 
344
        """Pass over inventory and mark new entry version as needed.
 
345
 
 
346
        Files get a new name version when they are new, have a
 
347
        different parent, or a different name from in the
 
348
        basis inventory, or if the file is in a different place
 
349
        to any of the parents."""
 
350
        # XXX: Need to think more here about when the user has
 
351
        # made a specific decision on a particular value -- c.f.
 
352
        # mark-merge.  
 
353
        for path, ie in self.new_inv.iter_entries():
 
354
            old_version = None
 
355
            file_id = ie.file_id
 
356
            for parent_tree in self.parent_trees:
 
357
                parent_inv = parent_tree.inventory
 
358
                if file_id not in parent_inv:
 
359
                    continue
 
360
                parent_ie = parent_inv[file_id]
 
361
                if parent_ie.parent_id != ie.parent_id:
 
362
                    old_version = None
 
363
                    break
 
364
                elif parent_ie.name != ie.name:
 
365
                    old_version = None
 
366
                    break
 
367
                elif old_version is None:
 
368
                    old_version = parent_ie.name_version
 
369
                elif old_version != parent_ie.name_version:
 
370
                    old_version = None
 
371
                    break
 
372
                else:
 
373
                    pass                # so far so good
 
374
            if old_version is None:
 
375
                mutter('new name_version for {%s}', file_id)
 
376
                ie.name_version = self.rev_id
 
377
            else:
 
378
                mutter('name_version for {%s} inherited as {%s}',
 
379
                       file_id, old_version)
 
380
                ie.name_version = old_version
 
381
 
 
382
 
 
383
    def _store_entries(self):
 
384
        """Build revision inventory and store modified files.
 
385
 
 
386
        This is called with new_inv a new empty inventory.  Depending on
 
387
        which files are selected for commit, and which ones have
 
388
        been modified or merged, new inventory entries are built
 
389
        based on the working and parent inventories.
 
390
 
 
391
        As a side-effect this stores new text versions for committed
 
392
        files with text changes or merges.
 
393
 
 
394
        Each entry can have one of several things happen:
 
395
 
 
396
        carry_file -- carried from the previous version (if not
 
397
            selected for commit)
 
398
 
 
399
        commit_nonfile -- no text to worry about
 
400
 
 
401
        commit_old_text -- same text, may have moved
 
402
 
 
403
        commit_file -- new text version
 
404
        """
 
405
        for path, new_ie in self.work_inv.iter_entries():
 
406
            file_id = new_ie.file_id
 
407
            mutter('check %s {%s}', path, new_ie.file_id)
 
408
            if self.specific_files:
 
409
                if not is_inside_any(self.specific_files, path):
 
410
                    mutter('%s not selected for commit', path)
 
411
                    self._carry_file(file_id)
 
412
                    continue
 
413
            if new_ie.kind != 'file':
 
414
                self._commit_nonfile(file_id)
 
415
                continue
 
416
            
 
417
            file_parents = self._find_file_parents(file_id)
 
418
            if len(file_parents) == 1:
 
419
                parent_ie = file_parents.values()[0]
 
420
                wc_sha1 = self.work_tree.get_file_sha1(file_id)
 
421
                if parent_ie.text_sha1 == wc_sha1:
 
422
                    # text not changed or merged
 
423
                    self._commit_old_text(file_id, parent_ie)
 
424
                    continue
 
425
 
 
426
            mutter('parents of %s are %r', path, file_parents)
 
427
 
 
428
            # file is either new, or a file merge; need to record
 
429
            # a new version
 
430
            if len(file_parents) > 1:
 
431
                note('merged %s', path)
 
432
            elif len(file_parents) == 0:
 
433
                note('added %s', path)
 
434
            else:
 
435
                note('modified %s', path)
 
436
            self._commit_file(new_ie, file_id, file_parents)
 
437
 
 
438
 
 
439
    def _commit_nonfile(self, file_id):
 
440
        self.new_inv.add(self.work_inv[file_id].copy())
 
441
 
 
442
 
 
443
    def _carry_file(self, file_id):
 
444
        """Carry the file unchanged from the basis revision."""
 
445
        if self.basis_inv.has_id(file_id):
 
446
            self.new_inv.add(self.basis_inv[file_id].copy())
 
447
 
 
448
 
 
449
    def _commit_old_text(self, file_id, parent_ie):
 
450
        """Keep the same text as last time, but possibly a different name."""
 
451
        ie = self.work_inv[file_id].copy()
 
452
        ie.text_version = parent_ie.text_version
 
453
        ie.text_size = parent_ie.text_size
 
454
        ie.text_sha1 = parent_ie.text_sha1
 
455
        self.new_inv.add(ie)
 
456
 
 
457
 
 
458
    def _report_deletes(self):
 
459
        for file_id in self.basis_inv:
 
460
            if file_id not in self.new_inv:
 
461
                note('deleted %s', self.basis_inv.id2path(file_id))
 
462
 
 
463
 
 
464
    def _commit_file(self, new_ie, file_id, file_parents):                    
 
465
        mutter('store new text for {%s} in revision {%s}',
 
466
               file_id, self.rev_id)
 
467
        new_lines = self.work_tree.get_file(file_id).readlines()
 
468
        self._add_text_to_weave(file_id, new_lines, file_parents)
 
469
        new_ie.text_version = self.rev_id
 
470
        new_ie.text_sha1 = sha_strings(new_lines)
 
471
        new_ie.text_size = sum(map(len, new_lines))
 
472
        self.new_inv.add(new_ie)
 
473
 
 
474
 
 
475
    def _add_text_to_weave(self, file_id, new_lines, parents):
 
476
        if file_id.startswith('__'):
 
477
            raise ValueError('illegal file-id %r for text file' % file_id)
 
478
        self.weave_store.add_text(file_id, self.rev_id, new_lines, parents)
 
479
 
 
480
 
 
481
def _gen_revision_id(branch, when):
190
482
    """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))
 
483
    s = '%s-%s-' % (user_email(branch), compact_date(when))
195
484
    s += hexlify(rand_bytes(8))
196
485
    return s
197
486
 
198
487
 
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, \
215
 
         local_time_offset, username, kind_marker, is_inside_any
216
 
    
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)
224
 
    missing_ids = []
225
 
    
226
 
    for path, entry in work_inv.iter_entries():
227
 
        ## TODO: Check that the file kind has not changed from the previous
228
 
        ## revision of this file (if any).
229
 
 
230
 
        p = branch.abspath(path)
231
 
        file_id = entry.file_id
232
 
        mutter('commit prep file %s, id %r ' % (p, file_id))
233
 
 
234
 
        if specific_files and not is_inside_any(specific_files, path):
235
 
            mutter('  skipping file excluded from commit')
236
 
            if basis_inv.has_id(file_id):
237
 
                # carry over with previous state
238
 
                inv.add(basis_inv[file_id].copy())
239
 
            else:
240
 
                # omit this from committed inventory
241
 
                pass
242
 
            continue
243
 
 
244
 
        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
248
 
            mutter("    file is missing, removing from inventory")
249
 
            missing_ids.append(file_id)
250
 
            continue
251
 
 
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
 
        inv.add(entry)
258
 
 
259
 
        if old_ie:
260
 
            old_kind = old_ie.kind
261
 
            if old_kind != entry.kind:
262
 
                raise BzrError("entry %r changed kind from %r to %r"
263
 
                        % (file_id, old_kind, entry.kind))
264
 
 
265
 
        if entry.kind == 'directory':
266
 
            if not isdir(p):
267
 
                raise BzrError("%s is entered as directory but not a directory"
268
 
                               % quotefn(p))
269
 
        elif entry.kind == 'file':
270
 
            if not isfile(p):
271
 
                raise BzrError("%s is entered as file but is not a file" % quotefn(p))
272
 
 
273
 
            new_sha1 = work_tree.get_file_sha1(file_id)
274
 
 
275
 
            if (old_ie
276
 
                and old_ie.text_sha1 == new_sha1):
277
 
                ## assert content == basis.get_file(file_id).read()
278
 
                entry.text_id = old_ie.text_id
279
 
                entry.text_sha1 = new_sha1
280
 
                entry.text_size = old_ie.text_size
281
 
                mutter('    unchanged from previous text_id {%s}' %
282
 
                       entry.text_id)
283
 
            else:
284
 
                content = file(p, 'rb').read()
285
 
 
286
 
                # calculate the sha again, just in case the file contents
287
 
                # changed since we updated the cache
288
 
                entry.text_sha1 = sha_string(content)
289
 
                entry.text_size = len(content)
290
 
 
291
 
                entry.text_id = gen_file_id(entry.name)
292
 
                branch.text_store.add(content, entry.text_id)
293
 
                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
311
 
 
312
 
 
 
488
 
 
489