/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Jelmer Vernooij
  • Date: 2009-04-02 15:54:49 UTC
  • mto: (0.200.326 trunk)
  • mto: This revision was merged to the branch mainline in revision 6960.
  • Revision ID: jelmer@samba.org-20090402155449-nuqhu1fsnqk6bt0g
Check that regenerated objects have the expected sha1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
# The newly committed revision is going to have a shape corresponding
19
 
# to that of the working tree.  Files that are not in the
20
 
# working tree and that were in the predecessor are reported as
21
 
# removed --- this can include files that were either removed from the
22
 
# inventory or deleted in the working tree.  If they were only
23
 
# deleted from disk, they are removed from the working inventory.
24
 
 
25
 
# We then consider the remaining entries, which will be in the new
26
 
# version.  Directory entries are simply copied across.  File entries
27
 
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
29
 
# version of the file was present.  If the file was present in at
30
 
# least one tree, and if it was the same version in all the trees,
31
 
# then we can just refer to that version.  Otherwise, a new version
32
 
# representing the merger of the file versions must be added.
33
 
 
34
 
# TODO: Update hashcache before and after - or does the WorkingTree
35
 
# look after that?
36
 
 
37
 
# TODO: Rather than mashing together the ancestry and storing it back,
38
 
# perhaps the weave should have single method which does it all in one
39
 
# go, avoiding a lot of redundant work.
40
 
 
41
 
# TODO: Perhaps give a warning if one of the revisions marked as
42
 
# merged is already in the ancestry, and then don't record it as a
43
 
# distinct parent.
44
 
 
45
 
# TODO: If the file is newly merged but unchanged from the version it
46
 
# merges from, then it should still be reported as newly added
47
 
# relative to the basis revision.
48
 
 
49
 
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
 
# the rest of the code; add a deprecation of the old name.
51
 
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
 
from bzrlib import (
60
 
    debug,
61
 
    errors,
62
 
    revision,
63
 
    tree,
64
 
    )
65
 
from bzrlib.branch import Branch
66
 
import bzrlib.config
67
 
from bzrlib.errors import (BzrError, PointlessCommit,
68
 
                           ConflictsInTree,
69
 
                           StrictCommitFailed
70
 
                           )
71
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
 
                            is_inside_or_parent_of_any,
73
 
                            minimum_path_selection,
74
 
                            quotefn, sha_file, split_lines,
75
 
                            splitpath,
76
 
                            )
77
 
from bzrlib.testament import Testament
78
 
from bzrlib.trace import mutter, note, warning, is_quiet
79
 
from bzrlib.xml5 import serializer_v5
80
 
from bzrlib.inventory import InventoryEntry, make_entry
81
 
from bzrlib import symbol_versioning
82
 
from bzrlib.symbol_versioning import (deprecated_passed,
83
 
        deprecated_function,
84
 
        DEPRECATED_PARAMETER)
85
 
from bzrlib.workingtree import WorkingTree
86
 
from bzrlib.urlutils import unescape_for_display
87
 
import bzrlib.ui
88
 
 
89
 
 
90
 
class NullCommitReporter(object):
91
 
    """I report on progress of a commit."""
92
 
 
93
 
    def started(self, revno, revid, location=None):
94
 
        if location is None:
95
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
96
 
                                   "to started.", DeprecationWarning,
97
 
                                   stacklevel=2)
98
 
        pass
99
 
 
100
 
    def snapshot_change(self, change, path):
101
 
        pass
102
 
 
103
 
    def completed(self, revno, rev_id):
104
 
        pass
105
 
 
106
 
    def deleted(self, file_id):
107
 
        pass
108
 
 
109
 
    def escaped(self, escape_count, message):
110
 
        pass
111
 
 
112
 
    def missing(self, path):
113
 
        pass
114
 
 
115
 
    def renamed(self, change, old_path, new_path):
116
 
        pass
117
 
 
118
 
    def is_verbose(self):
119
 
        return False
120
 
 
121
 
 
122
 
class ReportCommitToLog(NullCommitReporter):
123
 
 
124
 
    def _note(self, format, *args):
125
 
        """Output a message.
126
 
 
127
 
        Subclasses may choose to override this method.
128
 
        """
129
 
        note(format, *args)
130
 
 
131
 
    def snapshot_change(self, change, path):
132
 
        if change == 'unchanged':
133
 
            return
134
 
        if change == 'added' and path == '':
135
 
            return
136
 
        self._note("%s %s", change, path)
137
 
 
138
 
    def started(self, revno, rev_id, location=None):
139
 
        if location is not None:
