~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-07-07 10:22:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050707102201-2d2a13a25098b101
- rearrange and clear up merged weave

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2005 Canonical Ltd
 
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
 
# The newly committed revision is going to have a shape corresponding
19
 
# to that of the working inventory.  Files that are not in the
20
 
# working tree and that were in the predecessor are reported as
21
 
# removed --- this can include files that were either removed from the
22
 
# inventory or deleted in the working tree.  If they were only
23
 
# deleted from disk, they are removed from the working inventory.
24
 
 
25
 
# We then consider the remaining entries, which will be in the new
26
 
# version.  Directory entries are simply copied across.  File entries
27
 
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision inventory, we check to see what
29
 
# version of the file was present.  If the file was present in at
30
 
# least one tree, and if it was the same version in all the trees,
31
 
# then we can just refer to that version.  Otherwise, a new version
32
 
# representing the merger of the file versions must be added.
33
 
 
34
 
# TODO: Update hashcache before and after - or does the WorkingTree
35
 
# look after that?
36
 
 
37
 
# TODO: Rather than mashing together the ancestry and storing it back,
38
 
# perhaps the weave should have single method which does it all in one
39
 
# go, avoiding a lot of redundant work.
40
 
 
41
 
# TODO: Perhaps give a warning if one of the revisions marked as
42
 
# merged is already in the ancestry, and then don't record it as a
43
 
# distinct parent.
44
 
 
45
 
# TODO: If the file is newly merged but unchanged from the version it
46
 
# merges from, then it should still be reported as newly added
47
 
# relative to the basis revision.
48
 
 
49
 
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
 
# the rest of the code; add a deprecation of the old name.
51
 
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
 
from bzrlib import (
60
 
    errors,
61
 
    inventory,
62
 
    tree,
63
 
    )
64
 
from bzrlib.branch import Branch
65
 
import bzrlib.config
66
 
from bzrlib.errors import (BzrError, PointlessCommit,
67
 
                           ConflictsInTree,
68
 
                           StrictCommitFailed
69
 
                           )
70
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
71
 
                            is_inside_or_parent_of_any,
72
 
                            quotefn, sha_file, split_lines)
73
 
from bzrlib.testament import Testament
74
 
from bzrlib.trace import mutter, note, warning
75
 
from bzrlib.xml5 import serializer_v5
76
 
from bzrlib.inventory import Inventory, InventoryEntry
77
 
from bzrlib import symbol_versioning
78
 
from bzrlib.symbol_versioning import (deprecated_passed,
79
 
        deprecated_function,
80
 
        DEPRECATED_PARAMETER)
81
 
from bzrlib.workingtree import WorkingTree
82
 
import bzrlib.ui
83
 
 
84
 
 
85
 
class NullCommitReporter(object):
86
 
    """I report on progress of a commit."""
87
 
 
88
 
    def snapshot_change(self, change, path):
89
 
        pass
90
 
 
91
 
    def completed(self, revno, rev_id):
92
 
        pass
93
 
 
94
 
    def deleted(self, file_id):
95
 
        pass
96
 
 
97
 
    def escaped(self, escape_count, message):
98
 
        pass
99
 
 
100
 
    def missing(self, path):
101
 
        pass
102
 
 
103
 
    def renamed(self, change, old_path, new_path):
104
 
        pass
105
 
 
106
 
 
107
 
class ReportCommitToLog(NullCommitReporter):
108
 
 
109
 
    # this may be more useful if 'note' was replaced by an overridable
110
 
    # method on self, which would allow more trivial subclassing.
111
 
    # alternative, a callable could be passed in, allowing really trivial
112
 
    # reuse for some uis. RBC 20060511
113
 
 
114
 
    def snapshot_change(self, change, path):
115
 
        if change == 'unchanged':
116
 
            return
117
 
        if change == 'added' and path == '':
118
 
            return
119
 
        note("%s %s", change, path)
120
 
 
121
 
    def completed(self, revno, rev_id):
122
 
        note('Committed revision %d.', revno)
123
 
    
124
 
    def deleted(self, file_id):
125
 
        note('deleted %s', file_id)
126
 
 
127
 
    def escaped(self, escape_count, message):
128
 
        note("replaced %d control characters in message", escape_count)
129
 
 
130
 
    def missing(self, path):
131
 
        note('missing %s', path)
132
 
 
133
 
    def renamed(self, change, old_path, new_path):
134
 
        note('%s %s => %s', change, old_path, new_path)
135
 
 
136
 
 
137
 
