~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

- stub for revision properties

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
def commit(branch, message,
20
 
           timestamp=None,
21
 
           timezone=None,
22
 
           committer=None,
23
 
           verbose=True,
24
 
           specific_files=None,
25
 
           rev_id=None,
26
 
           allow_pointless=True):
27
 
    """Commit working copy as a new revision.
28
 
 
29
 
    The basic approach is to add all the file texts into the
30
 
    store, then the inventory, then make a new revision pointing
31
 
    to that inventory and store that.
32
 
 
33
 
    This is not quite safe if the working copy changes during the
34
 
    commit; for the moment that is simply not allowed.  A better
35
 
    approach is to make a temporary copy of the files before
36
 
    computing their hashes, and then add those hashes in turn to
37
 
    the inventory.  This should mean at least that there are no
38
 
    broken hash pointers.  There is no way we can get a snapshot
39
 
    of the whole directory at an instant.  This would also have to
40
 
    be robust against files disappearing, moving, etc.  So the
41
 
    whole thing is a bit hard.
42
 
 
43
 
    This raises PointlessCommit if there are no changes, no new merges,
44
 
    and allow_pointless  is false.
45
 
 
46
 
    timestamp -- if not None, seconds-since-epoch for a
47
 
         postdated/predated commit.
48
 
 
49
 
    specific_files
50
 
        If true, commit only those files.
51
 
 
52
 
    rev_id
53
 
        If set, use this as the new revision id.
54
 
        Useful for test or import commands that need to tightly
55
 
        control what revisions are assigned.  If you duplicate
56
 
        a revision id that exists elsewhere it is your own fault.
57
 
        If null (default), a time/random revision id is generated.
58
 
    """
59
 
 
60
 
    import time, tempfile
61
 
 
62
 
    from bzrlib.osutils import local_time_offset, username
63
 
    from bzrlib.branch import gen_file_id
64
 
    from bzrlib.errors import BzrError, PointlessCommit
65
 
    from bzrlib.revision import Revision, RevisionReference
66
 
    from bzrlib.trace import mutter, note
67
 
    from bzrlib.xml import serializer_v4
68
 
 
69
 
    branch.lock_write()
70
 
 
71
 
    try:
72
 
        # First walk over the working inventory; and both update that
73
 
        # and also build a new revision inventory.  The revision
74
 
        # inventory needs to hold the text-id, sha1 and size of the
75
 
        # actual file versions committed in the revision.  (These are
76
 
        # not present in the working inventory.)  We also need to
77
 
        # detect missing/deleted files, and remove them from the
78
 
        # working inventory.
79
 
 
80
 
        work_tree = branch.working_tree()
81
 
        work_inv = work_tree.inventory
82
 
        basis = branch.basis_tree()
83
 
        basis_inv = basis.inventory
84
 
 
85
 
        if verbose:
86
 
            # note('looking for changes...')
87
 
            # print 'looking for changes...'
88
 
            # disabled; should be done at a higher level
89
 
            pass
90
 
 
91
 
        pending_merges = branch.pending_merges()
92
 
 
93
 
        missing_ids, new_inv, any_changes = \
94
 
                     _gather_commit(branch,
95
 
                                    work_tree,
96
 
                                    work_inv,
97
 
                                    basis_inv,
98
 
                                    specific_files,
99
 
                                    verbose)
100
 
 
101
 
        if not (any_changes or allow_pointless or pending_merges):
102
 
            raise PointlessCommit()
103
 
 
104
 
        for file_id in missing_ids:
105
 
            # Any files that have been deleted are now removed from the
106
 
            # working inventory.  Files that were not selected for commit
107
 
            # are left as they were in the working inventory and ommitted
108
 
            # from the revision inventory.
109
 
 
110
 
            # have to do this later so we don't mess up the iterator.
111
 
            # since parents may be removed before their children we
112
 
            # have to test.
113
 
 
114
 
            # FIXME: There's probably a better way to do this; perhaps
115
 
            # the workingtree should know how to filter itbranch.
116
 
            if work_inv.has_id(file_id):
117
 
                del work_inv[file_id]
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
# 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
from bzrlib.revision import Revision
 
81
from bzrlib.trace import mutter, note, warning
 
82
from bzrlib.xml5 import serializer_v5
 
83
from bzrlib.inventory import Inventory, ROOT_ID
 
84
from bzrlib.weave import Weave
 
