~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2007-11-30 15:59:02 UTC
  • mto: This revision was merged to the branch mainline in revision 3061.
  • Revision ID: john@arbash-meinel.com-20071130155902-03cqo1ynbg2x7x5a
Change the lock check to raise ObjectNotLocked.

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
                            splitpath,
 
76
                            )
 
77
from bzrlib.testament import Testament
 
78
from bzrlib.trace import mutter, note, warning, is_quiet
 
79
from bzrlib.xml5 import serializer_v5
 
80
from bzrlib.inventory import InventoryEntry, make_entry
 
81
from bzrlib import symbol_versioning
 
82
from bzrlib.symbol_versioning import (deprecated_passed,
 
83
        deprecated_function,
 
84
        DEPRECATED_PARAMETER)
 
85
from bzrlib.workingtree import WorkingTree
 
86
from bzrlib.urlutils import unescape_for_display
 
87
import bzrlib.ui
 
88
 
 
89
 
 
90
class NullCommitReporter(object):
 
91
    """I report on progress of a commit."""
 
92
 
 
93
    def started(self, revno, revid, location=None):
 
94
        pass
 
95
 
 
96
    def snapshot_change(self, change, path):
 
97
        pass
 
98
 
 
99
    def completed(self, revno, rev_id):
 
100
        pass
 
101
 
 
102
    def deleted(self, file_id):
 
103
        pass
 
104
 
 
105
    def escaped(self, escape_count, message):
 
106
        pass
 
107
 
 
108
    def missing(self, path):
 
109
        pass
 
110
 
 
111
    def renamed(self, change, old_path, new_path):
 
112
        pass
 
113
 
 
114
    def is_verbose(self):
 
115
        return False
 
116
 
 
117
 
 
118
class ReportCommitToLog(NullCommitReporter):
 
119
 
 
120
    def _note(self, format, *args):
 
121
        """Output a message.
 
122
 
 
123
        Subclasses may choose to override this method.
 
124
        """
 
125
        note(format, *args)
 
126
 
 
127
    def snapshot_change(self, change, path):
 
128
        if change == 'unchanged':
 
129
            return
 
130
        if change == 'added' and path == '':
 
131
            return
 
132
        self._note("%s %s", change, path)
 
133
 
 
134
    def started(self, revno, rev_id, location=None):
 
135
        if location is not None:
 
136
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
 
137
        else:
 
138
            location = ''
 
139
        self._note('Committing revision %d%s.', revno, location)
 
140
 
 
141
    def completed(self, revno, rev_id):
 
142
        self._note('Committed revision %d.', revno)
 
143
 
 
144
    def deleted(self, file_id):
 
145
        self._note('deleted %s', file_id)
 
146
 
 
147
    def escaped(self, escape_count, message):
 
148
        self._note("replaced %d control characters in message", escape_count)
 
149
 
 
150
    def missing(self, path):
 
151
        self._note('missing %s', path)
 
152
 
 
153
    def renamed(self, change, old_path, new_path):
 
154
        self._note('%s %s => %s', change, old_path, new_path)
 
155
 
 
156
    def is_verbose(self):
 
157
        return True
 
158
 
 
159
 
 
160
class Commit(object):
 
161
    """Task of committing a new revision.
 
162
 
 
163
    This is a MethodObject: it accumulates state as the commit is
 
164
    prepared, and then it is discarded.  It doesn't represent
 
165
    historical revisions, just the act of recording a new one.
 
166
 
 
167
            missing_ids
 
168
            Modified to hold a list of files that have been deleted from
 
169
            the working directory; these should be removed from the
 
170
            working inventory.
 
171
    """
 
172
    def __init__(self,
 
173
                 reporter=None,
 
174
                 config=None):
 
175
        """Create a Commit object.
 
176
 
 
177
        :param reporter: the default reporter to use or None to decide later
 
178
        """
 
179
        self.reporter = reporter
 
180
        self.config = config
 
181
 
 
182
    def commit(self,
 
183
               message=None,
 
184
               timestamp=None,
 
185
               timezone=None,
 
186
               committer=None,
 
187
               specific_files=None,
 
188
               rev_id=None,
 
189
               allow_pointless=True,
 
190
               strict=False,
 
191
               verbose=False,
 
192
               revprops=None,
 
193
               working_tree=None,
 
194
               local=False,
 
195
               reporter=None,
 
196
               config=None,
 
197
               message_callback=None,
 
198
               recursive='down'):
 