140
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
141
 
        else:
142
 
            # When started was added, location was only made optional by
143
 
            # accident.  Matt Nordhoff 20071129
144
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
145
 
                                   "to started.", DeprecationWarning,
146
 
                                   stacklevel=2)
147
 
            location = ''
148
 
        self._note('Committing%s', location)
149
 
 
150
 
    def completed(self, revno, rev_id):
151
 
        self._note('Committed revision %d.', revno)
152
 
 
153
 
    def deleted(self, file_id):
154
 
        self._note('deleted %s', file_id)
155
 
 
156
 
    def escaped(self, escape_count, message):
157
 
        self._note("replaced %d control characters in message", escape_count)
158
 
 
159
 
    def missing(self, path):
160
 
        self._note('missing %s', path)
161
 
 
162
 
    def renamed(self, change, old_path, new_path):
163
 
        self._note('%s %s => %s', change, old_path, new_path)
164
 
 
165
 
    def is_verbose(self):
166
 
        return True
167
 
 
168
 
 
169
 
class Commit(object):
170
 
    """Task of committing a new revision.
171
 
 
172
 
    This is a MethodObject: it accumulates state as the commit is
173
 
    prepared, and then it is discarded.  It doesn't represent
174
 
    historical revisions, just the act of recording a new one.
175
 
 
176
 
            missing_ids
177
 
            Modified to hold a list of files that have been deleted from
178
 
            the working directory; these should be removed from the
179
 
            working inventory.
180
 
    """
181
 
    def __init__(self,
182
 
                 reporter=None,
183
 
                 config=None):
184
 
        """Create a Commit object.
185
 
 
186
 
        :param reporter: the default reporter to use or None to decide later
187
 
        """
188
 
        self.reporter = reporter
189
 
        self.config = config
190
 
 
191
 
    def commit(self,
192
 
               message=None,
193
 
               timestamp=None,
194
 
               timezone=None,
195
 
               committer=None,
196
 
               specific_files=None,
197
 
               rev_id=None,
198
 
               allow_pointless=True,
199
 
               strict=False,
200
 
               verbose=False,
201
 
               revprops=None,
202
 
               working_tree=None,
203
 
               local=False,
204
 
               reporter=None,
205
 
               config=None,
206
 
               message_callback=None,
207
 
               recursive='down'):
208
 
        """Commit working copy as a new revision.
209
 
 
210
 
        :param message: the commit message (it or message_callback is required)
211
 
 
212
 
        :param timestamp: if not None, seconds-since-epoch for a
213
 
            postdated/predated commit.
214
 
 
215
 
        :param specific_files: If true, commit only those files.
216
 
 
217
 
        :param rev_id: If set, use this as the new revision id.
218
 
            Useful for test or import commands that need to tightly
219
 
            control what revisions are assigned.  If you duplicate
220
 
            a revision id that exists elsewhere it is your own fault.
221
 
            If null (default), a time/random revision id is generated.
222
 
 
223
 
        :param allow_pointless: If true (default), commit even if nothing
224
 
            has changed and no merges are recorded.
225
 
 
226
 
        :param strict: If true, don't allow a commit if the working tree
227
 
            contains unknown files.
228
 
 
229
 
        :param revprops: Properties for new revision
230
 
        :param local: Perform a local only commit.
231
 
        :param reporter: the reporter to use or None for the default
232
 
        :param verbose: if True and the reporter is not None, report everything
233
 
        :param recursive: If set to 'down', commit in any subtrees that have
234
 
            pending changes of any sort during this commit.
235
 
        """
236
 
        mutter('preparing to commit')
237
 
 
238
 
        if working_tree is None:
239
 
            raise BzrError("working_tree must be passed into commit().")
240
 
        else:
241
 
            self.work_tree = working_tree
242
 
            self.branch = self.work_tree.branch
243
 
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
244
 
                if not self.branch.repository.supports_rich_root():
245
 
                    raise errors.RootNotRich()
246
 
        if message_callback is None:
247
 
            if message is not None:
248
 
                if isinstance(message, str):
249
 
                    message = message.decode(bzrlib.user_encoding)
250
 
                message_callback = lambda x: message
251
 
            else:
252
 
                raise BzrError("The message or message_callback keyword"
253
 
                               " parameter is required for commit().")
254
 
 
255
 
        self.bound_branch = None
256
 
        self.any_entries_changed = False
257
 
        self.any_entries_deleted = False
258
 
        self.local = local
259
 
        self.master_branch = None
260
 
        self.master_locked = False
261
 
        self.recursive = recursive
262
 
        self.rev_id = None
