~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

Merge doc updates

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
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
18
# The newly committed revision is going to have a shape corresponding
29
19
# to that of the working inventory.  Files that are not in the
30
20
# working tree and that were in the predecessor are reported as
56
46
# merges from, then it should still be reported as newly added
57
47
# relative to the basis revision.
58
48
 
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
 
 
 
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.
65
51
 
66
52
import os
67
53
import re
68
54
import sys
69
55
import time
70
 
import pdb
71
56
 
72
 
from binascii import hexlify
73
57
from cStringIO import StringIO
74
58
 
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)
 
59
from bzrlib import (
 
60
    errors,
 
61
    inventory,
 
62
    tree,
 
63
    )
 
64
from bzrlib.branch import Branch
81
65
import bzrlib.config
82
 
import bzrlib.errors as errors
83
66
from bzrlib.errors import (BzrError, PointlessCommit,
84
 
                           HistoryMissing,
85
67
                           ConflictsInTree,
86
68
                           StrictCommitFailed
87
69
                           )
88
 
from bzrlib.revision import Revision
 
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)
89
73
from bzrlib.testament import Testament
90
74
from bzrlib.trace import mutter, note, warning
91
75
from bzrlib.xml5 import serializer_v5
92
 
from bzrlib.inventory import Inventory, ROOT_ID
93
 
from bzrlib.symbol_versioning import *
 
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)
94
81
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)
 
82
import bzrlib.ui
107
83
 
108
84
 
109
85
class NullCommitReporter(object):
124
100
    def missing(self, path):
125
101
        pass
126
102
 
 
103
    def renamed(self, change, old_path, new_path):
 
104
        pass
 
105
 
127
106
 
128
107
class ReportCommitToLog(NullCommitReporter):
129
108
 
 
109
    def _note(self, format, *args):
 
110
        """Output a message.
 
111
 
 
112
        Subclasses may choose to override this method.
 
113
        """
 
114
        note(format, *args)
 
115
 
130
116
    def snapshot_change(self, change, path):
131
117
        if change == 'unchanged':
132
118
            return
133
 
        note("%s %s", change, path)
 
119
        if change == 'added' and path == '':
 
120
            return
 
121
        self._note("%s %s", change, path)
134
122
 
135
123
    def completed(self, revno, rev_id):
136
 
        note('Committed revision %d.', revno)
 
124
        self._note('Committed revision %d.', revno)
137
125
    
138
126
    def deleted(self, file_id):
139
 
        note('deleted %s', file_id)
 
127
        self._note('deleted %s', file_id)
140
128
 
141
129
    def escaped(self, escape_count, message):
142
 
        note("replaced %d control characters in message", escape_count)
 
130
        self._note("replaced %d control characters in message", escape_count)
143
131
 
144
132
    def missing(self, path):
145
 
        note('missing %s', path)
 
133
        self._note('missing %s', path)
 
134
 
 
135
    def renamed(self, change, old_path, new_path):
 
136
        self._note('%s %s => %s', change, old_path, new_path)
146
137
 
147
138
 
148
139
class Commit(object):
164
155
            self.reporter = reporter
165
156
        else:
166
157
            self.reporter = NullCommitReporter()
167
 
        if config is not None:
168
 
            self.config = config
169
 
        else:
170
 
            self.config = None
 
158
        self.config = config
171
159
        
172
160
    def commit(self,
173
 
               branch=DEPRECATED_PARAMETER, message=None,
 
161
               message=None,
174
162
               timestamp=None,
175
163
               timezone=None,
176
164
               committer=None,
183
171
               working_tree=None,
184
172
               local=False,
185
173
               reporter=None,
186
 
               config=None):
 
174
               config=None,
 
175
               message_callback=None,
 
176
               recursive='down'):
187
177
        """Commit working copy as a new revision.
188
178
 
189
 
        branch -- the deprecated branch to commit to. New callers should pass in 
190
 
                  working_tree instead
191
 
 
192
 
        message -- the commit message, a mandatory parameter
193
 
 
194
 
        timestamp -- if not None, seconds-since-epoch for a
195
 
             postdated/predated commit.
196
 
 
197
 
        specific_files -- If true, commit only those files.
198
 
 
199
 
        rev_id -- If set, use this as the new revision id.
 
179
        :param message: the commit message (it or message_callback is required)
 
180
 
 
181
        :param timestamp: if not None, seconds-since-epoch for a
 
182
            postdated/predated commit.
 
183
 
 
184
        :param specific_files: If true, commit only those files.
 
185
 
 
186
        :param rev_id: If set, use this as the new revision id.
200
187
            Useful for test or import commands that need to tightly
201
188
            control what revisions are assigned.  If you duplicate
202
189
            a revision id that exists elsewhere it is your own fault.
203
190
            If null (default), a time/random revision id is generated.
204
191
 
205
 
        allow_pointless -- If true (default), commit even if nothing
 
192
        :param allow_pointless: If true (default), commit even if nothing
206
193
            has changed and no merges are recorded.
207
194
 
208
 
        strict -- If true, don't allow a commit if the working tree
 
195
        :param strict: If true, don't allow a commit if the working tree
209
196
            contains unknown files.
210
197
 
211
 
        revprops -- Properties for new revision
 
198
        :param revprops: Properties for new revision
212
199
        :param local: Perform a local only commit.
 
200
        :param recursive: If set to 'down', commit in any subtrees that have
 
201
            pending changes of any sort during this commit.
213
202
        """
