~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

fixme note for bzr status

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