/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2007-10-02 02:54:30 UTC
  • mto: This revision was merged to the branch mainline in revision 2873.
  • Revision ID: mbp@sourcefrog.net-20071002025430-5qkc146iuaqxdsgk
Ignore .pyd files in bzr tree (windows C extensions)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
19
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
55
 
    revision,
56
 
    trace,
 
62
    inventory,
57
63
    tree,
58
64
    )
59
65
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
66
import bzrlib.config
62
67
from bzrlib.errors import (BzrError, PointlessCommit,
63
68
                           ConflictsInTree,
64
69
                           StrictCommitFailed
65
70
                           )
66
 
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
68
73
                            minimum_path_selection,
69
 
                            splitpath,
70
 
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
                            quotefn, sha_file, split_lines)
 
75
from bzrlib.testament import Testament
 
76
from bzrlib.trace import mutter, note, warning, is_quiet
 
77
from bzrlib.xml5 import serializer_v5
 
78
from bzrlib.inventory import Inventory, InventoryEntry
73
79
from bzrlib import symbol_versioning
 
80
from bzrlib.symbol_versioning import (deprecated_passed,
 
81
        deprecated_function,
 
82
        DEPRECATED_PARAMETER)
 
83
from bzrlib.workingtree import WorkingTree
74
84
from bzrlib.urlutils import unescape_for_display
75
85
import bzrlib.ui
76
86
 
79
89
    """I report on progress of a commit."""
80
90
 
81
91
    def started(self, revno, revid, location=None):
82
 
        if location is None:
83
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
 
                                   "to started.", DeprecationWarning,
85
 
                                   stacklevel=2)
86
92
        pass
87
93
 
88
94
    def snapshot_change(self, change, path):
91
97
    def completed(self, revno, rev_id):
92
98
        pass
93
99
 
94
 
    def deleted(self, path):
 
100
    def deleted(self, file_id):
 
101
        pass
 
102
 
 
103
    def escaped(self, escape_count, message):
95
104
        pass
96
105
 
97
106
    def missing(self, path):
114
123
        note(format, *args)
115
124
 
116
125
    def snapshot_change(self, change, path):
117
 
        if path == '' and change in ('added', 'modified'):
 
126
        if change == 'unchanged':
 
127
            return
 
128
        if change == 'added' and path == '':
118
129
            return
119
130
        self._note("%s %s", change, path)
120
131
 
121
132
    def started(self, revno, rev_id, location=None):
122
133
        if location is not None:
123
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
134
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
124
135
        else:
125
 
            # When started was added, location was only made optional by
126
 
            # accident.  Matt Nordhoff 20071129
127
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
 
                                   "to started.", DeprecationWarning,
129
 
                                   stacklevel=2)
130
136
            location = ''
131
 
        self._note('Committing%s', location)
 
137
        self._note('Committing revision %d%s.', revno, location)
132
138
 
133
139
    def completed(self, revno, rev_id):
134
140
        self._note('Committed revision %d.', revno)
135
 
        # self._note goes to the console too; so while we want to log the
136
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
137
 
        # term we should rearrange the reporting structure, but for now
138
 
        # we just mutter seperately. We mutter the revid and revno together
139
 
        # so that concurrent bzr invocations won't lead to confusion.
140
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
141
 
 
142
 
    def deleted(self, path):
143
 
        self._note('deleted %s', path)
 
141
 
 
142
    def deleted(self, file_id):
 
143
        self._note('deleted %s', file_id)
 
144
 
 
145
    def escaped(self, escape_count, message):
 
146
        self._note("replaced %d control characters in message", escape_count)
144
147
 
145
148
    def missing(self, path):
146
149
        self._note('missing %s', path)
190
193
               reporter=None,
191
194
               config=None,
192
195
               message_callback=None,
193
 
               recursive='down',
194
 
               exclude=None,
195
 
               possible_master_transports=None):
 
196
               recursive='down'):
196
197
        """Commit working copy as a new revision.
197
198
 
198
199
        :param message: the commit message (it or message_callback is required)
199
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
200
200
 
201
201
        :param timestamp: if not None, seconds-since-epoch for a
202
202
            postdated/predated commit.
203
203
 
204
 
        :param specific_files: If not None, commit only those files. An empty
205
 
            list means 'commit no files'.
 
204
        :param specific_files: If true, commit only those files.
206
205
 
207
206
        :param rev_id: If set, use this as the new revision id.
208
207
            Useful for test or import commands that need to tightly
222
221
        :param verbose: if True and the reporter is not None, report everything
223
222
        :param recursive: If set to 'down', commit in any subtrees that have
224
223
            pending changes of any sort during this commit.
225
 
        :param exclude: None or a list of relative paths to exclude from the
226
 
            commit. Pending changes to excluded files will be ignored by the
227
 
            commit.
228
224
        """
229
 
        operation = OperationWithCleanups(self._commit)
230
 
        self.revprops = revprops or {}
231
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
232
 
        self.config = config or self.config
233
 
        return operation.run(
234
 
               message=message,
235
 
               timestamp=timestamp,
236
 
               timezone=timezone,
237
 
               committer=committer,
238
 
               specific_files=specific_files,
239
 
               rev_id=rev_id,
240
 
               allow_pointless=allow_pointless,
241
 
               strict=strict,
242
 
               verbose=verbose,
243
 
               working_tree=working_tree,
244
 
               local=local,
245
 
               reporter=reporter,
246
 
               message_callback=message_callback,
247
 
               recursive=recursive,
248
 
               exclude=exclude,
249
 
               possible_master_transports=possible_master_transports)
