~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: abentley
  • Date: 2005-10-14 03:50:50 UTC
  • mto: (1185.25.1)
  • mto: This revision was merged to the branch mainline in revision 1460.
  • Revision ID: abentley@lappy-20051014035050-d779472ccb599a51
semi-broke merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
# XXX: Can we do any better about making interrupted commits change
 
19
# nothing?  Perhaps the best approach is to integrate commit of
 
20
# AtomicFiles with releasing the lock on the Branch.
 
21
 
 
22
# TODO: Separate 'prepare' phase where we find a list of potentially
 
23
# committed files.  We then can then pause the commit to prompt for a
 
24
# commit message, knowing the summary will be the same as what's
 
25
# actually used for the commit.  (But perhaps simpler to simply get
 
26
# the tree status, then use that for a selective commit?)
 
27
 
18
28
# The newly committed revision is going to have a shape corresponding
19
29
# to that of the working inventory.  Files that are not in the
20
30
# working tree and that were in the predecessor are reported as
46
56
# merges from, then it should still be reported as newly added
47
57
# relative to the basis revision.
48
58
 
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
59
 
52
60
import os
53
61
import re
54
62
import sys
55
63
import time
 
64
import pdb
56
65
 
 
66
from binascii import hexlify
57
67
from cStringIO import StringIO
58
68
 
59
 
from bzrlib import (
60
 
    debug,
61
 
    errors,
62
 
    inventory,
63
 
    tree,
64
 
    )
65
 
from bzrlib.branch import Branch
 
69
from bzrlib.osutils import (local_time_offset,
 
70
                            rand_bytes, compact_date,
 
71
                            kind_marker, is_inside_any, quotefn,
 
72
                            sha_string, sha_strings, sha_file, isdir, isfile,
 
73
                            split_lines)
 
74
from bzrlib.branch import gen_file_id
66
75
import bzrlib.config
67
76
from bzrlib.errors import (BzrError, PointlessCommit,
68
 
                           ConflictsInTree,
69
 
                           StrictCommitFailed
 
77
                           HistoryMissing,
 
78
                           ConflictsInTree
70
79
                           )
71
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
72
 
                            is_inside_or_parent_of_any,
73
 
                            quotefn, sha_file, split_lines)
74
 
from bzrlib.testament import Testament
 
80
from bzrlib.revision import Revision
75
81
from bzrlib.trace import mutter, note, warning
76
82
from bzrlib.xml5 import serializer_v5
77
 
from bzrlib.inventory import Inventory, InventoryEntry
78
 
from bzrlib import symbol_versioning
79
 
from bzrlib.symbol_versioning import (deprecated_passed,
80
 
        deprecated_function,
81
 
        DEPRECATED_PARAMETER)
82
 
from bzrlib.workingtree import WorkingTree
83
 
import bzrlib.ui
 
83
from bzrlib.inventory import Inventory, ROOT_ID
 
84
from bzrlib.weave import Weave
 
85
from bzrlib.weavefile import read_weave, write_weave_v5
 
86
from bzrlib.atomicfile import AtomicFile
 
87
 
 
88
 
 
89
def commit(*args, **kwargs):
 
90
    """Commit a new revision to a branch.
 
91
 
 
92
    Function-style interface for convenience of old callers.
 
93
 
 
94
    New code should use the Commit class instead.
 
95
    """
 
96
    ## XXX: Remove this in favor of Branch.commit?
 
97
    Commit().commit(*args, **kwargs)
84
98
 
85
99
 
86
100
class NullCommitReporter(object):
101
115
    def missing(self, path):
102
116
        pass
103
117
 
104
 
    def renamed(self, change, old_path, new_path):
105
 
        pass
106
 
 
107
 
 
108
118
class ReportCommitToLog(NullCommitReporter):
109
119
 
110
 
    def _note(self, format, *args):
111
 
        """Output a message.
112
 
 
113
 
        Subclasses may choose to override this method.
114
 
        """
115
 
        note(format, *args)
116
 
 
117
120
    def snapshot_change(self, change, path):
118
 
        if change == 'unchanged':
119
 
            return
120
 
        if change == 'added' and path == '':
121
 
            return
122
 
        self._note("%s %s", change, path)
 
121
        note("%s %s", change, path)
123
122
 
124
123
    def completed(self, revno, rev_id):
125
 
        self._note('Committed revision %d.', revno)
 
124
        note('committed r%d {%s}', revno, rev_id)
126
125
    
127
126
    def deleted(self, file_id):
128
 
        self._note('deleted %s', file_id)
 
127
        note('deleted %s', file_id)
129
128
 
130
129
    def escaped(self, escape_count, message):
131
 
        self._note("replaced %d control characters in message", escape_count)
 
130
        note("replaced %d control characters in message", escape_count)
132
131
 
133
132
    def missing(self, path):
134
 
        self._note('missing %s', path)
135
 
 
136
 
    def renamed(self, change, old_path, new_path):
137
 
        self._note('%s %s => %s', change, old_path, new_path)
138
 
 
 
