/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: Ian Clatworthy
  • Date: 2007-12-04 12:56:31 UTC
  • mto: (3075.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3076.
  • Revision ID: ian.clatworthy@internode.on.net-20071204125631-9xnjwum1nbkd1zhp
more feedback from jameinel

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
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
62
    revision,
56
 
    trace,
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,
 
74
                            quotefn, sha_file, split_lines,
69
75
                            splitpath,
70
76
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
77
from bzrlib.testament import Testament
 
78
from bzrlib.trace import mutter, note, warning, is_quiet
 
79
from bzrlib.xml5 import serializer_v5
 
80
from bzrlib.inventory import InventoryEntry, make_entry
73
81
from bzrlib import symbol_versioning
 
82
from bzrlib.symbol_versioning import (deprecated_passed,
 
83
        deprecated_function,
 
84
        DEPRECATED_PARAMETER)
 
85
from bzrlib.workingtree import WorkingTree
74
86
from bzrlib.urlutils import unescape_for_display
75
87
import bzrlib.ui
76
88
 
91
103
    def completed(self, revno, rev_id):
92
104
        pass
93
105
 
94
 
    def deleted(self, path):
 
106
    def deleted(self, file_id):
 
107
        pass
 
108
 
 
109
    def escaped(self, escape_count, message):
95
110
        pass
96
111
 
97
112
    def missing(self, path):
114
129
        note(format, *args)
115
130
 
116
131
    def snapshot_change(self, change, path):
117
 
        if path == '' and change in ('added', 'modified'):
 
132
        if change == 'unchanged':
 
133
            return
 
134
        if change == 'added' and path == '':
118
135
            return
119
136
        self._note("%s %s", change, path)
120
137
 
132
149
 
133
150
    def completed(self, revno, rev_id):
134
151
        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)
 
152
 
 
153
    def deleted(self, file_id):
 
154
        self._note('deleted %s', file_id)
 
155
 
 
156
    def escaped(self, escape_count, message):
 
157
        self._note("replaced %d control characters in message", escape_count)
144
158
 
145
159
    def missing(self, path):
146
160
        self._note('missing %s', path)
174
188
        self.reporter = reporter
175
189
        self.config = config
176
190
 
177
 
    @staticmethod
178
 
    def update_revprops(revprops, branch, authors=None, author=None,
179
 
                        local=False, possible_master_transports=None):
180
 
        if revprops is None:
181
 
            revprops = {}
182
 
        if possible_master_transports is None:
183
 
            possible_master_transports = []
184
 
        if not 'branch-nick' in revprops:
185
 
            revprops['branch-nick'] = branch._get_nick(
186
 
                local,
187
 
                possible_master_transports)
188
 
        if authors is not None:
189
 
            if author is not None:
190
 
                raise AssertionError('Specifying both author and authors '
191
 
                        'is not allowed. Specify just authors instead')
192
 
            if 'author' in revprops or 'authors' in revprops:
193
 
                # XXX: maybe we should just accept one of them?
194
 
                raise AssertionError('author property given twice')
195
 
            if authors:
196
 
                for individual in authors:
197
 
                    if '\n' in individual:
198
 
                        raise AssertionError('\\n is not a valid character '
199
 
                                'in an author identity')
200
 
                revprops['authors'] = '\n'.join(authors)
201
 
        if author is not None:
202
 
            symbol_versioning.warn('The parameter author was deprecated'
203
 
                   ' in version 1.13. Use authors instead',
204
 
                   DeprecationWarning)
205
 
            if 'author' in revprops or 'authors' in revprops:
206
 
                # XXX: maybe we should just accept one of them?
207
 
                raise AssertionError('author property given twice')
208
 
            if '\n' in author:
209
 
                raise AssertionError('\\n is not a valid character '
210
 
                        'in an author identity')
211
 
            revprops['authors'] = author
212
 
        return revprops
213
 
 
214
191
    def commit(self,
215
192
               message=None,
216
193
               timestamp=None,
227
204
               reporter=None,
228
205
               config=None,
229
206
               message_callback=None,
230
 
               recursive='down',
231
 
               exclude=None,
232
 
               possible_master_transports=None):
 
207
               recursive='down'):
233
208
        """Commit working copy as a new revision.
234
209
 
235
210
        :param message: the commit message (it or message_callback is required)
236
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
237
211
 
238
212
        :param timestamp: if not None, seconds-since-epoch for a
239
213
            postdated/predated commit.
240
214
 
241
 
        :param specific_files: If not None, commit only those files. An empty
242
 
            list means 'commit no files'.
 
215
        :param specific_files: If true, commit only those files.
243
216
 
244
217
        :param rev_id: If set, use this as the new revision id.
245
218
            Useful for test or import commands that need to tightly
259
232
        :param verbose: if True and the reporter is not None, report everything
260
233
        :param recursive: If set to 'down', commit in any subtrees that have
261
234
            pending changes of any sort during this commit.
262
 
        :param exclude: None or a list of relative paths to exclude from the
263
 
            commit. Pending changes to excluded files will be ignored by the
264
 
            commit.
265
235
        """