250
 
 
251
 
    def _commit(self, operation, message, timestamp, timezone, committer,
252
 
            specific_files, rev_id, allow_pointless, strict, verbose,
253
 
            working_tree, local, reporter, message_callback, recursive,
254
 
            exclude, possible_master_transports):
255
225
        mutter('preparing to commit')
256
226
 
257
227
        if working_tree is None:
265
235
        if message_callback is None:
266
236
            if message is not None:
267
237
                if isinstance(message, str):
268
 
                    message = message.decode(get_user_encoding())
 
238
                    message = message.decode(bzrlib.user_encoding)
269
239
                message_callback = lambda x: message
270
240
            else:
271
241
                raise BzrError("The message or message_callback keyword"
272
242
                               " parameter is required for commit().")
273
243
 
274
244
        self.bound_branch = None
 
245
        self.any_entries_changed = False
275
246
        self.any_entries_deleted = False
276
 
        if exclude is not None:
277
 
            self.exclude = sorted(
278
 
                minimum_path_selection(exclude))
279
 
        else:
280
 
            self.exclude = []
281
247
        self.local = local
282
248
        self.master_branch = None
283
 
        self.recursive = recursive
 
249
        self.master_locked = False
284
250
        self.rev_id = None
285
 
        # self.specific_files is None to indicate no filter, or any iterable to
286
 
        # indicate a filter - [] means no files at all, as per iter_changes.
287
251
        if specific_files is not None:
288
252
            self.specific_files = sorted(
289
253
                minimum_path_selection(specific_files))
290
254
        else:
291
255
            self.specific_files = None
292
 
            
 
256
        self.specific_file_ids = None
293
257
        self.allow_pointless = allow_pointless
 
258
        self.recursive = recursive
 
259
        self.revprops = revprops
294
260
        self.message_callback = message_callback
295
261
        self.timestamp = timestamp
296
262
        self.timezone = timezone
299
265
        self.verbose = verbose
300
266
 
301
267
        self.work_tree.lock_write()
302
 
        operation.add_cleanup(self.work_tree.unlock)
303
 
        self.parents = self.work_tree.get_parent_ids()
304
 
        # We can use record_iter_changes IFF iter_changes is compatible with
305
 
        # the command line parameters, and the repository has fast delta
306
 
        # generation. See bug 347649.
307
 
        self.use_record_iter_changes = (
308
 
            not self.exclude and 
309
 
            not self.branch.repository._format.supports_tree_reference and
310
 
            (self.branch.repository._format.fast_deltas or
311
 
             len(self.parents) < 2))
312
268
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
313
 
        operation.add_cleanup(self.pb.finished)
314
 
        self.basis_revid = self.work_tree.last_revision()
315
269
        self.basis_tree = self.work_tree.basis_tree()
316
270
        self.basis_tree.lock_read()
317
 
        operation.add_cleanup(self.basis_tree.unlock)
318
 
        # Cannot commit with conflicts present.
319
 
        if len(self.work_tree.conflicts()) > 0:
320
 
            raise ConflictsInTree
321
 
 
322
 
        # Setup the bound branch variables as needed.
323
 
        self._check_bound_branch(operation, possible_master_transports)
324
 
 
325
 
        # Check that the working tree is up to date
326
 
        old_revno, new_revno = self._check_out_of_date_tree()
327
 
 
328
 
        # Complete configuration setup
329
 
        if reporter is not None:
330
 
            self.reporter = reporter
331
 
        elif self.reporter is None:
332
 
            self.reporter = self._select_reporter()
333
 
        if self.config is None:
334
 
            self.config = self.branch.get_config()
335
 
 
336
 
        self._set_specific_file_ids()
337
 
 
338
 
        # Setup the progress bar. As the number of files that need to be
339
 
        # committed in unknown, progress is reported as stages.
340
 
        # We keep track of entries separately though and include that
341
 
        # information in the progress bar during the relevant stages.
342
 
        self.pb_stage_name = ""
343
 
        self.pb_stage_count = 0
344
 
        self.pb_stage_total = 5
345
 
        if self.bound_branch:
346
 
            self.pb_stage_total += 1
347
 
        self.pb.show_pct = False
348
 
        self.pb.show_spinner = False
349
 
        self.pb.show_eta = False
350
 
        self.pb.show_count = True
351
 
        self.pb.show_bar = True
352
 
 
353
 
        self._gather_parents()
354
 
        # After a merge, a selected file commit is not supported.
355
 
        # See 'bzr help merge' for an explanation as to why.
356
 
        if len(self.parents) > 1 and self.specific_files is not None:
357
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
358
 
        # Excludes are a form of selected file commit.
359
 
        if len(self.parents) > 1 and self.exclude:
360
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
361
 
 
362
 
        # Collect the changes
363
 
        self._set_progress_stage("Collecting changes", counter=True)