263
 
        if specific_files is not None:
264
 
            self.specific_files = sorted(
265
 
                minimum_path_selection(specific_files))
266
 
        else:
267
 
            self.specific_files = None
268
 
        self.specific_file_ids = None
269
 
        self.allow_pointless = allow_pointless
270
 
        self.revprops = revprops
271
 
        self.message_callback = message_callback
272
 
        self.timestamp = timestamp
273
 
        self.timezone = timezone
274
 
        self.committer = committer
275
 
        self.strict = strict
276
 
        self.verbose = verbose
277
 
        # accumulates an inventory delta to the basis entry, so we can make
278
 
        # just the necessary updates to the workingtree's cached basis.
279
 
        self._basis_delta = []
280
 
 
281
 
        self.work_tree.lock_write()
282
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
283
 
        self.basis_revid = self.work_tree.last_revision()
284
 
        self.basis_tree = self.work_tree.basis_tree()
285
 
        self.basis_tree.lock_read()
286
 
        try:
287
 
            # Cannot commit with conflicts present.
288
 
            if len(self.work_tree.conflicts()) > 0:
289
 
                raise ConflictsInTree
290
 
 
291
 
            # Setup the bound branch variables as needed.
292
 
            self._check_bound_branch()
293
 
 
294
 
            # Check that the working tree is up to date
295
 
            old_revno, new_revno = self._check_out_of_date_tree()
296
 
 
297
 
            # Complete configuration setup
298
 
            if reporter is not None:
299
 
                self.reporter = reporter
300
 
            elif self.reporter is None:
301
 
                self.reporter = self._select_reporter()
302
 
            if self.config is None:
303
 
                self.config = self.branch.get_config()
304
 
 
305
 
            # If provided, ensure the specified files are versioned
306
 
            if self.specific_files is not None:
307
 
                # Note: This routine is being called because it raises
308
 
                # PathNotVersionedError as a side effect of finding the IDs. We
309
 
                # later use the ids we found as input to the working tree
310
 
                # inventory iterator, so we only consider those ids rather than
311
 
                # examining the whole tree again.
312
 
                # XXX: Dont we have filter_unversioned to do this more
313
 
                # cheaply?
314
 
                self.specific_file_ids = tree.find_ids_across_trees(
315
 
                    specific_files, [self.basis_tree, self.work_tree])
316
 
 
317
 
            # Setup the progress bar. As the number of files that need to be
318
 
            # committed in unknown, progress is reported as stages.
319
 
            # We keep track of entries separately though and include that
320
 
            # information in the progress bar during the relevant stages.
321
 
            self.pb_stage_name = ""
322
 
            self.pb_stage_count = 0
323
 
            self.pb_stage_total = 5
324
 
            if self.bound_branch:
325
 
                self.pb_stage_total += 1
326
 
            self.pb.show_pct = False
327
 
            self.pb.show_spinner = False
328
 
            self.pb.show_eta = False
329
 
            self.pb.show_count = True
330
 
            self.pb.show_bar = True
331
 
 
332
 
            # After a merge, a selected file commit is not supported.
333
 
            # See 'bzr help merge' for an explanation as to why.
334
 
            self.basis_inv = self.basis_tree.inventory
335
 
            self._gather_parents()
336
 
            if len(self.parents) > 1 and self.specific_files:
337
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
338
 
 
339
 
            # Collect the changes
340
 
            self._set_progress_stage("Collecting changes",
341
 
                    entries_title="Directory")