133
        note('missing %s', path)
139
134
 
140
135
class Commit(object):
141
136
    """Task of committing a new revision.
150
145
            working inventory.
151
146
    """
152
147
    def __init__(self,
153
 
                 reporter=None,
154
 
                 config=None):
 
148
                 reporter=None):
155
149
        if reporter is not None:
156
150
            self.reporter = reporter
157
151
        else:
158
152
            self.reporter = NullCommitReporter()
159
 
        self.config = config
 
153
 
160
154
        
161
155
    def commit(self,
162
 
               message=None,
 
156
               branch, message,
163
157
               timestamp=None,
164
158
               timezone=None,
165
159
               committer=None,
166
160
               specific_files=None,
167
161
               rev_id=None,
168
162
               allow_pointless=True,
169
 
               strict=False,
170
 
               verbose=False,
171
 
               revprops=None,
172
 
               working_tree=None,
173
 
               local=False,
174
 
               reporter=None,
175
 
               config=None,
176
 
               message_callback=None,
177
 
               recursive='down'):
 
163
               verbose=False):
178
164
        """Commit working copy as a new revision.
179
165
 
180
 
        :param message: the commit message (it or message_callback is required)
181
 
 
182
 
        :param timestamp: if not None, seconds-since-epoch for a
183
 
            postdated/predated commit.
184
 
 
185
 
        :param specific_files: If true, commit only those files.
186
 
 
187
 
        :param rev_id: If set, use this as the new revision id.
 
166
        timestamp -- if not None, seconds-since-epoch for a
 
167
             postdated/predated commit.
 
168
 
 
169
        specific_files -- If true, commit only those files.
 
170
 
 
171
        rev_id -- If set, use this as the new revision id.
188
172
            Useful for test or import commands that need to tightly
189
173
            control what revisions are assigned.  If you duplicate
190
174
            a revision id that exists elsewhere it is your own fault.
191
175
            If null (default), a time/random revision id is generated.
192
176
 
193
 
        :param allow_pointless: If true (default), commit even if nothing
 
177
        allow_pointless -- If true (default), commit even if nothing
194
178
            has changed and no merges are recorded.
195
 
 
196
 
        :param strict: If true, don't allow a commit if the working tree
197
 
            contains unknown files.
198
 
 
199
 
        :param revprops: Properties for new revision
200
 
        :param local: Perform a local only commit.
201
 
        :param recursive: If set to 'down', commit in any subtrees that have
202
 
            pending changes of any sort during this commit.
203
179
        """
204
180
        mutter('preparing to commit')
205
181
 
206
 
        if working_tree is None:
207
 
            raise BzrError("working_tree must be passed into commit().")
208
 
        else:
209
 
            self.work_tree = working_tree
210
 
            self.branch = self.work_tree.branch
211
 
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
212
 
                if not self.branch.repository.supports_rich_root():
213
 
                    raise errors.RootNotRich()
214
 
        if message_callback is None:
215
 
            if message is not None:
216
 
                if isinstance(message, str):
217
 
                    message = message.decode(bzrlib.user_encoding)
218
 
                message_callback = lambda x: message
219
 
            else:
220
 
                raise BzrError("The message or message_callback keyword"
221
 
                               " parameter is required for commit().")
222
 
 
223
 
        self.bound_branch = None
224
 
        self.local = local
225
 
        self.master_branch = None
226
 
        self.master_locked = False
227
 
        self.rev_id = None
 
182
        self.branch = branch
 
183
        self.weave_store = branch.weave_store
 
184
        self.rev_id = rev_id
228
185
        self.specific_files = specific_files
229
186
        self.allow_pointless = allow_pointless
230
 
        self.recursive = recursive
231
 
        self.revprops = revprops
232
 
        self.message_callback = message_callback
233
 
        self.timestamp = timestamp
234
 
        self.timezone = timezone
235
 
        self.committer = committer
236
 
        self.strict = strict
237
 
        self.verbose = verbose
238
 
 
239
 
        if reporter is None and self.reporter is None:
240
 
            self.reporter = NullCommitReporter()
241
 
        elif reporter is not None:
242
 
            self.reporter = reporter
243
 
 
244
 
        self.work_tree.lock_write()
245
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
246
 
        self.basis_tree = self.work_tree.basis_tree()
247
 
        self.basis_tree.lock_read()
 
187
 
 
188
        if timestamp is None:
 
189
            self.timestamp = time.time()
 
190
        else:
 
191
            self.timestamp = long(timestamp)
 
192
            
 
193
        if rev_id is None:
 
194
            self.rev_id = _gen_revision_id(self.branch, self.timestamp)
 
195
        else:
 
196
            self.rev_id = rev_id
 
197
 
 
198
        if committer is None:
 
199
            self.committer = bzrlib.config.username(self.branch)
 
200
        else:
 
201
            assert isinstance(committer, basestring), type(committer)
 
202
            self.committer = committer
 
203
 
 
204
        if timezone is None:
 
205
            self.timezone = local_time_offset()
 
206
        else:
 