266
 
        operation = OperationWithCleanups(self._commit)
267
 
        self.revprops = revprops or {}
268
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
269
 
        self.config = config or self.config
270
 
        return operation.run(
271
 
               message=message,
272
 
               timestamp=timestamp,
273
 
               timezone=timezone,
274
 
               committer=committer,
275
 
               specific_files=specific_files,
276
 
               rev_id=rev_id,
277
 
               allow_pointless=allow_pointless,
278
 
               strict=strict,
279
 
               verbose=verbose,
280
 
               working_tree=working_tree,
281
 
               local=local,
282
 
               reporter=reporter,
283
 
               message_callback=message_callback,
284
 
               recursive=recursive,
285
 
               exclude=exclude,
286
 
               possible_master_transports=possible_master_transports)
287
 
 
288
 
    def _commit(self, operation, message, timestamp, timezone, committer,
289
 
            specific_files, rev_id, allow_pointless, strict, verbose,
290
 
            working_tree, local, reporter, message_callback, recursive,
291
 
            exclude, possible_master_transports):
292
236
        mutter('preparing to commit')
293
237
 
294
238
        if working_tree is None:
302
246
        if message_callback is None:
303
247
            if message is not None:
304
248
                if isinstance(message, str):
305
 
                    message = message.decode(get_user_encoding())
 
249
                    message = message.decode(bzrlib.user_encoding)
306
250
                message_callback = lambda x: message
307
251
            else:
308
252
                raise BzrError("The message or message_callback keyword"
309
253
                               " parameter is required for commit().")
310
254
 
311
255
        self.bound_branch = None
 
256
        self.any_entries_changed = False
312
257
        self.any_entries_deleted = False
313
 
        if exclude is not None:
314
 
            self.exclude = sorted(
315
 
                minimum_path_selection(exclude))
316
 
        else:
317
 
            self.exclude = []
318
258
        self.local = local
319
259
        self.master_branch = None
 
260
        self.master_locked = False
320
261
        self.recursive = recursive
321
262
        self.rev_id = None
322
 
        # self.specific_files is None to indicate no filter, or any iterable to
323
 
        # indicate a filter - [] means no files at all, as per iter_changes.
324
263
        if specific_files is not None:
325
264
            self.specific_files = sorted(
326
265
                minimum_path_selection(specific_files))
327
266
        else:
328
267
            self.specific_files = None
329
 
            
 
268
        self.specific_file_ids = None
330
269
        self.allow_pointless = allow_pointless
 
270
        self.revprops = revprops
331
271
        self.message_callback = message_callback
332
272
        self.timestamp = timestamp
333
273
        self.timezone = timezone
334
274
        self.committer = committer
335
275
        self.strict = strict
336
276
        self.verbose = verbose
 
277
        # accumulates an inventory delta to the basis entry, so we can make
 
278
        # just the necessary updates to the workingtree's cached basis.
 
279
        self._basis_delta = []
337
280
 
338
281
        self.work_tree.lock_write()
339
 
        operation.add_cleanup(self.work_tree.unlock)
340
 
        self.parents = self.work_tree.get_parent_ids()
341
 
        # We can use record_iter_changes IFF iter_changes is compatible with
342
 
        # the command line parameters, and the repository has fast delta
343
 
        # generation. See bug 347649.
344
 
        self.use_record_iter_changes = (
345
 
            not self.exclude and 
346
 
            not self.branch.repository._format.supports_tree_reference and
347
 
            (self.branch.repository._format.fast_deltas or
348
 
             len(self.parents) < 2))
349
282
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
350
 
        operation.add_cleanup(self.pb.finished)
351
283
        self.basis_revid = self.work_tree.last_revision()
352
284
        self.basis_tree = self.work_tree.basis_tree()
353
285
        self.basis_tree.lock_read()
354
 
        operation.add_cleanup(self.basis_tree.unlock)
355
 
        # Cannot commit with conflicts present.
356
 
        if len(self.work_tree.conflicts()) > 0:
357
 
            raise ConflictsInTree
358
 
 
359
 
        # Setup the bound branch variables as needed.
360
 
        self._check_bound_branch(operation, possible_master_transports)
361
 
 
362
 
        # Check that the working tree is up to date
363
 
        old_revno, new_revno = self._check_out_of_date_tree()
364
 
 
365
 
        # Complete configuration setup
366
 
        if reporter is not None:
367
 
            self.reporter = reporter
368
 
        elif self.reporter is None:
369
 
            self.reporter = self._select_reporter()
370
 
        if self.config is None:
371
 
            self.config = self.branch.get_config()
372
 
 
373
 
        self._set_specific_file_ids()
374
 
 
375
 
        # Setup the progress bar. As the number of files that need to be
376
 
        # committed in unknown, progress is reported as stages.
377
 
        # We keep track of entries separately though and include that
378
 
        # information in the progress bar during the relevant stages.
379
 
        self.pb_stage_name = ""
380
 
        self.pb_stage_count = 0
381
 
        self.pb_stage_total = 5
382
 
        if self.bound_branch:
383
 
            self.pb_stage_total += 1
