/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: Robert Collins
  • Date: 2005-10-17 23:13:00 UTC
  • mto: This revision was merged to the branch mainline in revision 1462.
  • Revision ID: robertc@robertcollins.net-20051017231300-e1c9e931bcfacd6a
Branch.open_containing now returns a tuple (Branch, relative-path).

This allows direct access to the common case of 'get me this file
from its branch'. (Robert Collins)

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
 
 
 
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
# TODO: Rather than mashing together the ancestry and storing it back,
 
48
# perhaps the weave should have single method which does it all in one
 
49
# go, avoiding a lot of redundant work.
 
50
 
 
51
# TODO: Perhaps give a warning if one of the revisions marked as
 
52
# merged is already in the ancestry, and then don't record it as a
 
53
# distinct parent.
 
54
 
 
55
# TODO: If the file is newly merged but unchanged from the version it
 
56
# merges from, then it should still be reported as newly added
 
57
# relative to the basis revision.
 
58
 
 
59
 
 
60
import os
 
61
import re
 
62
import sys
 
63
import time
 
64
import pdb
 
65
 
 
66
from binascii import hexlify
 
67
from cStringIO import StringIO
 
68
 
 
69
from bzrlib.osutils import (local_time_offset,
 
70
                            rand_bytes, compact_date,
 
71
                            kind_marker, is_inside_any, quotefn,
 
72
                            sha_string, sha_strings, sha_file, isdir, isfile,
 
73
                            split_lines)
 
74
from bzrlib.branch import gen_file_id
 
75
import bzrlib.config
 
76
from bzrlib.errors import (BzrError, PointlessCommit,
 
77
                           HistoryMissing,
 
78
                           ConflictsInTree
 
79
                           )
 
80
import bzrlib.gpg as gpg
 
81
from bzrlib.revision import Revision
 
82
from bzrlib.testament import Testament
 
83
from bzrlib.trace import mutter, note, warning
 
84
from bzrlib.xml5 import serializer_v5
 
85
from bzrlib.inventory import Inventory, ROOT_ID
 
86
from bzrlib.weave import Weave
 
87
from bzrlib.weavefile import read_weave, write_weave_v5
 
88
from bzrlib.atomicfile import AtomicFile
 
89
 
 
90
 
 
91
def commit(*args, **kwargs):
 
92
    """Commit a new revision to a branch.
 
93
 
 
94
    Function-style interface for convenience of old callers.
 
95
 
 
96
    New code should use the Commit class instead.
 
97
    """
 
98
    ## XXX: Remove this in favor of Branch.commit?
 
99
    Commit().commit(*args, **kwargs)
 
100
 
 
101
 
 
102
class NullCommitReporter(object):
 
103
    """I report on progress of a commit."""
 
104
 
 
105
    def snapshot_change(self, change, path):
 
106
        pass
 
107
 
 
108
    def completed(self, revno, rev_id):
 
109
        pass
 
110
 
 
111
    def deleted(self, file_id):
 
112
        pass
 
113
 
 
114
    def escaped(self, escape_count, message):
 
115
        pass
 
116
 
 
117
    def missing(self, path):
 
118
        pass
 
119
 
 
120
class ReportCommitToLog(NullCommitReporter):
 
121
 
 
122
    def snapshot_change(self, change, path):
 
123
        note("%s %s", change, path)
 
124
 
 
125
    def completed(self, revno, rev_id):
 
126
        note('committed r%d {%s}', revno, rev_id)
 
127
    
 
128
    def deleted(self, file_id):
 
129
        note('deleted %s', file_id)
 
130
 
 
131
    def escaped(self, escape_count, message):
 
132
        note("replaced %d control characters in message", escape_count)
 
133
 
 
134
    def missing(self, path):
 
135
        note('missing %s', path)
 
136
 
 
137
class Commit(object):
 
138
    """Task of committing a new revision.
 
139
 
 
140
    This is a MethodObject: it accumulates state as the commit is
 
141
    prepared, and then it is discarded.  It doesn't represent
 
142
    historical revisions, just the act of recording a new one.
 
143
 
 
144
            missing_ids
 
145
            Modified to hold a list of files that have been deleted from
 
146
            the working directory; these should be removed from the
 
147
            working inventory.
 
148
    """
 
