/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: Ian Clatworthy
  • Date: 2007-09-03 13:17:52 UTC
  • mto: (2819.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2820.
  • Revision ID: ian.clatworthy@internode.on.net-20070903131752-va6227ax1vj8b9pb
Make commit less verbose by default

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