384
 
        self.pb.show_pct = False
385
 
        self.pb.show_spinner = False
386
 
        self.pb.show_eta = False
387
 
        self.pb.show_count = True
388
 
        self.pb.show_bar = True
389
 
 
390
 
        self._gather_parents()
391
 
        # After a merge, a selected file commit is not supported.
392
 
        # See 'bzr help merge' for an explanation as to why.
393
 
        if len(self.parents) > 1 and self.specific_files is not None:
394
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
395
 
        # Excludes are a form of selected file commit.
396
 
        if len(self.parents) > 1 and self.exclude:
397
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
398
 
 
399
 
        # Collect the changes
400
 
        self._set_progress_stage("Collecting changes", counter=True)
401
 
        self.builder = self.branch.get_commit_builder(self.parents,
402
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
403
 
 
404
286
        try:
405
 
            self.builder.will_record_deletes()
406
 
            # find the location being committed to
407
 
            if self.bound_branch:
408
 
                master_location = self.master_branch.base
409
 
            else:
410
 
                master_location = self.branch.base
411
 
 
412
 
            # report the start of the commit
413
 
            self.reporter.started(new_revno, self.rev_id, master_location)
414
 
 
415
 
            self._update_builder_with_changes()
416
 
            self._check_pointless()
417
 
 
418
 
            # TODO: Now the new inventory is known, check for conflicts.
419
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
420
 
            # weave lines, because nothing should be recorded until it is known
421
 
            # that commit will succeed.
422
 
            self._set_progress_stage("Saving data locally")
423
 
            self.builder.finish_inventory()
424
 
 
425
 
            # Prompt the user for a commit message if none provided
426
 
            message = message_callback(self)
427
 
            self.message = message
428
 
 
429
 
            # Add revision data to the local branch
430
 
            self.rev_id = self.builder.commit(self.message)
431
 
 
432
 
        except Exception, e:
433
 
            mutter("aborting commit write group because of exception:")
434
 
            trace.log_exception_quietly()
435
 
            note("aborting commit write group: %r" % (e,))
436
 
            self.builder.abort()
437
 
            raise
438
 
 
439
 
        self._process_pre_hooks(old_revno, new_revno)
440
 
 
441
 
        # Upload revision data to the master.
442
 
        # this will propagate merged revisions too if needed.
443
 
        if self.bound_branch:
444
 
            self._set_progress_stage("Uploading data to master branch")
445
 
            # 'commit' to the master first so a timeout here causes the
446
 
            # local branch to be out of date
447
 
            self.master_branch.import_last_revision_info(
448
 
                self.branch.repository, new_revno, self.rev_id)
449
 
 
450
 
        # and now do the commit locally.
451
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
452
 
 
453
 
        # Make the working tree be up to date with the branch. This
454
 
        # includes automatic changes scheduled to be made to the tree, such
455
 
        # as updating its basis and unversioning paths that were missing.
456
 
        self.work_tree.unversion(self.deleted_ids)
457
 
        self._set_progress_stage("Updating the working tree")
458
 
        self.work_tree.update_basis_by_delta(self.rev_id,
459
 
             self.builder.get_basis_delta())
460
 
        self.reporter.completed(new_revno, self.rev_id)
461
 
        self._process_post_hooks(old_revno, new_revno)
 
287
            # Cannot commit with conflicts present.
 
288
            if len(self.work_tree.conflicts()) > 0:
 
289
                raise ConflictsInTree
 
290
 
 
291
            # Setup the bound branch variables as needed.
 
292
            self._check_bound_branch()
 
293
 
 
294
            # Check that the working tree is up to date
 
295
            old_revno, new_revno = self._check_out_of_date_tree()
 
296
 
 
297
            # Complete configuration setup
 
298
            if reporter is not None:
 
299
                self.reporter = reporter
 
300
            elif self.reporter is None:
 
301
                self.reporter = self._select_reporter()
 
302
            if self.config is None:
 
303
                self.config = self.branch.get_config()
 
304
 
 
305
            # If provided, ensure the specified files are versioned
 
306
            if self.specific_files is not None:
 
307
                # Note: This routine is being called because it raises
 
308
                # PathNotVersionedError as a side effect of finding the IDs. We
 
309
                # later use the ids we found as input to the working tree
 
310
                # inventory iterator, so we only consider those ids rather than
 
311
                # examining the whole tree again.
 
312
                # XXX: Dont we have filter_unversioned to do this more
 
313
                # cheaply?
 
314
                self.specific_file_ids = tree.find_ids_across_trees(
 
315
                    specific_files, [self.basis_tree, self.work_tree])
 
316
 
 
317
            # Setup the progress bar. As the number of files that need to be
 
318
            # committed in unknown, progress is reported as stages.
 
319
            # We keep track of entries separately though and include that
 
320
            # information in the progress bar during the relevant stages.
 
321
            self.pb_stage_name = ""
 
322
            self.pb_stage_count = 0
 
323
            self.pb_stage_total = 5
 
324
            if self.bound_branch:
 
325
                self.pb_stage_total += 1
 
326
            self.pb.show_pct = False
 
327
            self.pb.show_spinner = False
 
328
            self.pb.show_eta = False
 
329
            self.pb.show_count = True
 
330
            self.pb.show_bar = True
 
331
 
 
332
            # After a merge, a selected file commit is not supported.
 
333
            # See 'bzr help merge' for an explanation as to why.
 
334
            self.basis_inv = self.basis_tree.inventory
 
335
            self._gather_parents()
 
336
            if len(self.parents) > 1 and self.specific_files:
 
337
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
338
 
 
339
            # Collect the changes
 
340
            self._set_progress_stage("Collecting changes",
 
341
                    entries_title="Directory")
 
342
            self.builder = self.branch.get_commit_builder(self.parents,
 
343
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
344
            
 
345
            try:
 
346
                # find the location being committed to
 
347
                if self.bound_branch:
 
348
                    master_location = self.master_branch.base
 
349
                else:
 
350
                    master_location = self.branch.base
 
351
 
 
352
                # report the start of the commit
 
353
                self.reporter.started(new_revno, self.rev_id, master_location)
 
354
 
 
355
                self._update_builder_with_changes()
 
356
                self._report_and_accumulate_deletes()
 
357
                self._check_pointless()
 
358
 
 
359
                # TODO: Now the new inventory is known, check for conflicts.
 
360
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
361
                # weave lines, because nothing should be recorded until it is known
 
362
                # that commit will succeed.
 
363
                self._set_progress_stage("Saving data locally")
 
364
                self.builder.finish_inventory()
 
365
 
 
366
                # Prompt the user for a commit message if none provided
 
367
                message = message_callback(self)
 
368
                assert isinstance(message, unicode), type(message)
 
369
                self.message = message
 
370
                self._escape_commit_message()
 
371
 
 
372
                # Add revision data to the local branch
 
373
                self.rev_id = self.builder.commit(self.message)
 
374
 
 
375
            except:
 
376
                self.builder.abort()
 
377
                raise
 
378
 
 
379
            self._process_pre_hooks(old_revno, new_revno)
 
380
 
 
381
            # Upload revision data to the master.
 
382
            # this will propagate merged revisions too if needed.
 
383
            if self.bound_branch:
 
384
                self._set_progress_stage("Uploading data to master branch")
 
385
                self.master_branch.repository.fetch(self.branch.repository,
 
386
                                                    revision_id=self.rev_id)
 
387
                # now the master has the revision data
 
388
                # 'commit' to the master first so a timeout here causes the
 
389
                # local branch to be out of date
 
390
                self.master_branch.set_last_revision_info(new_revno,
 
391
                                                          self.rev_id)
 
392
 
 
393
            # and now do the commit locally.
 
394
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
395
 
 
396
            # Make the working tree up to date with the branch
 
397
            self._set_progress_stage("Updating the working tree")
 
398
            self.work_tree.update_basis_by_delta(self.rev_id,
 
399
                 self._basis_delta)
 
400
            self.reporter.completed(new_revno, self.rev_id)
 
401
            self._process_post_hooks(old_revno, new_revno)
 
402
        finally:
 
403
            self._cleanup()
462
404
        return self.rev_id
463
405
 
464
406
    def _select_reporter(self):
473
415
        # A merge with no effect on files
474
416
        if len(self.parents) > 1:
475
417
            return
476
 
        # TODO: we could simplify this by using self.builder.basis_delta.
 
418
        # TODO: we could simplify this by using self._basis_delta.
477
419
 
478
420
        # The initial commit adds a root directory, but this in itself is not
479
421
        # a worthwhile commit.
480
422
        if (self.basis_revid == revision.NULL_REVISION and
481
 
            ((self.builder.new_inventory is not None and
482
 
             len(self.builder.new_inventory) == 1) or
483
 
            len(self.builder._basis_delta) == 1)):
 
423
            len(self.builder.new_inventory) == 1):
484
424
            raise PointlessCommit()
485
 
        if self.builder.any_changes():
 
425
        # If length == 1, then we only have the root entry. Which means
 
426
        # that there is no real difference (only the root could be different)
 
427
        # unless deletes occured, in which case the length is irrelevant.
 
428
        if (self.any_entries_deleted or 
 
429
            (len(self.builder.new_inventory) != 1 and
 
430
             self.any_entries_changed)):
486
431
            return
487
432
        raise PointlessCommit()
488
433
 
489
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
434
    def _check_bound_branch(self):
490
435
        """Check to see if the local branch is bound.
491
436
 
492
437
        If it is bound, then most of the commit will actually be
497
442
            raise errors.LocalRequiresBoundBranch()
498
443
 
499
444
        if not self.local:
500
 
            self.master_branch = self.branch.get_master_branch(
501
 
                possible_master_transports)
 
445
            self.master_branch = self.branch.get_master_branch()
502
446
 
503
447
        if not self.master_branch:
504
448
            # make this branch the reference branch for out of date checks.
515
459
        #       commits to the remote branch if they would fit.
516
460
        #       But for now, just require remote to be identical
517
461
        #       to local.
518
 
 
 
462
        
519
463
        # Make sure the local branch is identical to the master
520
464
        master_info = self.master_branch.last_revision_info()
521
465
        local_info = self.branch.last_revision_info()
527
471
        # so grab the lock
528
472
        self.bound_branch = self.branch
529
473
        self.master_branch.lock_write()
530
 
        operation.add_cleanup(self.master_branch.unlock)
 
474
        self.master_locked = True
531
475
 
532
476
    def _check_out_of_date_tree(self):
533
477
        """Check that the working tree is up to date.
578
522
    def _process_hooks(self, hook_name, old_revno, new_revno):
579
523
        if not Branch.hooks[hook_name]:
580
524
            return
581
 
 
 
525
        
582
526
        # new style commit hooks:
583
527
        if not self.bound_branch:
584
528
            hook_master = self.branch
593
537
            old_revid = self.parents[0]
594
538
        else:
595
539
            old_revid = bzrlib.revision.NULL_REVISION
596
 
 
 
540
        
597
541
        if hook_name == "pre_commit":
598
542
            future_tree = self.builder.revision_tree()
599
543
            tree_delta = future_tree.changes_from(self.basis_tree,
600
544
                                             include_root=True)
601
 
 
 
545
        
602
546
        for hook in Branch.hooks[hook_name]:
603
547
            # show the running hook in the progress bar. As hooks may
604
548
            # end up doing nothing (e.g. because they are not configured by
618
562
                     old_revno, old_revid, new_revno, self.rev_id,
619
563
                     tree_delta, future_tree)
