~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-08-26 00:10:48 UTC
  • Revision ID: mbp@sourcefrog.net-20050826001048-b84148d3ef567d0d
- fix bzr.dev branch url in tutorial
  thanks to madduck

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