~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Robert Collins
  • Date: 2007-08-29 01:50:37 UTC
  • mto: This revision was merged to the branch mainline in revision 2764.
  • Revision ID: robertc@robertcollins.net-20070829015037-5ol4iw1qje4ajdga
Review feedback.

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