~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Robert Collins
  • Date: 2005-10-06 22:15:52 UTC
  • mfrom: (1185.13.2)
  • mto: This revision was merged to the branch mainline in revision 1420.
  • Revision ID: robertc@robertcollins.net-20051006221552-9b15c96fa504e0ad
mergeĀ fromĀ upstream

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
 
    errors,
61
 
    inventory,
62
 
    tree,
63
 
    )
64
 
from bzrlib.branch import Branch
65
 
import bzrlib.config
 
69
from bzrlib.osutils import (local_time_offset, username,
 
70
                            rand_bytes, compact_date, user_email,
 
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
from bzrlib.errors import (BzrError, PointlessCommit,
67
 
                           ConflictsInTree,
68
 
                           StrictCommitFailed
 
76
                           HistoryMissing,
 
77
                           ConflictsInTree
69
78
                           )
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
 
79
from bzrlib.revision import Revision
74
80
from bzrlib.trace import mutter, note, warning
75
81
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
 
82
from bzrlib.inventory import Inventory, ROOT_ID
 
83
from bzrlib.weave import Weave
 
84
from bzrlib.weavefile import read_weave, write_weave_v5
 
85
from bzrlib.atomicfile import AtomicFile
 
86
 
 
87
 
 
88
def commit(*args, **kwargs):
 
89
    """Commit a new revision to a branch.
 
90
 
 
91
    Function-style interface for convenience of old callers.
 
92
 
 
93
    New code should use the Commit class instead.
 
94
    """
 
95
    ## XXX: Remove this in favor of Branch.commit?
 
96
    Commit().commit(*args, **kwargs)
83
97
 
84
98
 
85
99
class NullCommitReporter(object):
100
114
    def missing(self, path):
101
115
        pass
102
116
 
103
 
    def renamed(self, change, old_path, new_path):
104
 
        pass
105
 
 
106
 
 
107
117
class ReportCommitToLog(NullCommitReporter):
108
118
 
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
119
    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)
 
120
        note("%s %s", change, path)
122
121
 
123
122
    def completed(self, revno, rev_id):
124
 
        self._note('Committed revision %d.', revno)
 
123
        note('committed r%d {%s}', revno, rev_id)
125
124
    
126
125
    def deleted(self, file_id):
127
 
        self._note('deleted %s', file_id)
 
126
        note('deleted %s', file_id)
128
127
 
129
128
    def escaped(self, escape_count, message):
130
 
        self._note("replaced %d control characters in message", escape_count)
 
129
        note("replaced %d control characters in message", escape_count)
131
130
 
132
131
    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)
137
 
 
 
132
        note('missing %s', path)
138
133
 
139
134
class Commit(object):
140
135
    """Task of committing a new revision.
149
144
            working inventory.
150
145
    """
151
146
    def __init__(self,
152
 
                 reporter=None,
153
 
                 config=None):
 
147
                 reporter=None):
154
148
        if reporter is not None:
155
149
            self.reporter = reporter
156
150
        else:
157
151
            self.reporter = NullCommitReporter()
158
 
        self.config = config
 
152
 
159
153
        
160
154
    def commit(self,
161
 
               message=None,
 
155
               branch, message,
162
156
               timestamp=None,
163
157
               timezone=None,
164
158
               committer=None,
165
159
               specific_files=None,
166
160
               rev_id=None,
167
161
               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'):
 
162
               verbose=False):
177
163
        """Commit working copy as a new revision.
178
164
 
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.
 
165
        timestamp -- if not None, seconds-since-epoch for a
 
166
             postdated/predated commit.
 
167
 
 
168
        specific_files -- If true, commit only those files.
 
169
 
 
170
        rev_id -- If set, use this as the new revision id.
187
171
            Useful for test or import commands that need to tightly
188
172
            control what revisions are assigned.  If you duplicate
189
173
            a revision id that exists elsewhere it is your own fault.
190
174
            If null (default), a time/random revision id is generated.
191
175
 
192
 
        :param allow_pointless: If true (default), commit even if nothing
 
176
        allow_pointless -- If true (default), commit even if nothing
193
177
            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
178
        """
203
179
        mutter('preparing to commit')
204
180
 
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
 
181
        self.branch = branch
 
182
        self.weave_store = branch.weave_store
 
183
        self.rev_id = rev_id
227
184
        self.specific_files = specific_files
228
185
        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()
 
186
 
 
187
        if timestamp is None:
 
188
            self.timestamp = time.time()
 
189
        else:
 
190
            self.timestamp = long(timestamp)
 
191
            
 
192
        if rev_id is None:
 
193
            self.rev_id = _gen_revision_id(self.branch, self.timestamp)
 
194
        else:
 
195
            self.rev_id = rev_id
 
196
 
 
197
        if committer is None:
 
198
            self.committer = username(self.branch)
 
