~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Robert Collins
  • Date: 2005-08-25 06:08:36 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825060836-40b430abb9d341d9
unbreak cmd_branch now that something tests the core of it..

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.atomicfile import AtomicFile
76
 
from bzrlib.osutils import (local_time_offset,
77
 
                            rand_bytes, compact_date,
78
 
                            kind_marker, is_inside_any, quotefn,
79
 
                            sha_file, isdir, isfile,
80
 
                            split_lines)
81
 
import bzrlib.config
82
 
import bzrlib.errors as errors
83
 
from bzrlib.errors import (BzrError, PointlessCommit,
84
 
                           HistoryMissing,
85
 
                           ConflictsInTree,
86
 
                           StrictCommitFailed
87
 
                           )
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.symbol_versioning import *
94
 
from bzrlib.workingtree import WorkingTree
95
 
 
96
 
 
97
 
@deprecated_function(zero_seven)
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
 
 
128
 
class ReportCommitToLog(NullCommitReporter):
129
 
 
130
 
    def snapshot_change(self, change, path):
131
 
        if change == 'unchanged':
132
 
            return
133
 
        note("%s %s", change, path)
134
 
 
135
 
    def completed(self, revno, rev_id):
136
 
        note('Committed revision %d.', revno)
137
 
    
138
 
    def deleted(self, file_id):
139
 
        note('deleted %s', file_id)
140
 
 
141
 
    def escaped(self, escape_count, message):
142
 
        note("replaced %d control characters in message", escape_count)
143
 
 
144
 
    def missing(self, path):
145
 
        note('missing %s', path)
146
 
 
147
 
 
148
 
class Commit(object):
149
 
    """Task of committing a new revision.
150
 
 
151
 
    This is a MethodObject: it accumulates state as the commit is
152
 
    prepared, and then it is discarded.  It doesn't represent
153
 
    historical revisions, just the act of recording a new one.
154
 
 
155
 
            missing_ids
156
 
            Modified to hold a list of files that have been deleted from
157
 
            the working directory; these should be removed from the
158
 
            working inventory.
159
 
    """
160
 
    def __init__(self,
161
 
                 reporter=None,
162
 
                 config=None):
163
 
        if reporter is not None:
164
 
            self.reporter = reporter
165
 
        else:
166
 
            self.reporter = NullCommitReporter()
167
 
        if config is not None:
168
 
            self.config = config
169
 
        else:
170
 
            self.config = None
171
 
        
172
 
    def commit(self,
173
 
               branch=DEPRECATED_PARAMETER, message=None,
174
 
               timestamp=None,
175
 
               timezone=None,
176
 
               committer=None,
177
 
               specific_files=None,
178
 
               rev_id=None,
179
 
               allow_pointless=True,
180
 
               strict=False,
181
 
               verbose=False,
182
 
               revprops=None,
183
 
               working_tree=None,
184
 
               local=False,
185
 
               reporter=None,
186
 
               config=None):
187
 
        """Commit working copy as a new revision.
188
 
 
189
 
        branch -- the deprecated branch to commit to. New callers should pass in 
190
 
                  working_tree instead
191
 
 
192
 
        message -- the commit message, a mandatory parameter
193
 
 
194
 
        timestamp -- if not None, seconds-since-epoch for a
195
 
             postdated/predated commit.
196
 
 
197
 
        specific_files -- If true, commit only those files.
198
 
 
199
 
        rev_id -- If set, use this as the new revision id.
200
 
            Useful for test or import commands that need to tightly
201
 
            control what revisions are assigned.  If you duplicate
202
 
            a revision id that exists elsewhere it is your own fault.
203
 
            If null (default), a time/random revision id is generated.
204
 
 
205
 
        allow_pointless -- If true (default), commit even if nothing
206
 
            has changed and no merges are recorded.
207
 
 
208
 
        strict -- If true, don't allow a commit if the working tree
209
 
            contains unknown files.
210
 
 
211
 
        revprops -- Properties for new revision
212
 
        :param local: Perform a local only commit.
213
 
        """
