~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

add a clean target

Show diffs side-by-side

added added

removed removed

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