342
 
            self.builder = self.branch.get_commit_builder(self.parents,
343
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
344
 
            
345
 
            try:
346
 
                # find the location being committed to
347
 
                if self.bound_branch:
348
 
                    master_location = self.master_branch.base
349
 
                else:
350
 
                    master_location = self.branch.base
351
 
 
352
 
                # report the start of the commit
353
 
                self.reporter.started(new_revno, self.rev_id, master_location)
354
 
 
355
 
                self._update_builder_with_changes()
356
 
                self._report_and_accumulate_deletes()
357
 
                self._check_pointless()
358
 
 
359
 
                # TODO: Now the new inventory is known, check for conflicts.
360
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
 
                # weave lines, because nothing should be recorded until it is known
362
 
                # that commit will succeed.
363
 
                self._set_progress_stage("Saving data locally")
364
 
                self.builder.finish_inventory()
365
 
 
366
 
                # Prompt the user for a commit message if none provided
367
 
                message = message_callback(self)
368
 
                assert isinstance(message, unicode), type(message)
369
 
                self.message = message
370
 
                self._escape_commit_message()
371
 
 
372
 
                # Add revision data to the local branch
373
 
                self.rev_id = self.builder.commit(self.message)
374
 
 
375
 
            except:
376
 
                self.builder.abort()
377
 
                raise
378
 
 
379
 
            self._process_pre_hooks(old_revno, new_revno)
380
 
 
381
 
            # Upload revision data to the master.
382
 
            # this will propagate merged revisions too if needed.
383
 
            if self.bound_branch:
384
 
                self._set_progress_stage("Uploading data to master branch")
385
 
                self.master_branch.repository.fetch(self.branch.repository,
386
 
                                                    revision_id=self.rev_id)
387
 
                # now the master has the revision data
388
 
                # 'commit' to the master first so a timeout here causes the
389
 
                # local branch to be out of date
390
 
                self.master_branch.set_last_revision_info(new_revno,
391
 
                                                          self.rev_id)
392
 
 
393
 
            # and now do the commit locally.
394
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
395
 
 
396
 
            # Make the working tree up to date with the branch
397
 
            self._set_progress_stage("Updating the working tree")
398
 
            self.work_tree.update_basis_by_delta(self.rev_id,
399
 
                 self._basis_delta)
400
 
            self.reporter.completed(new_revno, self.rev_id)
401
 
            self._process_post_hooks(old_revno, new_revno)
402
 
        finally:
403
 
            self._cleanup()
404
 
        return self.rev_id
405
 
 
406
 
    def _select_reporter(self):
407
 
        """Select the CommitReporter to use."""
408
 
        if is_quiet():
409
 
            return NullCommitReporter()
410
 
        return ReportCommitToLog()
411
 
 
412
 
    def _check_pointless(self):
413
 
        if self.allow_pointless:
414
 
            return
415
 
        # A merge with no effect on files
416
 
        if len(self.parents) > 1:
417
 
            return
418
 
        # TODO: we could simplify this by using self._basis_delta.
419
 
 
420
 
        # The initial commit adds a root directory, but this in itself is not
421
 
        # a worthwhile commit.
422
 
        if (self.basis_revid == revision.NULL_REVISION and
423
 
            len(self.builder.new_inventory) == 1):
424
 
            raise PointlessCommit()
425
 
        # If length == 1, then we only have the root entry. Which means
426
 
        # that there is no real difference (only the root could be different)
427
 
        # unless deletes occured, in which case the length is irrelevant.
428
 
        if (self.any_entries_deleted or 
429
 
            (len(self.builder.new_inventory) != 1 and
430
 
             self.any_entries_changed)):
431
 
            return
432
 
        raise PointlessCommit()
433
 
 
434
 
    def _check_bound_branch(self):
435
 
        """Check to see if the local branch is bound.
436
 
 
437
 
        If it is bound, then most of the commit will actually be
438
 
        done using the remote branch as the target branch.
439
 
        Only at the end will the local branch be updated.
440
 
        """
441
 
        if self.local and not self.branch.get_bound_location():
442
 
            raise errors.LocalRequiresBoundBranch()
443
 
 
444
 
        if not self.local:
445
 
            self.master_branch = self.branch.get_master_branch()
446
 
 
447
 
        if not self.master_branch:
448
 
            # make this branch the reference branch for out of date checks.
449
 
            self.master_branch = self.branch
450
 
            return
451
 
 
452
 
        # If the master branch is bound, we must fail
453
 
        master_bound_location = self.master_branch.get_bound_location()
454
 
        if master_bound_location:
455
 
            raise errors.CommitToDoubleBoundBranch(self.branch,
456
 
                    self.master_branch, master_bound_location)
457
 
 
458
 
        # TODO: jam 20051230 We could automatically push local
459
 
        #       commits to the remote branch if they would fit.
460
 
        #       But for now, just require remote to be identical
461
 
        #       to local.
462
 
        
463
 
        # Make sure the local branch is identical to the master
464
 
        master_info = self.master_branch.last_revision_info()
465
 
        local_info = self.branch.last_revision_info()
466
 
        if local_info != master_info:
467
 
            raise errors.BoundBranchOutOfDate(self.branch,
468
 
                    self.master_branch)
469
 
 
470
 
        # Now things are ready to change the master branch
471
 
        # so grab the lock
472
 
        self.bound_branch = self.branch
473
 
        self.master_branch.lock_write()
474
 
        self.master_locked = True
475
 
 
476
 
    def _check_out_of_date_tree(self):
477
 
        """Check that the working tree is up to date.
478
 
 
479
 
        :return: old_revision_number,new_revision_number tuple
480
 
        """
481
 
        try:
482
 
            first_tree_parent = self.work_tree.get_parent_ids()[0]
483
 
        except IndexError:
484
 
            # if there are no parents, treat our parent as 'None'
485
 
            # this is so that we still consider the master branch
486
 
            # - in a checkout scenario the tree may have no
487
 
            # parents but the branch may do.
488
 
            first_tree_parent = bzrlib.revision.NULL_REVISION
489
 
        old_revno, master_last = self.master_branch.last_revision_info()
490
 
        if master_last != first_tree_parent:
491
 
            if master_last != bzrlib.revision.NULL_REVISION:
492
 
                raise errors.OutOfDateTree(self.work_tree)
493
 
        if self.branch.repository.has_revision(first_tree_parent):
494
 
            new_revno = old_revno + 1
495
 
        else:
496
 
            # ghost parents never appear in revision history.
497
 
            new_revno = 1
498
 
        return old_revno,new_revno
499
 
 
500
 
    def _process_pre_hooks(self, old_revno, new_revno):
501
 
        """Process any registered pre commit hooks."""
502
 
        self._set_progress_stage("Running pre_commit hooks")
503
 
        self._process_hooks("pre_commit", old_revno, new_revno)
504
 
 
505
 
    def _process_post_hooks(self, old_revno, new_revno):
506
 
        """Process any registered post commit hooks."""
507
 
        # Process the post commit hooks, if any
508
 
        self._set_progress_stage("Running post_commit hooks")
509
 
        # old style commit hooks - should be deprecated ? (obsoleted in
510
 
        # 0.15)
511
 
        if self.config.post_commit() is not None:
512
 
            hooks = self.config.post_commit().split(' ')
513
 
            # this would be nicer with twisted.python.reflect.namedAny
514
 
            for hook in hooks:
515
 
                result = eval(hook + '(branch, rev_id)',
516
 
                              {'branch':self.branch,
517
 
                               'bzrlib':bzrlib,
518
 
                               'rev_id':self.rev_id})
519
 
        # process new style post commit hooks
520
 
        self._process_hooks("post_commit", old_revno, new_revno)
521
 
 
522
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
523
 
        if not Branch.hooks[hook_name]:
524
 
            return
525
 
        
526
 
        # new style commit hooks:
527
 
        if not self.bound_branch:
528
 
            hook_master = self.branch
529
 
            hook_local = None
530
 
        else:
531
 
            hook_master = self.master_branch
532
 
            hook_local = self.branch
533
 
        # With bound branches, when the master is behind the local branch,
534
 
        # the 'old_revno' and old_revid values here are incorrect.
535
 
        # XXX: FIXME ^. RBC 20060206
536
 
        if self.parents:
537
 
            old_revid = self.parents[0]
538
 
        else:
539
 
            old_revid = bzrlib.revision.NULL_REVISION
540
 
        
541
 
        if hook_name == "pre_commit":
542
 
            future_tree = self.builder.revision_tree()
543
 
            tree_delta = future_tree.changes_from(self.basis_tree,
544
 
                                             include_root=True)
545
 
        
546
 
        for hook in Branch.hooks[hook_name]:
547
 
            # show the running hook in the progress bar. As hooks may
548
 
            # end up doing nothing (e.g. because they are not configured by
549
 
            # the user) this is still showing progress, not showing overall
550
 
            # actions - its up to each plugin to show a UI if it want's to
551
 
            # (such as 'Emailing diff to foo@example.com').
552
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
553
 
                (hook_name, Branch.hooks.get_hook_name(hook))
554
 
            self._emit_progress()
555
 
            if 'hooks' in debug.debug_flags:
556
 
                mutter("Invoking commit hook: %r", hook)
557
 
            if hook_name == "post_commit":
558
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
559
 
                     self.rev_id)