214
203
        mutter('preparing to commit')
215
204
 
216
 
        if deprecated_passed(branch):
217
 
            warn("Commit.commit (branch, ...): The branch parameter is "
218
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
219
 
                 DeprecationWarning, stacklevel=2)
220
 
            self.branch = branch
221
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
222
 
        elif working_tree is None:
223
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
205
        if working_tree is None:
 
206
            raise BzrError("working_tree must be passed into commit().")
224
207
        else:
225
208
            self.work_tree = working_tree
226
209
            self.branch = self.work_tree.branch
227
 
        if message is None:
228
 
            raise BzrError("The message keyword parameter is required for commit().")
 
210
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
211
                if not self.branch.repository.supports_rich_root():
 
212
                    raise errors.RootNotRich()
 
213
        if message_callback is None:
 
214
            if message is not None:
 
215
                if isinstance(message, str):
 
216
                    message = message.decode(bzrlib.user_encoding)
 
217
                message_callback = lambda x: message
 
218
            else:
 
219
                raise BzrError("The message or message_callback keyword"
 
220
                               " parameter is required for commit().")
229
221
 
230
 
        self.weave_store = self.branch.repository.weave_store
231
222
        self.bound_branch = None
232
223
        self.local = local
233
224
        self.master_branch = None
234
225
        self.master_locked = False
235
 
        self.rev_id = rev_id
 
226
        self.rev_id = None
236
227
        self.specific_files = specific_files
237
228
        self.allow_pointless = allow_pointless
238
 
        self.revprops = {}
239
 
        if revprops is not None:
240
 
            self.revprops.update(revprops)
 
229
        self.recursive = recursive
 
230
        self.revprops = revprops
 
231
        self.message_callback = message_callback
 
232
        self.timestamp = timestamp
 
233
        self.timezone = timezone
 
234
        self.committer = committer
 
235
        self.strict = strict
 
236
        self.verbose = verbose
241
237
 
242
238
        if reporter is None and self.reporter is None:
243
239
            self.reporter = NullCommitReporter()
245
241
            self.reporter = reporter
246
242
 
247
243
        self.work_tree.lock_write()
 
244
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
245
        self.basis_tree = self.work_tree.basis_tree()
 
246
        self.basis_tree.lock_read()
248
247
        try:
249
 
            # setup the bound branch variables as needed.
 
248
            # Cannot commit with conflicts present.
 
249
            if len(self.work_tree.conflicts()) > 0:
 
250
                raise ConflictsInTree
 
251
 
 
252
            # Setup the bound branch variables as needed.
250
253
            self._check_bound_branch()
251
254
 
252
 
            # check for out of date working trees
253
 
            # if we are bound, then self.branch is the master branch and this
254
 
            # test is thus all we need.
255
 
            if self.work_tree.last_revision() != self.master_branch.last_revision():
256
 
                raise errors.OutOfDateTree(self.work_tree)
257
 
    
 
255
            # Check that the working tree is up to date
 
256
            old_revno,new_revno = self._check_out_of_date_tree()
 
257
 
258
258
            if strict:
259
259
                # raise an exception as soon as we find a single unknown.
260
260
                for unknown in self.work_tree.unknowns():
261
261
                    raise StrictCommitFailed()
262
 
    
263
 
            if timestamp is None:
264
 
                self.timestamp = time.time()
265
 
            else:
266
 
                self.timestamp = long(timestamp)
267
 
                
 
262
                   
268
263
            if self.config is None:
269
 
                self.config = bzrlib.config.BranchConfig(self.branch)
270
 
    
271
 
            if rev_id is None:
272
 
                self.rev_id = _gen_revision_id(self.config, self.timestamp)
273
 
            else:
274
 
                self.rev_id = rev_id
275
 
    
276
 
            if committer is None:
277
 
                self.committer = self.config.username()