214
 
        mutter('preparing to commit')
215
 
 
216
 
        if deprecated_passed(branch):
217
 
            warn("Commit.commit (branch, ...): The branch parameter is "
218
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
219
 
                 DeprecationWarning, stacklevel=2)
220
 
            self.branch = branch
221
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
222
 
        elif working_tree is None:
223
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
224
 
        else:
225
 
            self.work_tree = working_tree
226
 
            self.branch = self.work_tree.branch
227
 
        if message is None:
228
 
            raise BzrError("The message keyword parameter is required for commit().")
229
 
 
230
 
        self.weave_store = self.branch.repository.weave_store
231
 
        self.bound_branch = None
232
 
        self.local = local
233
 
        self.master_branch = None
234
 
        self.master_locked = False
235
 
        self.rev_id = rev_id
236
 
        self.specific_files = specific_files
237
 
        self.allow_pointless = allow_pointless
238
 
        self.revprops = {}
239
 
        if revprops is not None:
240
 
            self.revprops.update(revprops)
241
 
 
242
 
        if reporter is None and self.reporter is None:
243
 
            self.reporter = NullCommitReporter()
244
 
        elif reporter is not None:
245
 
            self.reporter = reporter
246
 
 
247
 
        self.work_tree.lock_write()
248
 
        try:
249
 
            # setup the bound branch variables as needed.
250
 
            self._check_bound_branch()
251
 
 
252
 
            # check for out of date working trees
253
 
            # if we are bound, then self.branch is the master branch and this
254
 
            # test is thus all we need.
255
 
            if self.work_tree.last_revision() != self.master_branch.last_revision():
256
 
                raise errors.OutOfDateTree(self.work_tree)
257
 
    
258
 
            if strict:
259
 
                # raise an exception as soon as we find a single unknown.
260
 
                for unknown in self.work_tree.unknowns():
261
 
                    raise StrictCommitFailed()
262
 
    
263
 
            if timestamp is None:
264
 
                self.timestamp = time.time()
265
 
            else:
266
 
                self.timestamp = long(timestamp)
267
 
                
268
 
            if self.config is None:
269
 
                self.config = bzrlib.config.BranchConfig(self.branch)
270
 
    
271
 
            if rev_id is None:
272
 
                self.rev_id = _gen_revision_id(self.config, self.timestamp)
273
 
            else:
274
 
                self.rev_id = rev_id
275
 
    
276
 
            if committer is None:
277
 
                self.committer = self.config.username()
278
 
            else:
279
 
                assert isinstance(committer, basestring), type(committer)
280
 
                self.committer = committer
281
 
    
282
 
            if timezone is None:
283
 
                self.timezone = local_time_offset()
284
 
            else:
285
 
                self.timezone = int(timezone)
286
 
    
287
 
            if isinstance(message, str):
288
 
                message = message.decode(bzrlib.user_encoding)
289
 
            assert isinstance(message, unicode), type(message)
290
 
            self.message = message
291
 
            self._escape_commit_message()
292
 
 
293
 
            self.work_inv = self.work_tree.inventory
294
 
            self.basis_tree = self.work_tree.basis_tree()
295
 
            self.basis_inv = self.basis_tree.inventory
296
 
 
297
 
            self._gather_parents()
298
 
            if len(self.parents) > 1 and self.specific_files:
299
 
                raise NotImplementedError('selected-file commit of merges is not supported yet')
300
 
            self._check_parents_present()
301
 
            
302
 
            self._remove_deleted()
303
 
            self._populate_new_inv()
304
 
            self._store_snapshot()
305
 
            self._report_deletes()
306
 
 
307
 
            if not (self.allow_pointless
308
 
                    or len(self.parents) > 1
309
 
                    or self.new_inv != self.basis_inv):
310
 
                raise PointlessCommit()
311
 
 
312
 
            if len(self.work_tree.conflicts())>0:
313
 
                raise ConflictsInTree