560
 
            elif hook_name == "pre_commit":
561
 
                hook(hook_local, hook_master,
562
 
                     old_revno, old_revid, new_revno, self.rev_id,
563
 
                     tree_delta, future_tree)
564
 
 
565
 
    def _cleanup(self):
566
 
        """Cleanup any open locks, progress bars etc."""
567
 
        cleanups = [self._cleanup_bound_branch,
568
 
                    self.basis_tree.unlock,
569
 
                    self.work_tree.unlock,
570
 
                    self.pb.finished]
571
 
        found_exception = None
572
 
        for cleanup in cleanups:
573
 
            try:
574
 
                cleanup()
575
 
            # we want every cleanup to run no matter what.
576
 
            # so we have a catchall here, but we will raise the
577
 
            # last encountered exception up the stack: and
578
 
            # typically this will be useful enough.
579
 
            except Exception, e:
580
 
                found_exception = e
581
 
        if found_exception is not None: 
582
 
            # don't do a plan raise, because the last exception may have been
583
 
            # trashed, e is our sure-to-work exception even though it loses the
584
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
585
 
            # exc_info and if its the same one do a plain raise otherwise 
586
 
            # 'raise e' as we do now.
587
 
            raise e
588
 
 
589
 
    def _cleanup_bound_branch(self):