199
        """Commit working copy as a new revision.
 
200
 
 
201
        :param message: the commit message (it or message_callback is required)
 
202
 
 
203
        :param timestamp: if not None, seconds-since-epoch for a
 
204
            postdated/predated commit.
 
205
 
 
206
        :param specific_files: If true, commit only those files.
 
207
 
 
208
        :param rev_id: If set, use this as the new revision id.
 
209
            Useful for test or import commands that need to tightly
 
210
            control what revisions are assigned.  If you duplicate
 
211
            a revision id that exists elsewhere it is your own fault.
 
212
            If null (default), a time/random revision id is generated.
 
213
 
 
214
        :param allow_pointless: If true (default), commit even if nothing
 
215
            has changed and no merges are recorded.
 
216
 
 
217
        :param strict: If true, don't allow a commit if the working tree
 
218
            contains unknown files.
 
219
 
 
220
        :param revprops: Properties for new revision
 
221
        :param local: Perform a local only commit.
 
222
        :param reporter: the reporter to use or None for the default
 
223
        :param verbose: if True and the reporter is not None, report everything
 
224
        :param recursive: If set to 'down', commit in any subtrees that have
 
225
            pending changes of any sort during this commit.
 
226
        """
 
227
        mutter('preparing to commit')
 
228
 
 
229
        if working_tree is None:
 
230
            raise BzrError("working_tree must be passed into commit().")
 
231
        else:
 
232
            self.work_tree = working_tree
 
233
            self.branch = self.work_tree.branch
 
234
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
235
                if not self.branch.repository.supports_rich_root():
 
236
                    raise errors.RootNotRich()
 
237
        if message_callback is None:
 
238
            if message is not None:
 
239
                if isinstance(message, str):
 
240
                    message = message.decode(bzrlib.user_encoding)
 
241
                message_callback = lambda x: message
 
242
            else:
 
243
                raise BzrError("The message or message_callback keyword"
 
244
                               " parameter is required for commit().")
 
245
 
 
246
        self.bound_branch = None
 
247
        self.any_entries_changed = False
 
248
        self.any_entries_deleted = False
 
249
        self.local = local
 
250
        self.master_branch = None
 
251
        self.master_locked = False
 
252
        self.recursive = recursive
 
253
        self.rev_id = None
 
254
        if specific_files is not None:
 
255
            self.specific_files = sorted(
 
256
                minimum_path_selection(specific_files))
 
257
        else:
 
258
            self.specific_files = None
 
259
        self.specific_file_ids = None
 
260
        self.allow_pointless = allow_pointless
 
261
        self.revprops = revprops
 
262
        self.message_callback = message_callback
 
263
        self.timestamp = timestamp
 
264
        self.timezone = timezone
 
265
        self.committer = committer
 
266
        self.strict = strict
 
267
        self.verbose = verbose
 
268
        # accumulates an inventory delta to the basis entry, so we can make
 
269
        # just the necessary updates to the workingtree's cached basis.
 
270
        self._basis_delta = []
 
271
 
 
272
        self.work_tree.lock_write()
 
273
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
274
        self.basis_revid = self.work_tree.last_revision()
 
275
        self.basis_tree = self.work_tree.basis_tree()
 
276
        self.basis_tree.lock_read()
 
277
        try:
 
278
            # Cannot commit with conflicts present.
 
279
            if len(self.work_tree.conflicts()) > 0:
 
280
                raise ConflictsInTree
 
281
 
 
282
            # Setup the bound branch variables as needed.
 
283
            self._check_bound_branch()
 
284
 
 
285
            # Check that the working tree is up to date
 
286
            old_revno, new_revno = self._check_out_of_date_tree()
 
287
 
 
288
            # Complete configuration setup
 
289
            if reporter is not None:
 
290
                self.reporter = reporter
 
291
            elif self.reporter is None:
 
292
                self.reporter = self._select_reporter()
 
293
            if self.config is None:
 
294
                self.config = self.branch.get_config()
 
295
 
 
296
            # If provided, ensure the specified files are versioned
 
297
            if self.specific_files is not None:
 
298
                # Note: This routine is being called because it raises
 
299
                # PathNotVersionedError as a side effect of finding the IDs. We
 
300
                # later use the ids we found as input to the working tree
 
301
                # inventory iterator, so we only consider those ids rather than
 
302
                # examining the whole tree again.
 
303
                # XXX: Dont we have filter_unversioned to do this more
 
304
                # cheaply?
 
305
                self.specific_file_ids = tree.find_ids_across_trees(
 
306
                    specific_files, [self.basis_tree, self.work_tree])
 
307
 
 
308
            # Setup the progress bar. As the number of files that need to be
 
309
            # committed in unknown, progress is reported as stages.
 