149
    def __init__(self,
 
150
                 reporter=None,
 
151
                 config=None):
 
152
        if reporter is not None:
 
153
            self.reporter = reporter
 
154
        else:
 
155
            self.reporter = NullCommitReporter()
 
156
        if config is not None:
 
157
            self.config = config
 
158
        else:
 
159
            self.config = None
 
160
        
 
161
    def commit(self,
 
162
               branch, message,
 
163
               timestamp=None,
 
164
               timezone=None,
 
165
               committer=None,
 
166
               specific_files=None,
 
167
               rev_id=None,
 
168
               allow_pointless=True,
 
169
               verbose=False,
 
170
               revprops=None):
 
171
        """Commit working copy as a new revision.
 
172
 
 
173
        timestamp -- if not None, seconds-since-epoch for a
 
174
             postdated/predated commit.
 
175
 
 
176
        specific_files -- If true, commit only those files.
 
177
 
 
178
        rev_id -- If set, use this as the new revision id.
 
179
            Useful for test or import commands that need to tightly
 
180
            control what revisions are assigned.  If you duplicate
 
181
            a revision id that exists elsewhere it is your own fault.
 
182
            If null (default), a time/random revision id is generated.
 
183
 
 
184
        allow_pointless -- If true (default), commit even if nothing
 
185
            has changed and no merges are recorded.
 
186
 
 
187
        revprops -- Properties for new revision
 
188
        """
 
189
        mutter('preparing to commit')
 
190
 
 
191
        self.branch = branch
 
192
        self.weave_store = branch.weave_store
 
193
        self.rev_id = rev_id
 
194
        self.specific_files = specific_files
 
195
        self.allow_pointless = allow_pointless
 
196
        self.revprops = revprops
 
197
 
 
198
        if timestamp is None:
 
199
            self.timestamp = time.time()
 
200
        else:
 
201
            self.timestamp = long(timestamp)
 
202
            
 
203
        if self.config is None:
 
204
            self.config = bzrlib.config.BranchConfig(self.branch)
118
205
 
119
206
        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()
 
207
            self.rev_id = _gen_revision_id(self.config, self.timestamp)
 
208
        else:
 
209
            self.rev_id = rev_id
 
210
 
 
211
        if committer is None:
 
212
            self.committer = self.config.username()
 
213
        else:
 
214
            assert isinstance(committer, basestring), type(committer)
 
215
            self.committer = committer
 
216
 
 
217
        if timezone is None:
 
218
            self.timezone = local_time_offset()
 
219
        else:
 
220
            self.timezone = int(timezone)
 
221
 
 
222
        assert isinstance(message, basestring), type(message)
 
223
        self.message = message
 
224
        self._escape_commit_message()
 
225
 
 
226
        self.branch.lock_write()
 
227
        try:
 
228
            self.work_tree = self.branch.working_tree()
 
229
            self.work_inv = self.work_tree.inventory
 
230
            self.basis_tree = self.branch.basis_tree()
 
231
            self.basis_inv = self.basis_tree.inventory
 
232
 
 
233
            self._gather_parents()
 
234
            if len(self.parents) > 1 and self.specific_files:
 
235
                raise NotImplementedError('selected-file commit of merges is not supported yet')
 
236
            self._check_parents_present()
 
237
            
 
238
            self._remove_deleted()
 
239
            self._populate_new_inv()
 
240
            self._store_snapshot()
 
241
            self._report_deletes()
 
242
 
 
243
            if not (self.allow_pointless
 
244
                    or len(self.parents) > 1
 
245
                    or self.new_inv != self.basis_inv):
 
246
                raise PointlessCommit()
 
247
 
 
248
            if len(list(self.work_tree.iter_conflicts()))>0:
 
249
                raise ConflictsInTree
 
250
 
 
251
            self._record_inventory()
 
252
            self._make_revision()
 
253
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
 
254
            self.branch.append_revision(self.rev_id)
 
255
            self.branch.set_pending_merges([])
 
256
        finally:
 
257
            self.branch.unlock()
 