278
 
            else:
279
 
                assert isinstance(committer, basestring), type(committer)
280
 
                self.committer = committer
281
 
    
282
 
            if timezone is None:
283
 
                self.timezone = local_time_offset()
284
 
            else:
285
 
                self.timezone = int(timezone)
286
 
    
287
 
            if isinstance(message, str):
288
 
                message = message.decode(bzrlib.user_encoding)
 
264
                self.config = self.branch.get_config()
 
265
 
 
266
            # If provided, ensure the specified files are versioned
 
267
            if specific_files is not None:
 
268
                # Note: We don't actually need the IDs here. This routine
 
269
                # is being called because it raises PathNotVerisonedError
 
270
                # as a side effect of finding the IDs.
 
271
                # XXX: Dont we have filter_unversioned to do this more
 
272
                # cheaply?
 
273
                tree.find_ids_across_trees(specific_files,
 
274
                                           [self.basis_tree, self.work_tree])
 
275
 
 
276
            # Setup the progress bar. As the number of files that need to be
 
277
            # committed in unknown, progress is reported as stages.
 
278
            # We keep track of entries separately though and include that
 
279
            # information in the progress bar during the relevant stages.
 
280
            self.pb_stage_name = ""
 
281
            self.pb_stage_count = 0
 
282
            self.pb_stage_total = 4
 
283
            if self.bound_branch:
 
284
                self.pb_stage_total += 1
 
285
            self.pb.show_pct = False
 
286
            self.pb.show_spinner = False
 
287
            self.pb.show_eta = False
 
288
            self.pb.show_count = True
 
289
            self.pb.show_bar = False
 
290
 
 
291
            # After a merge, a selected file commit is not supported.
 
292
            # See 'bzr help merge' for an explanation as to why.
 
293
            self.basis_inv = self.basis_tree.inventory
 
294
            self._gather_parents()
 
295
            if len(self.parents) > 1 and self.specific_files:
 
296
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
297
            
 
298
            # Collect the changes
 
299
            self._emit_progress_set_stage("Collecting changes", show_entries=True)
 