310
            # We keep track of entries separately though and include that
 
311
            # information in the progress bar during the relevant stages.
 
312
            self.pb_stage_name = ""
 
313
            self.pb_stage_count = 0
 
314
            self.pb_stage_total = 5
 
315
            if self.bound_branch:
 
316
                self.pb_stage_total += 1
 
317
            self.pb.show_pct = False
 
318
            self.pb.show_spinner = False
 
319
            self.pb.show_eta = False
 
320
            self.pb.show_count = True
 
321
            self.pb.show_bar = True
 
322
 
 
323
            # After a merge, a selected file commit is not supported.
 
324
            # See 'bzr help merge' for an explanation as to why.
 
325
            self.basis_inv = self.basis_tree.inventory
 
326
            self._gather_parents()
 
327
            if len(self.parents) > 1 and self.specific_files:
 
328
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
329
 
 
330
            # Collect the changes
 
331
            self._set_progress_stage("Collecting changes",
 
332
                    entries_title="Directory")
 
333
            self.builder = self.branch.get_commit_builder(self.parents,
 
334
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
335
            
 
336
            try:
 
337
                # find the location being committed to
 
338
                if self.bound_branch:
 
339
                    master_location = self.master_branch.base
 
340
                else:
 
341
                    master_location = self.branch.base
 
342
 
 
343
                # report the start of the commit
 
344
                self.reporter.started(new_revno, self.rev_id, master_location)
 
345
 
 
346
                self._update_builder_with_changes()
 
347
                self._report_and_accumulate_deletes()
 
348
                self._check_pointless()
 
349
 
 
350
                # TODO: Now the new inventory is known, check for conflicts.
 
351
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
352
                # weave lines, because nothing should be recorded until it is known
 
353
                # that commit will succeed.
 
354
                self._set_progress_stage("Saving data locally")
 
355
                self.builder.finish_inventory()
 
356
 
 
357
                # Prompt the user for a commit message if none provided
 
358
                message = message_callback(self)
 
359
                assert isinstance(message, unicode), type(message)
 
360
                self.message = message
 
361
                self._escape_commit_message()
 
362
 
 
363
                # Add revision data to the local branch
 
364
                self.rev_id = self.builder.commit(self.message)
 
365
 
 
366
            except:
 
367
                self.builder.abort()
 
368
                raise
 
369
 
 
370
            self._process_pre_hooks(old_revno, new_revno)
 
371
 
 
372
            # Upload revision data to the master.
 
373
            # this will propagate merged revisions too if needed.
 
374
            if self.bound_branch:
 
375
                self._set_progress_stage("Uploading data to master branch")
 
376
                self.master_branch.repository.fetch(self.branch.repository,
 
377
                                                    revision_id=self.rev_id)
 
378
                # now the master has the revision data
 
379
                # 'commit' to the master first so a timeout here causes the
 
380
                # local branch to be out of date
 
381
                self.master_branch.set_last_revision_info(new_revno,
 
382
                                                          self.rev_id)
 
383
 
 
384
            # and now do the commit locally.
 
385
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
386
 
 
387
            # Make the working tree up to date with the branch
 
388
            self._set_progress_stage("Updating the working tree")
 
389
            self.work_tree.update_basis_by_delta(self.rev_id,
 
390
                 self._basis_delta)
 
391
            self.reporter.completed(new_revno, self.rev_id)
 
392
            self._process_post_hooks(old_revno, new_revno)
 
393
        finally:
 
394
            self._cleanup()
 
395
        return self.rev_id
 
396
 
 
397
    def _select_reporter(self):
 
398
        """Select the CommitReporter to use."""
 
399
        if is_quiet():
 
400
            return NullCommitReporter()
 
401
        return ReportCommitToLog()
 
402
 
 
403
    def _check_pointless(self):
 
404
        if self.allow_pointless:
 
405
            return
 
406
        # A merge with no effect on files
 
407
        if len(self.parents) > 1:
 
408
            return
 
409
        # TODO: we could simplify this by using self._basis_delta.
 
410
 
 
411
        # The initial commit adds a root directory, but this in itself is not
 
412
        # a worthwhile commit.
 
413
        if (self.basis_revid == revision.NULL_REVISION and
 
414
            len(self.builder.new_inventory) == 1):
 
415
            raise PointlessCommit()
 
416
        # If length == 1, then we only have the root entry. Which means
 
417
        # that there is no real difference (only the root could be different)
 
418
        # unless deletes occured, in which case the length is irrelevant.
 
419
        if (self.any_entries_deleted or 
 
420
            (len(self.builder.new_inventory) != 1 and
 
421
             self.any_entries_changed)):
 
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
        # 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
                delta, version_recorded = self.builder.record_entry_contents(
 
670
                    ie, self.parent_invs, path, self.basis_tree, None)
 
671
                if version_recorded:
 
672
                    self.any_entries_changed = True
 
673
                if delta: self._basis_delta.append(delta)
 
674
 
 
675
    def _report_and_accumulate_deletes(self):
 
676
        # XXX: Could the list of deleted paths and ids be instead taken from
 
677
        # _populate_from_inventory?
 
678
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
679
            set(self.builder.new_inventory._byid.keys())
 
680
        if deleted_ids:
 
681
            self.any_entries_deleted = True
 
682
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
683
                for file_id in deleted_ids]
 