199
        else:
 
200
            assert isinstance(committer, basestring), type(committer)
 
201
            self.committer = committer
 
202
 
 
203
        if timezone is None:
 
204
            self.timezone = local_time_offset()
 
205
        else:
 
206
            self.timezone = int(timezone)
 
207
 
 
208
        assert isinstance(message, basestring), type(message)
 
209
        self.message = message
 
210
        self._escape_commit_message()
 
211
 
 
212
        self.branch.lock_write()
247
213
        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.
 
214
            self.work_tree = self.branch.working_tree()
 
215
            self.work_inv = self.work_tree.inventory
 
216
            self.basis_tree = self.branch.basis_tree()
293
217
            self.basis_inv = self.basis_tree.inventory
 
218
 
294
219
            self._gather_parents()
295
220
            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)
 
221
                raise NotImplementedError('selected-file commit of merges is not supported yet')
 
222
            self._check_parents_present()
 
223
            
 
224
            self._remove_deleted()
 
225
            self._populate_new_inv()
 
226
            self._store_snapshot()
 
227
            self._report_deletes()
 
228
 
 
229
            if not (self.allow_pointless
 
230
                    or len(self.parents) > 1
 
231
                    or self.new_inv != self.basis_inv):
 
232
                raise PointlessCommit()
 
233
 
 
234
            if len(list(self.work_tree.iter_conflicts()))>0:
 
235
                raise ConflictsInTree
 
236
 
 
237
            self._record_inventory()
 
238
            self._make_revision()
 
239
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
 
240
            self.branch.append_revision(self.rev_id)
 
241
            self.branch.set_pending_merges([])
345
242
        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()
 
243
            self.branch.unlock()
 
244
 
 
245
    def _record_inventory(self):
 
246
        """Store the inventory for the new revision."""
 
247
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
 
248
        self.inv_sha1 = sha_string(inv_text)
 
249
        s = self.branch.control_weaves
 
250
        s.add_text('inventory', self.rev_id,
 
251
                   split_lines(inv_text), self.present_parents)
535
252
 
536
253
    def _escape_commit_message(self):
537
254
        """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
255
        # Python strings can include characters that can't be
544
256
        # represented in well-formed XML; escape characters that
545
257
        # aren't listed in the XML specification
546
258
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
259
        if isinstance(self.message, unicode):
 
260
            char_pattern = u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]'
 
261
        else:
 
262
            # Use a regular 'str' as pattern to avoid having re.subn
 
263
            # return 'unicode' results.
 
264
            char_pattern = '[^x09\x0A\x0D\x20-\xFF]'
547
265
        self.message, escape_count = re.subn(
548
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
266
            char_pattern,
549
267
            lambda match: match.group(0).encode('unicode_escape'),
550
268
            self.message)
551
269
        if escape_count:
553
271
 
554
272
    def _gather_parents(self):
555
273
        """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.
 
274
        pending_merges = self.branch.pending_merges()
 
275
        self.parents = []
 
276
        self.parent_invs = []
 
277
        self.present_parents = []
 
278
        precursor_id = self.branch.last_revision()
 
279
        if precursor_id:
 
280
            self.parents.append(precursor_id)
 
281
        self.parents += pending_merges
 
282
        for revision in self.parents:
 
283
            if self.branch.has_revision(revision):
 
284
                self.parent_invs.append(self.branch.get_inventory(revision))
 
285
                self.present_parents.append(revision)
 
286
 
 
287
    def _check_parents_present(self):
 
288
        for parent_id in self.parents:
 
289
            mutter('commit parent revision {%s}', parent_id)
 
290
            if not self.branch.has_revision(parent_id):
 
291
                if parent_id == self.branch.last_revision():
 
292
                    warning("parent is missing %r", parent_id)
 
293
                    raise HistoryMissing(self.branch, 'revision', parent_id)
 
294
                else:
 
295
                    mutter("commit will ghost revision %r", parent_id)
 
296
            
 
297
    def _make_revision(self):
 
298
        """Record a new revision object for this commit."""
 
299
        self.rev = Revision(timestamp=self.timestamp,
 
300
                            timezone=self.timezone,
 
301
                            committer=self.committer,
 
302
                            message=self.message,
 
303
                            inventory_sha1=self.inv_sha1,
 
304
                            revision_id=self.rev_id)
 
305
        self.rev.parent_ids = self.parents
 
306
        rev_tmp = StringIO()
 
307
        serializer_v5.write_revision(self.rev, rev_tmp)
 
308
        rev_tmp.seek(0)
 
309
        self.branch.revision_store.add(rev_tmp, self.rev_id)
 
310
        mutter('new revision_id is {%s}', self.rev_id)
 
311
 
 
312
    def _remove_deleted(self):
 