364
 
        self.builder = self.branch.get_commit_builder(self.parents,
365
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
366
 
 
367
271
        try:
368
 
            self.builder.will_record_deletes()
369
 
            # find the location being committed to
370
 
            if self.bound_branch:
371
 
                master_location = self.master_branch.base
372
 
            else:
373
 
                master_location = self.branch.base
374
 
 
375
 
            # report the start of the commit
376
 
            self.reporter.started(new_revno, self.rev_id, master_location)
377
 
 
378
 
            self._update_builder_with_changes()
379
 
            self._check_pointless()
380
 
 
381
 
            # TODO: Now the new inventory is known, check for conflicts.
382
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
383
 
            # weave lines, because nothing should be recorded until it is known
384
 
            # that commit will succeed.
385
 
            self._set_progress_stage("Saving data locally")
386
 
            self.builder.finish_inventory()
387
 
 
388
 
            # Prompt the user for a commit message if none provided
389
 
            message = message_callback(self)
390
 
            self.message = message
391
 
 
392
 
            # Add revision data to the local branch
393
 
            self.rev_id = self.builder.commit(self.message)
394
 
 
395
 
        except Exception, e:
396
 
            mutter("aborting commit write group because of exception:")
397
 
            trace.log_exception_quietly()
398
 
            note("aborting commit write group: %r" % (e,))
399
 
            self.builder.abort()
400
 
            raise
401
 
 
402
 
        self._process_pre_hooks(old_revno, new_revno)
403
 
 
404
 
        # Upload revision data to the master.
405
 
        # this will propagate merged revisions too if needed.
406
 
        if self.bound_branch:
407
 
            self._set_progress_stage("Uploading data to master branch")
408
 
            # 'commit' to the master first so a timeout here causes the
409
 
            # local branch to be out of date
410
 
            self.master_branch.import_last_revision_info(
411
 
                self.branch.repository, new_revno, self.rev_id)
412
 
 
413
 
        # and now do the commit locally.
414
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
415
 
 
416
 
        # Make the working tree be up to date with the branch. This
417
 
        # includes automatic changes scheduled to be made to the tree, such
418
 
        # as updating its basis and unversioning paths that were missing.
419
 
        self.work_tree.unversion(self.deleted_ids)
420
 
        self._set_progress_stage("Updating the working tree")
421
 
        self.work_tree.update_basis_by_delta(self.rev_id,
422
 
             self.builder.get_basis_delta())
423
 
        self.reporter.completed(new_revno, self.rev_id)
424
 
        self._process_post_hooks(old_revno, new_revno)
 
272
            # Cannot commit with conflicts present.
 
273
            if len(self.work_tree.conflicts()) > 0:
 
274
                raise ConflictsInTree
 
275
 
 
276
            # Setup the bound branch variables as needed.
 
277
            self._check_bound_branch()
 
278
 
 
279
            # Check that the working tree is up to date
 
280
            old_revno, new_revno = self._check_out_of_date_tree()
 
281
 
 
282
            # Complete configuration setup
 
283
            if reporter is not None:
 
284
                self.reporter = reporter
 
285
            elif self.reporter is None:
 
286
                self.reporter = self._select_reporter()
 
287
            if self.config is None:
 
288
                self.config = self.branch.get_config()
 
289
 
 
290
            # If provided, ensure the specified files are versioned
 
291
            if self.specific_files is not None:
 
292
                # Note: This routine
 
293
                # is being called because it raises PathNotVerisonedError
 
294
                # as a side effect of finding the IDs. We later use the ids we
 
295
                # found as input to the working tree inventory iterator, so we
 
296
                # only consider those ids rather than examining the whole tree
 
297
                # again.
 
298
                # XXX: Dont we have filter_unversioned to do this more
 
299
                # cheaply?
 
300
                self.specific_file_ids = tree.find_ids_across_trees(
 
301
                    specific_files, [self.basis_tree, self.work_tree])
 
302
 
 
303
            # Setup the progress bar. As the number of files that need to be
 
304
            # committed in unknown, progress is reported as stages.
 
305
            # We keep track of entries separately though and include that
 
306
            # information in the progress bar during the relevant stages.
 
307
            self.pb_stage_name = ""
 
308
            self.pb_stage_count = 0
 
309
            self.pb_stage_total = 5
 
310
            if self.bound_branch:
 
311
                self.pb_stage_total += 1
 
312
            self.pb.show_pct = False
 
313
            self.pb.show_spinner = False
 
314
            self.pb.show_eta = False
 
315
            self.pb.show_count = True
 
316
            self.pb.show_bar = True
 
317
 
 
318
            # After a merge, a selected file commit is not supported.
 
319
            # See 'bzr help merge' for an explanation as to why.
 
320
            self.basis_inv = self.basis_tree.inventory
 
321
            self._gather_parents()
 
322
            if len(self.parents) > 1 and self.specific_files:
 
323
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
324
 
 
325
            # Collect the changes
 
326
            self._set_progress_stage("Collecting changes",
 
327
                    entries_title="Directory")
 
328
            self.builder = self.branch.get_commit_builder(self.parents,
 
329
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
330
            
 
331
            try:
 
332
                # find the location being committed to
 
333
                if self.bound_branch:
 
334
                    master_location = self.master_branch.base
 
335
                else:
 
336
                    master_location = self.branch.base
 
337
 
 
338
                # report the start of the commit
 
339
                self.reporter.started(new_revno, self.rev_id, master_location)
 
340
 
 
341
                self._update_builder_with_changes()
 
342
                self._check_pointless()
 
343
 
 
344
                # TODO: Now the new inventory is known, check for conflicts.
 
345
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
346
                # weave lines, because nothing should be recorded until it is known
 
347
                # that commit will succeed.
 
348
                self._set_progress_stage("Saving data locally")
 
349
                self.builder.finish_inventory()
 
350
 
 
351
                # Prompt the user for a commit message if none provided
 
352
                message = message_callback(self)
 
353
                assert isinstance(message, unicode), type(message)
 
354
                self.message = message
 
355
                self._escape_commit_message()
 
356
 
 
357
                # Add revision data to the local branch
 
358
                self.rev_id = self.builder.commit(self.message)
 
359
 
 
360
            except:
 
361
                self.builder.abort()
 
362
                raise
 
363
 
 
364
            self._process_pre_hooks(old_revno, new_revno)
 
365
 
 
366
            # Upload revision data to the master.
 
367
            # this will propagate merged revisions too if needed.
 
368
            if self.bound_branch:
 
369
                self._set_progress_stage("Uploading data to master branch")
 
370
                self.master_branch.repository.fetch(self.branch.repository,
 
371
                                                    revision_id=self.rev_id)
 
372
                # now the master has the revision data
 
373
                # 'commit' to the master first so a timeout here causes the
 
374
                # local branch to be out of date
 
375
                self.master_branch.set_last_revision_info(new_revno,
 
376
                                                          self.rev_id)
 
377
 
 
378
            # and now do the commit locally.
 
379
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
380
 
 
381
            # Make the working tree up to date with the branch
 
382
            self._set_progress_stage("Updating the working tree")
 
383
            rev_tree = self.builder.revision_tree()
 
384
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
385
            self.reporter.completed(new_revno, self.rev_id)
 
386
            self._process_post_hooks(old_revno, new_revno)
 
387
        finally:
 
388
            self._cleanup()
425
389
        return self.rev_id
426
390
 
427
391
    def _select_reporter(self):
436
400
        # A merge with no effect on files
437
401
        if len(self.parents) > 1:
438
402
            return
439
 
        # TODO: we could simplify this by using self.builder.basis_delta.
440
 
 
441
 
        # The initial commit adds a root directory, but this in itself is not
442
 
        # a worthwhile commit.
443
 
        if (self.basis_revid == revision.NULL_REVISION and
444
 
            ((self.builder.new_inventory is not None and
445
 
             len(self.builder.new_inventory) == 1) or
446
 
            len(self.builder._basis_delta) == 1)):
 
403
        # work around the fact that a newly-initted tree does differ from its
 
404
        # basis
 
405
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
447
406
            raise PointlessCommit()
448
 
        if self.builder.any_changes():
 
407
        # Shortcut, if the number of entries changes, then we obviously have
 
408
        # a change
 
409
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
410
            return
 
411
        # If length == 1, then we only have the root entry. Which means
 
412
        # that there is no real difference (only the root could be different)
 
413
        if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
 
414
            or self.any_entries_deleted):
449
415
            return
450
416
        raise PointlessCommit()
451
417
 
452
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
418
    def _check_bound_branch(self):
453
419
        """Check to see if the local branch is bound.
454
420
 
455
421
        If it is bound, then most of the commit will actually be
460
426
            raise errors.LocalRequiresBoundBranch()
461
427
 
462
428
        if not self.local:
463
 
            self.master_branch = self.branch.get_master_branch(
464
 
                possible_master_transports)
 
429
            self.master_branch = self.branch.get_master_branch()
465
430
 
466
431
        if not self.master_branch:
467
432
            # make this branch the reference branch for out of date checks.
478
443
        #       commits to the remote branch if they would fit.
479
444
        #       But for now, just require remote to be identical
480
445
        #       to local.
481
 
 
 
446
        
482
447
        # Make sure the local branch is identical to the master
483
448
        master_info = self.master_branch.last_revision_info()
484
449
        local_info = self.branch.last_revision_info()
490
455
        # so grab the lock
491
456
        self.bound_branch = self.branch
492
457
        self.master_branch.lock_write()
493
 
        operation.add_cleanup(self.master_branch.unlock)
 
458
        self.master_locked = True
494
459
 
495
460
    def _check_out_of_date_tree(self):
496
461
        """Check that the working tree is up to date.
541
506
    def _process_hooks(self, hook_name, old_revno, new_revno):
542
507
        if not Branch.hooks[hook_name]:
543
508
            return
544
 
 
 
509
        
545
510
        # new style commit hooks:
546
511
        if not self.bound_branch:
547
512
            hook_master = self.branch
556
521
            old_revid = self.parents[0]
557
522
        else:
558
523
            old_revid = bzrlib.revision.NULL_REVISION
559
 
 
 
524
        
560
525
        if hook_name == "pre_commit":
561
526
            future_tree = self.builder.revision_tree()
562
527
            tree_delta = future_tree.changes_from(self.basis_tree,
563
528
                                             include_root=True)
564
 
 
 
529
        
565
530
        for hook in Branch.hooks[hook_name]:
566
531
            # show the running hook in the progress bar. As hooks may
567
532
            # end up doing nothing (e.g. because they are not configured by
581
546
                     old_revno, old_revid, new_revno, self.rev_id,
582
547
                     tree_delta, future_tree)