class Commit(object):
138
 
    """Task of committing a new revision.
139
 
 
140
 
    This is a MethodObject: it accumulates state as the commit is
141
 
    prepared, and then it is discarded.  It doesn't represent
142
 
    historical revisions, just the act of recording a new one.
143
 
 
144
 
            missing_ids
145
 
            Modified to hold a list of files that have been deleted from
146
 
            the working directory; these should be removed from the
147
 
            working inventory.
148
 
    """
149
 
    def __init__(self,
150
 
                 reporter=None,
151
 
                 config=None):
152
 
        if reporter is not None:
153
 
            self.reporter = reporter
154
 
        else:
155
 
            self.reporter = NullCommitReporter()
156
 
        if config is not None:
157
 
            self.config = config
158
 
        else:
159
 
            self.config = None
160
 
        
161
 
    def commit(self,
162
 
               branch=DEPRECATED_PARAMETER, message=None,
163
 
               timestamp=None,
164
 
               timezone=None,
165
 
               committer=None,
166
 
               specific_files=None,
167
 
               rev_id=None,
168
 
               allow_pointless=True,
169
 
               strict=False,
170
 
               verbose=False,
171
 
               revprops=None,
172
 
               working_tree=None,
173
 
               local=False,
174
 
               reporter=None,
175
 
               config=None,
176
 
               message_callback=None):
177
 
        """Commit working copy as a new revision.
178
 
 
179
 
        branch -- the deprecated branch to commit to. New callers should pass in 
180
 
                  working_tree instead
181
 
 
182
 
        message -- the commit message (it or message_callback is required)
183
 
 
184
 
        timestamp -- if not None, seconds-since-epoch for a
185
 
             postdated/predated commit.
186
 
 
187
 
        specific_files -- If true, commit only those files.
188
 
 
189
 
        rev_id -- If set, use this as the new revision id.
190
 
            Useful for test or import commands that need to tightly
191
 
            control what revisions are assigned.  If you duplicate
192
 
            a revision id that exists elsewhere it is your own fault.
193
 
            If null (default), a time/random revision id is generated.
194
 
 
195
 
        allow_pointless -- If true (default), commit even if nothing
196
 
            has changed and no merges are recorded.
197
 
 
198
 
        strict -- If true, don't allow a commit if the working tree
199
 
            contains unknown files.
200
 
 
201
 
        revprops -- Properties for new revision
202
 
        :param local: Perform a local only commit.
203
 
        """
204
 
        mutter('preparing to commit')
205
 
 
206
 
        if deprecated_passed(branch):
207
 
            symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
208
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
209
 
                 DeprecationWarning, stacklevel=2)
210
 
            self.branch = branch
211
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
212
 
        elif working_tree is None:
213
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
214
 
        else:
215
 
            self.work_tree = working_tree
216
 
            self.branch = self.work_tree.branch
217
 
        if message_callback is None:
218
 
            if message is not None:
219
 
                if isinstance(message, str):
220
 
                    message = message.decode(bzrlib.user_encoding)
221
 
                message_callback = lambda x: message
222
 
            else:
223
 
                raise BzrError("The message or message_callback keyword"
224
 
                               " parameter is required for commit().")
225
 
 
226
 
        self.bound_branch = None
227
 
        self.local = local
228
 
        self.master_branch = None
229
 
        self.master_locked = False
230
 
        self.rev_id = None
231
 
        self.specific_files = specific_files
232
 
        self.allow_pointless = allow_pointless
233
 
 
234
 
        if reporter is None and self.reporter is None:
235
 
            self.reporter = NullCommitReporter()
236
 
        elif reporter is not None:
237
 
            self.reporter = reporter
238
 
 
239
 
        self.work_tree.lock_write()
240
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
241
 
        self.basis_tree = self.work_tree.basis_tree()
242
 
        self.basis_tree.lock_read()
243
 
        try:
244
 
            # Cannot commit with conflicts present.
245
 
            if len(self.work_tree.conflicts())>0:
246
 
                raise ConflictsInTree
247
 
 
248
 
            # setup the bound branch variables as needed.
249
 
            self._check_bound_branch()
250
 
 
251
 
            # check for out of date working trees
252
 
            try:
253
 
                first_tree_parent = self.work_tree.get_parent_ids()[0]
254
 
            except IndexError:
255
 
                # if there are no parents, treat our parent as 'None'
256
 
                # this is so that we still consier the master branch
257
 
                # - in a checkout scenario the tree may have no
258
 
                # parents but the branch may do.
259
 
                first_tree_parent = bzrlib.revision.NULL_REVISION
260
 
            old_revno, master_last = self.master_branch.last_revision_info()