620
564
 
 
565
    def _cleanup(self):
 
566
        """Cleanup any open locks, progress bars etc."""
 
567
        cleanups = [self._cleanup_bound_branch,
 
568
                    self.basis_tree.unlock,
 
569
                    self.work_tree.unlock,
 
570
                    self.pb.finished]
 
571
        found_exception = None
 
572
        for cleanup in cleanups:
 
573
            try:
 
574
                cleanup()
 
575
            # we want every cleanup to run no matter what.
 
576
            # so we have a catchall here, but we will raise the
 
577
            # last encountered exception up the stack: and
 
578
            # typically this will be useful enough.
 
579
            except Exception, e:
 
580
                found_exception = e
 
581
        if found_exception is not None: 
 
582
            # don't do a plan raise, because the last exception may have been
 
583
            # trashed, e is our sure-to-work exception even though it loses the
 
584
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
585
            # exc_info and if its the same one do a plain raise otherwise 
 
586
            # 'raise e' as we do now.
 
587
            raise e
 
588
 
 
589
    def _cleanup_bound_branch(self):
 
590
        """Executed at the end of a try/finally to cleanup a bound branch.
 
591
 
 
592
        If the branch wasn't bound, this is a no-op.
 
593
        If it was, it resents self.branch to the local branch, instead
 
594
        of being the master.
 
595
        """
 