583
548
 
 
549
    def _cleanup(self):
 
550
        """Cleanup any open locks, progress bars etc."""
 
551
        cleanups = [self._cleanup_bound_branch,
 
552
                    self.basis_tree.unlock,
 
553
                    self.work_tree.unlock,
 
554
                    self.pb.finished]
 
555
        found_exception = None
 
556
        for cleanup in cleanups:
 
557
            try:
 
558
                cleanup()
 
559
            # we want every cleanup to run no matter what.
 
560
            # so we have a catchall here, but we will raise the
 
561
            # last encountered exception up the stack: and
 
562
            # typically this will be useful enough.
 
563
            except Exception, e:
 
564
                found_exception = e
 
565
        if found_exception is not None: 
 
566
            # don't do a plan raise, because the last exception may have been
 
567
            # trashed, e is our sure-to-work exception even though it loses the
 
568
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
569
            # exc_info and if its the same one do a plain raise otherwise 
 
570
            # 'raise e' as we do now.
 
571
            raise e
 
572
 
 
573
    def _cleanup_bound_branch(self):
 
574
        """Executed at the end of a try/finally to cleanup a bound branch.
 
575
 
 
576
        If the branch wasn't bound, this is a no-op.
 
577
        If it was, it resents self.branch to the local branch, instead
 
578
        of being the master.
 
579
        """
 