207
            self.timezone = int(timezone)
 
208
 
 
209
        assert isinstance(message, basestring), type(message)
 
210
        self.message = message
 
211
        self._escape_commit_message()
 
212
 
 
213
        self.branch.lock_write()
248
214
        try:
249
 
            # Cannot commit with conflicts present.
250
 
            if len(self.work_tree.conflicts()) > 0:
251
 
                raise ConflictsInTree
252
 
 
253
 
            # Setup the bound branch variables as needed.
254
 
            self._check_bound_branch()
255
 
 
256
 
            # Check that the working tree is up to date
257
 
            old_revno,new_revno = self._check_out_of_date_tree()
258
 
 
259
 
            if strict:
260
 
                # raise an exception as soon as we find a single unknown.
261
 
                for unknown in self.work_tree.unknowns():
262
 
                    raise StrictCommitFailed()
263
 
                   
264
 
            if self.config is None:
265
 
                self.config = self.branch.get_config()
266
 
 
267
 
            # If provided, ensure the specified files are versioned
268
 
            if specific_files is not None:
269
 
                # Note: We don't actually need the IDs here. This routine
270
 
                # is being called because it raises PathNotVerisonedError
271
 
                # as a side effect of finding the IDs.
272
 
                # XXX: Dont we have filter_unversioned to do this more
273
 
                # cheaply?
274
 
                tree.find_ids_across_trees(specific_files,
275
 
                                           [self.basis_tree, self.work_tree])
276
 
 
277
 
            # Setup the progress bar. As the number of files that need to be
278
 
            # committed in unknown, progress is reported as stages.
279
 
            # We keep track of entries separately though and include that
280
 
            # information in the progress bar during the relevant stages.
281
 
            self.pb_stage_name = ""
282
 
            self.pb_stage_count = 0
283
 
            self.pb_stage_total = 4
284
 
            if self.bound_branch:
285
 
                self.pb_stage_total += 1
286
 
            self.pb.show_pct = False
287
 
            self.pb.show_spinner = False
288
 
            self.pb.show_eta = False
289
 
            self.pb.show_count = True
290
 
            self.pb.show_bar = True
291
 
 
292
 
            # After a merge, a selected file commit is not supported.
293
 
            # See 'bzr help merge' for an explanation as to why.
 
215
            self.work_tree = self.branch.working_tree()
 
216
            self.work_inv = self.work_tree.inventory
 
217
            self.basis_tree = self.branch.basis_tree()
294
218
            self.basis_inv = self.basis_tree.inventory
 
219
 
295
220
            self._gather_parents()
296
221
            if len(self.parents) > 1 and self.specific_files:
297
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
298
 
            
299
 
            # Collect the changes
300
 
            self._emit_progress_set_stage("Collecting changes", show_entries=True)