596
        if not self.bound_branch:
 
597
            return
 
598
        if self.master_locked:
 
599
            self.master_branch.unlock()
 
600
 
 
601
    def _escape_commit_message(self):
 
602
        """Replace xml-incompatible control characters."""
 
603
        # FIXME: RBC 20060419 this should be done by the revision
 
604
        # serialiser not by commit. Then we can also add an unescaper
 
605
        # in the deserializer and start roundtripping revision messages
 
606
        # precisely. See repository_implementations/test_repository.py
 
607
        
 
608
        # Python strings can include characters that can't be
 
609
        # represented in well-formed XML; escape characters that
 
610
        # aren't listed in the XML specification
 
611
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
612
        self.message, escape_count = re.subn(
 
613
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
614
            lambda match: match.group(0).encode('unicode_escape'),
 
615
            self.message)
 
616
        if escape_count:
 
617
            self.reporter.escaped(escape_count, self.message)
 
618
 
621
619
    def _gather_parents(self):
622
620
        """Record the parents of a merge for merge detection."""
623
 
        # TODO: Make sure that this list doesn't contain duplicate
 
621
        # TODO: Make sure that this list doesn't contain duplicate 
624
622
        # entries and the order is preserved when doing this.
625
 
        if self.use_record_iter_changes:
626
 
            return
627
 
        self.basis_inv = self.basis_tree.inventory
 
623
        self.parents = self.work_tree.get_parent_ids()
628
624
        self.parent_invs = [self.basis_inv]
629
625
        for revision in self.parents[1:]:
630
626
            if self.branch.repository.has_revision(revision):
637
633
    def _update_builder_with_changes(self):
638
634
        """Update the commit builder with the data about what has changed.
639
635
        """
640
 
        exclude = self.exclude
 
636
        # Build the revision inventory.
 
637
        #
 
638
        # This starts by creating a new empty inventory. Depending on
 
639
        # which files are selected for commit, and what is present in the
 
640
        # current tree, the new inventory is populated. inventory entries 
 
641
        # which are candidates for modification have their revision set to
 
642
        # None; inventory entries that are carried over untouched have their
 
643
        # revision set to their prior value.
 
644
        #
 
645
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
646
        # results to create a new inventory at the same time, which results
 