314
 
 
315
 
            self.inv_sha1 = self.branch.repository.add_inventory(
316
 
                self.rev_id,
317
 
                self.new_inv,
318
 
                self.present_parents
319
 
                )
320
 
            self._make_revision()
321
 
            # revision data is in the local branch now.
322
 
            
323
 
            # upload revision data to the master.
324
 
            # this will propogate merged revisions too if needed.
325
 
            if self.bound_branch:
326
 
                self.master_branch.repository.fetch(self.branch.repository,
327
 
                                                    revision_id=self.rev_id)
328
 
                # now the master has the revision data
329
 
                # 'commit' to the master first so a timeout here causes the local
330
 
                # branch to be out of date
331
 
                self.master_branch.append_revision(self.rev_id)
332
 
 
333
 
            # and now do the commit locally.
334
 
            self.branch.append_revision(self.rev_id)
335
 
 
336
 
            self.work_tree.set_pending_merges([])
337
 
            self.work_tree.set_last_revision(self.rev_id)
338
 
            # now the work tree is up to date with the branch
339
 
            
340
 
            self.reporter.completed(self.branch.revno(), self.rev_id)
341
 
            if self.config.post_commit() is not None:
342
 
                hooks = self.config.post_commit().split(' ')
343
 
                # this would be nicer with twisted.python.reflect.namedAny
344
 
                for hook in hooks:
345
 
                    result = eval(hook + '(branch, rev_id)',
346
 
                                  {'branch':self.branch,
347
 
                                   'bzrlib':bzrlib,
348
 
                                   'rev_id':self.rev_id})
349
 
        finally:
350
 
            self._cleanup_bound_branch()
351
 
            self.work_tree.unlock()
352
 
 
353
 
    def _check_bound_branch(self):
354
 
        """Check to see if the local branch is bound.
355
 
 
356
 
        If it is bound, then most of the commit will actually be
357
 
        done using the remote branch as the target branch.
358
 
        Only at the end will the local branch be updated.
359
 
        """
360
 
        if self.local and not self.branch.get_bound_location():
361
 
            raise errors.LocalRequiresBoundBranch()
362
 
 
363
 
        if not self.local:
364
 
            self.master_branch = self.branch.get_master_branch()
365
 
 
366
 
        if not self.master_branch:
367
 
            # make this branch the reference branch for out of date checks.
368
 
            self.master_branch = self.branch
369
 
            return
370
 
 
371
 
        # If the master branch is bound, we must fail
372
 
        master_bound_location = self.master_branch.get_bound_location()
373
 
        if master_bound_location:
374
 
            raise errors.CommitToDoubleBoundBranch(self.branch,
375
 
                    self.master_branch, master_bound_location)
376
 
 
377
 
        # TODO: jam 20051230 We could automatically push local
378
 
        #       commits to the remote branch if they would fit.
379
 
        #       But for now, just require remote to be identical
380
 
        #       to local.
381
 
        
382
 
        # Make sure the local branch is identical to the master
383
 
        master_rh = self.master_branch.revision_history()
384
 
        local_rh = self.branch.revision_history()
385
 
        if local_rh != master_rh:
386
 
            raise errors.BoundBranchOutOfDate(self.branch,
387
 
                    self.master_branch)
388
 
 
389
 
        # Now things are ready to change the master branch
390
 
        # so grab the lock
391
 
        self.bound_branch = self.branch
392
 
        self.master_branch.lock_write()
393
 
        self.master_locked = True
394
 
####        
395
 
####        # Check to see if we have any pending merges. If we do
396
 
####        # those need to be pushed into the master branch
397
 
####        pending_merges = self.work_tree.pending_merges()
398
 
####        if pending_merges:
399
 
####            for revision_id in pending_merges:
400
 
####                self.master_branch.repository.fetch(self.bound_branch.repository,
401
 
####                                                    revision_id=revision_id)
402
 
 
403
 
    def _cleanup_bound_branch(self):