301
 
            self.builder = self.branch.get_commit_builder(self.parents,
302
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
303
 
            self._update_builder_with_changes()
304
 
            self._check_pointless()
305
 
 
306
 
            # TODO: Now the new inventory is known, check for conflicts.
307
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
308
 
            # weave lines, because nothing should be recorded until it is known
309
 
            # that commit will succeed.
310
 
            self._emit_progress_set_stage("Saving data locally")
311
 
            self.builder.finish_inventory()
312
 
 
313
 
            # Prompt the user for a commit message if none provided
314
 
            message = message_callback(self)
315
 
            assert isinstance(message, unicode), type(message)
316
 
            self.message = message
317
 
            self._escape_commit_message()
318
 
 
319
 
            # Add revision data to the local branch
320
 
            self.rev_id = self.builder.commit(self.message)
321
 
            
322
 
            # Upload revision data to the master.
323
 
            # this will propagate merged revisions too if needed.
324
 
            if self.bound_branch:
325
 
                self._emit_progress_set_stage("Uploading data to master branch")
326
 
                self.master_branch.repository.fetch(self.branch.repository,
327
 
                                                    revision_id=self.rev_id)
328
 
                # now the master has the revision data
329
 
                # 'commit' to the master first so a timeout here causes the
330
 
                # local branch to be out of date
331
 
                self.master_branch.set_last_revision_info(new_revno,
332
 
                                                          self.rev_id)
333
 
 
334
 
            # and now do the commit locally.
335
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
336
 
 
337
 
            # Make the working tree up to date with the branch
338
 
            self._emit_progress_set_stage("Updating the working tree")
339
 
            rev_tree = self.builder.revision_tree()
340
 
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
341
 
            self.reporter.completed(new_revno, self.rev_id)
342
 
            self._process_hooks(old_revno, new_revno)
 
222
                raise NotImplementedError('selected-file commit of merges is not supported yet')
 
223
            self._check_parents_present()
 
224
            
 
225
            self._remove_deleted()
 
226
            self._populate_new_inv()
 
227
            self._store_snapshot()
 
228
            self._report_deletes()
 
229
 
 
230
            if not (self.allow_pointless
 
231
                    or len(self.parents) > 1
 
232
                    or self.new_inv != self.basis_inv):
 
233
                raise PointlessCommit()
 
234
 
 
235
            if len(list(self.work_tree.iter_conflicts()))>0:
 
236
                raise ConflictsInTree
 
237
 
 
238
            self._record_inventory()
 
239
            self._make_revision()
 
240
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
 
241
            self.branch.append_revision(self.rev_id)
 
242
            self.branch.set_pending_merges([])
343
243
        finally:
344
 
            self._cleanup()
345
 
        return self.rev_id
346
 
 
347
 
    def _any_real_changes(self):
348
 
        """Are there real changes between new_inventory and basis?
349
 
 
350
 
        For trees without rich roots, inv.root.revision changes every commit.
351
 
        But if that is the only change, we want to treat it as though there
352
 
        are *no* changes.
353
 
        """
354
 
        new_entries = self.builder.new_inventory.iter_entries()
355
 
        basis_entries = self.basis_inv.iter_entries()
356
 
        new_path, new_root_ie = new_entries.next()
357
 
        basis_path, basis_root_ie = basis_entries.next()
358
 
 
359
 
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
360
 
        def ie_equal_no_revision(this, other):
361
 
            return ((this.file_id == other.file_id)
362
 
                    and (this.name == other.name)
363
 
                    and (this.symlink_target == other.symlink_target)
364
 
                    and (this.text_sha1 == other.text_sha1)
365
 
                    and (this.text_size == other.text_size)
366
 
                    and (this.text_id == other.text_id)
367
 
                    and (this.parent_id == other.parent_id)
368
 
                    and (this.kind == other.kind)
369
 
                    and (this.executable == other.executable)
370
 
                    and (this.reference_revision == other.reference_revision)
371
 
                    )
372
 
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
373
 
            return True
374
 
 
375
 
        for new_ie, basis_ie in zip(new_entries, basis_entries):
376
 
            if new_ie != basis_ie:
377
 
                return True
378
 
 
379
 
        # No actual changes present
380
 
        return False
381
 
 
382
 
    def _check_pointless(self):
383
 
        if self.allow_pointless:
384
 
            return
385
 
        # A merge with no effect on files
386
 
        if len(self.parents) > 1:
387
 
            return
388
 
        # work around the fact that a newly-initted tree does differ from its
389
 
        # basis
390
 
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
391
 
            raise PointlessCommit()
392
 
        # Shortcut, if the number of entries changes, then we obviously have
393
 
        # a change
394
 
        if len(self.builder.new_inventory) != len(self.basis_inv):
395
 
            return
396
 
        # If length == 1, then we only have the root entry. Which means
397
 
        # that there is no real difference (only the root could be different)
398
 
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
399
 
            return
400
 
        raise PointlessCommit()
401
 
 
402
 
    def _check_bound_branch(self):
403
 
        """Check to see if the local branch is bound.
404
 
 
405
 
        If it is bound, then most of the commit will actually be
406
 
        done using the remote branch as the target branch.
407
 
        Only at the end will the local branch be updated.
408
 
        """
409
 
        if self.local and not self.branch.get_bound_location():
410
 
            raise errors.LocalRequiresBoundBranch()
411
 
 
412
 
        if not self.local:
413
 
            self.master_branch = self.branch.get_master_branch()
414
 
 
415
 
        if not self.master_branch:
416
 
            # make this branch the reference branch for out of date checks.
417
 
            self.master_branch = self.branch
418
 
            return
419
 
 
420
 
        # If the master branch is bound, we must fail
421
 
        master_bound_location = self.master_branch.get_bound_location()
422
 
        if master_bound_location:
423
 
            raise errors.CommitToDoubleBoundBranch(self.branch,
424
 
                    self.master_branch, master_bound_location)
425
 
 
426
 
        # TODO: jam 20051230 We could automatically push local
427
 
        #       commits to the remote branch if they would fit.
428
 
        #       But for now, just require remote to be identical
429
 
        #       to local.
430
 
        
431
 
        # Make sure the local branch is identical to the master
432
 
        master_info = self.master_branch.last_revision_info()
433
 
        local_info = self.branch.last_revision_info()
434
 
        if local_info != master_info:
435
 
            raise errors.BoundBranchOutOfDate(self.branch,
436
 
                    self.master_branch)
437
 
 
438
 
        # Now things are ready to change the master branch
439
 
        # so grab the lock
440
 
        self.bound_branch = self.branch
441
 
        self.master_branch.lock_write()
442
 
        self.master_locked = True
443
 
 
444
 
    def _check_out_of_date_tree(self):
445
 
        """Check that the working tree is up to date.
446
 
 
447
 
        :return: old_revision_number,new_revision_number tuple
448
 
        """
449
 
        try:
450
 
            first_tree_parent = self.work_tree.get_parent_ids()[0]
451
 
        except IndexError:
452
 
            # if there are no parents, treat our parent as 'None'
453
 
            # this is so that we still consider the master branch
454
 
            # - in a checkout scenario the tree may have no
455
 
            # parents but the branch may do.
456
 
            first_tree_parent = bzrlib.revision.NULL_REVISION
457
 
        old_revno, master_last = self.master_branch.last_revision_info()
458
 
        if master_last != first_tree_parent:
459
 
            if master_last != bzrlib.revision.NULL_REVISION:
460
 
                raise errors.OutOfDateTree(self.work_tree)
461
 
        if self.branch.repository.has_revision(first_tree_parent):
462
 
            new_revno = old_revno + 1
463
 
        else:
464
 
            # ghost parents never appear in revision history.
465
 
            new_revno = 1
466
 
        return old_revno,new_revno
467
 
 
468
 
    def _process_hooks(self, old_revno, new_revno):
469
 
        """Process any registered commit hooks."""
470
 
        # Process the post commit hooks, if any
471
 
        self._emit_progress_set_stage("Running post commit hooks")
472
 
        # old style commit hooks - should be deprecated ? (obsoleted in
473
 
        # 0.15)
474
 
        if self.config.post_commit() is not None:
475
 
            hooks = self.config.post_commit().split(' ')
476
 
            # this would be nicer with twisted.python.reflect.namedAny
477
 
            for hook in hooks:
478
 
                result = eval(hook + '(branch, rev_id)',
479
 
                              {'branch':self.branch,
480
 
                               'bzrlib':bzrlib,
481
 
                               'rev_id':self.rev_id})
482
 
        # new style commit hooks:
483
 
        if not self.bound_branch:
484
 
            hook_master = self.branch
485
 
            hook_local = None
486
 
        else:
487
 
            hook_master = self.master_branch
488
 
            hook_local = self.branch
489
 
        # With bound branches, when the master is behind the local branch,
490
 
        # the 'old_revno' and old_revid values here are incorrect.
491
 
        # XXX: FIXME ^. RBC 20060206
492
 
        if self.parents:
493
 
            old_revid = self.parents[0]
494
 
        else:
495
 
            old_revid = bzrlib.revision.NULL_REVISION
496
 
        for hook in Branch.hooks['post_commit']:
497
 
            # show the running hook in the progress bar. As hooks may
498
 
            # end up doing nothing (e.g. because they are not configured by
499
 
            # the user) this is still showing progress, not showing overall
500
 
            # actions - its up to each plugin to show a UI if it want's to
501
 
            # (such as 'Emailing diff to foo@example.com').
502
 
            self.pb_stage_name = "Running post commit hooks [%s]" % \
503
 
                Branch.hooks.get_hook_name(hook)
504
 
            self._emit_progress()
505
 
            if 'hooks' in debug.debug_flags:
506
 
                mutter("Invoking commit hook: %r", hook)
507
 
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
508
 
                self.rev_id)
