~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2005-09-21 08:57:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050921085713-541dec922df6225d
- remove dead code from bzrlib.check

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