85
from bzrlib.weavefile import read_weave, write_weave_v5
 
86
from bzrlib.atomicfile import AtomicFile
 
87
 
 
88
 
 
89
def commit(*args, **kwargs):
 
90
    """Commit a new revision to a branch.
 
91
 
 
92
    Function-style interface for convenience of old callers.
 
93
 
 
94
    New code should use the Commit class instead.
 
95
    """
 
96
    ## XXX: Remove this in favor of Branch.commit?
 
97
    Commit().commit(*args, **kwargs)
 
98
 
 
99
 
 
100
class NullCommitReporter(object):
 
101
    """I report on progress of a commit."""
 
102
 
 
103
    def snapshot_change(self, change, path):
 
104
        pass
 
105
 
 
106
    def completed(self, revno, rev_id):
 
107
        pass
 
108
 
 
109
    def deleted(self, file_id):
 
110
        pass
 
111
 
 
112
    def escaped(self, escape_count, message):
 
113
        pass
 
114
 
 
115
    def missing(self, path):
 
116
        pass
 
117
 
 
118
class ReportCommitToLog(NullCommitReporter):
 
119
 
 
120
    def snapshot_change(self, change, path):
 
121
        note("%s %s", change, path)
 
122
 
 
123
    def completed(self, revno, rev_id):
 
124
        note('committed r%d {%s}', revno, rev_id)
 
125
    
 
126
    def deleted(self, file_id):
 
127
        note('deleted %s', file_id)
 
128
 
 
129
    def escaped(self, escape_count, message):
 
130
        note("replaced %d control characters in message", escape_count)
 
131
 
 
132
    def missing(self, path):
 
133
        note('missing %s', path)
 
134
 
 
135
class Commit(object):
 
136
    """Task of committing a new revision.
 
137
 
 
138
    This is a MethodObject: it accumulates state as the commit is
 
139
    prepared, and then it is discarded.  It doesn't represent
 
140
    historical revisions, just the act of recording a new one.
 
141
 
 
142
            missing_ids
 
143
            Modified to hold a list of files that have been deleted from
 
144
            the working directory; these should be removed from the
 
145
            working inventory.
 
146
    """
 
147
    def __init__(self,
 
148
                 reporter=None):
 
149
        if reporter is not None:
 
150
            self.reporter = reporter
 
151
        else:
 
152
            self.reporter = NullCommitReporter()
 
153
 
 
154
        
 
155
    def commit(self,
 
156
               branch, message,
 
157
               timestamp=None,
 
158
               timezone=None,
 
159
               committer=None,
 
160
               specific_files=None,
 
161
               rev_id=None,
 
162
               allow_pointless=True,
 
163
               verbose=False,
 
164
               revprops=None):
 
165
        """Commit working copy as a new revision.
 
166
 
 
167
        timestamp -- if not None, seconds-since-epoch for a
 
168
             postdated/predated commit.
 
169
 
 
170
        specific_files -- If true, commit only those files.
 
171
 
 
172
        rev_id -- If set, use this as the new revision id.
 
173
            Useful for test or import commands that need to tightly
 
174
            control what revisions are assigned.  If you duplicate
 
175
            a revision id that exists elsewhere it is your own fault.
 
176
            If null (default), a time/random revision id is generated.
 
177
 
 
178
        allow_pointless -- If true (default), commit even if nothing
 
179
            has changed and no merges are recorded.
 
180
 
 
181
        revprops -- Properties for new revision
 
182
        """
 
183
        mutter('preparing to commit')
 
184
 
 
185
        self.branch = branch
 
186
        self.weave_store = branch.weave_store
 
187
        self.rev_id = rev_id
 
188
        self.specific_files = specific_files
 
189
        self.allow_pointless = allow_pointless
 
190
        self.revprops = revprops
 
191
 
 
192
        if timestamp is None:
 
193
            self.timestamp = time.time()
 
194
        else:
 
195
            self.timestamp = long(timestamp)
 
196
            
119
197
        if rev_id is None:
120
 
            rev_id = _gen_revision_id(branch, time.time())
121
 
        inv_id = rev_id
122
 
 
123
 
        inv_tmp = tempfile.TemporaryFile()
124
 
        
125
 
        serializer_v4.write_inventory(new_inv, inv_tmp)
126
 
        inv_tmp.seek(0)
127
 
        branch.inventory_store.add(inv_tmp, inv_id)