404
 
        """Executed at the end of a try/finally to cleanup a bound branch.
405
 
 
406
 
        If the branch wasn't bound, this is a no-op.
407
 
        If it was, it resents self.branch to the local branch, instead
408
 
        of being the master.
409
 
        """
410
 
        if not self.bound_branch:
411
 
            return
412
 
        if self.master_locked:
413
 
            self.master_branch.unlock()
414
 
 
415
 
    def _escape_commit_message(self):
416
 
        """Replace xml-incompatible control characters."""
417
 
        # FIXME: RBC 20060419 this should be done by the revision
418
 
        # serialiser not by commit. Then we can also add an unescaper
419
 
        # in the deserializer and start roundtripping revision messages
420
 
        # precisely. See repository_implementations/test_repository.py
421
 
        
422
 
        # Python strings can include characters that can't be
423
 
        # represented in well-formed XML; escape characters that
424
 
        # aren't listed in the XML specification
425
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
426
 
        self.message, escape_count = re.subn(
427
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
428
 
            lambda match: match.group(0).encode('unicode_escape'),
429
 
            self.message)
430
 
        if escape_count:
431
 
            self.reporter.escaped(escape_count, self.message)
432
 
 
433
 
    def _gather_parents(self):
434
 
        """Record the parents of a merge for merge detection."""
435
 
        pending_merges = self.work_tree.pending_merges()
436
 
        self.parents = []
437
 
        self.parent_invs = []
438
 
        self.present_parents = []
439
 
        precursor_id = self.branch.last_revision()
 
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]
 
120
 
 
121
        if rev_id is None:
 
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()
440
158
        if precursor_id:
441
 
            self.parents.append(precursor_id)
442
 
        self.parents += pending_merges
443
 
        for revision in self.parents:
444
 
            if self.branch.repository.has_revision(revision):
445
 
                inventory = self.branch.repository.get_inventory(revision)
446
 
                self.parent_invs.append(inventory)
447
 
                self.present_parents.append(revision)
448
 
 
449
 
    def _check_parents_present(self):
450
 
        for parent_id in self.parents:
451
 
            mutter('commit parent revision {%s}', parent_id)
452
 
            if not self.branch.repository.has_revision(parent_id):
453
 
                if parent_id == self.branch.last_revision():
454
 
                    warning("parent is missing %r", parent_id)
455
 
                    raise HistoryMissing(self.branch, 'revision', parent_id)
456
 
                else:
457
 
                    mutter("commit will ghost revision %r", parent_id)
458
 
            
459
 
    def _make_revision(self):
460
 
        """Record a new revision object for this commit."""
461
 
        rev = Revision(timestamp=self.timestamp,
462
 
                       timezone=self.timezone,
463
 
                       committer=self.committer,
464
 
                       message=self.message,
465
 
                       inventory_sha1=self.inv_sha1,
466
 
                       revision_id=self.rev_id,
467
 
                       properties=self.revprops)
468
 
        rev.parent_ids = self.parents
469
 
        self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
470
 
 
471
 
    def _remove_deleted(self):
472
 
        """Remove deleted files from the working inventories.
473
 
 
474
 
        This is done prior to taking the working inventory as the
475
 
        basis for the new committed inventory.
476
 
 
477
 
        This returns true if any files
478
 
        *that existed in the basis inventory* were deleted.
479
 
        Files that were added and deleted
480
 
        in the working copy don't matter.
481
 
        """
482
 
        specific = self.specific_files
483
 
        deleted_ids = []
484
 
        for path, ie in self.work_inv.iter_entries():
485
 
            if specific and not is_inside_any(specific, path):
486
 
                continue
487
 
            if not self.work_tree.has_filename(path):
488
 
                self.reporter.missing(path)
489
 
                deleted_ids.append((path, ie.file_id))
490
 
        if deleted_ids:
491
 
            deleted_ids.sort(reverse=True)
492
 
            for path, file_id in deleted_ids:
493
 
                del self.work_inv[file_id]
494
 
            self.work_tree._write_inventory(self.work_inv)
