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