261
 
            if master_last != first_tree_parent:
262
 
                if master_last != bzrlib.revision.NULL_REVISION:
263
 
                    raise errors.OutOfDateTree(self.work_tree)
264
 
            if self.branch.repository.has_revision(first_tree_parent):
265
 
                new_revno = old_revno + 1
266
 
            else:
267
 
                # ghost parents never appear in revision history.
268
 
                new_revno = 1
269
 
            if strict:
270
 
                # raise an exception as soon as we find a single unknown.
271
 
                for unknown in self.work_tree.unknowns():
272
 
                    raise StrictCommitFailed()
273
 
                   
274
 
            if self.config is None:
275
 
                self.config = self.branch.get_config()
276
 
 
277
 
            self.work_inv = self.work_tree.inventory
278
 
            self.basis_inv = self.basis_tree.inventory
279
 
            if specific_files is not None:
280
 
                # Ensure specified files are versioned
281
 
                # (We don't actually need the ids here)
282
 
                tree.find_ids_across_trees(specific_files, 
283
 
                                           [self.basis_tree, self.work_tree])
284
 
            # one to finish, one for rev and inventory, and one for each
285
 
            # inventory entry, and the same for the new inventory.
286
 
            # note that this estimate is too long when we do a partial tree
287
 
            # commit which excludes some new files from being considered.
288
 
            # The estimate is corrected when we populate the new inv.
289
 
            self.pb_total = len(self.work_inv) + 5
290
 
            self.pb_count = 0
291
 
 
292
 
            self._gather_parents()
293
 
            if len(self.parents) > 1 and self.specific_files:
294
 
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
295
 
                        self.specific_files)
296
 
            
297
 
            self.builder = self.branch.get_commit_builder(self.parents, 
298
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
299
 
            
300
 
            self._remove_deleted()
301
 
            self._populate_new_inv()
302
 
            self._report_deletes()
303
 
 
304
 
            self._check_pointless()
305
 
 
306
 
            self._emit_progress_update()
307
 
            # TODO: Now the new inventory is known, check for conflicts and
308
 
            # prompt the user for a commit message.
309
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
310
 
            # weave lines, because nothing should be recorded until it is known
311
 
            # that commit will succeed.
312
 
            self.builder.finish_inventory()
313
 
            self._emit_progress_update()
314
 
            message = message_callback(self)
315
 
            assert isinstance(message, unicode), type(message)
316
 
            self.message = message
317
 
            self._escape_commit_message()
318
 
 
319
 
            self.rev_id = self.builder.commit(self.message)
320
 
            self._emit_progress_update()
321
 
            # revision data is in the local branch now.
322
 
            
323
 
            # upload revision data to the master.
324
 
            # this will propagate 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.set_last_revision_info(new_revno,
332
 
                                                          self.rev_id)
333
 
 
334
 
            # and now do the commit locally.
335
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
336
 
 
337
 
            rev_tree = self.builder.revision_tree()
338
 
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
339
 
            # now the work tree is up to date with the branch
340
 
            
341
 
            self.reporter.completed(new_revno, self.rev_id)
342
 
            # old style commit hooks - should be deprecated ? (obsoleted in
343
 
            # 0.15)
344
 
            if self.config.post_commit() is not None:
345
 
                hooks = self.config.post_commit().split(' ')
346
 
                # this would be nicer with twisted.python.reflect.namedAny
347
 
                for hook in hooks:
348
 
                    result = eval(hook + '(branch, rev_id)',
349
 
                                  {'branch':self.branch,
350
 
                                   'bzrlib':bzrlib,
351
 
                                   'rev_id':self.rev_id})
352
 
            # new style commit hooks:
353
 
            if not self.bound_branch:
354
 
                hook_master = self.branch
355
 
                hook_local = None
356
 
            else:
357
 
                hook_master = self.master_branch
358
 
                hook_local = self.branch
359
 
            # With bound branches, when the master is behind the local branch,
360
 
            # the 'old_revno' and old_revid values here are incorrect.
361
 
            # XXX: FIXME ^. RBC 20060206
362
 
            if self.parents:
363
 
                old_revid = self.parents[0]
364
 
            else:
365
 
                old_revid = bzrlib.revision.NULL_REVISION
366
 
            for hook in Branch.hooks['post_commit']:
367
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
368
 
                    self.rev_id)
369
 
            self._emit_progress_update()
370
 
        finally:
371
 
            self._cleanup()
372
 
        return self.rev_id
373
 
 
374
 
    def _any_real_changes(self):