590
 
        """Executed at the end of a try/finally to cleanup a bound branch.
591
 
 
592
 
        If the branch wasn't bound, this is a no-op.
593
 
        If it was, it resents self.branch to the local branch, instead
594
 
        of being the master.
595
 
        """
596
 
        if not self.bound_branch:
597
 
            return
598
 
        if self.master_locked:
599
 
            self.master_branch.unlock()
600
 
 
601
 
    def _escape_commit_message(self):
602
 
        """Replace xml-incompatible control characters."""
603
 
        # FIXME: RBC 20060419 this should be done by the revision
604
 
        # serialiser not by commit. Then we can also add an unescaper
605
 
        # in the deserializer and start roundtripping revision messages
606
 
        # precisely. See repository_implementations/test_repository.py
607
 
        
608
 
        # Python strings can include characters that can't be
609
 
        # represented in well-formed XML; escape characters that
610
 
        # aren't listed in the XML specification
611
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
612
 
        self.message, escape_count = re.subn(
613
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
614
 
            lambda match: match.group(0).encode('unicode_escape'),
615
 
            self.message)
616
 
        if escape_count:
617
 
            self.reporter.escaped(escape_count, self.message)
618
 
 
619
 
    def _gather_parents(self):
620
 
        """Record the parents of a merge for merge detection."""
621
 
        # TODO: Make sure that this list doesn't contain duplicate 
622
 
        # entries and the order is preserved when doing this.
623
 
        self.parents = self.work_tree.get_parent_ids()
624
 
        self.parent_invs = [self.basis_inv]
625
 
        for revision in self.parents[1:]:
626
 
            if self.branch.repository.has_revision(revision):
627
 
                mutter('commit parent revision {%s}', revision)
628
 
                inventory = self.branch.repository.get_inventory(revision)
629
 
                self.parent_invs.append(inventory)
630
 
            else:
631
 
                mutter('commit parent ghost revision {%s}', revision)
632
 
 
633
 
    def _update_builder_with_changes(self):
634
 
        """Update the commit builder with the data about what has changed.
635
 
        """
636
 
        # Build the revision inventory.
637
 
        #
638
 
        # This starts by creating a new empty inventory. Depending on
639
 
        # which files are selected for commit, and what is present in the
640
 
        # current tree, the new inventory is populated. inventory entries 
641
 
        # which are candidates for modification have their revision set to
642
 
        # None; inventory entries that are carried over untouched have their
643
 
        # revision set to their prior value.
644
 
        #
645
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
646
 
        # results to create a new inventory at the same time, which results
647
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
648
 
        # ADHB 11-07-2006
649
 
 
650
 
        specific_files = self.specific_files
651
 
        mutter("Selecting files for commit with filter %s", specific_files)
652
 
 
653
 
        # Build the new inventory
654
 
        self._populate_from_inventory(specific_files)
655
 
 
656
 
        # If specific files are selected, then all un-selected files must be
657
 
        # recorded in their previous state. For more details, see
658
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
659
 
        if specific_files:
660
 
            for path, old_ie in self.basis_inv.iter_entries():
661
 
                if old_ie.file_id in self.builder.new_inventory:
662
 
                    # already added - skip.
663
 
                    continue
664
 
                if is_inside_any(specific_files, path):
665
 
                    # was inside the selected path, if not present it has been
666
 
                    # deleted so skip.
667
 
                    continue
668
 
                if old_ie.kind == 'directory':
669
 
                    self._next_progress_entry()
670
 
                # not in final inv yet, was not in the selected files, so is an
671
 
                # entry to be preserved unaltered.
672
 
                ie = old_ie.copy()
673
 
                # Note: specific file commits after a merge are currently
674
 
                # prohibited. This test is for sanity/safety in case it's
675
 
                # required after that changes.
676
 
                if len(self.parents) > 1:
677
 
                    ie.revision = None
678
 
                delta, version_recorded = self.builder.record_entry_contents(
679
 
                    ie, self.parent_invs, path, self.basis_tree, None)
680
 
                if version_recorded:
