~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-06-11 01:33:22 UTC
  • Revision ID: mbp@sourcefrog.net-20050611013322-f12014bf65accd0c
- don't show progress bar unless completion is known

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