509
 
 
510
 
    def _cleanup(self):
511
 
        """Cleanup any open locks, progress bars etc."""
512
 
        cleanups = [self._cleanup_bound_branch,
513
 
                    self.basis_tree.unlock,
514
 
                    self.work_tree.unlock,
515
 
                    self.pb.finished]
516
 
        found_exception = None
517
 
        for cleanup in cleanups:
518
 
            try:
519
 
                cleanup()
520
 
            # we want every cleanup to run no matter what.
521
 
            # so we have a catchall here, but we will raise the
522
 
            # last encountered exception up the stack: and
523
 
            # typically this will be useful enough.
524
 
            except Exception, e:
525
 
                found_exception = e
526
 
        if found_exception is not None: 
527
 
            # don't do a plan raise, because the last exception may have been
528
 
            # trashed, e is our sure-to-work exception even though it loses the
529
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
530
 
            # exc_info and if its the same one do a plain raise otherwise 
531
 
            # 'raise e' as we do now.
532
 
            raise e
533
 
 
534
 
    def _cleanup_bound_branch(self):
535
 
        """Executed at the end of a try/finally to cleanup a bound branch.
536
 
 
537
 
        If the branch wasn't bound, this is a no-op.
538
 
        If it was, it resents self.branch to the local branch, instead
539
 
        of being the master.
540
 
        """
541
 
        if not self.bound_branch:
542
 
            return
543
 
        if self.master_locked:
544
 
            self.master_branch.unlock()
 
244
            self.branch.unlock()
 
245
 
 
246
    def _record_inventory(self):
 
247
        """Store the inventory for the new revision."""
 
248
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
249
        self.inv_sha1 = sha_string(inv_text)
 
250
        s = self.branch.control_weaves
 
251
        s.add_text('inventory', self.rev_id,
 
252
                   split_lines(inv_text), self.present_parents,
 
253
                   self.branch.get_transaction())
545
254
 
546
255
    def _escape_commit_message(self):
547
256
        """Replace xml-incompatible control characters."""
548
 
        # FIXME: RBC 20060419 this should be done by the revision
549
 
        # serialiser not by commit. Then we can also add an unescaper
550
 
        # in the deserializer and start roundtripping revision messages
551
 
        # precisely. See repository_implementations/test_repository.py
552
 
        
553
257
        # Python strings can include characters that can't be