681
 
                    self.any_entries_changed = True
682
 
                if delta: self._basis_delta.append(delta)
683
 
 
684
 
    def _report_and_accumulate_deletes(self):
685
 
        # XXX: Could the list of deleted paths and ids be instead taken from
686
 
        # _populate_from_inventory?
687
 
        deleted_ids = set(self.basis_inv._byid.keys()) - \
688
 
            set(self.builder.new_inventory._byid.keys())
689
 
        if deleted_ids:
690
 
            self.any_entries_deleted = True
691
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
692
 
                for file_id in deleted_ids]
693
 
            deleted.sort()
694
 
            # XXX: this is not quite directory-order sorting
695
 
            for path, file_id in deleted:
696
 
                self._basis_delta.append((path, None, file_id, None))
697
 
                self.reporter.deleted(path)
698
 
 
699
 
    def _populate_from_inventory(self, specific_files):
700
 
        """Populate the CommitBuilder by walking the working tree inventory."""
701
 
        if self.strict:
702
 
            # raise an exception as soon as we find a single unknown.
703
 
            for unknown in self.work_tree.unknowns():
704
 
                raise StrictCommitFailed()
705
 
               
706
 
        report_changes = self.reporter.is_verbose()
707
 
        deleted_ids = []
708
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
709
 
        # deleted, then we have {'foo':{'bar':{}}}
710
 
        deleted_paths = {}
711
 
        # XXX: Note that entries may have the wrong kind because the entry does
712
 
        # not reflect the status on disk.
713
 
        work_inv = self.work_tree.inventory