258
 
 
259
    def _record_inventory(self):
 
260
        """Store the inventory for the new revision."""
 
261
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
262
        self.inv_sha1 = sha_string(inv_text)
 
263
        s = self.branch.control_weaves
 
264
        s.add_text('inventory', self.rev_id,
 
265
                   split_lines(inv_text), self.present_parents,
 
266
                   self.branch.get_transaction())
 
267
 
 
268
    def _escape_commit_message(self):
 
269
        """Replace xml-incompatible control characters."""
 
270
        # Python strings can include characters that can't be
 
271
        # represented in well-formed XML; escape characters that
 
272
        # aren't listed in the XML specification
 
273
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
274
        if isinstance(self.message, unicode):
 
275
            char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
 
276
        else:
 
277
            # Use a regular 'str' as pattern to avoid having re.subn
 
278
            # return 'unicode' results.
 
279
            char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
 
280
        self.message, escape_count = re.subn(
 
281
            char_pattern,
 
282
            lambda match: match.group(0).encode('unicode_escape'),
 
283
            self.message)
 
284
        if escape_count:
 
285
            self.reporter.escaped(escape_count, self.message)
 
286
 
 
287
    def _gather_parents(self):
 
288
        """Record the parents of a merge for merge detection."""
 
289
        pending_merges = self.branch.pending_merges()
 
290
        self.parents = []
 
291
        self.parent_invs = []
 
292
        self.present_parents = []
 
293
        precursor_id = self.branch.last_revision()
156
294
        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))            
 
295
            self.parents.append(precursor_id)
 
296
        self.parents += pending_merges
 
297
        for revision in self.parents:
 
298
            if self.branch.has_revision(revision):
 
299
                self.parent_invs.append(self.branch.get_inventory(revision))
 
300
                self.present_parents.append(revision)
161
301
 
162
 
        rev_tmp = tempfile.TemporaryFile()
163
 
        pack_xml(rev, rev_tmp)
 
302
    def _check_parents_present(self):
 
303
        for parent_id in self.parents:
 
304
            mutter('commit parent revision {%s}', parent_id)
 
305
            if not self.branch.has_revision(parent_id):
 
306
                if parent_id == self.branch.last_revision():
 
307
                    warning("parent is missing %r", parent_id)
 
308
                    raise HistoryMissing(self.branch, 'revision', parent_id)
 
309
                else:
 
310
                    mutter("commit will ghost revision %r", parent_id)
 
311
            
 
312
    def _make_revision(self):
 
313
        """Record a new revision object for this commit."""
 
314
        self.rev = Revision(timestamp=self.timestamp,
 
315
                            timezone=self.timezone,
 
316
                            committer=self.committer,
 
317
                            message=self.message,
 
318
                            inventory_sha1=self.inv_sha1,
 
319
                            revision_id=self.rev_id,
 
320
                            properties=self.revprops)
 
321
        self.rev.parent_ids = self.parents
 
322
        rev_tmp = StringIO()
 
323
        serializer_v5.write_revision(self.rev, rev_tmp)
164
324
        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):
 
325
        if self.config.signature_needed():
 
326
            plaintext = Testament(self.rev, self.new_inv).as_short_text()
 
327
            self.branch.store_revision_signature(gpg.GPGStrategy(self.config),
 
328
                                                 plaintext, self.rev_id)
 
329
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
330
        mutter('new revision_id is {%s}', self.rev_id)
 
331
 
 
332
    def _remove_deleted(self):
 
333
        """Remove deleted files from the working inventories.
 
334
 
 
335
        This is done prior to taking the working inventory as the
 
336
        basis for the new committed inventory.
 
337
 
 
338
        This returns true if any files
 
339
        *that existed in the basis inventory* were deleted.
 
340
        Files that were added and deleted
 
341
        in the working copy don't matter.
 
342
        """
 
343
        specific = self.specific_files
 
344
        deleted_ids = []
 
345
        for path, ie in self.work_inv.iter_entries():
 
346
            if specific and not is_inside_any(specific, path):
 
347
                continue
 
348
            if not self.work_tree.has_filename(path):
 
349
                self.reporter.missing(path)
 