554
258
        # represented in well-formed XML; escape characters that
555
259
        # aren't listed in the XML specification
556
260
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
261
        if isinstance(self.message, unicode):
 
262
            char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
 
263
        else:
 
264
            # Use a regular 'str' as pattern to avoid having re.subn
 
265
            # return 'unicode' results.
 
266
            char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
557
267
        self.message, escape_count = re.subn(
558
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
268
            char_pattern,
559
269
            lambda match: match.group(0).encode('unicode_escape'),
560
270
            self.message)
561
271
        if escape_count:
563
273
 
564
274
    def _gather_parents(self):
565
275
        """Record the parents of a merge for merge detection."""
566
 
        # TODO: Make sure that this list doesn't contain duplicate 
567
 
        # entries and the order is preserved when doing this.
568
 
        self.parents = self.work_tree.get_parent_ids()
569
 
        self.parent_invs = [self.basis_inv]
570
 
        for revision in self.parents[1:]:
571
 
            if self.branch.repository.has_revision(revision):
572
 
                mutter('commit parent revision {%s}', revision)
573
 
                inventory = self.branch.repository.get_inventory(revision)
574
 
                self.parent_invs.append(inventory)
575
 
            else:
576
 
                mutter('commit parent ghost revision {%s}', revision)
577
 
 
578
 
    def _update_builder_with_changes(self):
579
 
        """Update the commit builder with the data about what has changed.
 
276
        pending_merges = self.branch.pending_merges()
 
277
        self.parents = []
 
278
        self.parent_invs = []
 
279
        self.present_parents = []
 
280
        precursor_id = self.branch.last_revision()
 
281
        if precursor_id:
 
282
            self.parents.append(precursor_id)
 
283
        self.parents += pending_merges
 
284
        for revision in self.parents:
 
285
            if self.branch.has_revision(revision):
 
286
                self.parent_invs.append(self.branch.get_inventory(revision))
 
287
                self.present_parents.append(revision)
 
288
 
 
289
    def _check_parents_present(self):
 
290
        for parent_id in self.parents:
 
291
            mutter('commit parent revision {%s}', parent_id)
 
292
            if not self.branch.has_revision(parent_id):
 
293
                if parent_id == self.branch.last_revision():
 
294
                    warning("parent is missing %r", parent_id)
 
295
                    raise HistoryMissing(self.branch, 'revision', parent_id)
 
296
                else:
 
297
                    mutter("commit will ghost revision %r", parent_id)
 
298
            
 
299
    def _make_revision(self):
 
300
        """Record a new revision object for this commit."""
 
301
        self.rev = Revision(timestamp=self.timestamp,
 
302
                            timezone=self.timezone,
 
303
                            committer=self.committer,
 
304
                            message=self.message,
 
305
                            inventory_sha1=self.inv_sha1,
 
306
                            revision_id=self.rev_id)
 
307
        self.rev.parent_ids = self.parents
 
308
        rev_tmp = StringIO()
 
309
        serializer_v5.write_revision(self.rev, rev_tmp)
 
310
        rev_tmp.seek(0)
 
311
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
312
        mutter('new revision_id is {%s}', self.rev_id)
 
313
 
 
314
    def _remove_deleted(self):
 
315
        """Remove deleted files from the working inventories.
 
316
 
 
317
        This is done prior to taking the working inventory as the
 
318
        basis for the new committed inventory.
 
319
 
 
320
        This returns true if any files
 
321
        *that existed in the basis inventory* were deleted.
 
322
        Files that were added and deleted
 
323
        in the working copy don't matter.
580
324
        """
581
 
        # Build the revision inventory.
582
 
        #
583
 
        # This starts by creating a new empty inventory. Depending on
584
 
        # which files are selected for commit, and what is present in the
585
 
        # current tree, the new inventory is populated. inventory entries 
586
 
        # which are candidates for modification have their revision set to
587
 
        # None; inventory entries that are carried over untouched have their
588
 
        # revision set to their prior value.
589
 
        #
590
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
591
 
        # results to create a new inventory at the same time, which results
592
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
593
 
        # ADHB 11-07-2006
594
 
 
595
 
        specific_files = self.specific_files
596
 
        mutter("Selecting files for commit with filter %s", specific_files)
597
 
        work_inv = self.work_tree.inventory
598
 
        assert work_inv.root is not None
599
 
        self.pb_entries_total = len(work_inv)
600
 
 
601
 
        # Check and warn about old CommitBuilders
602
 
        entries = work_inv.iter_entries()
603
 
        if not self.builder.record_root_entry:
604
 
            symbol_versioning.warn('CommitBuilders should support recording'
605
 
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
606
 
                stacklevel=1)
607
 
            self.builder.new_inventory.add(self.basis_inv.root.copy())
608
 
            entries.next()
609
 
 
 
325
        specific = self.specific_files
610
326
        deleted_ids = []
611
 
        deleted_paths = set()
612
 
        for path, new_ie in entries:
613
 
            self._emit_progress_next_entry()
 
327
        for path, ie in self.work_inv.iter_entries():
 
328
            if specific and not is_inside_any(specific, path):
 
329
                continue
 
330
            if not self.work_tree.has_filename(path):
 
331
                self.reporter.missing(path)
 
332
                deleted_ids.append((path, ie.file_id))
 
333
        if deleted_ids:
 
334
            deleted_ids.sort(reverse=True)
 
335
            for path, file_id in deleted_ids:
 
336
                del self.work_inv[file_id]
 
337
            self.branch._write_inventory(self.work_inv)
 
338
 
 
339
    def _store_snapshot(self):
 
340
        """Pass over inventory and record a snapshot.
 