580
        if not self.bound_branch:
 
581
            return
 
582
        if self.master_locked:
 
583
            self.master_branch.unlock()
 
584
 
 
585
    def _escape_commit_message(self):
 
586
        """Replace xml-incompatible control characters."""
 
587
        # FIXME: RBC 20060419 this should be done by the revision
 
588
        # serialiser not by commit. Then we can also add an unescaper
 
589
        # in the deserializer and start roundtripping revision messages
 
590
        # precisely. See repository_implementations/test_repository.py
 
591
        
 
592
        # Python strings can include characters that can't be
 
593
        # represented in well-formed XML; escape characters that
 
594
        # aren't listed in the XML specification
 
595
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
596
        self.message, escape_count = re.subn(
 
597
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
598
            lambda match: match.group(0).encode('unicode_escape'),
 
599
            self.message)
 
600
        if escape_count:
 
601
            self.reporter.escaped(escape_count, self.message)
 
602
 
584
603
    def _gather_parents(self):
585
604
        """Record the parents of a merge for merge detection."""
586
 
        # TODO: Make sure that this list doesn't contain duplicate
 
605
        # TODO: Make sure that this list doesn't contain duplicate 
587
606
        # entries and the order is preserved when doing this.
588
 
        if self.use_record_iter_changes:
589
 
            return
590
 
        self.basis_inv = self.basis_tree.inventory
 
607
        self.parents = self.work_tree.get_parent_ids()
591
608
        self.parent_invs = [self.basis_inv]
592
609
        for revision in self.parents[1:]:
593
610
            if self.branch.repository.has_revision(revision):
600
617
    def _update_builder_with_changes(self):
601
618
        """Update the commit builder with the data about what has changed.
602
619
        """
603
 
        exclude = self.exclude
 
620
        # Build the revision inventory.
 
621
        #
 
622
        # This starts by creating a new empty inventory. Depending on
 
623
        # which files are selected for commit, and what is present in the
 
624
        # current tree, the new inventory is populated. inventory entries 
 
625
        # which are candidates for modification have their revision set to
 
626
        # None; inventory entries that are carried over untouched have their
 
627
        # revision set to their prior value.
 
628
        #
 
629
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
630
        # results to create a new inventory at the same time, which results
 
631
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
632
        # ADHB 11-07-2006
 
633
 
604
634
        specific_files = self.specific_files
605
635
        mutter("Selecting files for commit with filter %s", specific_files)
606
636
 
607
 
        self._check_strict()
608
 
        if self.use_record_iter_changes:
609
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
610
 
                specific_files=specific_files)
611
 
            iter_changes = self._filter_iter_changes(iter_changes)
612
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
613
 
                self.work_tree, self.basis_revid, iter_changes):
614
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
615
 
        else:
616
 
            # Build the new inventory
617
 
            self._populate_from_inventory()
618
 
            self._record_unselected()
619
 
            self._report_and_accumulate_deletes()
620
 
 
621
 
    def _filter_iter_changes(self, iter_changes):
622
 
        """Process iter_changes.
623
 
 
624
 
        This method reports on the changes in iter_changes to the user, and 
625
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
626
 
        entries. 'missing' entries have their
627
 
 
628
 
        :param iter_changes: An iter_changes to process.
629
 
        :return: A generator of changes.
630
 
        """
631
 
        reporter = self.reporter
632
 
        report_changes = reporter.is_verbose()
633
 
        deleted_ids = []
634
 
        for change in iter_changes:
635
 
            if report_changes:
636
 
                old_path = change[1][0]
637
 
                new_path = change[1][1]
638
 
                versioned = change[3][1]
639
 
            kind = change[6][1]
640
 
            versioned = change[3][1]
641
 
            if kind is None and versioned:
642
 
                # 'missing' path
643
 
                if report_changes:
644
 
                    reporter.missing(new_path)
645
 
                deleted_ids.append(change[0])
646
 
                # Reset the new path (None) and new versioned flag (False)
647
 
                change = (change[0], (change[1][0], None), change[2],
648
 
                    (change[3][0], False)) + change[4:]
649
 
            elif kind == 'tree-reference':