647
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
648
        # ADHB 11-07-2006
 
649
 
641
650
        specific_files = self.specific_files
642
651
        mutter("Selecting files for commit with filter %s", specific_files)
643
652
 
644
 
        self._check_strict()
645
 
        if self.use_record_iter_changes:
646
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
647
 
                specific_files=specific_files)
648
 
            iter_changes = self._filter_iter_changes(iter_changes)
649
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
650
 
                self.work_tree, self.basis_revid, iter_changes):
651
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
652
 
        else:
653
 
            # Build the new inventory
654
 
            self._populate_from_inventory()
655
 
            self._record_unselected()
656
 
            self._report_and_accumulate_deletes()
657
 
 
658
 
    def _filter_iter_changes(self, iter_changes):
659
 
        """Process iter_changes.
660
 
 
661
 
        This method reports on the changes in iter_changes to the user, and 
662
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
663
 
        entries. 'missing' entries have their
664
 
 
665
 
        :param iter_changes: An iter_changes to process.
666
 
        :return: A generator of changes.
667
 
        """
668
 
        reporter = self.reporter
669
 
        report_changes = reporter.is_verbose()
670
 
        deleted_ids = []
671
 
        for change in iter_changes:
672
 
            if report_changes:
673
 
                old_path = change[1][0]
674
 
                new_path = change[1][1]
675
 
                versioned = change[3][1]
676
 
            kind = change[6][1]
677
 
            versioned = change[3][1]
678
 
            if kind is None and versioned:
679
 
                # 'missing' path
680
 
                if report_changes:
681
 
                    reporter.missing(new_path)
682
 
                deleted_ids.append(change[0])
683
 
                # Reset the new path (None) and new versioned flag (False)
684
 
                change = (change[0], (change[1][0], None), change[2],
685
 
                    (change[3][0], False)) + change[4:]
686
 
            elif kind == 'tree-reference':
687
 
                if self.recursive == 'down':
688
 
                    self._commit_nested_tree(change[0], change[1][1])
689
 
            if change[3][0] or change[3][1]:
690
 
                yield change
691
 
                if report_changes:
692
 
                    if new_path is None:
693
 
                        reporter.deleted(old_path)
694
 
                    elif old_path is None:
695
 
                        reporter.snapshot_change('added', new_path)
696
 
                    elif old_path != new_path:
697
 
                        reporter.renamed('renamed', old_path, new_path)
698
 
                    else:
699
 
                        if (new_path or 
700
 
                            self.work_tree.branch.repository._format.rich_root_data):
701
 
                            # Don't report on changes to '' in non rich root
702
 
                            # repositories.
703
 
                            reporter.snapshot_change('modified', new_path)
704
 
            self._next_progress_entry()
705
 
        # Unversion IDs that were found to be deleted
706
 
        self.deleted_ids = deleted_ids
707
 
 
708
 
    def _record_unselected(self):
 
653
        # Build the new inventory
 
654
        self._populate_from_inventory(specific_files)
 
655
 
709
656
        # If specific files are selected, then all un-selected files must be
710
657
        # recorded in their previous state. For more details, see
711
658
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
 
        if self.specific_files or self.exclude:
713
 
            specific_files = self.specific_files or []
 
659
        if specific_files:
714
660
            for path, old_ie in self.basis_inv.iter_entries():
715
661
                if old_ie.file_id in self.builder.new_inventory:
716
662
                    # already added - skip.
717
663
                    continue
718
 
                if (is_inside_any(specific_files, path)
719
 
                    and not is_inside_any(self.exclude, path)):
720
 
                    # was inside the selected path, and not excluded - if not
721
 
                    # present it has been deleted so skip.
 
664
                if is_inside_any(specific_files, path):
 
665
                    # was inside the selected path, if not present it has been
 
666
                    # deleted so skip.
722
667
                    continue
723
 
                # From here down it was either not selected, or was excluded:
724
 
                # We preserve the entry unaltered.
 
668
                if old_ie.kind == 'directory':
 
669
                    self._next_progress_entry()
 
670
                # not in final inv yet, was not in the selected files, so is an
 
671
                # entry to be preserved unaltered.
725
672
                ie = old_ie.copy()
726
673
                # Note: specific file commits after a merge are currently
727
674
                # prohibited. This test is for sanity/safety in case it's
728
675
                # required after that changes.
729
676
                if len(self.parents) > 1:
730
677
                    ie.revision = None
731
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
732
 
                    self.basis_tree, None)
 
678
                delta, version_recorded = self.builder.record_entry_contents(
 
679
                    ie, self.parent_invs, path, self.basis_tree, None)
 
680
                if version_recorded:
 
681
                    self.any_entries_changed = True
 
682
                if delta: self._basis_delta.append(delta)
733
683
 
734
684
    def _report_and_accumulate_deletes(self):
735
 
        if (isinstance(self.basis_inv, Inventory)
736
 
            and isinstance(self.builder.new_inventory, Inventory)):
737
 
            # the older Inventory classes provide a _byid dict, and building a
738
 
            # set from the keys of this dict is substantially faster than even