341
 
 
342
        Entries get a new revision when they are modified in 
 
343
        any way, which includes a merge with a new set of
 
344
        parents that have the same entry. 
 
345
        """
 
346
        # XXX: Need to think more here about when the user has
 
347
        # made a specific decision on a particular value -- c.f.
 
348
        # mark-merge.  
 
349
        for path, ie in self.new_inv.iter_entries():
 
350
            previous_entries = ie.find_previous_heads(
 
351
                self.parent_invs, 
 
352
                self.weave_store.get_weave_or_empty(ie.file_id,
 
353
                    self.branch.get_transaction()))
 
354
            if ie.revision is None:
 
355
                change = ie.snapshot(self.rev_id, path, previous_entries,
 
356
                                     self.work_tree, self.weave_store,
 
357
                                     self.branch.get_transaction())
 
358
            else:
 
359
                change = "unchanged"
 
360
            self.reporter.snapshot_change(change, path)
 
361
 
 
362
    def _populate_new_inv(self):
 
363
        """Build revision inventory.
 
364
 
 
365
        This creates a new empty inventory. Depending on
 
366
        which files are selected for commit, and what is present in the
 
367
        current tree, the new inventory is populated. inventory entries 
 
368
        which are candidates for modification have their revision set to
 
369
        None; inventory entries that are carried over untouched have their
 
370
        revision set to their prior value.
 
