/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: Martin Pool
  • Date: 2007-10-12 08:00:07 UTC
  • mto: This revision was merged to the branch mainline in revision 2913.
  • Revision ID: mbp@sourcefrog.net-20071012080007-vf80woayyom8s8e1
Rename update_to_one_parent_via_delta to more wieldy update_basis_by_delta

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