684
            deleted.sort()
 
685
            # XXX: this is not quite directory-order sorting
 
686
            for path, file_id in deleted:
 
687
                self._basis_delta.append((path, None, file_id, None))
 
688
                self.reporter.deleted(path)
 
689
 
 
690
    def _populate_from_inventory(self, specific_files):
 
691
        """Populate the CommitBuilder by walking the working tree inventory."""
 
692
        if self.strict:
 
693
            # raise an exception as soon as we find a single unknown.
 
694
            for unknown in self.work_tree.unknowns():
 
695
                raise StrictCommitFailed()
 
696
               
 
697
        report_changes = self.reporter.is_verbose()
 
698
        deleted_ids = []
 
699
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
700
        # deleted, then we have {'foo':{'bar':{}}}
 
701
        deleted_paths = {}
 
702
        # XXX: Note that entries may have the wrong kind because the entry does
 
703
        # not reflect the status on disk.
 
704
        work_inv = self.work_tree.inventory
 
705
        entries = work_inv.iter_entries_by_dir(
 
706
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
707
        for path, existing_ie in entries:
 
708
            file_id = existing_ie.file_id
 
709
            name = existing_ie.name
 
710
            parent_id = existing_ie.parent_id
 
711
            kind = existing_ie.kind
 
712
            if kind == 'directory':
 
713
                self._next_progress_entry()
 
714
            # Skip files that have been deleted from the working tree.
 
715
            # The deleted path ids are also recorded so they can be explicitly
 
716
            # unversioned later.
 
717
            if deleted_paths:
 
718
                path_segments = splitpath(path)
 
719
                deleted_dict = deleted_paths
 
720
                for segment in path_segments:
 
721
                    deleted_dict = deleted_dict.get(segment, None)
 
722
                    if not deleted_dict:
 
723
                        # We either took a path not present in the dict
 
724
                        # (deleted_dict was None), or we've reached an empty
 
725
                        # child dir in the dict, so are now a sub-path.
 
726
                        break
 
727
                else:
 
728
                    deleted_dict = None
 
729
                if deleted_dict is not None:
 
730
                    # the path has a deleted parent, do not add it.
 
731
                    continue
 
732
            content_summary = self.work_tree.path_content_summary(path)
 
733
            # Note that when a filter of specific files is given, we must only
 
734
            # skip/record deleted files matching that filter.
 
735
            if not specific_files or is_inside_any(specific_files, path):
 
736
                if content_summary[0] == 'missing':
 
737
                    if not deleted_paths:
 
738
                        # path won't have been split yet.
 
739
                        path_segments = splitpath(path)
 
740
                    deleted_dict = deleted_paths
 
741
                    for segment in path_segments:
 
742
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
743
                    self.reporter.missing(path)
 
744
                    deleted_ids.append(file_id)
 
745
                    continue
 
746
            # TODO: have the builder do the nested commit just-in-time IF and
 
747
            # only if needed.
 
748
            if content_summary[0] == 'tree-reference':
 
749
                # enforce repository nested tree policy.
 
750
                if (not self.work_tree.supports_tree_reference() or
 
751
                    # repository does not support it either.
 
752
                    not self.branch.repository._format.supports_tree_reference):
 
753
                    content_summary = ('directory',) + content_summary[1:]
 
754
            kind = content_summary[0]
 
755
            # TODO: specific_files filtering before nested tree processing
 
756
            if kind == 'tree-reference':
 
757
                if self.recursive == 'down':
 
758
                    nested_revision_id = self._commit_nested_tree(
 
759
                        file_id, path)
 
760
                    content_summary = content_summary[:3] + (
 
761
                        nested_revision_id,)
 
762
                else:
 
763
                    content_summary = content_summary[:3] + (
 
764
                        self.work_tree.get_reference_revision(file_id),)
 
765
 
 
766
            # Record an entry for this item
 
767
            # Note: I don't particularly want to have the existing_ie
 
768
            # parameter but the test suite currently (28-Jun-07) breaks
 
769
            # without it thanks to a unicode normalisation issue. :-(
 
770
            definitely_changed = kind != existing_ie.kind
 
771
            self._record_entry(path, file_id, specific_files, kind, name,
 
772
                parent_id, definitely_changed, existing_ie, report_changes,
 
773
                content_summary)
 
774
 
 
775
        # Unversion IDs that were found to be deleted
 
776
        self.work_tree.unversion(deleted_ids)
 
777
 
 
778
    def _commit_nested_tree(self, file_id, path):
 
779
        "Commit a nested tree."
 
780
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
781
        # FIXME: be more comprehensive here:
 
782
        # this works when both trees are in --trees repository,
 
783
        # but when both are bound to a different repository,
 
784
        # it fails; a better way of approaching this is to 
 
785
        # finally implement the explicit-caches approach design
 
786
        # a while back - RBC 20070306.
 
787
        if sub_tree.branch.repository.has_same_location(
 
788
            self.work_tree.branch.repository):
 
789
            sub_tree.branch.repository = \
 
790
                self.work_tree.branch.repository
 
791
        try:
 
792
            return sub_tree.commit(message=None, revprops=self.revprops,
 
793
                recursive=self.recursive,
 
794
                message_callback=self.message_callback,
 
795
                timestamp=self.timestamp, timezone=self.timezone,
 
796
                committer=self.committer,
 
797
                allow_pointless=self.allow_pointless,
 
798
                strict=self.strict, verbose=self.verbose,
 
799
                local=self.local, reporter=self.reporter)
 
800
        except errors.PointlessCommit:
 
801
            return self.work_tree.get_reference_revision(file_id)
 
802
 
 
803
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
804
        parent_id, definitely_changed, existing_ie, report_changes,
 
805
        content_summary):
 