739
 
            # getting a set of ids from the inventory
740
 
            #
741
 
            # <lifeless> set(dict) is roughly the same speed as
742
 
            # set(iter(dict)) and both are significantly slower than
743
 
            # set(dict.keys())
744
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
745
 
               set(self.builder.new_inventory._byid.keys())
746
 
        else:
747
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
685
        # XXX: Could the list of deleted paths and ids be instead taken from
 
686
        # _populate_from_inventory?
 
687
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
688
            set(self.builder.new_inventory._byid.keys())
748
689
        if deleted_ids:
749
690
            self.any_entries_deleted = True
750
691
            deleted = [(self.basis_tree.id2path(file_id), file_id)
752
693
            deleted.sort()
753
694
            # XXX: this is not quite directory-order sorting
754
695
            for path, file_id in deleted:
755
 
                self.builder.record_delete(path, file_id)
 
696
                self._basis_delta.append((path, None, file_id, None))
756
697
                self.reporter.deleted(path)
757
698
 
758
 
    def _check_strict(self):
759
 
        # XXX: when we use iter_changes this would likely be faster if
760
 
        # iter_changes would check for us (even in the presence of
761
 
        # selected_files).
 
699
    def _populate_from_inventory(self, specific_files):
 
700
        """Populate the CommitBuilder by walking the working tree inventory."""
762
701
        if self.strict:
763
702
            # raise an exception as soon as we find a single unknown.
764
703
            for unknown in self.work_tree.unknowns():
765
704
                raise StrictCommitFailed()
766
 
 
767
 
    def _populate_from_inventory(self):
768
 
        """Populate the CommitBuilder by walking the working tree inventory."""
769
 
        # Build the revision inventory.
770
 
        #
771
 
        # This starts by creating a new empty inventory. Depending on
772
 
        # which files are selected for commit, and what is present in the
773
 
        # current tree, the new inventory is populated. inventory entries
774
 
        # which are candidates for modification have their revision set to
775
 
        # None; inventory entries that are carried over untouched have their
776
 
        # revision set to their prior value.
777
 
        #
778
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
779
 
        # results to create a new inventory at the same time, which results
780
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
781
 
        # ADHB 11-07-2006
782
 
 
783
 
        specific_files = self.specific_files
784
 
        exclude = self.exclude
 
705
               
785
706
        report_changes = self.reporter.is_verbose()
786
707
        deleted_ids = []
787
708
        # A tree of paths that have been deleted. E.g. if foo/bar has been
790
711
        # XXX: Note that entries may have the wrong kind because the entry does
791
712
        # not reflect the status on disk.
792
713
        work_inv = self.work_tree.inventory
793
 
        # NB: entries will include entries within the excluded ids/paths
794
 
        # because iter_entries_by_dir has no 'exclude' facility today.
795
714
        entries = work_inv.iter_entries_by_dir(
796
715
            specific_file_ids=self.specific_file_ids, yield_parents=True)
797
716
        for path, existing_ie in entries:
799
718
            name = existing_ie.name
800
719
            parent_id = existing_ie.parent_id
801
720
            kind = existing_ie.kind
 
721
            if kind == 'directory':
 
722
                self._next_progress_entry()
802
723
            # Skip files that have been deleted from the working tree.
803
724
            # The deleted path ids are also recorded so they can be explicitly
804
725
            # unversioned later.
817
738
                if deleted_dict is not None:
818
739
                    # the path has a deleted parent, do not add it.
819
740
                    continue
820
 
            if exclude and is_inside_any(exclude, path):
821
 
                # Skip excluded paths. Excluded paths are processed by
822
 
                # _update_builder_with_changes.
823
 
                continue
824
741
            content_summary = self.work_tree.path_content_summary(path)
825
 
            kind = content_summary[0]
826
742
            # Note that when a filter of specific files is given, we must only
827
743
            # skip/record deleted files matching that filter.
828
744
            if not specific_files or is_inside_any(specific_files, path):
829
 
                if kind == 'missing':
 
745
                if content_summary[0] == 'missing':
830
746
                    if not deleted_paths:
831
747
                        # path won't have been split yet.
832
748
                        path_segments = splitpath(path)
834
750
                    for segment in path_segments:
835
751
                        deleted_dict = deleted_dict.setdefault(segment, {})
836
752
                    self.reporter.missing(path)
837
 
                    self._next_progress_entry()
838
753
                    deleted_ids.append(file_id)
839
754
                    continue
840
755
            # TODO: have the builder do the nested commit just-in-time IF and
841
756
            # only if needed.
842
 
            if kind == 'tree-reference':
 
757
            if content_summary[0] == 'tree-reference':
843
758
                # enforce repository nested tree policy.
844
759
                if (not self.work_tree.supports_tree_reference() or
845
760
                    # repository does not support it either.
846
761
                    not self.branch.repository._format.supports_tree_reference):
847
 
                    kind = 'directory'
848
 
                    content_summary = (kind, None, None, None)
849
 
                elif self.recursive == 'down':
 
762
                    content_summary = ('directory',) + content_summary[1:]
 
763
            kind = content_summary[0]
 
764
            # TODO: specific_files filtering before nested tree processing
 
765
            if kind == 'tree-reference':
 
766
                if self.recursive == 'down':
850
767
                    nested_revision_id = self._commit_nested_tree(
851
768
                        file_id, path)
852
 
                    content_summary = (kind, None, None, nested_revision_id)
 
769
                    content_summary = content_summary[:3] + (
 
770
                        nested_revision_id,)
853
771
                else:
854
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
 
                    content_summary = (kind, None, None, nested_revision_id)
 
772
                    content_summary = content_summary[:3] + (
 
773
                        self.work_tree.get_reference_revision(file_id),)
856
774
 
857
775
            # Record an entry for this item
858
776
            # Note: I don't particularly want to have the existing_ie
864
782
                content_summary)
