/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

merge with bzr.dev

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