650
 
                if self.recursive == 'down':
651
 
                    self._commit_nested_tree(change[0], change[1][1])
652
 
            if change[3][0] or change[3][1]:
653
 
                yield change
654
 
                if report_changes:
655
 
                    if new_path is None:
656
 
                        reporter.deleted(old_path)
657
 
                    elif old_path is None:
658
 
                        reporter.snapshot_change('added', new_path)
659
 
                    elif old_path != new_path:
660
 
                        reporter.renamed('renamed', old_path, new_path)
661
 
                    else:
662
 
                        if (new_path or 
663
 
                            self.work_tree.branch.repository._format.rich_root_data):
664
 
                            # Don't report on changes to '' in non rich root
665
 
                            # repositories.
666
 
                            reporter.snapshot_change('modified', new_path)
667
 
            self._next_progress_entry()
668
 
        # Unversion IDs that were found to be deleted
669
 
        self.deleted_ids = deleted_ids
670
 
 
671
 
    def _record_unselected(self):
 
637
        # Check and warn about old CommitBuilders
 
638
        if not self.builder.record_root_entry:
 
639
            symbol_versioning.warn('CommitBuilders should support recording'
 
640
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
641
                stacklevel=1)
 
642
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
643
 
 
644
        # Build the new inventory
 
645
        self._populate_from_inventory(specific_files)
 
646
 
672
647
        # If specific files are selected, then all un-selected files must be
673
648
        # recorded in their previous state. For more details, see
674
649
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
675
 
        if self.specific_files or self.exclude:
676
 
            specific_files = self.specific_files or []
 
650
        if specific_files:
677
651
            for path, old_ie in self.basis_inv.iter_entries():
678
652
                if old_ie.file_id in self.builder.new_inventory:
679
 
                    # already added - skip.
680
 
                    continue
681
 
                if (is_inside_any(specific_files, path)
682
 
                    and not is_inside_any(self.exclude, path)):
683
 
                    # was inside the selected path, and not excluded - if not
684
 
                    # present it has been deleted so skip.
685
 
                    continue
686
 
                # From here down it was either not selected, or was excluded:
687
 
                # We preserve the entry unaltered.
 
653
                    continue
 
654
                if is_inside_any(specific_files, path):
 
655
                    continue
 
656
                if old_ie.kind == 'directory':
 
657
                    self._next_progress_entry()
688
658
                ie = old_ie.copy()
689
659
                # Note: specific file commits after a merge are currently
690
660
                # prohibited. This test is for sanity/safety in case it's
691
661
                # required after that changes.
692
662
                if len(self.parents) > 1:
693
663
                    ie.revision = None
694
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
695
 
                    self.basis_tree, None)
 
664
                if self.builder.record_entry_contents(ie, self.parent_invs, path,
 
665
                    self.basis_tree):
 
666
                    self.any_entries_changed = True
696
667
 
697
 
    def _report_and_accumulate_deletes(self):
698
 
        if (isinstance(self.basis_inv, Inventory)
699
 
            and isinstance(self.builder.new_inventory, Inventory)):
700
 
            # the older Inventory classes provide a _byid dict, and building a
701
 
            # set from the keys of this dict is substantially faster than even
702
 
            # getting a set of ids from the inventory
703
 
            #
704
 
            # <lifeless> set(dict) is roughly the same speed as
705
 
            # set(iter(dict)) and both are significantly slower than
706
 
            # set(dict.keys())
707
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
708
 
               set(self.builder.new_inventory._byid.keys())
709
 
        else:
710
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
711
 
        if deleted_ids:
 
668
        # note that deletes have occurred
 
669
        if set(self.basis_inv._byid.keys()) - set(self.builder.new_inventory._byid.keys()):
712
670
            self.any_entries_deleted = True
713
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
714
 
                for file_id in deleted_ids]
715
 
            deleted.sort()
716
 
            # XXX: this is not quite directory-order sorting
717
 
            for path, file_id in deleted:
718
 
                self.builder.record_delete(path, file_id)
719
 
                self.reporter.deleted(path)
 
671
        # Report what was deleted.
 
672
        if self.any_entries_deleted and self.reporter.is_verbose():
 
673
            for path, ie in self.basis_inv.iter_entries():
 
674
                if ie.file_id not in self.builder.new_inventory:
 
675
                    self.reporter.deleted(path)
720
676
 
721
 
    def _check_strict(self):
722
 
        # XXX: when we use iter_changes this would likely be faster if
723
 
        # iter_changes would check for us (even in the presence of
724
 
        # selected_files).
 
677
    def _populate_from_inventory(self, specific_files):
 
678
        """Populate the CommitBuilder by walking the working tree inventory."""
725
679
        if self.strict:
726
680
            # raise an exception as soon as we find a single unknown.
727
681
            for unknown in self.work_tree.unknowns():
728
682
                raise StrictCommitFailed()
729
 
 
730
 
    def _populate_from_inventory(self):
731
 
        """Populate the CommitBuilder by walking the working tree inventory."""
732
 
        # Build the revision inventory.
733
 
        #
734
 
        # This starts by creating a new empty inventory. Depending on
735
 
        # which files are selected for commit, and what is present in the
736
 
        # current tree, the new inventory is populated. inventory entries
737
 
        # which are candidates for modification have their revision set to
738
 
        # None; inventory entries that are carried over untouched have their
