/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
from bzrlib import (
54
53
    debug,
55
54
    errors,
 
55
    revision,
56
56
    trace,
57
 
    ui,
 
57
    tree,
58
58
    )
59
 
from .branch import Branch
60
 
from .cleanup import OperationWithCleanups
61
 
import breezy.config
62
 
from .errors import (BzrError,
63
 
                     ConflictsInTree,
64
 
                     StrictCommitFailed
65
 
                     )
66
 
from .osutils import (get_user_encoding,
67
 
                      has_symlinks,
68
 
                      is_inside_any,
69
 
                      minimum_path_selection,
70
 
                      )
71
 
from .trace import mutter, note, is_quiet
72
 
from .tree import TreeChange
73
 
from .urlutils import unescape_for_display
74
 
from .i18n import gettext
75
 
 
76
 
 
77
 
class PointlessCommit(BzrError):
78
 
 
79
 
    _fmt = "No changes to commit"
80
 
 
81
 
 
82
 
class CannotCommitSelectedFileMerge(BzrError):
83
 
 
84
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
85
 
        ' files %(files_str)s'
86
 
 
87
 
    def __init__(self, files):
88
 
        files_str = ', '.join(files)
89
 
        BzrError.__init__(self, files=files, files_str=files_str)
90
 
 
91
 
 
92
 
def filter_excluded(iter_changes, exclude):
93
 
    """Filter exclude filenames.
94
 
 
95
 
    :param iter_changes: iter_changes function
96
 
    :param exclude: List of paths to exclude
97
 
    :return: iter_changes function
98
 
    """
99
 
    for change in iter_changes:
100
 
        new_excluded = (change.path[1] is not None and
101
 
                        is_inside_any(exclude, change.path[1]))
102
 
 
103
 
        old_excluded = (change.path[0] is not None and
104
 
                        is_inside_any(exclude, change.path[0]))
105
 
 
106
 
        if old_excluded and new_excluded:
107
 
            continue
108
 
 
109
 
        if old_excluded or new_excluded:
110
 
            # TODO(jelmer): Perhaps raise an error here instead?
111
 
            continue
112
 
 
113
 
        yield change
 
59
from bzrlib.branch import Branch
 
60
from bzrlib.cleanup import OperationWithCleanups
 
61
import bzrlib.config
 
62
from bzrlib.errors import (BzrError, PointlessCommit,
 
63
                           ConflictsInTree,
 
64
                           StrictCommitFailed
 
65
                           )
 
66
from bzrlib.osutils import (get_user_encoding,
 
67
                            is_inside_any,
 
68
                            minimum_path_selection,
 
69
                            splitpath,
 
70
                            )
 
71
from bzrlib.trace import mutter, note, is_quiet
 
72
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
73
from bzrlib import symbol_versioning
 
74
from bzrlib.urlutils import unescape_for_display
 
75
import bzrlib.ui
114
76
 
115
77
 
116
78
class NullCommitReporter(object):
117
79
    """I report on progress of a commit."""
118
80
 
119
 
    def started(self, revno, revid, location):
 
81
    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)
120
86
        pass
121
87
 
122
88
    def snapshot_change(self, change, path):
148
114
        note(format, *args)
149
115
 
150
116
    def snapshot_change(self, change, path):
151
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
117
        if path == '' and change in ('added', 'modified'):
152
118
            return
153
119
        self._note("%s %s", change, path)
154
120
 
155
 
    def started(self, revno, rev_id, location):
156
 
        self._note(
157
 
            gettext('Committing to: %s'),
158
 
            unescape_for_display(location, 'utf-8'))
 
121
    def started(self, revno, rev_id, location=None):
 
122
        if location is not None:
 
123
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
124
        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
            location = ''
 
131
        self._note('Committing%s', location)
159
132
 
160
133
    def completed(self, revno, rev_id):
161
 
        if revno is not None:
162
 
            self._note(gettext('Committed revision %d.'), revno)
163
 
            # self._note goes to the console too; so while we want to log the
164
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
165
 
            # term we should rearrange the reporting structure, but for now
166
 
            # we just mutter seperately. We mutter the revid and revno together
167
 
            # so that concurrent bzr invocations won't lead to confusion.
168
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
169
 
        else:
170
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
134
        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)
171
141
 
172
142
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
143
        self._note('deleted %s', path)
174
144
 
175
145
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
146
        self._note('missing %s', path)
177
147
 
178
148
    def renamed(self, change, old_path, new_path):
179
149
        self._note('%s %s => %s', change, old_path, new_path)
194
164
            the working directory; these should be removed from the
195
165
            working inventory.
196
166
    """
197
 
 
198
167
    def __init__(self,
199
168
                 reporter=None,
200
 
                 config_stack=None):
 
169
                 config=None):
201
170
        """Create a Commit object.
202
171
 
203
172
        :param reporter: the default reporter to use or None to decide later
204
173
        """
205
174
        self.reporter = reporter
206
 
        self.config_stack = config_stack
207
 
 
208
 
    @staticmethod
209
 
    def update_revprops(revprops, branch, authors=None,
210
 
                        local=False, possible_master_transports=None):
211
 
        if revprops is None:
212
 
            revprops = {}
213
 
        if possible_master_transports is None:
214
 
            possible_master_transports = []
215
 
        if (u'branch-nick' not in revprops and
216
 
                branch.repository._format.supports_storing_branch_nick):
217
 
            revprops[u'branch-nick'] = branch._get_nick(
218
 
                local,
219
 
                possible_master_transports)
220
 
        if authors is not None:
221
 
            if u'author' in revprops or u'authors' in revprops:
222
 
                # XXX: maybe we should just accept one of them?
223
 
                raise AssertionError('author property given twice')
224
 
            if authors:
225
 
                for individual in authors:
226
 
                    if '\n' in individual:
227
 
                        raise AssertionError('\\n is not a valid character '
228
 
                                             'in an author identity')
229
 
                revprops[u'authors'] = '\n'.join(authors)
230
 
        return revprops
 
175
        self.config = config
231
176
 
232
177
    def commit(self,
233
178
               message=None,
247
192
               message_callback=None,
248
193
               recursive='down',
249
194
               exclude=None,
250
 
               possible_master_transports=None,
251
 
               lossy=False):
 
195
               possible_master_transports=None):
252
196
        """Commit working copy as a new revision.
253
197
 
254
198
        :param message: the commit message (it or message_callback is required)
255
 
        :param message_callback: A callback: message =
256
 
            message_callback(cmt_obj)
 
199
        :param message_callback: A callback: message = message_callback(cmt_obj)
257
200
 
258
201
        :param timestamp: if not None, seconds-since-epoch for a
259
202
            postdated/predated commit.
282
225
        :param exclude: None or a list of relative paths to exclude from the
283
226
            commit. Pending changes to excluded files will be ignored by the
284
227
            commit.
285
 
        :param lossy: When committing to a foreign VCS, ignore any
286
 
            data that can not be natively represented.