806
        "Record the new inventory entry for a path if any."
 
807
        # mutter('check %s {%s}', path, file_id)
 
808
        # mutter('%s selected for commit', path)
 
809
        if definitely_changed or existing_ie is None:
 
810
            ie = make_entry(kind, name, parent_id, file_id)
 
811
        else:
 
812
            ie = existing_ie.copy()
 
813
            ie.revision = None
 
814
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
815
            self.parent_invs, path, self.work_tree, content_summary)
 
816
        if delta:
 
817
            self._basis_delta.append(delta)
 
818
        if version_recorded:
 
819
            self.any_entries_changed = True
 
820
        if report_changes:
 
821
            self._report_change(ie, path)
 
822
        return ie
 
823
 
 
824
    def _report_change(self, ie, path):
 
825
        """Report a change to the user.
 
826
 
 
827
        The change that has occurred is described relative to the basis
 
828
        inventory.
 
829
        """
 
830
        if (self.basis_inv.has_id(ie.file_id)):
 
831
            basis_ie = self.basis_inv[ie.file_id]
 
832
        else:
 
833
            basis_ie = None
 
834
        change = ie.describe_change(basis_ie, ie)
 
835
        if change in (InventoryEntry.RENAMED, 
 
836
            InventoryEntry.MODIFIED_AND_RENAMED):
 
837
            old_path = self.basis_inv.id2path(ie.file_id)
 
838
            self.reporter.renamed(change, old_path, path)
 
839
        else:
 
840
            self.reporter.snapshot_change(change, path)
 
841
 
 
842
    def _set_progress_stage(self, name, entries_title=None):
 
843
        """Set the progress stage and emit an update to the progress bar."""
 
844
        self.pb_stage_name = name
 
845
        self.pb_stage_count += 1
 
846
        self.pb_entries_title = entries_title
 
847
        if entries_title is not None:
 
848
            self.pb_entries_count = 0
 
849
            self.pb_entries_total = '?'
 
850
        self._emit_progress()
 
851
 
 
852
    def _next_progress_entry(self):
 
853
        """Emit an update to the progress bar and increment the entry count."""
 
854
        self.pb_entries_count += 1
 
855
        self._emit_progress()
 
856
 
 
857
    def _emit_progress(self):
 
858
        if self.pb_entries_title:
 
859
            if self.pb_entries_total == '?':
 
860
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
861
                    self.pb_entries_title, self.pb_entries_count)
 
862
            else:
 
863
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
864
                    self.pb_entries_title, self.pb_entries_count,
 
865
                    str(self.pb_entries_total))
 
866
        else:
 
867
            text = "%s - Stage" % (self.pb_stage_name)
 
868
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
869