739
 
        # revision set to their prior value.
740
 
        #
741
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
742
 
        # results to create a new inventory at the same time, which results
743
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
744
 
        # ADHB 11-07-2006
745
 
 
746
 
        specific_files = self.specific_files
747
 
        exclude = self.exclude
 
683
               
748
684
        report_changes = self.reporter.is_verbose()
749
685
        deleted_ids = []
750
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
751
 
        # deleted, then we have {'foo':{'bar':{}}}
752
 
        deleted_paths = {}
753
 
        # XXX: Note that entries may have the wrong kind because the entry does
754
 
        # not reflect the status on disk.
 
686
        deleted_paths = set()
755
687
        work_inv = self.work_tree.inventory
756
 
        # NB: entries will include entries within the excluded ids/paths
757
 
        # because iter_entries_by_dir has no 'exclude' facility today.
 
688
        assert work_inv.root is not None
758
689
        entries = work_inv.iter_entries_by_dir(
759
690
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
691
        if not self.builder.record_root_entry:
 
692
            entries.next()
760
693
        for path, existing_ie in entries:
761
694
            file_id = existing_ie.file_id
762
695
            name = existing_ie.name
763
696
            parent_id = existing_ie.parent_id
764
697
            kind = existing_ie.kind
 
698
            if kind == 'directory':
 
699
                self._next_progress_entry()
765
700
            # Skip files that have been deleted from the working tree.
766
 
            # The deleted path ids are also recorded so they can be explicitly
767
 
            # unversioned later.
768
 
            if deleted_paths:
769
 
                path_segments = splitpath(path)
770
 
                deleted_dict = deleted_paths
771
 
                for segment in path_segments:
772
 
                    deleted_dict = deleted_dict.get(segment, None)
773
 
                    if not deleted_dict:
774
 
                        # We either took a path not present in the dict
775
 
                        # (deleted_dict was None), or we've reached an empty
776
 
                        # child dir in the dict, so are now a sub-path.
777
 
                        break
778
 
                else:
779
 
                    deleted_dict = None
780
 
                if deleted_dict is not None:
781
 
                    # the path has a deleted parent, do not add it.
782
 
                    continue
783
 
            if exclude and is_inside_any(exclude, path):
784
 
                # Skip excluded paths. Excluded paths are processed by
785
 
                # _update_builder_with_changes.
786
 
                continue
787
 
            content_summary = self.work_tree.path_content_summary(path)
788
 
            kind = content_summary[0]
789
 
            # Note that when a filter of specific files is given, we must only
790
 
            # skip/record deleted files matching that filter.
791
 
            if not specific_files or is_inside_any(specific_files, path):
792
 
                if kind == 'missing':
793
 
                    if not deleted_paths:
794
 
                        # path won't have been split yet.
795
 
                        path_segments = splitpath(path)
796
 
                    deleted_dict = deleted_paths
797
 
                    for segment in path_segments:
798
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
799
 
                    self.reporter.missing(path)
800
 
                    self._next_progress_entry()
801
 
                    deleted_ids.append(file_id)
802
 
                    continue
803
 
            # TODO: have the builder do the nested commit just-in-time IF and
804
 
            # only if needed.
805
 
            if kind == 'tree-reference':
806
 
                # enforce repository nested tree policy.
807
 
                if (not self.work_tree.supports_tree_reference() or
808
 
                    # repository does not support it either.
809
 
                    not self.branch.repository._format.supports_tree_reference):
810
 
                    kind = 'directory'
811
 
                    content_summary = (kind, None, None, None)
812
 
                elif self.recursive == 'down':
813
 
                    nested_revision_id = self._commit_nested_tree(
814
 
                        file_id, path)
815
 
                    content_summary = (kind, None, None, nested_revision_id)
816
 
                else:
817
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
818
 
                    content_summary = (kind, None, None, nested_revision_id)
 
701
            # The deleted files/directories are also recorded so they
 
702
            # can be explicitly unversioned later. Note that when a
 
703
            # filter of specific files is given, we must only skip/record
 
704
            # deleted files matching that filter.
 
705
            if is_inside_any(deleted_paths, path):
 
706
                continue
 
707
            if not self.work_tree.has_filename(path):
 
708
                deleted_paths.add(path)
 
709
                self.reporter.missing(path)
 
710
                deleted_ids.append(file_id)
 
711
                continue
 
712
            try:
 
713
                kind = self.work_tree.kind(file_id)
 
714
                # TODO: specific_files filtering before nested tree processing
 
715
                if kind == 'tree-reference' and self.recursive == 'down':
 
716
                    self._commit_nested_tree(file_id, path)
 
717
            except errors.NoSuchFile:
 
718
                pass
819
719
 
820
720
            # Record an entry for this item
821
721
            # Note: I don't particularly want to have the existing_ie
823
723
            # without it thanks to a unicode normalisation issue. :-(
824
724
            definitely_changed = kind != existing_ie.kind
825
725
            self._record_entry(path, file_id, specific_files, kind, name,
826
 
                parent_id, definitely_changed, existing_ie, report_changes,
827
 
                content_summary)
 
726
                parent_id, definitely_changed, existing_ie, report_changes)
828
727
 
829
728
        # Unversion IDs that were found to be deleted
830
 
        self.deleted_ids = deleted_ids
 
729
        self.work_tree.unversion(deleted_ids)