375
 
        """Are there real changes between new_inventory and basis?
376
 
 
377
 
        For trees without rich roots, inv.root.revision changes every commit.
378
 
        But if that is the only change, we want to treat it as though there
379
 
        are *no* changes.
380
 
        """
381
 
        new_entries = self.builder.new_inventory.iter_entries()
382
 
        basis_entries = self.basis_inv.iter_entries()
383
 
        new_path, new_root_ie = new_entries.next()
384
 
        basis_path, basis_root_ie = basis_entries.next()
385
 
 
386
 
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
387
 
        def ie_equal_no_revision(this, other):
388
 
            return ((this.file_id == other.file_id)
389
 
                    and (this.name == other.name)
390
 
                    and (this.symlink_target == other.symlink_target)
391
 
                    and (this.text_sha1 == other.text_sha1)
392
 
                    and (this.text_size == other.text_size)
393
 
                    and (this.text_id == other.text_id)
394
 
                    and (this.parent_id == other.parent_id)
395
 
                    and (this.kind == other.kind)
396
 
                    and (this.executable == other.executable)
397
 
                    )
398
 
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
399
 
            return True
400
 
 
401
 
        for new_ie, basis_ie in zip(new_entries, basis_entries):
402
 
            if new_ie != basis_ie:
403
 
                return True
404
 
 
405
 
        # No actual changes present
406
 
        return False
407
 
 
408
 
    def _check_pointless(self):
409
 
        if self.allow_pointless:
410
 
            return
411
 
        # A merge with no effect on files
412
 
        if len(self.parents) > 1:
413
 
            return
414
 
        # work around the fact that a newly-initted tree does differ from its
415
 
        # basis
416
 
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
417
 
            raise PointlessCommit()
418
 
        # Shortcut, if the number of entries changes, then we obviously have
419
 
        # a change
420
 
        if len(self.builder.new_inventory) != len(self.basis_inv):
421
 
            return
422
 
        # If length == 1, then we only have the root entry. Which means
423
 
        # that there is no real difference (only the root could be different)
424
 
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
425
 
            return
426
 
        raise PointlessCommit()
427
 
 
428
 
    def _check_bound_branch(self):
429
 
        """Check to see if the local branch is bound.
430
 
 
431
 
        If it is bound, then most of the commit will actually be
432
 
        done using the remote branch as the target branch.
433
 
        Only at the end will the local branch be updated.
434
 
        """
435
 
        if self.local and not self.branch.get_bound_location():
436
 
            raise errors.LocalRequiresBoundBranch()
437
 
 
438
 
        if not self.local:
439
 
            self.master_branch = self.branch.get_master_branch()
440
 
 
441
 
        if not self.master_branch:
442
 
            # make this branch the reference branch for out of date checks.
443
 
            self.master_branch = self.branch
444
 
            return
445
 
 
446
 
        # If the master branch is bound, we must fail
447
 
        master_bound_location = self.master_branch.get_bound_location()
448
 
        if master_bound_location:
449
 
            raise errors.CommitToDoubleBoundBranch(self.branch,
450
 
                    self.master_branch, master_bound_location)
451
 
 
452
 
        # TODO: jam 20051230 We could automatically push local
453
 
        #       commits to the remote branch if they would fit.
454
 
        #       But for now, just require remote to be identical
455
 
        #       to local.
456
 
        
457
 
        # Make sure the local branch is identical to the master
458
 
        master_info = self.master_branch.last_revision_info()
459
 
        local_info = self.branch.last_revision_info()
460
 
        if local_info != master_info:
461
 
            raise errors.BoundBranchOutOfDate(self.branch,
462
 
                    self.master_branch)
463
 
 
464
 
        # Now things are ready to change the master branch
465
 
        # so grab the lock
466
 
        self.bound_branch = self.branch
467
 
        self.master_branch.lock_write()
468
 
        self.master_locked = True
469
 
 
470
 
    def _cleanup(self):
471
 
        """Cleanup any open locks, progress bars etc."""
472
 
        cleanups = [self._cleanup_bound_branch,
473
 
                    self.basis_tree.unlock,
474
 
                    self.work_tree.unlock,
475
 
                    self.pb.finished]
476
 
        found_exception = None
477
 
        for cleanup in cleanups:
478
 
            try:
479
 
                cleanup()
480
 
            # we want every cleanup to run no matter what.
481
 
            # so we have a catchall here, but we will raise the
482
 
            # last encountered exception up the stack: and
483
 
            # typically this will be useful enough.
484
 
            except Exception, e:
485
 
                found_exception = e
486
 
        if found_exception is not None: 