128
 
        mutter('new inventory_id is {%s}' % inv_id)
129
 
 
130
 
        # We could also just sha hash the inv_tmp file
131
 
        # however, in the case that branch.inventory_store.add()
132
 
        # ever actually does anything special
133
 
        inv_sha1 = branch.get_inventory_sha1(inv_id)
134
 
 
135
 
        branch._write_inventory(work_inv)
136
 
 
137
 
        if timestamp == None:
138
 
            timestamp = time.time()
139
 
 
140
 
        if committer == None:
141
 
            committer = username(branch)
142
 
 
143
 
        if timezone == None:
144
 
            timezone = local_time_offset()
145
 
 
146
 
        mutter("building commit log message")
147
 
        rev = Revision(timestamp=timestamp,
148
 
                       timezone=timezone,
149
 
                       committer=committer,
150
 
                       message = message,
151
 
                       inventory_id=inv_id,
152
 
                       inventory_sha1=inv_sha1,
153
 
                       revision_id=rev_id)
154
 
 
155
 
        rev.parents = []
156
 
        precursor_id = branch.last_patch()
 
198
            self.rev_id = _gen_revision_id(self.branch, self.timestamp)
 
199
        else:
 
200
            self.rev_id = rev_id
 
201
 
 
202
        if committer is None:
 
203
            self.committer = bzrlib.config.username(self.branch)
 
204
        else:
 
205
            assert isinstance(committer, basestring), type(committer)
 
206
            self.committer = committer
 
207
 
 
208
        if timezone is None:
 
209
            self.timezone = local_time_offset()
 
210
        else:
 
211
            self.timezone = int(timezone)
 
212
 
 
213
        assert isinstance(message, basestring), type(message)
 
214
        self.message = message
 
215
        self._escape_commit_message()
 
216
 
 
217
        self.branch.lock_write()
 
218
        try:
 
219
            self.work_tree = self.branch.working_tree()
 
220
            self.work_inv = self.work_tree.inventory
 
221
            self.basis_tree = self.branch.basis_tree()
 
222
            self.basis_inv = self.basis_tree.inventory
 
223
 
 
224
            self._gather_parents()
 
225
            if len(self.parents) > 1 and self.specific_files:
 
226
                raise NotImplementedError('selected-file commit of merges is not supported yet')
 
227
            self._check_parents_present()
 
228
            
 
229
            self._remove_deleted()
 
230
            self._populate_new_inv()
 
231
            self._store_snapshot()
 
232
            self._report_deletes()
 
233
 
 
234
            if not (self.allow_pointless
 
235
                    or len(self.parents) > 1
 
236
                    or self.new_inv != self.basis_inv):
 
237
                raise PointlessCommit()
 
238
 
 
239
            if len(list(self.work_tree.iter_conflicts()))>0:
 
240
                raise ConflictsInTree
 
241
 
 
242
            self._record_inventory()
 
243
            self._make_revision()
 
244
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
 
245
            self.branch.append_revision(self.rev_id)
 
246
            self.branch.set_pending_merges([])
 
247
        finally:
 
248
            self.branch.unlock()
 
249
 
 
250
    def _record_inventory(self):
 
251
        """Store the inventory for the new revision."""
 
252
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
253
        self.inv_sha1 = sha_string(inv_text)
 
254
        s = self.branch.control_weaves
 
255
        s.add_text('inventory', self.rev_id,
 
256
                   split_lines(inv_text), self.present_parents,
 
257
                   self.branch.get_transaction())
 
258
 
 
259
    def _escape_commit_message(self):
 
260
        """Replace xml-incompatible control characters."""
 
261
        # Python strings can include characters that can't be
 
262
        # represented in well-formed XML; escape characters that
 
263
        # aren't listed in the XML specification
 
264
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
265
        if isinstance(self.message, unicode):
 
266
            char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
 
267
        else:
 
268
            # Use a regular 'str' as pattern to avoid having re.subn
 
269
            # return 'unicode' results.
 
270
            char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
 
271
        self.message, escape_count = re.subn(
 
272
            char_pattern,
 
273
            lambda match: match.group(0).encode('unicode_escape'),
 
274
            self.message)
 
275
        if escape_count:
 
276
            self.reporter.escaped(escape_count, self.message)
 
277
 
 
278
    def _gather_parents(self):
 
279
        """Record the parents of a merge for merge detection."""
 