371
        """
 
372
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
373
        self.new_inv = Inventory()
 
374
        for path, new_ie in self.work_inv.iter_entries():
614
375
            file_id = new_ie.file_id
615
 
 
616
 
            # Skip files that have been deleted from the working tree.
617
 
            # The deleted files/directories are also recorded so they
618
 
            # can be explicitly unversioned later. Note that when a
619
 
            # filter of specific files is given, we must only skip/record
620
 
            # deleted files matching that filter.
621
 
            if is_inside_any(deleted_paths, path):
622
 
                continue
623
 
            if not specific_files or is_inside_any(specific_files, path):
624
 
                if not self.work_tree.has_filename(path):
625
 
                    deleted_paths.add(path)
626
 
                    self.reporter.missing(path)
627
 
                    deleted_ids.append(file_id)
 
376
            mutter('check %s {%s}', path, new_ie.file_id)
 
377
            if self.specific_files:
 
378
                if not is_inside_any(self.specific_files, path):
 
379
                    mutter('%s not selected for commit', path)
 
380
                    self._carry_entry(file_id)
628
381
                    continue
629
 
            try:
630
 
                kind = self.work_tree.kind(file_id)
631
 
                if kind == 'tree-reference' and self.recursive == 'down':
632
 
                    # nested tree: commit in it
633
 
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
634
 
                    # FIXME: be more comprehensive here:
635
 
                    # this works when both trees are in --trees repository,
636
 
                    # but when both are bound to a different repository,
637
 
                    # it fails; a better way of approaching this is to 
638
 
                    # finally implement the explicit-caches approach design
639
 
                    # a while back - RBC 20070306.
640
 
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
641
 
                        ==
642
 
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
643
 
                        sub_tree.branch.repository = \
644
 
                            self.work_tree.branch.repository
645
 
                    try:
646
 
                        sub_tree.commit(message=None, revprops=self.revprops,
647
 
                            recursive=self.recursive,
648
 
                            message_callback=self.message_callback,
649
 
                            timestamp=self.timestamp, timezone=self.timezone,
650
 
                            committer=self.committer,
651
 
                            allow_pointless=self.allow_pointless,
652
 
                            strict=self.strict, verbose=self.verbose,
653
 
                            local=self.local, reporter=self.reporter)
654
 
                    except errors.PointlessCommit:
655
 
                        pass
656
 
                if kind != new_ie.kind:
657
 
                    new_ie = inventory.make_entry(kind, new_ie.name,
658
 
                                                  new_ie.parent_id, file_id)
659
 
            except errors.NoSuchFile:
660
 
                pass
661
 
            # mutter('check %s {%s}', path, file_id)
662
 
            if (not specific_files or 
663
 
                is_inside_or_parent_of_any(specific_files, path)):
664
 
                    # mutter('%s selected for commit', path)
665
 
                    ie = new_ie.copy()
666
 
                    ie.revision = None
667
 
            else:
668
 
                # mutter('%s not selected for commit', path)
669
 
                if self.basis_inv.has_id(file_id):
670
 
                    ie = self.basis_inv[file_id].copy()
671
382
                else:
672
 
                    # this entry is new and not being committed
673
 
                    continue
674
 
            self.builder.record_entry_contents(ie, self.parent_invs, 
675
 
                path, self.work_tree)
676
 
            # describe the nature of the change that has occurred relative to
677
 
            # the basis inventory.
678
 
            if (self.basis_inv.has_id(ie.file_id)):
679
 
                basis_ie = self.basis_inv[ie.file_id]
680
 
            else:
681
 
                basis_ie = None
682
 
            change = ie.describe_change(basis_ie, ie)
683
 
            if change in (InventoryEntry.RENAMED, 
684
 
                InventoryEntry.MODIFIED_AND_RENAMED):
685
 
                old_path = self.basis_inv.id2path(ie.file_id)
686
 
                self.reporter.renamed(change, old_path, path)
687
 
            else:
688
 
                self.reporter.snapshot_change(change, path)
689
 
 
690
 
        # Unversion IDs that were found to be deleted
691
 
        self.work_tree.unversion(deleted_ids)
692
 
 
693
 
        # If specific files/directories were nominated, it is possible
694
 
        # that some data from outside those needs to be preserved from
695
 
        # the basis tree. For example, if a file x is moved from out of
696
 
        # directory foo into directory bar and the user requests
697
 
        # ``commit foo``, then information about bar/x must also be
698
 
        # recorded.
699
 
        if specific_files:
700
 
            for path, new_ie in self.basis_inv.iter_entries():
701
 
                if new_ie.file_id in work_inv:
702
 
                    continue
703
 
                if is_inside_any(specific_files, path):
704
 
                    continue
705
 
                ie = new_ie.copy()
706
 
                ie.revision = None
707
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
708
 
                                                   self.basis_tree)
709
 
 
710
 
        # Report what was deleted. We could skip this when no deletes are
711
 
        # detected to gain a performance win, but it arguably serves as a
712
 
        # 'safety check' by informing the user whenever anything disappears.
713
 
        for path, ie in self.basis_inv.iter_entries():
714
 
            if ie.file_id not in self.builder.new_inventory:
715
 
                self.reporter.deleted(path)
716
 
 
717
 
    def _emit_progress_set_stage(self, name, show_entries=False):
718
 
        """Set the progress stage and emit an update to the progress bar."""
719
 
        self.pb_stage_name = name
720
 
        self.pb_stage_count += 1
721
 
        self.pb_entries_show = show_entries
722
 
        if show_entries:
723
 
            self.pb_entries_count = 0
724
 
            self.pb_entries_total = '?'
725
 
        self._emit_progress()
726
 
 
727
 
    def _emit_progress_next_entry(self):
728
 
        """Emit an update to the progress bar and increment the file count."""
729
 
        self.pb_entries_count += 1
730
 
        self._emit_progress()
731
 
 
732
 
    def _emit_progress(self):
733
 
        if self.pb_entries_show:
734
 
            text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
735
 
                self.pb_entries_count,str(self.pb_entries_total))
736
 
        else:
737
 
            text = "%s - Stage" % (self.pb_stage_name)
738
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
739
 
 
 
383
                    # this is selected, ensure its parents are too.
 
384
                    parent_id = new_ie.parent_id
 
385
                    while parent_id != ROOT_ID:
 
386
                        if not self.new_inv.has_id(parent_id):
 
387
                            ie = self._select_entry(self.work_inv[parent_id])
 
388
                            mutter('%s selected for commit because of %s',
 
389
                                   self.new_inv.id2path(parent_id), path)
 
390
 
 
391
                        ie = self.new_inv[parent_id]
 
392
                        if ie.revision is not None:
 
393
                            ie.revision = None
 
394
                            mutter('%s selected for commit because of %s',
 
395
                                   self.new_inv.id2path(parent_id), path)
 
396
                        parent_id = ie.parent_id
 
397
            mutter('%s selected for commit', path)
 
398
            self._select_entry(new_ie)
 
399
 
 
400
    def _select_entry(self, new_ie):
 
401
        """Make new_ie be considered for committing."""
 
402
        ie = new_ie.copy()
 
403
        ie.revision = None
 
404
        self.new_inv.add(ie)
 
405
        return ie
 
406
 
 
407
    def _carry_entry(self, file_id):
 
408
        """Carry the file unchanged from the basis revision."""
 
409
        if self.basis_inv.has_id(file_id):
 
410
            self.new_inv.add(self.basis_inv[file_id].copy())
 
411
 
 
412
    def _report_deletes(self):
 
413
        for file_id in self.basis_inv:
 
414
            if file_id not in self.new_inv:
 
415
                self.reporter.deleted(self.basis_inv.id2path(file_id))
 
416
 
 
417
def _gen_revision_id(branch, when):
 
418
    """Return new revision-id."""
 
419
    s = '%s-%s-' % (bzrlib.config.user_email(branch), compact_date(when))
 
420
    s += hexlify(rand_bytes(8))
 
421
    return s