350
                deleted_ids.append((path, ie.file_id))
 
351
        if deleted_ids:
 
352
            deleted_ids.sort(reverse=True)
 
353
            for path, file_id in deleted_ids:
 
354
                del self.work_inv[file_id]
 
355
            self.branch._write_inventory(self.work_inv)
 
356
 
 
357
    def _store_snapshot(self):
 
358
        """Pass over inventory and record a snapshot.
 
359
 
 
360
        Entries get a new revision when they are modified in 
 
361
        any way, which includes a merge with a new set of
 
362
        parents that have the same entry. 
 
363
        """
 
364
        # XXX: Need to think more here about when the user has
 
365
        # made a specific decision on a particular value -- c.f.
 
366
        # mark-merge.  
 
367
        for path, ie in self.new_inv.iter_entries():
 
368
            previous_entries = ie.find_previous_heads(
 
369
                self.parent_invs, 
 
370
                self.weave_store.get_weave_or_empty(ie.file_id,
 
371
                    self.branch.get_transaction()))
 
372
            if ie.revision is None:
 
373
                change = ie.snapshot(self.rev_id, path, previous_entries,
 
374
                                     self.work_tree, self.weave_store,
 
375
                                     self.branch.get_transaction())
 
376
            else:
 
377
                change = "unchanged"
 
378
            self.reporter.snapshot_change(change, path)
 
379
 
 
380
    def _populate_new_inv(self):
 
381
        """Build revision inventory.
 
382
 
 
383
        This creates a new empty inventory. Depending on
 
384
        which files are selected for commit, and what is present in the
 
385
        current tree, the new inventory is populated. inventory entries 
 
386
        which are candidates for modification have their revision set to
 
387
        None; inventory entries that are carried over untouched have their
 
388
        revision set to their prior value.
 
389
        """
 
390
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
391
        self.new_inv = Inventory()
 
392
        for path, new_ie in self.work_inv.iter_entries():
 
393
            file_id = new_ie.file_id
 
394
            mutter('check %s {%s}', path, new_ie.file_id)
 
395
            if self.specific_files:
 
396
                if not is_inside_any(self.specific_files, path):
 
397
                    mutter('%s not selected for commit', path)
 
398
                    self._carry_entry(file_id)
 
399
                    continue
 
400
                else:
 
401
                    # this is selected, ensure its parents are too.
 
402
                    parent_id = new_ie.parent_id
 
403
                    while parent_id != ROOT_ID:
 
404
                        if not self.new_inv.has_id(parent_id):
 
405
                            ie = self._select_entry(self.work_inv[parent_id])
 
406
                            mutter('%s selected for commit because of %s',
 
407
                                   self.new_inv.id2path(parent_id), path)
 
408
 
 
409
                        ie = self.new_inv[parent_id]
 
410
                        if ie.revision is not None:
 
411
                            ie.revision = None
 
412
                            mutter('%s selected for commit because of %s',
 
413
                                   self.new_inv.id2path(parent_id), path)
 
414
                        parent_id = ie.parent_id
 
415
            mutter('%s selected for commit', path)
 
416
            self._select_entry(new_ie)
 
417
 
 
418
    def _select_entry(self, new_ie):
 
419
        """Make new_ie be considered for committing."""
 
420
        ie = new_ie.copy()
 
421
        ie.revision = None
 
422
        self.new_inv.add(ie)
 
423
        return ie
 
424
 
 
425
    def _carry_entry(self, file_id):
 
426
        """Carry the file unchanged from the basis revision."""
 
427
        if self.basis_inv.has_id(file_id):
 
428
            self.new_inv.add(self.basis_inv[file_id].copy())
 
429
 
 
430
    def _report_deletes(self):
 
431
        for file_id in self.basis_inv:
 
432
            if file_id not in self.new_inv:
 
433
                self.reporter.deleted(self.basis_inv.id2path(file_id))
 
434
 
 
435
def _gen_revision_id(config, when):
190
436
    """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))
 
437
    s = '%s-%s-' % (config.user_email(), compact_date(when))
195
438
    s += hexlify(rand_bytes(8))
196
439
    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, \
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