280
        pending_merges = self.branch.pending_merges()
 
281
        self.parents = []
 
282
        self.parent_invs = []
 
283
        self.present_parents = []
 
284
        precursor_id = self.branch.last_revision()
157
285
        if precursor_id:
158
 
            precursor_sha1 = branch.get_revision_sha1(precursor_id)
159
 
            rev.parents.append(RevisionReference(precursor_id, precursor_sha1))
160
 
        for merge_rev in pending_merges:
161
 
            rev.parents.append(RevisionReference(merge_rev))            
 
286
            self.parents.append(precursor_id)
 
287
        self.parents += pending_merges
 
288
        for revision in self.parents:
 
289
            if self.branch.has_revision(revision):
 
290
                self.parent_invs.append(self.branch.get_inventory(revision))
 
291
                self.present_parents.append(revision)
162
292
 
163
 
        rev_tmp = tempfile.TemporaryFile()
164
 
        serializer_v4.write_revision(rev, rev_tmp)
 
293
    def _check_parents_present(self):
 
294
        for parent_id in self.parents:
 
295
            mutter('commit parent revision {%s}', parent_id)
 
296
            if not self.branch.has_revision(parent_id):
 
297
                if parent_id == self.branch.last_revision():
 
298
                    warning("parent is missing %r", parent_id)
 
299
                    raise HistoryMissing(self.branch, 'revision', parent_id)
 
300
                else:
 
301
                    mutter("commit will ghost revision %r", parent_id)
 
302
            
 
303
    def _make_revision(self):
 
304
        """Record a new revision object for this commit."""
 
305
        self.rev = Revision(timestamp=self.timestamp,
 
306
                            timezone=self.timezone,
 
307
                            committer=self.committer,
 
308
                            message=self.message,
 
309
                            inventory_sha1=self.inv_sha1,
 
310
                            revision_id=self.rev_id,
 
311
                            properties=self.revprops)
 
312
        self.rev.parent_ids = self.parents
 
313
        rev_tmp = StringIO()
 
314
        serializer_v5.write_revision(self.rev, rev_tmp)
165
315
        rev_tmp.seek(0)
166
 
        branch.revision_store.add(rev_tmp, rev_id)
167
 
        mutter("new revision_id is {%s}" % rev_id)
168
 
 
169
 
        ## XXX: Everything up to here can simply be orphaned if we abort
170
 
        ## the commit; it will leave junk files behind but that doesn't
171
 
        ## matter.
172
 
 
173
 
        ## TODO: Read back the just-generated changeset, and make sure it
174
 
        ## applies and recreates the right state.
175
 
 
176
 
        ## TODO: Also calculate and store the inventory SHA1
177
 
        mutter("committing patch r%d" % (branch.revno() + 1))
178
 
 
179
 
        branch.append_revision(rev_id)
180
 
 
181
 
        branch.set_pending_merges([])
182
 
 
183
 
        if verbose:
184
 
            # disabled; should go through logging
185
 
            # note("commited r%d" % branch.revno())
186
 
            # print ("commited r%d" % branch.revno())
187
 
            pass
188
 
    finally:
189
 
        branch.unlock()
190
 
 
191
 
 
 
316
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
317
        mutter('new revision_id is {%s}', self.rev_id)
 
318
 
 
319
    def _remove_deleted(self):
 
320
        """Remove deleted files from the working inventories.
 
321
 
 
322
        This is done prior to taking the working inventory as the
 
323
        basis for the new committed inventory.
 
324
 
 
325
        This returns true if any files
 
326
        *that existed in the basis inventory* were deleted.
 
327
        Files that were added and deleted
 
328
        in the working copy don't matter.
 
329
        """
 
330
        specific = self.specific_files
 
331
        deleted_ids = []
 
332
        for path, ie in self.work_inv.iter_entries():
 
333
            if specific and not is_inside_any(specific, path):
 
334
                continue
 
335
            if not self.work_tree.has_filename(path):
 
336
                self.reporter.missing(path)
 
337
                deleted_ids.append((path, ie.file_id))
 
338
        if deleted_ids:
 
339
            deleted_ids.sort(reverse=True)
 
340
            for path, file_id in deleted_ids:
 
341
                del self.work_inv[file_id]
 
342
            self.branch._write_inventory(self.work_inv)
 
343
 
 
344
    def _store_snapshot(self):
 