865
783
 
866
784
        # Unversion IDs that were found to be deleted
867
 
        self.deleted_ids = deleted_ids
 
785
        self.work_tree.unversion(deleted_ids)
868
786
 
869
787
    def _commit_nested_tree(self, file_id, path):
870
788
        "Commit a nested tree."
872
790
        # FIXME: be more comprehensive here:
873
791
        # this works when both trees are in --trees repository,
874
792
        # but when both are bound to a different repository,
875
 
        # it fails; a better way of approaching this is to
 
793
        # it fails; a better way of approaching this is to 
876
794
        # finally implement the explicit-caches approach design
877
795
        # a while back - RBC 20070306.
878
796
        if sub_tree.branch.repository.has_same_location(
902
820
        else:
903
821
            ie = existing_ie.copy()
904
822
            ie.revision = None
905
 
        # For carried over entries we don't care about the fs hash - the repo
906
 
        # isn't generating a sha, so we're not saving computation time.
907
 
        _, _, fs_hash = self.builder.record_entry_contents(
908
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
823
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
824
            self.parent_invs, path, self.work_tree, content_summary)
 
825
        if delta:
 
826
            self._basis_delta.append(delta)
 
827
        if version_recorded:
 
828
            self.any_entries_changed = True
909
829
        if report_changes:
910
830
            self._report_change(ie, path)
911
 
        if fs_hash:
912
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
913
831
        return ie
914
832
 
915
833
    def _report_change(self, ie, path):
923
841
        else:
924
842
            basis_ie = None
925
843
        change = ie.describe_change(basis_ie, ie)
926
 
        if change in (InventoryEntry.RENAMED,
 
844
        if change in (InventoryEntry.RENAMED, 
927
845
            InventoryEntry.MODIFIED_AND_RENAMED):
928
846
            old_path = self.basis_inv.id2path(ie.file_id)
929
847
            self.reporter.renamed(change, old_path, path)
930
 
            self._next_progress_entry()
931
848
        else:
932
 
            if change == 'unchanged':
933
 
                return
934
849
            self.reporter.snapshot_change(change, path)
935
 
            self._next_progress_entry()
936
850
 
937
 
    def _set_progress_stage(self, name, counter=False):
 
851
    def _set_progress_stage(self, name, entries_title=None):
938
852
        """Set the progress stage and emit an update to the progress bar."""
939
853
        self.pb_stage_name = name
940
854
        self.pb_stage_count += 1
941
 
        if counter:
 
855
        self.pb_entries_title = entries_title
 
856
        if entries_title is not None:
942
857
            self.pb_entries_count = 0
943
 
        else:
944
 
            self.pb_entries_count = None
 
858
            self.pb_entries_total = '?'
945
859
        self._emit_progress()
946
860
 
947
861
    def _next_progress_entry(self):
950
864
        self._emit_progress()
951
865
 
952
866
    def _emit_progress(self):
953
 
        if self.pb_entries_count is not None:
954
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
955
 
                self.pb_entries_count)
 
867
        if self.pb_entries_title:
 
868
            if self.pb_entries_total == '?':
 
869
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
870
                    self.pb_entries_title, self.pb_entries_count)
 
871
            else:
 
872
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
873
                    self.pb_entries_title, self.pb_entries_count,
 
874
                    str(self.pb_entries_total))
956
875
        else:
957
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
876
            text = "%s - Stage" % (self.pb_stage_name)
958
877
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
959
878
 
960
 
    def _set_specific_file_ids(self):
961
 
        """populate self.specific_file_ids if we will use it."""
962
 
        if not self.use_record_iter_changes:
963
 
            # If provided, ensure the specified files are versioned
964
 
            if self.specific_files is not None:
965
 
                # Note: This routine is being called because it raises
966
 
                # PathNotVersionedError as a side effect of finding the IDs. We
967
 
                # later use the ids we found as input to the working tree
968
 
                # inventory iterator, so we only consider those ids rather than
969
 
                # examining the whole tree again.
970
 
                # XXX: Dont we have filter_unversioned to do this more
971
 
                # cheaply?
972
 
                self.specific_file_ids = tree.find_ids_across_trees(
973
 
                    self.specific_files, [self.basis_tree, self.work_tree])
974
 
            else:
975
 
                self.specific_file_ids = None