287
228
        """
288
229
        operation = OperationWithCleanups(self._commit)
289
230
        self.revprops = revprops or {}
290
231
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
291
 
        self.config_stack = config or self.config_stack
 
232
        self.config = config or self.config
292
233
        return operation.run(
293
 
            message=message,
294
 
            timestamp=timestamp,
295
 
            timezone=timezone,
296
 
            committer=committer,
297
 
            specific_files=specific_files,
298
 
            rev_id=rev_id,
299
 
            allow_pointless=allow_pointless,
300
 
            strict=strict,
301
 
            verbose=verbose,
302
 
            working_tree=working_tree,
303
 
            local=local,
304
 
            reporter=reporter,
305
 
            message_callback=message_callback,
306
 
            recursive=recursive,
307
 
            exclude=exclude,
308
 
            possible_master_transports=possible_master_transports,
309
 
            lossy=lossy)
 
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)
310
250
 
311
251
    def _commit(self, operation, message, timestamp, timezone, committer,
312
 
                specific_files, rev_id, allow_pointless, strict, verbose,
313
 
                working_tree, local, reporter, message_callback, recursive,
314
 
                exclude, possible_master_transports, lossy):
 
252
            specific_files, rev_id, allow_pointless, strict, verbose,
 
253
            working_tree, local, reporter, message_callback, recursive,
 
254
            exclude, possible_master_transports):
315
255
        mutter('preparing to commit')
316
256
 
317
257
        if working_tree is None:
324
264
                    raise errors.RootNotRich()
325
265
        if message_callback is None:
326
266
            if message is not None:
327
 
                if isinstance(message, bytes):
 
267
                if isinstance(message, str):
328
268
                    message = message.decode(get_user_encoding())
329
 
 
330
 
                def message_callback(x):
331
 
                    return message
 
269
                message_callback = lambda x: message
332
270
            else:
333
271
                raise BzrError("The message or message_callback keyword"
334
272
                               " parameter is required for commit().")
351
289
                minimum_path_selection(specific_files))
352
290
        else:
353
291
            self.specific_files = None
354
 
 
 
292
            
355
293
        self.allow_pointless = allow_pointless
356
294
        self.message_callback = message_callback
357
295
        self.timestamp = timestamp
363
301
        self.work_tree.lock_write()
364
302
        operation.add_cleanup(self.work_tree.unlock)
365
303
        self.parents = self.work_tree.get_parent_ids()
366
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
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
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
367
313
        operation.add_cleanup(self.pb.finished)
368
314
        self.basis_revid = self.work_tree.last_revision()
369
315
        self.basis_tree = self.work_tree.basis_tree()
376
322
        # Setup the bound branch variables as needed.
377
323
        self._check_bound_branch(operation, possible_master_transports)
378
324
 
379
 
        if self.config_stack is None:
380
 
            self.config_stack = self.work_tree.get_config_stack()
381
 
 
382
325
        # Check that the working tree is up to date
383
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
 
326
        old_revno, new_revno = self._check_out_of_date_tree()
384
327
 
385
328
        # Complete configuration setup
386
329
        if reporter is not None:
387
330
            self.reporter = reporter
388
331
        elif self.reporter is None:
389
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()
390
337
 
391
338
        # Setup the progress bar. As the number of files that need to be
392
339
        # committed in unknown, progress is reported as stages.
396
343
        self.pb_stage_count = 0
397
344
        self.pb_stage_total = 5
398
345
        if self.bound_branch:
399
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
400
 
            # tags to master branch"
401
 
            self.pb_stage_total += 2
 
346
            self.pb_stage_total += 1
402
347
        self.pb.show_pct = False
403
348
        self.pb.show_spinner = False
404
349
        self.pb.show_eta = False
405
350
        self.pb.show_count = True
406
351
        self.pb.show_bar = True
407
352
 
 
353
        self._gather_parents()
408
354
        # After a merge, a selected file commit is not supported.
409
355
        # See 'bzr help merge' for an explanation as to why.
410
356
        if len(self.parents) > 1 and self.specific_files is not None:
411
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
 
357
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
412
358
        # Excludes are a form of selected file commit.
413
359
        if len(self.parents) > 1 and self.exclude:
414
 
            raise CannotCommitSelectedFileMerge(self.exclude)
 
360
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
415
361
 
416
362
        # Collect the changes
417
363
        self._set_progress_stage("Collecting changes", counter=True)
418
 
        self._lossy = lossy
419
 
        self.builder = self.branch.get_commit_builder(
420
 
            self.parents, self.config_stack, timestamp, timezone, committer,
421
 
            self.revprops, rev_id, lossy=lossy)
422
 
 
423
 
        if self.builder.updates_branch and self.bound_branch:
424
 
            self.builder.abort()
425
 
            raise AssertionError(
426
 
                "bound branches not supported for commit builders "
427
 
                "that update the branch")
 
364
        self.builder = self.branch.get_commit_builder(self.parents,
 
365
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
428
366
 
429
367
        try:
 
368
            self.builder.will_record_deletes()
430
369
            # find the location being committed to
431
370
            if self.bound_branch:
432
371
                master_location = self.master_branch.base
453
392
            # Add revision data to the local branch
454
393
            self.rev_id = self.builder.commit(self.message)
455
394
 
456
 
        except Exception:
 
395
        except Exception, e:
457
396
            mutter("aborting commit write group because of exception:")
458
397
            trace.log_exception_quietly()
 
398
            note("aborting commit write group: %r" % (e,))
459
399
            self.builder.abort()
460
400
            raise
461
401
 
462
 
        self._update_branches(old_revno, old_revid, new_revno)
 
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)
463
415
 
464
416
        # Make the working tree be up to date with the branch. This
465
417
        # includes automatic changes scheduled to be made to the tree, such
466
418
        # as updating its basis and unversioning paths that were missing.
467
 
        self.work_tree.unversion(self.deleted_paths)
 
419
        self.work_tree.unversion(self.deleted_ids)
468
420
        self._set_progress_stage("Updating the working tree")
469
421
        self.work_tree.update_basis_by_delta(self.rev_id,
470
 
                                             self.builder.get_basis_delta())
 
422
             self.builder.get_basis_delta())
471
423
        self.reporter.completed(new_revno, self.rev_id)
472
424
        self._process_post_hooks(old_revno, new_revno)
473
425
        return self.rev_id
474
426
 
475
 
    def _update_branches(self, old_revno, old_revid, new_revno):
476
 
        """Update the master and local branch to the new revision.