487
 
            # don't do a plan raise, because the last exception may have been
488
 
            # trashed, e is our sure-to-work exception even though it loses the
489
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
490
 
            # exc_info and if its the same one do a plain raise otherwise 
491
 
            # 'raise e' as we do now.
492
 
            raise e
493
 
 
494
 
    def _cleanup_bound_branch(self):
495
 
        """Executed at the end of a try/finally to cleanup a bound branch.
496
 
 
497
 
        If the branch wasn't bound, this is a no-op.
498
 
        If it was, it resents self.branch to the local branch, instead
499
 
        of being the master.
500
 
        """
501
 
        if not self.bound_branch:
502
 
            return
503
 
        if self.master_locked:
504
 
            self.master_branch.unlock()
505
 
 
506
 
    def _escape_commit_message(self):
507
 
        """Replace xml-incompatible control characters."""
508
 
        # FIXME: RBC 20060419 this should be done by the revision
509
 
        # serialiser not by commit. Then we can also add an unescaper
510
 
        # in the deserializer and start roundtripping revision messages
511
 
        # precisely. See repository_implementations/test_repository.py
512
 
        
513
 
        # Python strings can include characters that can't be
514
 
        # represented in well-formed XML; escape characters that
515
 
        # aren't listed in the XML specification
516
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
517
 
        self.message, escape_count = re.subn(
518
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
519
 
            lambda match: match.group(0).encode('unicode_escape'),
520
 
            self.message)
521
 
        if escape_count:
522
 
            self.reporter.escaped(escape_count, self.message)
523
 
 
524
 
    def _gather_parents(self):
525
 
        """Record the parents of a merge for merge detection."""
526
 
        # TODO: Make sure that this list doesn't contain duplicate 
527
 
        # entries and the order is preserved when doing this.
528
 
        self.parents = self.work_tree.get_parent_ids()
529
 
        self.parent_invs = [self.basis_inv]
530
 
        for revision in self.parents[1:]:
531
 
            if self.branch.repository.has_revision(revision):
532
 
                mutter('commit parent revision {%s}', revision)
533
 
                inventory = self.branch.repository.get_inventory(revision)
534
 
                self.parent_invs.append(inventory)
535
 
            else:
536
 
                mutter('commit parent ghost revision {%s}', revision)
537
 
 
538
 
    def _remove_deleted(self):
539
 
        """Remove deleted files from the working inventories.
540
 
 
541
 
        This is done prior to taking the working inventory as the
542
 
        basis for the new committed inventory.
543
 
 
544
 
        This returns true if any files
545
 
        *that existed in the basis inventory* were deleted.
546
 
        Files that were added and deleted
547
 
        in the working copy don't matter.
548
 
        """
549
 
        specific = self.specific_files
550
 
        deleted_ids = []
551
 
        deleted_paths = set()
552
 
        for path, ie in self.work_inv.iter_entries():
553
 
            if is_inside_any(deleted_paths, path):
554
 
                # The tree will delete the required ids recursively.
555
 
                continue
556
 
            if specific and not is_inside_any(specific, path):
557
 
                continue
558
 
            if not self.work_tree.has_filename(path):
559
 
                deleted_paths.add(path)
560
 
                self.reporter.missing(path)
561
 
                deleted_ids.append(ie.file_id)
562
 
        self.work_tree.unversion(deleted_ids)
563
 
 
564
 
    def _populate_new_inv(self):
565
 
        """Build revision inventory.
566
 
 
567
 
        This creates a new empty inventory. Depending on
568
 
        which files are selected for commit, and what is present in the
569
 
        current tree, the new inventory is populated. inventory entries 
570
 
        which are candidates for modification have their revision set to
571
 
        None; inventory entries that are carried over untouched have their
572
 
        revision set to their prior value.
573
 
        """
574
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
575
 
        # results to create a new inventory at the same time, which results
576
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
577
 
        # ADHB 11-07-2006
578
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
579
 
        assert self.work_inv.root is not None
580
 
        entries = self.work_inv.iter_entries()
581
 
        if not self.builder.record_root_entry:
582
 
            symbol_versioning.warn('CommitBuilders should support recording'
583
 
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
584
 
                stacklevel=1)
585
 
            self.builder.new_inventory.add(self.basis_inv.root.copy())
586
 
            entries.next()
587
 
            self._emit_progress_update()
588
 
        for path, new_ie in entries:
589
 
            self._emit_progress_update()
590
 
            file_id = new_ie.file_id
591
 
            try:
592
 
                kind = self.work_tree.kind(file_id)
