~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-11-03 23:02:16 UTC
  • mfrom: (2951.1.1 pack)
  • Revision ID: pqm@pqm.ubuntu.com-20071103230216-mnmwuxm413lyhjdv
(robertc) Fix data-refresh logic for packs not to refresh mid-transaction when a names write lock is held. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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