477
 
 
478
 
        This will try to make sure that the master branch is updated
479
 
        before the local branch.
480
 
 
481
 
        :param old_revno: Revision number of master branch before the
482
 
            commit
483
 
        :param old_revid: Tip of master branch before the commit
484
 
        :param new_revno: Revision number of the new commit
485
 
        """
486
 
        if not self.builder.updates_branch:
487
 
            self._process_pre_hooks(old_revno, new_revno)
488
 
 
489
 
            # Upload revision data to the master.
490
 
            # this will propagate merged revisions too if needed.
491
 
            if self.bound_branch:
492
 
                self._set_progress_stage("Uploading data to master branch")
493
 
                # 'commit' to the master first so a timeout here causes the
494
 
                # local branch to be out of date
495
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
496
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
497
 
                if self._lossy:
498
 
                    self.branch.fetch(self.master_branch, self.rev_id)
499
 
 
500
 
            # and now do the commit locally.
501
 
            if new_revno is None:
502
 
                # Keep existing behaviour around ghosts
503
 
                new_revno = 1
504
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
505
 
        else:
506
 
            try:
507
 
                self._process_pre_hooks(old_revno, new_revno)
508
 
            except BaseException:
509
 
                # The commit builder will already have updated the branch,
510
 
                # revert it.
511
 
                self.branch.set_last_revision_info(old_revno, old_revid)
512
 
                raise
513
 
 
514
 
        # Merge local tags to remote
515
 
        if self.bound_branch:
516
 
            self._set_progress_stage("Merging tags to master branch")
517
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
518
 
                self.master_branch.tags)
519
 
            if tag_conflicts:
520
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
521
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
522
 
                    "\n".join(warning_lines))))
523
 
 
524
427
    def _select_reporter(self):
525
428
        """Select the CommitReporter to use."""
526
429
        if is_quiet():
533
436
        # A merge with no effect on files
534
437
        if len(self.parents) > 1:
535
438
            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)):
 
447
            raise PointlessCommit()
536
448
        if self.builder.any_changes():
537
449
            return
538
450
        raise PointlessCommit()
559
471
        # If the master branch is bound, we must fail
560
472
        master_bound_location = self.master_branch.get_bound_location()
561
473
        if master_bound_location:
562
 
            raise errors.CommitToDoubleBoundBranch(
563
 
                self.branch, self.master_branch, master_bound_location)
 
474
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
475
                    self.master_branch, master_bound_location)
564
476
 
565
477
        # TODO: jam 20051230 We could automatically push local
566
478
        #       commits to the remote branch if they would fit.
568
480
        #       to local.
569
481
 
570
482
        # Make sure the local branch is identical to the master
571
 
        master_revid = self.master_branch.last_revision()
572
 
        local_revid = self.branch.last_revision()
573
 
        if local_revid != master_revid:
 
483
        master_info = self.master_branch.last_revision_info()
 
484
        local_info = self.branch.last_revision_info()
 
485
        if local_info != master_info:
574
486
            raise errors.BoundBranchOutOfDate(self.branch,
575
 
                                              self.master_branch)
 
487
                    self.master_branch)
576
488
 
577
489
        # Now things are ready to change the master branch
578
490
        # so grab the lock
583
495
    def _check_out_of_date_tree(self):
584
496
        """Check that the working tree is up to date.