345
        """Pass over inventory and record a snapshot.
 
346
 
 
347
        Entries get a new revision when they are modified in 
 
348
        any way, which includes a merge with a new set of
 
349
        parents that have the same entry. 
 
350
        """
 
351
        # XXX: Need to think more here about when the user has
 
352
        # made a specific decision on a particular value -- c.f.
 
353
        # mark-merge.  
 
354
        for path, ie in self.new_inv.iter_entries():
 
355
            previous_entries = ie.find_previous_heads(
 
356
                self.parent_invs, 
 
357
                self.weave_store.get_weave_or_empty(ie.file_id,
 
358
                    self.branch.get_transaction()))
 
359
            if ie.revision is None:
 
360
                change = ie.snapshot(self.rev_id, path, previous_entries,
 
361
                                     self.work_tree, self.weave_store,
 
362
                                     self.branch.get_transaction())
 
363
            else:
 
364
                change = "unchanged"
 
365
            self.reporter.snapshot_change(change, path)
 
366
 
 
367
    def _populate_new_inv(self):
 
368
        """Build revision inventory.
 
369
 
 
370
        This creates a new empty inventory. Depending on
 
371
        which files are selected for commit, and what is present in the
 
372
        current tree, the new inventory is populated. inventory entries 
 
373
        which are candidates for modification have their revision set to
 
374
        None; inventory entries that are carried over untouched have their
 
375
        revision set to their prior value.
 
376
        """
 
377
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
378
        self.new_inv = Inventory()
 
379
        for path, new_ie in self.work_inv.iter_entries():
 
380
            file_id = new_ie.file_id
 
381
            mutter('check %s {%s}', path, new_ie.file_id)
 
382
            if self.specific_files:
 
383
                if not is_inside_any(self.specific_files, path):
 
384
                    mutter('%s not selected for commit', path)
 
385
                    self._carry_entry(file_id)
 
386
                    continue
 
387
                else:
 
388
                    # this is selected, ensure its parents are too.
 
389
                    parent_id = new_ie.parent_id
 
390
                    while parent_id != ROOT_ID:
 
391
                        if not self.new_inv.has_id(parent_id):
 
392
                            ie = self._select_entry(self.work_inv[parent_id])
 
393
                            mutter('%s selected for commit because of %s',
 
394
                                   self.new_inv.id2path(parent_id), path)
 
395
 
 
396
                        ie = self.new_inv[parent_id]
 
397
                        if ie.revision is not None:
 
398
                            ie.revision = None
 
399
                            mutter('%s selected for commit because of %s',
 
400
                                   self.new_inv.id2path(parent_id), path)
 
401
                        parent_id = ie.parent_id
 
402
            mutter('%s selected for commit', path)
 
403
            self._select_entry(new_ie)
 
404
 
 
405
    def _select_entry(self, new_ie):
 
406
        """Make new_ie be considered for committing."""
 
407
        ie = new_ie.copy()
 
408
        ie.revision = None
 
409
        self.new_inv.add(ie)
 
410
        return ie
 
411
 
 
412
    def _carry_entry(self, file_id):
 
413
        """Carry the file unchanged from the basis revision."""
 
414
        if self.basis_inv.has_id(file_id):
 
415
            self.new_inv.add(self.basis_inv[file_id].copy())
 
416
 
 
417
    def _report_deletes(self):
 
418
        for file_id in self.basis_inv:
 
419
            if file_id not in self.new_inv:
 
420
                self.reporter.deleted(self.basis_inv.id2path(file_id))
192
421
 
193
422
def _gen_revision_id(branch, when):
194
423
    """Return new revision-id."""
195
 
    from binascii import hexlify
196
 
    from bzrlib.osutils import rand_bytes, compact_date, user_email
197
 
 
198
 
    s = '%s-%s-' % (user_email(branch), compact_date(when))
 
424
    s = '%s-%s-' % (bzrlib.config.user_email(branch), compact_date(when))
199
425
    s += hexlify(rand_bytes(8))
200
426
    return s
201
 
 
202
 
 
203
 
def _gather_commit(branch, work_tree, work_inv, basis_inv, specific_files,
204
 
                   verbose):
205
 
    """Build inventory preparatory to commit.
206
 
 
207
 
    Returns missing_ids, new_inv, any_changes.
208
 
 
209
 
    This adds any changed files into the text store, and sets their
210
 
    test-id, sha and size in the returned inventory appropriately.
211
 
 
212
 
    missing_ids
213
 
        Modified to hold a list of files that have been deleted from
214
 
        the working directory; these should be removed from the
215
 
        working inventory.
216
 
    """