593
 
                if kind != new_ie.kind:
594
 
                    new_ie = inventory.make_entry(kind, new_ie.name,
595
 
                                                  new_ie.parent_id, file_id)
596
 
            except errors.NoSuchFile:
 
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
    """Commit working copy as a new revision.
 
29
 
 
30
    The basic approach is to add all the file texts into the
 
31
    store, then the inventory, then make a new revision pointing
 
32
    to that inventory and store that.
 
33
 
 
34
    This is not quite safe if the working copy changes during the
 
35
    commit; for the moment that is simply not allowed.  A better
 
36
    approach is to make a temporary copy of the files before
 
37
    computing their hashes, and then add those hashes in turn to
 
38
    the inventory.  This should mean at least that there are no
 
39
    broken hash pointers.  There is no way we can get a snapshot
 
40
    of the whole directory at an instant.  This would also have to
 
41
    be robust against files disappearing, moving, etc.  So the
 
42
    whole thing is a bit hard.
 
43
 
 
44
    timestamp -- if not None, seconds-since-epoch for a
 
45
         postdated/predated commit.
 
46
 
 
47
    specific_files
 
48
        If true, commit only those files.
 
49
 
 
50
    rev_id
 
51
        If set, use this as the new revision id.
 
52
        Useful for test or import commands that need to tightly
 
53
        control what revisions are assigned.  If you duplicate
 
54
        a revision id that exists elsewhere it is your own fault.
 
55
        If null (default), a time/random revision id is generated.
 
56
    """
 
57
 
 
58
    import time, tempfile
 
59
 
 
60
    from bzrlib.osutils import local_time_offset, username
 
61
    from bzrlib.branch import gen_file_id
 
62
    from bzrlib.errors import BzrError
 
63
    from bzrlib.revision import Revision, RevisionReference
 
64
    from bzrlib.trace import mutter, note
 
65
    from bzrlib.xml import pack_xml
 
66
 
 
67
    branch.lock_write()
 
68
 
 
69
    try:
 
70
        # First walk over the working inventory; and both update that
 
71
        # and also build a new revision inventory.  The revision
 
72
        # inventory needs to hold the text-id, sha1 and size of the
 
73
        # actual file versions committed in the revision.  (These are
 
74
        # not present in the working inventory.)  We also need to
 
75
        # detect missing/deleted files, and remove them from the
 
76
        # working inventory.
 
77
 
 
78
        work_tree = branch.working_tree()
 
79
        work_inv = work_tree.inventory
 
80
        basis = branch.basis_tree()
 
81
        basis_inv = basis.inventory
 
82
 
 
83
        if verbose:
 
84
            note('looking for changes...')
 
85
 
 
86
        pending_merges = branch.pending_merges()
 
87
 
 
88
        missing_ids, new_inv = _gather_commit(branch,
 
89
                                              work_tree,
 
90
                                              work_inv,
 
91
                                              basis_inv,
 
92
                                              specific_files,
 
93
                                              verbose)
 
94
 
 
95
        for file_id in missing_ids:
 
96
            # Any files that have been deleted are now removed from the
 
97
            # working inventory.  Files that were not selected for commit
 
98
            # are left as they were in the working inventory and ommitted
 
99
            # from the revision inventory.
 
100
 
 
101
            # have to do this later so we don't mess up the iterator.
 
102
            # since parents may be removed before their children we
 
103
            # have to test.
 
104
 
 
105
            # FIXME: There's probably a better way to do this; perhaps
 
106
            # the workingtree should know how to filter itbranch.
 
107
            if work_inv.has_id(file_id):
 
108
                del work_inv[file_id]
 
109
 
 
110
 
 
111
        if rev_id is None:
 
112
            rev_id = _gen_revision_id(time.time())
 
113
        inv_id = rev_id
 
114
 
 
115
        inv_tmp = tempfile.TemporaryFile()
 
116
        pack_xml(new_inv, inv_tmp)
 
117
        inv_tmp.seek(0)
 
118
        branch.inventory_store.add(inv_tmp, inv_id)
 
119
        mutter('new inventory_id is {%s}' % inv_id)
 
120
 
 
121
        # We could also just sha hash the inv_tmp file
 
122
        # however, in the case that branch.inventory_store.add()
 
123
        # ever actually does anything special
 
124
        inv_sha1 = branch.get_inventory_sha1(inv_id)
 
125
 
 
126
        branch._write_inventory(work_inv)
 
127
 
 
128
        if timestamp == None:
 
129
            timestamp = time.time()
 
130
 
 
131
        if committer == None:
 
132
            committer = username()
 