313
        """Remove deleted files from the working inventories.
 
314
 
 
315
        This is done prior to taking the working inventory as the
 
316
        basis for the new committed inventory.
 
317
 
 
318
        This returns true if any files
 
319
        *that existed in the basis inventory* were deleted.
 
320
        Files that were added and deleted
 
321
        in the working copy don't matter.
570
322
        """
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
 
 
 
323
        specific = self.specific_files
600
324
        deleted_ids = []
601
 
        deleted_paths = set()
602
 
        for path, new_ie in entries:
603
 
            self._emit_progress_next_entry()
 
325
        for path, ie in self.work_inv.iter_entries():
 
326
            if specific and not is_inside_any(specific, path):
 
327
                continue
 
328
            if not self.work_tree.has_filename(path):
 
329
                self.reporter.missing(path)
 
330
                deleted_ids.append((path, ie.file_id))
 
331
        if deleted_ids:
 
332
            deleted_ids.sort(reverse=True)
 
333
            for path, file_id in deleted_ids:
 
334
                del self.work_inv[file_id]
 
335
            self.branch._write_inventory(self.work_inv)
 
336
 
 
337
    def _store_snapshot(self):
 
338
        """Pass over inventory and record a snapshot.
 
339
 
 
340
        Entries get a new revision when they are modified in 
 
341
        any way, which includes a merge with a new set of
 
342
        parents that have the same entry. 
 
343
        """
 
344
        # XXX: Need to think more here about when the user has
 
345
        # made a specific decision on a particular value -- c.f.
 
346
        # mark-merge.  
 
347
        for path, ie in self.new_inv.iter_entries():
 
348
            previous_entries = ie.find_previous_heads(
 
349
                self.parent_invs, 
 
350
                self.weave_store.get_weave_or_empty(ie.file_id))
 
351
            if ie.revision is None:
 
352
                change = ie.snapshot(self.rev_id, path, previous_entries,
 
353
                                     self.work_tree, self.weave_store)
 
354
            else:
 
355
                change = "unchanged"
 
356
            self.reporter.snapshot_change(change, path)
 
357
 
 
358
    def _populate_new_inv(self):
 
359
        """Build revision inventory.
 
360
 
 
361
        This creates a new empty inventory. Depending on
 
362
        which files are selected for commit, and what is present in the
 
363
        current tree, the new inventory is populated. inventory entries 
 
364
        which are candidates for modification have their revision set to
 
365
        None; inventory entries that are carried over untouched have their
 
366
        revision set to their prior value.
 
367
        """
 
368
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
369
        self.new_inv = Inventory()
 
370
        for path, new_ie in self.work_inv.iter_entries():
604
371
            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):
612
 
                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)
 
372
            mutter('check %s {%s}', path, new_ie.file_id)
 
373
            if self.specific_files:
 
374
                if not is_inside_any(self.specific_files, path):
 
375
                    mutter('%s not selected for commit', path)
 
376
                    self._carry_entry(file_id)
618
377
                    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
378
                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)
729
 
 
 
379
                    # this is selected, ensure its parents are too.
 
380
                    parent_id = new_ie.parent_id
 
381
                    while parent_id != ROOT_ID:
 
382
                        if not self.new_inv.has_id(parent_id):
 
383
                            ie = self._select_entry(self.work_inv[parent_id])
 
384
                            mutter('%s selected for commit because of %s',
 
385
                                   self.new_inv.id2path(parent_id), path)
 
386
 
 
387
                        ie = self.new_inv[parent_id]
 
388
                        if ie.revision is not None:
 
389
                            ie.revision = None
 
390
                            mutter('%s selected for commit because of %s',
 
391
                                   self.new_inv.id2path(parent_id), path)
 
392
                        parent_id = ie.parent_id
 
393
            mutter('%s selected for commit', path)
 
394
            self._select_entry(new_ie)
 
395
 
 
396
    def _select_entry(self, new_ie):
 
397
        """Make new_ie be considered for committing."""
 
398
        ie = new_ie.copy()
 
399
        ie.revision = None
 
400
        self.new_inv.add(ie)
 
401
        return ie
 
402
 
 
403
    def _carry_entry(self, file_id):
 
404
        """Carry the file unchanged from the basis revision."""
 
405
        if self.basis_inv.has_id(file_id):
 
406
            self.new_inv.add(self.basis_inv[file_id].copy())
 
407
 
 
408
    def _report_deletes(self):
 
409
        for file_id in self.basis_inv:
 
410
            if file_id not in self.new_inv:
 
411
                self.reporter.deleted(self.basis_inv.id2path(file_id))
 
412
 
 
413
def _gen_revision_id(branch, when):
 
414
    """Return new revision-id."""
 
415
    s = '%s-%s-' % (user_email(branch), compact_date(when))
 
416
    s += hexlify(rand_bytes(8))
 
417
    return s