714
 
        entries = work_inv.iter_entries_by_dir(
715
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
716
 
        for path, existing_ie in entries:
717
 
            file_id = existing_ie.file_id
718
 
            name = existing_ie.name
719
 
            parent_id = existing_ie.parent_id
720
 
            kind = existing_ie.kind
721
 
            if kind == 'directory':
722
 
                self._next_progress_entry()
723
 
            # Skip files that have been deleted from the working tree.
724
 
            # The deleted path ids are also recorded so they can be explicitly
725
 
            # unversioned later.
726
 
            if deleted_paths:
727
 
                path_segments = splitpath(path)
728
 
                deleted_dict = deleted_paths
729
 
                for segment in path_segments:
730
 
                    deleted_dict = deleted_dict.get(segment, None)
731
 
                    if not deleted_dict:
732
 
                        # We either took a path not present in the dict
733
 
                        # (deleted_dict was None), or we've reached an empty
734
 
                        # child dir in the dict, so are now a sub-path.
735
 
                        break
736
 
                else:
737
 
                    deleted_dict = None
738
 
                if deleted_dict is not None:
739
 
                    # the path has a deleted parent, do not add it.
740
 
                    continue
741
 
            content_summary = self.work_tree.path_content_summary(path)
742
 
            # Note that when a filter of specific files is given, we must only
743
 
            # skip/record deleted files matching that filter.
744
 
            if not specific_files or is_inside_any(specific_files, path):
745
 
                if content_summary[0] == 'missing':
746
 
                    if not deleted_paths:
747
 
                        # path won't have been split yet.
748
 
                        path_segments = splitpath(path)
749
 
                    deleted_dict = deleted_paths
750
 
                    for segment in path_segments:
751
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
752
 
                    self.reporter.missing(path)
753
 
                    deleted_ids.append(file_id)
754
 
                    continue
755
 
            # TODO: have the builder do the nested commit just-in-time IF and
756
 
            # only if needed.
757
 
            if content_summary[0] == 'tree-reference':
758
 
                # enforce repository nested tree policy.
759
 
                if (not self.work_tree.supports_tree_reference() or
760
 
                    # repository does not support it either.
761
 
                    not self.branch.repository._format.supports_tree_reference):
762
 
                    content_summary = ('directory',) + content_summary[1:]
763
 
            kind = content_summary[0]
764
 
            # TODO: specific_files filtering before nested tree processing
765
 
            if kind == 'tree-reference':
766
 
                if self.recursive == 'down':
767
 
                    nested_revision_id = self._commit_nested_tree(
768
 
                        file_id, path)
769
 
                    content_summary = content_summary[:3] + (
770
 
                        nested_revision_id,)
771
 
                else:
772
 
                    content_summary = content_summary[:3] + (
773
 
                        self.work_tree.get_reference_revision(file_id),)
774
 
 
775
 
            # Record an entry for this item
776
 
            # Note: I don't particularly want to have the existing_ie
777
 
            # parameter but the test suite currently (28-Jun-07) breaks
778
 
            # without it thanks to a unicode normalisation issue. :-(
779
 
            definitely_changed = kind != existing_ie.kind
780
 
            self._record_entry(path, file_id, specific_files, kind, name,
781
 
                parent_id, definitely_changed, existing_ie, report_changes,
782
 
                content_summary)
783
 
 
784
 
        # Unversion IDs that were found to be deleted
785
 
        self.work_tree.unversion(deleted_ids)
786
 
 
787
 
    def _commit_nested_tree(self, file_id, path):
788
 
        "Commit a nested tree."
789
 
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
790
 
        # FIXME: be more comprehensive here:
791
 
        # this works when both trees are in --trees repository,
792
 
        # but when both are bound to a different repository,
793
 
        # it fails; a better way of approaching this is to 
794
 
        # finally implement the explicit-caches approach design
795
 
        # a while back - RBC 20070306.
796
 
        if sub_tree.branch.repository.has_same_location(
797
 
            self.work_tree.branch.repository):
798
 
            sub_tree.branch.repository = \
799
 
                self.work_tree.branch.repository
800
 
        try:
801
 
            return sub_tree.commit(message=None, revprops=self.revprops,
802
 
                recursive=self.recursive,
803
 
                message_callback=self.message_callback,
804
 
                timestamp=self.timestamp, timezone=self.timezone,
805
 
                committer=self.committer,
806
 
                allow_pointless=self.allow_pointless,
807
 
                strict=self.strict, verbose=self.verbose,
808
 
                local=self.local, reporter=self.reporter)
809
 
        except errors.PointlessCommit:
810
 
            return self.work_tree.get_reference_revision(file_id)
811
 
 
812
 
    def _record_entry(self, path, file_id, specific_files, kind, name,
813
 
        parent_id, definitely_changed, existing_ie, report_changes,
814
 
        content_summary):
815
 
        "Record the new inventory entry for a path if any."
816
 
        # mutter('check %s {%s}', path, file_id)
817
 
        # mutter('%s selected for commit', path)
818
 
        if definitely_changed or existing_ie is None:
819
 
            ie = make_entry(kind, name, parent_id, file_id)
820
 
        else:
821
 
            ie = existing_ie.copy()
822
 
            ie.revision = None
823
 
        delta, version_recorded = self.builder.record_entry_contents(ie,
824
 
            self.parent_invs, path, self.work_tree, content_summary)
825
 
        if delta:
826
 
            self._basis_delta.append(delta)
827
 
        if version_recorded:
828
 
            self.any_entries_changed = True
829
 
        if report_changes:
830
 
            self._report_change(ie, path)
831
 
        return ie
832
 
 
833
 
    def _report_change(self, ie, path):
834
 
        """Report a change to the user.
835
 
 
836
 
        The change that has occurred is described relative to the basis
837
 
        inventory.
838
 
        """
839
 
        if (self.basis_inv.has_id(ie.file_id)):
840
 
            basis_ie = self.basis_inv[ie.file_id]
841
 
        else:
842
 
            basis_ie = None
843
 
        change = ie.describe_change(basis_ie, ie)
844
 
        if change in (InventoryEntry.RENAMED, 
845
 
            InventoryEntry.MODIFIED_AND_RENAMED):
846
 
            old_path = self.basis_inv.id2path(ie.file_id)
847
 
            self.reporter.renamed(change, old_path, path)
848
 
        else:
849
 
            self.reporter.snapshot_change(change, path)
850
 
 
851
 
    def _set_progress_stage(self, name, entries_title=None):
852
 
        """Set the progress stage and emit an update to the progress bar."""
853
 
        self.pb_stage_name = name
854
 
        self.pb_stage_count += 1
855
 
        self.pb_entries_title = entries_title
856
 
        if entries_title is not None:
857
 
            self.pb_entries_count = 0
858
 
            self.pb_entries_total = '?'
859
 
        self._emit_progress()
860
 
 
861
 
    def _next_progress_entry(self):
862
 
        """Emit an update to the progress bar and increment the entry count."""
863
 
        self.pb_entries_count += 1
864
 
        self._emit_progress()
865
 
 
866
 
    def _emit_progress(self):
867
 
        if self.pb_entries_title:
868
 
            if self.pb_entries_total == '?':
869
 
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
870
 
                    self.pb_entries_title, self.pb_entries_count)
871
 
            else:
872
 
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
873
 
                    self.pb_entries_title, self.pb_entries_count,
874
 
                    str(self.pb_entries_total))
875
 
        else:
876
 
            text = "%s - Stage" % (self.pb_stage_name)
877
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
878