585
497
 
586
 
        :return: old_revision_number, old_revision_id, new_revision_number
587
 
            tuple
 
498
        :return: old_revision_number,new_revision_number tuple
588
499
        """
589
500
        try:
590
501
            first_tree_parent = self.work_tree.get_parent_ids()[0]
593
504
            # this is so that we still consider the master branch
594
505
            # - in a checkout scenario the tree may have no
595
506
            # parents but the branch may do.
596
 
            first_tree_parent = breezy.revision.NULL_REVISION
597
 
        if (self.master_branch._format.stores_revno() or
598
 
                self.config_stack.get('calculate_revnos')):
599
 
            try:
600
 
                old_revno, master_last = self.master_branch.last_revision_info()
601
 
            except errors.UnsupportedOperation:
602
 
                master_last = self.master_branch.last_revision()
603
 
                old_revno = self.branch.revision_id_to_revno(master_last)
604
 
        else:
605
 
            master_last = self.master_branch.last_revision()
606
 
            old_revno = None
 
507
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
508
        old_revno, master_last = self.master_branch.last_revision_info()
607
509
        if master_last != first_tree_parent:
608
 
            if master_last != breezy.revision.NULL_REVISION:
 
510
            if master_last != bzrlib.revision.NULL_REVISION:
609
511
                raise errors.OutOfDateTree(self.work_tree)
610
 
        if (old_revno is not None and
611
 
                self.branch.repository.has_revision(first_tree_parent)):
 
512
        if self.branch.repository.has_revision(first_tree_parent):
612
513
            new_revno = old_revno + 1
613
514
        else:
614
515
            # ghost parents never appear in revision history.
615
 
            new_revno = None
616
 
        return old_revno, master_last, new_revno
 
516
            new_revno = 1
 
517
        return old_revno,new_revno
617
518
 
618
519
    def _process_pre_hooks(self, old_revno, new_revno):
619
520
        """Process any registered pre commit hooks."""
625
526
        # Process the post commit hooks, if any
626
527
        self._set_progress_stage("Running post_commit hooks")
627
528
        # old style commit hooks - should be deprecated ? (obsoleted in
628
 
        # 0.15^H^H^H^H 2.5.0)
629
 
        post_commit = self.config_stack.get('post_commit')
630
 
        if post_commit is not None:
631
 
            hooks = post_commit.split(' ')
 
529
        # 0.15)
 
530
        if self.config.post_commit() is not None:
 
531
            hooks = self.config.post_commit().split(' ')
632
532
            # this would be nicer with twisted.python.reflect.namedAny
633
533
            for hook in hooks:
634
534
                result = eval(hook + '(branch, rev_id)',
635
 
                              {'branch': self.branch,
636
 
                               'breezy': breezy,
637
 
                               'rev_id': self.rev_id})
 
535
                              {'branch':self.branch,
 
536
                               'bzrlib':bzrlib,
 
537
                               'rev_id':self.rev_id})
638
538
        # process new style post commit hooks
639
539
        self._process_hooks("post_commit", old_revno, new_revno)
640
540
 
655
555
        if self.parents:
656
556
            old_revid = self.parents[0]
657
557
        else:
658
 
            old_revid = breezy.revision.NULL_REVISION
 
558
            old_revid = bzrlib.revision.NULL_REVISION
659
559
 
660
560
        if hook_name == "pre_commit":
661
561
            future_tree = self.builder.revision_tree()
662
562
            tree_delta = future_tree.changes_from(self.basis_tree,
663
 
                                                  include_root=True)
 
563
                                             include_root=True)
664
564
 
665
565
        for hook in Branch.hooks[hook_name]:
666
566
            # show the running hook in the progress bar. As hooks may
681
581
                     old_revno, old_revid, new_revno, self.rev_id,
682
582
                     tree_delta, future_tree)
683
583
 
 
584
    def _gather_parents(self):
 
585
        """Record the parents of a merge for merge detection."""
 
586
        # TODO: Make sure that this list doesn't contain duplicate
 
587
        # 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
 
591
        self.parent_invs = [self.basis_inv]
 
592
        for revision in self.parents[1:]:
 
593
            if self.branch.repository.has_revision(revision):
 
594
                mutter('commit parent revision {%s}', revision)
 
595
                inventory = self.branch.repository.get_inventory(revision)
 
596
                self.parent_invs.append(inventory)
 
597
            else:
 
598
                mutter('commit parent ghost revision {%s}', revision)
 
599
 
684
600
    def _update_builder_with_changes(self):
685
601
        """Update the commit builder with the data about what has changed.