831
730
 
832
731
    def _commit_nested_tree(self, file_id, path):
833
732
        "Commit a nested tree."
835
734
        # FIXME: be more comprehensive here:
836
735
        # this works when both trees are in --trees repository,
837
736
        # but when both are bound to a different repository,
838
 
        # it fails; a better way of approaching this is to
 
737
        # it fails; a better way of approaching this is to 
839
738
        # finally implement the explicit-caches approach design
840
739
        # a while back - RBC 20070306.
841
740
        if sub_tree.branch.repository.has_same_location(
843
742
            sub_tree.branch.repository = \
844
743
                self.work_tree.branch.repository
845
744
        try:
846
 
            return sub_tree.commit(message=None, revprops=self.revprops,
 
745
            sub_tree.commit(message=None, revprops=self.revprops,
847
746
                recursive=self.recursive,
848
747
                message_callback=self.message_callback,
849
748
                timestamp=self.timestamp, timezone=self.timezone,
852
751
                strict=self.strict, verbose=self.verbose,
853
752
                local=self.local, reporter=self.reporter)
854
753
        except errors.PointlessCommit:
855
 
            return self.work_tree.get_reference_revision(file_id)
 
754
            pass
856
755
 
857
756
    def _record_entry(self, path, file_id, specific_files, kind, name,
858
 
        parent_id, definitely_changed, existing_ie, report_changes,
859
 
        content_summary):
 
757
            parent_id, definitely_changed, existing_ie=None,
 
758
            report_changes=True):
860
759
        "Record the new inventory entry for a path if any."
861
760
        # mutter('check %s {%s}', path, file_id)
862
761
        # mutter('%s selected for commit', path)
863
762
        if definitely_changed or existing_ie is None:
864
 
            ie = make_entry(kind, name, parent_id, file_id)
 
763
            ie = inventory.make_entry(kind, name, parent_id, file_id)
865
764
        else:
866
765
            ie = existing_ie.copy()
867
766
            ie.revision = None
868
 
        # For carried over entries we don't care about the fs hash - the repo
869
 
        # isn't generating a sha, so we're not saving computation time.
870
 
        _, _, fs_hash = self.builder.record_entry_contents(
871
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
767
        if self.builder.record_entry_contents(ie, self.parent_invs, 
 
768
            path, self.work_tree):
 
769
            self.any_entries_changed = True
872
770
        if report_changes:
873
771
            self._report_change(ie, path)
874
 
        if fs_hash:
875
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
876
772
        return ie
877
773
 
878
774
    def _report_change(self, ie, path):
886
782
        else:
887
783
            basis_ie = None
888
784
        change = ie.describe_change(basis_ie, ie)
889
 
        if change in (InventoryEntry.RENAMED,
 
785
        if change in (InventoryEntry.RENAMED, 
890
786
            InventoryEntry.MODIFIED_AND_RENAMED):
891
787
            old_path = self.basis_inv.id2path(ie.file_id)
892
788
            self.reporter.renamed(change, old_path, path)
893
 
            self._next_progress_entry()
894
789
        else:
895
 
            if change == 'unchanged':
896
 
                return
897
790
            self.reporter.snapshot_change(change, path)
898
 
            self._next_progress_entry()
899
791
 
900
 
    def _set_progress_stage(self, name, counter=False):
 
792
    def _set_progress_stage(self, name, entries_title=None):
901
793
        """Set the progress stage and emit an update to the progress bar."""
902
794
        self.pb_stage_name = name
903
795
        self.pb_stage_count += 1
904
 
        if counter:
 
796
        self.pb_entries_title = entries_title
 
797
        if entries_title is not None:
905
798
            self.pb_entries_count = 0
906
 
        else:
907
 
            self.pb_entries_count = None
 
799
            self.pb_entries_total = '?'
908
800
        self._emit_progress()
909
801
 
910
802
    def _next_progress_entry(self):
913
805
        self._emit_progress()
914
806
 
915
807
    def _emit_progress(self):
916
 
        if self.pb_entries_count is not None:
917
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
918
 
                self.pb_entries_count)
 
808
        if self.pb_entries_title:
 
809
            if self.pb_entries_total == '?':
 
810
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
811
                    self.pb_entries_title, self.pb_entries_count)
 
812
            else:
 
813
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
814
                    self.pb_entries_title, self.pb_entries_count,
 
815
                    str(self.pb_entries_total))
919
816
        else:
920
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
817
            text = "%s - Stage" % (self.pb_stage_name)
921
818
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
922
819
 
923
 
    def _set_specific_file_ids(self):
924
 
        """populate self.specific_file_ids if we will use it."""
925
 
        if not self.use_record_iter_changes:
926
 
            # If provided, ensure the specified files are versioned
927
 
            if self.specific_files is not None:
928
 
                # Note: This routine is being called because it raises
929
 
                # PathNotVersionedError as a side effect of finding the IDs. We
930
 
                # later use the ids we found as input to the working tree
931
 
                # inventory iterator, so we only consider those ids rather than
932
 
                # examining the whole tree again.
933
 
                # XXX: Dont we have filter_unversioned to do this more
934
 
                # cheaply?
935
 
                self.specific_file_ids = tree.find_ids_across_trees(
936
 
                    self.specific_files, [self.basis_tree, self.work_tree])
937
 
            else:
938
 
                self.specific_file_ids = None