133
 
 
134
        if timezone == None:
 
135
            timezone = local_time_offset()
 
136
 
 
137
        mutter("building commit log message")
 
138
        rev = Revision(timestamp=timestamp,
 
139
                       timezone=timezone,
 
140
                       committer=committer,
 
141
                       message = message,
 
142
                       inventory_id=inv_id,
 
143
                       inventory_sha1=inv_sha1,
 
144
                       revision_id=rev_id)
 
145
 
 
146
        rev.parents = []
 
147
        precursor_id = branch.last_patch()
 
148
        if precursor_id:
 
149
            precursor_sha1 = branch.get_revision_sha1(precursor_id)
 
150
            rev.parents.append(RevisionReference(precursor_id, precursor_sha1))
 
151
        for merge_rev in pending_merges:
 
152
            rev.parents.append(RevisionReference(merge_rev))            
 
153
 
 
154
        rev_tmp = tempfile.TemporaryFile()
 
155
        pack_xml(rev, rev_tmp)
 
156
        rev_tmp.seek(0)
 
157
        branch.revision_store.add(rev_tmp, rev_id)
 
158
        mutter("new revision_id is {%s}" % rev_id)
 
159
 
 
160
        ## XXX: Everything up to here can simply be orphaned if we abort
 
161
        ## the commit; it will leave junk files behind but that doesn't
 
162
        ## matter.
 
163
 
 
164
        ## TODO: Read back the just-generated changeset, and make sure it
 
165
        ## applies and recreates the right state.
 
166
 
 
167
        ## TODO: Also calculate and store the inventory SHA1
 
168
        mutter("committing patch r%d" % (branch.revno() + 1))
 
169
 
 
170
        branch.append_revision(rev_id)
 
171
 
 
172
        branch.set_pending_merges([])
 
173
 
 
174
        if verbose:
 
175
            note("commited r%d" % branch.revno())
 
176
    finally:
 
177
        branch.unlock()
 
178
 
 
179
 
 
180
 
 
181
def _gen_revision_id(when):
 
182
    """Return new revision-id."""
 
183
    from binascii import hexlify
 
184
    from osutils import rand_bytes, compact_date, user_email
 
185
 
 
186
    s = '%s-%s-' % (user_email(), compact_date(when))
 
187
    s += hexlify(rand_bytes(8))
 
188
    return s
 
189
 
 
190
 
 
191
def _gather_commit(branch, work_tree, work_inv, basis_inv, specific_files,
 
192
                   verbose):
 
193
    """Build inventory preparatory to commit.
 
194
 
 
195
    This adds any changed files into the text store, and sets their
 
196
    test-id, sha and size in the returned inventory appropriately.
 
197
 
 
198
    missing_ids
 
199
        Modified to hold a list of files that have been deleted from
 
200
        the working directory; these should be removed from the
 
201
        working inventory.
 
202
    """
 
203
    from bzrlib.inventory import Inventory
 
204
    from osutils import isdir, isfile, sha_string, quotefn, \
 
205
         local_time_offset, username, kind_marker, is_inside_any
 
206
    
 
207
    from branch import gen_file_id
 
208
    from errors import BzrError
 
209
    from revision import Revision
 
210
    from bzrlib.trace import mutter, note
 
211
 
 
212
    inv = Inventory()
 
213
    missing_ids = []
 
214
    
 
215
    for path, entry in work_inv.iter_entries():
 
216
        ## TODO: Check that the file kind has not changed from the previous
 
217
        ## revision of this file (if any).
 
218
 
 
219
        p = branch.abspath(path)
 
220
        file_id = entry.file_id
 
221
        mutter('commit prep file %s, id %r ' % (p, file_id))
 
222
 
 
223
        if specific_files and not is_inside_any(specific_files, path):
 
224
            if basis_inv.has_id(file_id):
 
225
                # carry over with previous state
 
226
                inv.add(basis_inv[file_id].copy())
 
227
            else:
 
228
                # omit this from committed inventory
597
229
                pass
598
 
            # mutter('check %s {%s}', path, file_id)
599
 
            if (not self.specific_files or 
600
 
                is_inside_or_parent_of_any(self.specific_files, path)):
601
 
                    # mutter('%s selected for commit', path)
602
 
                    ie = new_ie.copy()
603
 
                    ie.revision = None
604
 
            else:
605
 
                # mutter('%s not selected for commit', path)
606
 
                if self.basis_inv.has_id(file_id):
607
 
                    ie = self.basis_inv[file_id].copy()
608
 
                else:
609
 
                    # this entry is new and not being committed