686
602
        """
 
603
        exclude = self.exclude
687
604
        specific_files = self.specific_files
688
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
605
        mutter("Selecting files for commit with filter %s", specific_files)
689
606
 
690
607
        self._check_strict()
691
 
        iter_changes = self.work_tree.iter_changes(
692
 
            self.basis_tree, specific_files=specific_files)
693
 
        if self.exclude:
694
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
695
 
        iter_changes = self._filter_iter_changes(iter_changes)
696
 
        for path, fs_hash in self.builder.record_iter_changes(
 
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(
697
613
                self.work_tree, self.basis_revid, iter_changes):
698
 
            self.work_tree._observed_sha1(path, fs_hash)
 
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()
699
620
 
700
621
    def _filter_iter_changes(self, iter_changes):
701
622
        """Process iter_changes.
702
623
 
703
 
        This method reports on the changes in iter_changes to the user, and
 
624
        This method reports on the changes in iter_changes to the user, and 
704
625
        converts 'missing' entries in the iter_changes iterator to 'deleted'
705
626
        entries. 'missing' entries have their
706
627
 
709
630
        """
710
631
        reporter = self.reporter
711
632
        report_changes = reporter.is_verbose()
712
 
        deleted_paths = []
 
633
        deleted_ids = []
713
634
        for change in iter_changes:
714
635
            if report_changes:
715
 
                old_path = change.path[0]
716
 
                new_path = change.path[1]
717
 
                versioned = change.versioned[1]
718
 
            kind = change.kind[1]
719
 
            versioned = change.versioned[1]
 
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]
720
641
            if kind is None and versioned:
721
642
                # 'missing' path
722
643
                if report_changes:
723
644
                    reporter.missing(new_path)
724
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
725
 
                    trace.warning('Ignoring "%s" as symlinks are not '
726
 
                                  'supported on this filesystem.' % (change.path[0],))
727
 
                    continue
728
 
                deleted_paths.append(change[1][1])
 
645
                deleted_ids.append(change[0])
729
646
                # Reset the new path (None) and new versioned flag (False)
730
 
                change = change.discard_new()
731
 
                new_path = change.path[1]
732
 
                versioned = False
 
647
                change = (change[0], (change[1][0], None), change[2],
 
648
                    (change[3][0], False)) + change[4:]
733
649
            elif kind == 'tree-reference':
734
650
                if self.recursive == 'down':
735
 
                    self._commit_nested_tree(change[1][1])
736
 
            if change.versioned[0] or change.versioned[1]:
 
651
                    self._commit_nested_tree(change[0], change[1][1])
 
652
            if change[3][0] or change[3][1]:
737
653
                yield change
738
654
                if report_changes:
739
655
                    if new_path is None:
740
656
                        reporter.deleted(old_path)
741
657
                    elif old_path is None:
742
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
658
                        reporter.snapshot_change('added', new_path)
743
659
                    elif old_path != new_path:
744
 
                        reporter.renamed(gettext('renamed'),
745
 
                                         old_path, new_path)
 
660
                        reporter.renamed('renamed', old_path, new_path)
746
661
                    else:
747
 
                        if (new_path
748
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
662
                        if (new_path or 
 
663
                            self.work_tree.branch.repository._format.rich_root_data):
749
664
                            # Don't report on changes to '' in non rich root
750
665
                            # repositories.
751
 
                            reporter.snapshot_change(
752
 
                                gettext('modified'), new_path)
 
666
                            reporter.snapshot_change('modified', new_path)
753
667
            self._next_progress_entry()
754
 
        # Unversion files that were found to be deleted
755
 
        self.deleted_paths = deleted_paths
 
668
        # Unversion IDs that were found to be deleted
 
669
        self.deleted_ids = deleted_ids
 
670
 
 
671
    def _record_unselected(self):
 
672
        # If specific files are selected, then all un-selected files must be
 
673
        # recorded in their previous state. For more details, see
 
674
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
675
        if self.specific_files or self.exclude:
 
676
            specific_files = self.specific_files or []
 
677
            for path, old_ie in self.basis_inv.iter_entries():
 
678
                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.
 
688
                ie = old_ie.copy()
 
689
                # Note: specific file commits after a merge are currently
 
690
                # prohibited. This test is for sanity/safety in case it's
 
691
                # required after that changes.
 
692
                if len(self.parents) > 1:
 
693
                    ie.revision = None
 
694
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
695
                    self.basis_tree, None)
 
696
 
 
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:
 
712
            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)
756
720
 
757
721
    def _check_strict(self):
758
722
        # XXX: when we use iter_changes this would likely be faster if
763
727
            for unknown in self.work_tree.unknowns():
764
728
                raise StrictCommitFailed()
765
729
 
766
 
    def _commit_nested_tree(self, path):
 
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
 
748
        report_changes = self.reporter.is_verbose()
 
749
        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.
 
755
        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.
 
758
        entries = work_inv.iter_entries_by_dir(
 
759
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
760
        for path, existing_ie in entries:
 
761
            file_id = existing_ie.file_id
 
762
            name = existing_ie.name
 
763
            parent_id = existing_ie.parent_id
 
764
            kind = existing_ie.kind
 
765
            # 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)
 
819
 
 
820
            # Record an entry for this item
 
821
            # Note: I don't particularly want to have the existing_ie
 
822
            # parameter but the test suite currently (28-Jun-07) breaks
 
823
            # without it thanks to a unicode normalisation issue. :-(
 
824
            definitely_changed = kind != existing_ie.kind
 
825
            self._record_entry(path, file_id, specific_files, kind, name,
 
826
                parent_id, definitely_changed, existing_ie, report_changes,
 
827
                content_summary)
 
828
 
 
829
        # Unversion IDs that were found to be deleted
 
830
        self.deleted_ids = deleted_ids
 
831
 
 
832
    def _commit_nested_tree(self, file_id, path):
767
833
        "Commit a nested tree."
768
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
834
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
769
835
        # FIXME: be more comprehensive here:
770
836
        # this works when both trees are in --trees repository,
771
837
        # but when both are bound to a different repository,
773
839
        # finally implement the explicit-caches approach design
774
840
        # a while back - RBC 20070306.
775
841
        if sub_tree.branch.repository.has_same_location(
776
 
                self.work_tree.branch.repository):
 
842
            self.work_tree.branch.repository):
777
843
            sub_tree.branch.repository = \
778
844
                self.work_tree.branch.repository
779
845
        try:
780
846
            return sub_tree.commit(message=None, revprops=self.revprops,
781
 
                                   recursive=self.recursive,
782
 
                                   message_callback=self.message_callback,
783
 
                                   timestamp=self.timestamp,
784
 
                                   timezone=self.timezone,
785
 
                                   committer=self.committer,
786
 
                                   allow_pointless=self.allow_pointless,
787
 
                                   strict=self.strict, verbose=self.verbose,
788
 
                                   local=self.local, reporter=self.reporter)
789
 
        except PointlessCommit:
790
 
            return self.work_tree.get_reference_revision(path)
 
847
                recursive=self.recursive,
 
848
                message_callback=self.message_callback,
 
849
                timestamp=self.timestamp, timezone=self.timezone,
 
850
                committer=self.committer,
 
851
                allow_pointless=self.allow_pointless,
 
852
                strict=self.strict, verbose=self.verbose,
 
853
                local=self.local, reporter=self.reporter)
 
854
        except errors.PointlessCommit:
 
855
            return self.work_tree.get_reference_revision(file_id)
 
856
 
 
857
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
858
        parent_id, definitely_changed, existing_ie, report_changes,
 
859
        content_summary):
 
860
        "Record the new inventory entry for a path if any."
 
861
        # mutter('check %s {%s}', path, file_id)
 
862
        # mutter('%s selected for commit', path)
 
863
        if definitely_changed or existing_ie is None:
 
864
            ie = make_entry(kind, name, parent_id, file_id)
 
865
        else:
 
866
            ie = existing_ie.copy()
 
867
            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)
 
872
        if report_changes:
 
873
            self._report_change(ie, path)
 
874
        if fs_hash:
 
875
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
876
        return ie
 
877
 
 
878
    def _report_change(self, ie, path):
 
879
        """Report a change to the user.
 