217
 
    from bzrlib.inventory import Inventory
218
 
    from bzrlib.osutils import isdir, isfile, sha_string, quotefn, \
219
 
         local_time_offset, username, kind_marker, is_inside_any
220
 
    
221
 
    from bzrlib.branch import gen_file_id
222
 
    from bzrlib.errors import BzrError
223
 
    from bzrlib.revision import Revision
224
 
    from bzrlib.trace import mutter, note
225
 
 
226
 
    any_changes = False
227
 
    inv = Inventory(work_inv.root.file_id)
228
 
    missing_ids = []
229
 
    
230
 
    for path, entry in work_inv.iter_entries():
231
 
        ## TODO: Check that the file kind has not changed from the previous
232
 
        ## revision of this file (if any).
233
 
 
234
 
        p = branch.abspath(path)
235
 
        file_id = entry.file_id
236
 
        mutter('commit prep file %s, id %r ' % (p, file_id))
237
 
 
238
 
        if specific_files and not is_inside_any(specific_files, path):
239
 
            mutter('  skipping file excluded from commit')
240
 
            if basis_inv.has_id(file_id):
241
 
                # carry over with previous state
242
 
                inv.add(basis_inv[file_id].copy())
243
 
            else:
244
 
                # omit this from committed inventory
245
 
                pass
246
 
            continue
247
 
 
248
 
        if not work_tree.has_id(file_id):
249
 
            if verbose:
250
 
                print('deleted %s%s' % (path, kind_marker(entry.kind)))
251
 
                any_changes = True
252
 
            mutter("    file is missing, removing from inventory")
253
 
            missing_ids.append(file_id)
254
 
            continue
255
 
 
256
 
        # this is present in the new inventory; may be new, modified or
257
 
        # unchanged.
258
 
        old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
259
 
        
260
 
        entry = entry.copy()
261
 
        inv.add(entry)
262
 
 
263
 
        if old_ie:
264
 
            old_kind = old_ie.kind
265
 
            if old_kind != entry.kind:
266
 
                raise BzrError("entry %r changed kind from %r to %r"
267
 
                        % (file_id, old_kind, entry.kind))
268
 
 
269
 
        if entry.kind == 'directory':
270
 
            if not isdir(p):
271
 
                raise BzrError("%s is entered as directory but not a directory"
272
 
                               % quotefn(p))
273
 
        elif entry.kind == 'file':
274
 
            if not isfile(p):
275
 
                raise BzrError("%s is entered as file but is not a file" % quotefn(p))
276
 
 
277
 
            new_sha1 = work_tree.get_file_sha1(file_id)
278
 
 
279
 
            if (old_ie
280
 
                and old_ie.text_sha1 == new_sha1):
281
 
                ## assert content == basis.get_file(file_id).read()
282
 
                entry.text_id = old_ie.text_id
283
 
                entry.text_sha1 = new_sha1
284
 
                entry.text_size = old_ie.text_size
285
 
                mutter('    unchanged from previous text_id {%s}' %
286
 
                       entry.text_id)
287
 
            else:
288
 
                content = file(p, 'rb').read()
289
 
 
290
 
                # calculate the sha again, just in case the file contents
291
 
                # changed since we updated the cache
292
 
                entry.text_sha1 = sha_string(content)
293
 
                entry.text_size = len(content)
294
 
 
295
 
                entry.text_id = gen_file_id(entry.name)
296
 
                branch.text_store.add(content, entry.text_id)
297
 
                mutter('    stored with text_id {%s}' % entry.text_id)
298
 
 
299
 
        if verbose:
300
 
            marked = path + kind_marker(entry.kind)
301
 
            if not old_ie:
302
 
                print 'added', marked
303
 
                any_changes = True
304
 
            elif old_ie == entry:
305
 
                pass                    # unchanged
306
 
            elif (old_ie.name == entry.name
307
 
                  and old_ie.parent_id == entry.parent_id):
308
 
                print 'modified', marked
309
 
                any_changes = True
310
 
            else:
311
 
                print 'renamed', marked
312
 
                any_changes = True
313
 
                        
314
 
    return missing_ids, inv, any_changes
315
 
 
316