495
 
 
496
 
    def _store_snapshot(self):
497
 
        """Pass over inventory and record a snapshot.
498
 
 
499
 
        Entries get a new revision when they are modified in 
500
 
        any way, which includes a merge with a new set of
501
 
        parents that have the same entry. 
502
 
        """
503
 
        # XXX: Need to think more here about when the user has
504
 
        # made a specific decision on a particular value -- c.f.
505
 
        # mark-merge.  
506
 
        for path, ie in self.new_inv.iter_entries():
507
 
            previous_entries = ie.find_previous_heads(
508
 
                self.parent_invs,
509
 
                self.weave_store,
510
 
                self.branch.repository.get_transaction())
511
 
            if ie.revision is None:
512
 
                change = ie.snapshot(self.rev_id, path, previous_entries,
513
 
                                     self.work_tree, self.weave_store,
514
 
                                     self.branch.get_transaction())
515
 
            else:
516
 
                change = "unchanged"
517
 
            self.reporter.snapshot_change(change, path)
518
 
 
519
 
    def _populate_new_inv(self):
520
 
        """Build revision inventory.
521
 
 
522
 
        This creates a new empty inventory. Depending on
523
 
        which files are selected for commit, and what is present in the
524
 
        current tree, the new inventory is populated. inventory entries 
525
 
        which are candidates for modification have their revision set to
526
 
        None; inventory entries that are carried over untouched have their
527
 
        revision set to their prior value.
528
 
        """
529
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
530
 
        self.new_inv = Inventory(revision_id=self.rev_id)
531
 
        for path, new_ie in self.work_inv.iter_entries():
532
 
            file_id = new_ie.file_id
533
 
            mutter('check %s {%s}', path, new_ie.file_id)
534
 
            if self.specific_files:
535
 
                if not is_inside_any(self.specific_files, path):
536
 
                    mutter('%s not selected for commit', path)
537
 
                    self._carry_entry(file_id)
538
 
                    continue
539
 
                else:
540
 
                    # this is selected, ensure its parents are too.
541
 
                    parent_id = new_ie.parent_id
542
 
                    while parent_id != ROOT_ID:
543
 
                        if not self.new_inv.has_id(parent_id):
544
 
                            ie = self._select_entry(self.work_inv[parent_id])
545
 
                            mutter('%s selected for commit because of %s',
546
 
                                   self.new_inv.id2path(parent_id), path)
547
 
 
548
 
                        ie = self.new_inv[parent_id]
549
 
                        if ie.revision is not None:
550
 
                            ie.revision = None
551
 
                            mutter('%s selected for commit because of %s',
552
 
                                   self.new_inv.id2path(parent_id), path)
553
 
                        parent_id = ie.parent_id
554
 
            mutter('%s selected for commit', path)
555
 
            self._select_entry(new_ie)
556
 
 
557
 
    def _select_entry(self, new_ie):
558
 
        """Make new_ie be considered for committing."""
559
 
        ie = new_ie.copy()
560
 
        ie.revision = None
561
 
        self.new_inv.add(ie)
562
 
        return ie
563
 
 
564
 
    def _carry_entry(self, file_id):
565
 
        """Carry the file unchanged from the basis revision."""
566
 
        if self.basis_inv.has_id(file_id):
567
 
            self.new_inv.add(self.basis_inv[file_id].copy())
568
 
 
569
 
    def _report_deletes(self):
570
 
        for file_id in self.basis_inv:
571
 
            if file_id not in self.new_inv:
572
 
                self.reporter.deleted(self.basis_inv.id2path(file_id))
573
 
 
574
 
def _gen_revision_id(config, when):
 
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))            
 
163
 
 
164
        rev_tmp = tempfile.TemporaryFile()
 
165
        pack_xml(rev, rev_tmp)
 
166
        rev_tmp.seek(0)
 
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):
575
195
    """Return new revision-id."""
576
 
    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))
577
200
    s += hexlify(rand_bytes(8))
578
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