610
 
                    continue
611
 
            self.builder.record_entry_contents(ie, self.parent_invs, 
612
 
                path, self.work_tree)
613
 
            # describe the nature of the change that has occurred relative to
614
 
            # the basis inventory.
615
 
            if (self.basis_inv.has_id(ie.file_id)):
616
 
                basis_ie = self.basis_inv[ie.file_id]
617
 
            else:
618
 
                basis_ie = None
619
 
            change = ie.describe_change(basis_ie, ie)
620
 
            if change in (InventoryEntry.RENAMED, 
621
 
                InventoryEntry.MODIFIED_AND_RENAMED):
622
 
                old_path = self.basis_inv.id2path(ie.file_id)
623
 
                self.reporter.renamed(change, old_path, path)
624
 
            else:
625
 
                self.reporter.snapshot_change(change, path)
626
 
 
627
 
        if not self.specific_files:
628
 
            return
629
 
 
630
 
        # ignore removals that don't match filespec
631
 
        for path, new_ie in self.basis_inv.iter_entries():
632
 
            if new_ie.file_id in self.work_inv:
633
 
                continue
634
 
            if is_inside_any(self.specific_files, path):
635
 
                continue
636
 
            ie = new_ie.copy()
637
 
            ie.revision = None
638
 
            self.builder.record_entry_contents(ie, self.parent_invs, path,
639
 
                                               self.basis_tree)
640
 
 
641
 
    def _emit_progress_update(self):
642
 
        """Emit an update to the progress bar."""
643
 
        self.pb.update("Committing", self.pb_count, self.pb_total)
644
 
        self.pb_count += 1
645
 
 
646
 
    def _report_deletes(self):
647
 
        for path, ie in self.basis_inv.iter_entries():
648
 
            if ie.file_id not in self.builder.new_inventory:
649
 
                self.reporter.deleted(path)
 
230
            continue
 
231
 
 
232
        if not work_tree.has_id(file_id):
 
233
            if verbose:
 
234
                print('deleted %s%s' % (path, kind_marker(entry.kind)))
 
235
            mutter("    file is missing, removing from inventory")
 
236
            missing_ids.append(file_id)
 
237
            continue
 
238
 
 
239
        # this is present in the new inventory; may be new, modified or
 
240
        # unchanged.
 
241
        old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
 
242
        
 
243
        entry = entry.copy()
 
244
        inv.add(entry)
 
245
 
 
246
        if old_ie:
 
247
            old_kind = old_ie.kind
 
248
            if old_kind != entry.kind:
 
249
                raise BzrError("entry %r changed kind from %r to %r"
 
250
                        % (file_id, old_kind, entry.kind))
 
251
 
 
252
        if entry.kind == 'directory':
 
253
            if not isdir(p):
 
254
                raise BzrError("%s is entered as directory but not a directory"
 
255
                               % quotefn(p))
 
256
        elif entry.kind == 'file':
 
257
            if not isfile(p):
 
258
                raise BzrError("%s is entered as file but is not a file" % quotefn(p))
 
259
 
 
260
            new_sha1 = work_tree.get_file_sha1(file_id)
 
261
 
 
262
            if (old_ie
 
263
                and old_ie.text_sha1 == new_sha1):
 
264
                ## assert content == basis.get_file(file_id).read()
 
265
                entry.text_id = old_ie.text_id
 
266
                entry.text_sha1 = new_sha1
 
267
                entry.text_size = old_ie.text_size
 
268
                mutter('    unchanged from previous text_id {%s}' %
 
269
                       entry.text_id)
 
270
            else:
 
271
                content = file(p, 'rb').read()
 
272
 
 
273
                # calculate the sha again, just in case the file contents
 
274
                # changed since we updated the cache
 
275
                entry.text_sha1 = sha_string(content)
 
276
                entry.text_size = len(content)
 
277
 
 
278
                entry.text_id = gen_file_id(entry.name)
 
279
                branch.text_store.add(content, entry.text_id)
 
280
                mutter('    stored with text_id {%s}' % entry.text_id)
 
281
 
 
282
        if verbose:
 
283
            marked = path + kind_marker(entry.kind)
 
284
            if not old_ie:
 
285
                print 'added', marked
 
286
            elif old_ie == entry:
 
287
                pass                    # unchanged
 
288
            elif (old_ie.name == entry.name
 
289
                  and old_ie.parent_id == entry.parent_id):
 
290
                print 'modified', marked
 
291
            else:
 
292
                print 'renamed', marked
 
293
                        
 
294
    return missing_ids, inv
650
295
 
651
296