300
            self.builder = self.branch.get_commit_builder(self.parents,
 
301
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
302
            self._update_builder_with_changes()
 
303
            self._check_pointless()
 
304
 
 
305
            # TODO: Now the new inventory is known, check for conflicts.
 
306
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
307
            # weave lines, because nothing should be recorded until it is known
 
308
            # that commit will succeed.
 
309
            self._emit_progress_set_stage("Saving data locally")
 
310
            self.builder.finish_inventory()
 
311
 
 
312
            # Prompt the user for a commit message if none provided
 
313
            message = message_callback(self)
289
314
            assert isinstance(message, unicode), type(message)
290
315
            self.message = message
291
316
            self._escape_commit_message()
292
317
 
293
 
            self.work_inv = self.work_tree.inventory
294
 
            self.basis_tree = self.work_tree.basis_tree()
295
 
            self.basis_inv = self.basis_tree.inventory
296
 
 
297
 
            self._gather_parents()
298
 
            if len(self.parents) > 1 and self.specific_files:
299
 
                raise NotImplementedError('selected-file commit of merges is not supported yet')
300
 
            self._check_parents_present()
301
 
            
302
 
            self._remove_deleted()
303
 
            self._populate_new_inv()
304
 
            self._store_snapshot()
305
 
            self._report_deletes()
306
 
 
307
 
            if not (self.allow_pointless
308
 
                    or len(self.parents) > 1
309
 
                    or self.new_inv != self.basis_inv):
310
 
                raise PointlessCommit()
311
 
 
312
 
            if len(self.work_tree.conflicts())>0:
313
 
                raise ConflictsInTree
314
 
 
315
 
            self.inv_sha1 = self.branch.repository.add_inventory(
316
 
                self.rev_id,
317
 
                self.new_inv,
318
 
                self.present_parents
319
 
                )
320
 
            self._make_revision()
321
 
            # revision data is in the local branch now.
322
 
            
323
 
            # upload revision data to the master.
324
 
            # this will propogate merged revisions too if needed.
 
318
            # Add revision data to the local branch
 
319
            self.rev_id = self.builder.commit(self.message)
 
320
            
 
321
            # Upload revision data to the master.
 
322
            # this will propagate merged revisions too if needed.
325
323
            if self.bound_branch:
 
324
                self._emit_progress_set_stage("Uploading data to master branch")
326
325
                self.master_branch.repository.fetch(self.branch.repository,
327
326
                                                    revision_id=self.rev_id)
328
327
                # now the master has the revision data
329
 
                # 'commit' to the master first so a timeout here causes the local
330
 
                # branch to be out of date
331
 
                self.master_branch.append_revision(self.rev_id)
 
328
                # 'commit' to the master first so a timeout here causes the
 
329
                # local branch to be out of date
 
330
                self.master_branch.set_last_revision_info(new_revno,
 
331
                                                          self.rev_id)
332
332
 
333
333
            # and now do the commit locally.
334
 
            self.branch.append_revision(self.rev_id)
 
334
            self.branch.set_last_revision_info(new_revno, self.rev_id)
335
335
 
336
 
            self.work_tree.set_pending_merges([])
337
 
            self.work_tree.set_last_revision(self.rev_id)
338
 
            # now the work tree is up to date with the branch
339
 
            
340
 
            self.reporter.completed(self.branch.revno(), self.rev_id)
341
 
            if self.config.post_commit() is not None:
342
 
                hooks = self.config.post_commit().split(' ')
343
 
                # this would be nicer with twisted.python.reflect.namedAny
344
 
                for hook in hooks:
345
 
                    result = eval(hook + '(branch, rev_id)',
346
 
                                  {'branch':self.branch,
347
 
                                   'bzrlib':bzrlib,
348
 
                                   'rev_id':self.rev_id})
 
336
            # Make the working tree up to date with the branch
 
337
            self._emit_progress_set_stage("Updating the working tree")
 
338
            rev_tree = self.builder.revision_tree()
 
339
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
340
            self.reporter.completed(new_revno, self.rev_id)
 
341
            self._process_hooks(old_revno, new_revno)
349
342
        finally:
350
 
            self._cleanup_bound_branch()
351
 
            self.work_tree.unlock()
 
343
            self._cleanup()
 
344
        return self.rev_id
 
345
 
 
346
    def _any_real_changes(self):
 
347
        """Are there real changes between new_inventory and basis?
 
348
 
 
349
        For trees without rich roots, inv.root.revision changes every commit.
 
350
        But if that is the only change, we want to treat it as though there
 
351
        are *no* changes.
 
352
        """
 
353
        new_entries = self.builder.new_inventory.iter_entries()
 
354
        basis_entries = self.basis_inv.iter_entries()
 
355
        new_path, new_root_ie = new_entries.next()
 
356
        basis_path, basis_root_ie = basis_entries.next()
 
357
 
 
358
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
359
        def ie_equal_no_revision(this, other):
 
360
            return ((this.file_id == other.file_id)
 
361
                    and (this.name == other.name)
 
362
                    and (this.symlink_target == other.symlink_target)
 
363
                    and (this.text_sha1 == other.text_sha1)
 
364
                    and (this.text_size == other.text_size)
 
365
                    and (this.text_id == other.text_id)
 
366
                    and (this.parent_id == other.parent_id)
 
367
                    and (this.kind == other.kind)
 
368
                    and (this.executable == other.executable)
 
369
                    and (this.reference_revision == other.reference_revision)
 
370
                    )
 
371
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
372
            return True
 
373
 
 
374
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
375
            if new_ie != basis_ie:
 
376
                return True
 
377
 
 
378
        # No actual changes present
 
379
        return False
 
380
 
 
381
    def _check_pointless(self):
 
382
        if self.allow_pointless:
 
383
            return
 
384
        # A merge with no effect on files
 
385
        if len(self.parents) > 1:
 
386
            return
 
387
        # work around the fact that a newly-initted tree does differ from its
 
388
        # basis
 
389
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
 
390
            raise PointlessCommit()
 
391
        # Shortcut, if the number of entries changes, then we obviously have
 
392
        # a change
 
393
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
394
            return
 
395
        # If length == 1, then we only have the root entry. Which means
 
396
        # that there is no real difference (only the root could be different)
 
397
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
 
398
            return
 
399
        raise PointlessCommit()
352
400
 
353
401
    def _check_bound_branch(self):
354
402
        """Check to see if the local branch is bound.
380
428
        #       to local.
381
429
        
382
430
        # Make sure the local branch is identical to the master
383
 
        master_rh = self.master_branch.revision_history()
384
 
        local_rh = self.branch.revision_history()
385
 
        if local_rh != master_rh:
 
431
        master_info = self.master_branch.last_revision_info()
 
432
        local_info = self.branch.last_revision_info()
 
433
        if local_info != master_info:
386
434
            raise errors.BoundBranchOutOfDate(self.branch,
387
435
                    self.master_branch)
388
436
 
391
439
        self.bound_branch = self.branch
392
440
        self.master_branch.lock_write()
393
441
        self.master_locked = True
394
 
####        
395
 
####        # Check to see if we have any pending merges. If we do
396
 
####        # those need to be pushed into the master branch
397
 
####        pending_merges = self.work_tree.pending_merges()
398
 
####        if pending_merges:
399
 
####            for revision_id in pending_merges:
400
 
####                self.master_branch.repository.fetch(self.bound_branch.repository,
401
 
####                                                    revision_id=revision_id)
 
442
 
 
443
    def _check_out_of_date_tree(self):
 
444
        """Check that the working tree is up to date.
 
445
 
 
446
        :return: old_revision_number,new_revision_number tuple
 
447
        """
 
448
        try:
 
449
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
450
        except IndexError:
 
451
            # if there are no parents, treat our parent as 'None'
 
452
            # this is so that we still consider the master branch
 
453
            # - in a checkout scenario the tree may have no
 
454
            # parents but the branch may do.
 
455
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
456
        old_revno, master_last = self.master_branch.last_revision_info()
 
457
        if master_last != first_tree_parent:
 
458
            if master_last != bzrlib.revision.NULL_REVISION:
 
459
                raise errors.OutOfDateTree(self.work_tree)
 
460
        if self.branch.repository.has_revision(first_tree_parent):
 
461
            new_revno = old_revno + 1
 
462
        else:
 
463
            # ghost parents never appear in revision history.
 
464
            new_revno = 1
 
465
        return old_revno,new_revno
 
466
 
 
467
    def _process_hooks(self, old_revno, new_revno):
 
468
        """Process any registered commit hooks."""
 
469
        # Process the post commit hooks, if any
 
470
        self._emit_progress_set_stage("Running post commit hooks")
 
471
        # old style commit hooks - should be deprecated ? (obsoleted in
 
472
        # 0.15)
 
473
        if self.config.post_commit() is not None:
 
474
            hooks = self.config.post_commit().split(' ')
 
475
            # this would be nicer with twisted.python.reflect.namedAny
 
476
            for hook in hooks:
 
477
                result = eval(hook + '(branch, rev_id)',
 
478
                              {'branch':self.branch,
 
479
                               'bzrlib':bzrlib,
 
480
                               'rev_id':self.rev_id})
 
481
        # new style commit hooks:
 
482
        if not self.bound_branch:
 
483
            hook_master = self.branch
 
484
            hook_local = None
 
485
        else:
 
486
            hook_master = self.master_branch
 
487
            hook_local = self.branch
 
488
        # With bound branches, when the master is behind the local branch,
 
489
        # the 'old_revno' and old_revid values here are incorrect.
 
490
        # XXX: FIXME ^. RBC 20060206
 
491
        if self.parents:
 
492
            old_revid = self.parents[0]
 
493
        else:
 
494
            old_revid = bzrlib.revision.NULL_REVISION
 
495
        for hook in Branch.hooks['post_commit']:
 
496
            # show the running hook in the progress bar. As hooks may
 
497
            # end up doing nothing (e.g. because they are not configured by
 
498
            # the user) this is still showing progress, not showing overall
 
499
            # actions - its up to each plugin to show a UI if it want's to
 
500
            # (such as 'Emailing diff to foo@example.com').
 
501
            self.pb_stage_name = "Running post commit hooks [%s]" % \
 
502
                Branch.hooks.get_hook_name(hook)
 
503
            self._emit_progress()
 
504
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
505
                self.rev_id)
 
506
 
 
507
    def _cleanup(self):
 
508
        """Cleanup any open locks, progress bars etc."""
 
509
        cleanups = [self._cleanup_bound_branch,
 
510
                    self.basis_tree.unlock,
 
511
                    self.work_tree.unlock,
 
512
                    self.pb.finished]
 
513
        found_exception = None
 
514
        for cleanup in cleanups:
 
515
            try:
 
516
                cleanup()
 
517
            # we want every cleanup to run no matter what.
 
518
            # so we have a catchall here, but we will raise the
 
519
            # last encountered exception up the stack: and
 
520
            # typically this will be useful enough.
 
521
            except Exception, e:
 
522
                found_exception = e
 
523
        if found_exception is not None: 
 
524
            # don't do a plan raise, because the last exception may have been
 
525
            # trashed, e is our sure-to-work exception even though it loses the
 
526
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
527
            # exc_info and if its the same one do a plain raise otherwise 
 
528
            # 'raise e' as we do now.
 
529
            raise e
402
530
 
403
531
    def _cleanup_bound_branch(self):
404
532
        """Executed at the end of a try/finally to cleanup a bound branch.
432
560
 
433
561
    def _gather_parents(self):
434
562
        """Record the parents of a merge for merge detection."""
435
 
        pending_merges = self.work_tree.pending_merges()
436
 
        self.parents = []
437
 
        self.parent_invs = []
438
 
        self.present_parents = []
439
 
        precursor_id = self.branch.last_revision()
440
 
        if precursor_id:
441
 
            self.parents.append(precursor_id)
442
 
        self.parents += pending_merges
443
 
        for revision in self.parents:
 
563
        # TODO: Make sure that this list doesn't contain duplicate 
 
564
        # entries and the order is preserved when doing this.
 
565
        self.parents = self.work_tree.get_parent_ids()
 
566
        self.parent_invs = [self.basis_inv]
 
567
        for revision in self.parents[1:]:
444
568
            if self.branch.repository.has_revision(revision):
 
569
                mutter('commit parent revision {%s}', revision)
445
570
                inventory = self.branch.repository.get_inventory(revision)
446
571
                self.parent_invs.append(inventory)
447
 
                self.present_parents.append(revision)
448
 
 
449
 
    def _check_parents_present(self):
450
 
        for parent_id in self.parents:
451
 
            mutter('commit parent revision {%s}', parent_id)
452
 
            if not self.branch.repository.has_revision(parent_id):
453
 
                if parent_id == self.branch.last_revision():
454
 
                    warning("parent is missing %r", parent_id)
455
 
                    raise HistoryMissing(self.branch, 'revision', parent_id)
456
 
                else:
457
 
                    mutter("commit will ghost revision %r", parent_id)
458
 
            
459
 
    def _make_revision(self):
460
 
        """Record a new revision object for this commit."""
461
 
        rev = Revision(timestamp=self.timestamp,
462
 
                       timezone=self.timezone,
463
 
                       committer=self.committer,
464
 
                       message=self.message,
465
 
                       inventory_sha1=self.inv_sha1,
466
 
                       revision_id=self.rev_id,
467
 
                       properties=self.revprops)
468
 
        rev.parent_ids = self.parents
469
 
        self.branch.repository.add_revision(self.rev_id, rev, self.new_inv, self.config)
470
 
 
471
 
    def _remove_deleted(self):
472
 
        """Remove deleted files from the working inventories.
473
 
 
474
 
        This is done prior to taking the working inventory as the
475
 
        basis for the new committed inventory.
476
 
 
477
 
        This returns true if any files
478
 
        *that existed in the basis inventory* were deleted.
479
 
        Files that were added and deleted
480
 
        in the working copy don't matter.
 
572
            else:
 
573
                mutter('commit parent ghost revision {%s}', revision)
 
574
 
 
575
    def _update_builder_with_changes(self):
 
576
        """Update the commit builder with the data about what has changed.
481
577
        """
482
 
        specific = self.specific_files
 
578
        # Build the revision inventory.
 
579
        #
 
580
        # This starts by creating a new empty inventory. Depending on
 
581
        # which files are selected for commit, and what is present in the
 
582
        # current tree, the new inventory is populated. inventory entries 
 
583
        # which are candidates for modification have their revision set to
 
584
        # None; inventory entries that are carried over untouched have their
 
585
        # revision set to their prior value.
 
586
        #
 
587
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
588
        # results to create a new inventory at the same time, which results
 
589
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
590
        # ADHB 11-07-2006
 
591
 
 
592
        specific_files = self.specific_files
 
593
        mutter("Selecting files for commit with filter %s", specific_files)
 
594
        work_inv = self.work_tree.inventory
 
595
        assert work_inv.root is not None
 
596
        self.pb_entries_total = len(work_inv)
 
597
 
 
598
        # Check and warn about old CommitBuilders
 
599
        entries = work_inv.iter_entries()
 
600
        if not self.builder.record_root_entry:
 
601
            symbol_versioning.warn('CommitBuilders should support recording'
 
602
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
603
                stacklevel=1)
 
604
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
605
            entries.next()
 
606
 
483
607
        deleted_ids = []
484
 
        for path, ie in self.work_inv.iter_entries():
485
 
            if specific and not is_inside_any(specific, path):
 
608
        deleted_paths = set()
 
609
        for path, new_ie in entries:
 
610
            self._emit_progress_next_entry()
 
611
            file_id = new_ie.file_id
 
612
 
 
613
            # Skip files that have been deleted from the working tree.
 
614
            # The deleted files/directories are also recorded so they
 
615
            # can be explicitly unversioned later. Note that when a
 
616
            # filter of specific files is given, we must only skip/record
 
617
            # deleted files matching that filter.
 
618
            if is_inside_any(deleted_paths, path):
486
619
                continue
487
 
            if not self.work_tree.has_filename(path):
488
 
                self.reporter.missing(path)
489
 
                deleted_ids.append((path, ie.file_id))
490
 
        if deleted_ids:
491
 
            deleted_ids.sort(reverse=True)
492
 
            for path, file_id in deleted_ids:
493
 
                del self.work_inv[file_id]
494
 
            self.work_tree._write_inventory(self.work_inv)
495
 
 
496
 
    def _store_snapshot(self):
497
 
        """Pass over inventory and record a snapshot.
498
 
 
499
 
        Entries get a new revision when they are modified in 
500
 
        any way, which includes a merge with a new set of
501
 
        parents that have the same entry. 
502
 
        """
503
 
        # XXX: Need to think more here about when the user has
504
 
        # made a specific decision on a particular value -- c.f.
505
 
        # mark-merge.  
506
 
        for path, ie in self.new_inv.iter_entries():
507
 
            previous_entries = ie.find_previous_heads(
508
 
                self.parent_invs,
509
 
                self.weave_store,
510
 
                self.branch.repository.get_transaction())
511
 
            if ie.revision is None:
512
 
                change = ie.snapshot(self.rev_id, path, previous_entries,
513
 
                                     self.work_tree, self.weave_store,
514
 
                                     self.branch.get_transaction())
 
620
            if not specific_files or is_inside_any(specific_files, path):
 
621
                if not self.work_tree.has_filename(path):
 
622
                    deleted_paths.add(path)
 
623
                    self.reporter.missing(path)
 
624
                    deleted_ids.append(file_id)
 
625
                    continue
 
626
            try:
 
627
                kind = self.work_tree.kind(file_id)
 
628
                if kind == 'tree-reference' and self.recursive == 'down':
 
629
                    # nested tree: commit in it
 
630
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
631
                    # FIXME: be more comprehensive here:
 
632
                    # this works when both trees are in --trees repository,
 
633
                    # but when both are bound to a different repository,
 
634
                    # it fails; a better way of approaching this is to 
 
635
                    # finally implement the explicit-caches approach design
 
636
                    # a while back - RBC 20070306.
 
637
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
638
                        ==
 
639
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
640
                        sub_tree.branch.repository = \
 
641
                            self.work_tree.branch.repository
 
642
                    try:
 
643
                        sub_tree.commit(message=None, revprops=self.revprops,
 
644
                            recursive=self.recursive,
 
645
                            message_callback=self.message_callback,
 
646
                            timestamp=self.timestamp, timezone=self.timezone,
 
647
                            committer=self.committer,
 
648
                            allow_pointless=self.allow_pointless,
 
649
                            strict=self.strict, verbose=self.verbose,
 
650
                            local=self.local, reporter=self.reporter)
 
651
                    except errors.PointlessCommit:
 
652
                        pass
 
653
                if kind != new_ie.kind:
 
654
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
655
                                                  new_ie.parent_id, file_id)
 
656
            except errors.NoSuchFile:
 
657
                pass
 
658
            # mutter('check %s {%s}', path, file_id)
 
659
            if (not specific_files or 
 
660
                is_inside_or_parent_of_any(specific_files, path)):
 
661
                    # mutter('%s selected for commit', path)
 
662
                    ie = new_ie.copy()
 
663
                    ie.revision = None
515
664
            else:
516
 
                change = "unchanged"
517
 
            self.reporter.snapshot_change(change, path)
518
 
 
519
 
    def _populate_new_inv(self):
520
 
        """Build revision inventory.
521
 
 
522
 
        This creates a new empty inventory. Depending on
523
 
        which files are selected for commit, and what is present in the
524
 
        current tree, the new inventory is populated. inventory entries 
525
 
        which are candidates for modification have their revision set to
526
 
        None; inventory entries that are carried over untouched have their
527
 
        revision set to their prior value.
528
 
        """
529
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
530
 
        self.new_inv = Inventory(revision_id=self.rev_id)
531
 
        for path, new_ie in self.work_inv.iter_entries():
532
 
            file_id = new_ie.file_id
533
 
            mutter('check %s {%s}', path, new_ie.file_id)
534
 
            if self.specific_files:
535
 
                if not is_inside_any(self.specific_files, path):
536
 
                    mutter('%s not selected for commit', path)
537
 
                    self._carry_entry(file_id)
538
 
                    continue
 
665
                # mutter('%s not selected for commit', path)
 
666
                if self.basis_inv.has_id(file_id):
 
667
                    ie = self.basis_inv[file_id].copy()
539
668
                else:
540
 
                    # this is selected, ensure its parents are too.
541
 
                    parent_id = new_ie.parent_id
542
 
                    while parent_id != ROOT_ID:
543
 
                        if not self.new_inv.has_id(parent_id):
544
 
                            ie = self._select_entry(self.work_inv[parent_id])
545
 
                            mutter('%s selected for commit because of %s',
546
 
                                   self.new_inv.id2path(parent_id), path)
547
 
 
548
 
                        ie = self.new_inv[parent_id]
549
 
                        if ie.revision is not None:
550
 
                            ie.revision = None
551
 
                            mutter('%s selected for commit because of %s',
552
 
                                   self.new_inv.id2path(parent_id), path)
553
 
                        parent_id = ie.parent_id
554
 
            mutter('%s selected for commit', path)
555
 
            self._select_entry(new_ie)
556
 
 
557
 
    def _select_entry(self, new_ie):
558
 
        """Make new_ie be considered for committing."""
559
 
        ie = new_ie.copy()
560
 
        ie.revision = None
561
 
        self.new_inv.add(ie)
562
 
        return ie
563
 
 
564
 
    def _carry_entry(self, file_id):
565
 
        """Carry the file unchanged from the basis revision."""
566
 
        if self.basis_inv.has_id(file_id):
567
 
            self.new_inv.add(self.basis_inv[file_id].copy())
568
 
 
569
 
    def _report_deletes(self):
570
 
        for file_id in self.basis_inv:
571
 
            if file_id not in self.new_inv:
572
 
                self.reporter.deleted(self.basis_inv.id2path(file_id))
573
 
 
574
 
def _gen_revision_id(config, when):
575
 
    """Return new revision-id."""
576
 
    s = '%s-%s-' % (config.user_email(), compact_date(when))
577
 
    s += hexlify(rand_bytes(8))
578
 
    return s
 
669
                    # this entry is new and not being committed
 
670
                    continue
 
671
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
672
                path, self.work_tree)
 
673
            # describe the nature of the change that has occurred relative to
 
674
            # the basis inventory.
 
675
            if (self.basis_inv.has_id(ie.file_id)):
 
676
                basis_ie = self.basis_inv[ie.file_id]
 
677
            else:
 
678
                basis_ie = None
 
679
            change = ie.describe_change(basis_ie, ie)
 
680
            if change in (InventoryEntry.RENAMED, 
 
681
                InventoryEntry.MODIFIED_AND_RENAMED):
 
682
                old_path = self.basis_inv.id2path(ie.file_id)
 
683
                self.reporter.renamed(change, old_path, path)
 
684
            else:
 
685
                self.reporter.snapshot_change(change, path)
 
686
 
 
687
        # Unversion IDs that were found to be deleted
 
688
        self.work_tree.unversion(deleted_ids)
 
689
 
 
690
        # If specific files/directories were nominated, it is possible
 
691
        # that some data from outside those needs to be preserved from
 
692
        # the basis tree. For example, if a file x is moved from out of
 
693
        # directory foo into directory bar and the user requests
 
694
        # ``commit foo``, then information about bar/x must also be
 
695
        # recorded.
 
696
        if specific_files:
 
697
            for path, new_ie in self.basis_inv.iter_entries():
 
698
                if new_ie.file_id in work_inv:
 
699
                    continue
 
700
                if is_inside_any(specific_files, path):
 
701
                    continue
 
702
                ie = new_ie.copy()
 
703
                ie.revision = None
 
704
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
705
                                                   self.basis_tree)
 
706
 
 
707
        # Report what was deleted. We could skip this when no deletes are
 
708
        # detected to gain a performance win, but it arguably serves as a
 
709
        # 'safety check' by informing the user whenever anything disappears.
 
710
        for path, ie in self.basis_inv.iter_entries():
 
711
            if ie.file_id not in self.builder.new_inventory:
 
712
                self.reporter.deleted(path)
 
713
 
 
714
    def _emit_progress_set_stage(self, name, show_entries=False):
 
715
        """Set the progress stage and emit an update to the progress bar."""
 
716
        self.pb_stage_name = name
 
717
        self.pb_stage_count += 1
 
718
        self.pb_entries_show = show_entries
 
719
        if show_entries:
 
720
            self.pb_entries_count = 0
 
721
            self.pb_entries_total = '?'
 
722
        self._emit_progress()
 
723
 
 
724
    def _emit_progress_next_entry(self):
 
725
        """Emit an update to the progress bar and increment the file count."""
 
726
        self.pb_entries_count += 1
 
727
        self._emit_progress()
 
728
 
 
729
    def _emit_progress(self):
 
730
        if self.pb_entries_show:
 
731
            text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
 
732
                self.pb_entries_count,str(self.pb_entries_total))
 
733
        else:
 
734
            text = "%s - Stage" % (self.pb_stage_name)
 
735
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
736