880
 
 
881
        The change that has occurred is described relative to the basis
 
882
        inventory.
 
883
        """
 
884
        if (self.basis_inv.has_id(ie.file_id)):
 
885
            basis_ie = self.basis_inv[ie.file_id]
 
886
        else:
 
887
            basis_ie = None
 
888
        change = ie.describe_change(basis_ie, ie)
 
889
        if change in (InventoryEntry.RENAMED,
 
890
            InventoryEntry.MODIFIED_AND_RENAMED):
 
891
            old_path = self.basis_inv.id2path(ie.file_id)
 
892
            self.reporter.renamed(change, old_path, path)
 
893
            self._next_progress_entry()
 
894
        else:
 
895
            if change == 'unchanged':
 
896
                return
 
897
            self.reporter.snapshot_change(change, path)
 
898
            self._next_progress_entry()
791
899
 
792
900
    def _set_progress_stage(self, name, counter=False):
793
901
        """Set the progress stage and emit an update to the progress bar."""
806
914
 
807
915
    def _emit_progress(self):
808
916
        if self.pb_entries_count is not None:
809
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
810
 
                                                       self.pb_entries_count)
 
917
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
918
                self.pb_entries_count)
811
919
        else:
812
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
920
            text = "%s - Stage" % (self.pb_stage_name, )
813
921
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
922
 
 
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