/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 .urlutils import unescape_for_display
73
 
from .i18n import gettext
74
 
 
75
 
 
76
 
class PointlessCommit(BzrError):
77
 
 
78
 
    _fmt = "No changes to commit"
79
 
 
80
 
 
81
 
class CannotCommitSelectedFileMerge(BzrError):
82
 
 
83
 
    _fmt = 'Selected-file commit of merges is not supported yet:'\
84
 
        ' files %(files_str)s'
85
 
 
86
 
    def __init__(self, files):
87
 
        files_str = ', '.join(files)
88
 
        BzrError.__init__(self, files=files, files_str=files_str)
89
 
 
90
 
 
91
 
def filter_excluded(iter_changes, exclude):
92
 
    """Filter exclude filenames.
93
 
 
94
 
    :param iter_changes: iter_changes function
95
 
    :param exclude: List of paths to exclude
96
 
    :return: iter_changes function
97
 
    """
98
 
    for change in iter_changes:
99
 
        old_path = change[1][0]
100
 
        new_path = change[1][1]
101
 
 
102
 
        new_excluded = (new_path is not None and
103
 
                        is_inside_any(exclude, new_path))
104
 
 
105
 
        old_excluded = (old_path is not None and
106
 
                        is_inside_any(exclude, old_path))
107
 
 
108
 
        if old_excluded and new_excluded:
109
 
            continue
110
 
 
111
 
        if old_excluded or new_excluded:
112
 
            # TODO(jelmer): Perhaps raise an error here instead?
113
 
            continue
114
 
 
115
 
        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
116
76
 
117
77
 
118
78
class NullCommitReporter(object):
119
79
    """I report on progress of a commit."""
120
80
 
121
 
    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)
122
86
        pass
123
87
 
124
88
    def snapshot_change(self, change, path):
150
114
        note(format, *args)
151
115
 
152
116
    def snapshot_change(self, change, path):
153
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
117
        if path == '' and change in ('added', 'modified'):
154
118
            return
155
119
        self._note("%s %s", change, path)
156
120
 
157
 
    def started(self, revno, rev_id, location):
158
 
        self._note(
159
 
            gettext('Committing to: %s'),
160
 
            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)
161
132
 
162
133
    def completed(self, revno, rev_id):
163
 
        self._note(gettext('Committed revision %d.'), revno)
 
134
        self._note('Committed revision %d.', revno)
164
135
        # self._note goes to the console too; so while we want to log the
165
136
        # rev_id, we can't trivially only log it. (See bug 526425). Long
166
137
        # term we should rearrange the reporting structure, but for now
169
140
        mutter('Committed revid %s as revno %d.', rev_id, revno)
170
141
 
171
142
    def deleted(self, path):
172
 
        self._note(gettext('deleted %s'), path)
 
143
        self._note('deleted %s', path)
173
144
 
174
145
    def missing(self, path):
175
 
        self._note(gettext('missing %s'), path)
 
146
        self._note('missing %s', path)
176
147
 
177
148
    def renamed(self, change, old_path, new_path):
178
149
        self._note('%s %s => %s', change, old_path, new_path)
193
164
            the working directory; these should be removed from the
194
165
            working inventory.
195
166
    """
196
 
 
197
167
    def __init__(self,
198
168
                 reporter=None,
199
 
                 config_stack=None):
 
169
                 config=None):
200
170
        """Create a Commit object.
201
171
 
202
172
        :param reporter: the default reporter to use or None to decide later
203
173
        """
204
174
        self.reporter = reporter
205
 
        self.config_stack = config_stack
206
 
 
207
 
    @staticmethod
208
 
    def update_revprops(revprops, branch, authors=None,
209
 
                        local=False, possible_master_transports=None):
210
 
        if revprops is None:
211
 
            revprops = {}
212
 
        if possible_master_transports is None:
213
 
            possible_master_transports = []
214
 
        if (u'branch-nick' not in revprops and
215
 
                branch.repository._format.supports_storing_branch_nick):
216
 
            revprops[u'branch-nick'] = branch._get_nick(
217
 
                local,
218
 
                possible_master_transports)
219
 
        if authors is not None:
220
 
            if u'author' in revprops or u'authors' in revprops:
221
 
                # XXX: maybe we should just accept one of them?
222
 
                raise AssertionError('author property given twice')
223
 
            if authors:
224
 
                for individual in authors:
225
 
                    if '\n' in individual:
226
 
                        raise AssertionError('\\n is not a valid character '
227
 
                                             'in an author identity')
228
 
                revprops[u'authors'] = '\n'.join(authors)
229
 
        return revprops
 
175
        self.config = config
230
176
 
231
177
    def commit(self,
232
178
               message=None,
246
192
               message_callback=None,
247
193
               recursive='down',
248
194
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
195
               possible_master_transports=None):
251
196
        """Commit working copy as a new revision.
252
197
 
253
198
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message =
255
 
            message_callback(cmt_obj)
 
199
        :param message_callback: A callback: message = message_callback(cmt_obj)
256
200
 
257
201
        :param timestamp: if not None, seconds-since-epoch for a
258
202
            postdated/predated commit.
281
225
        :param exclude: None or a list of relative paths to exclude from the
282
226
            commit. Pending changes to excluded files will be ignored by the
283
227
            commit.
284
 
        :param lossy: When committing to a foreign VCS, ignore any
285
 
            data that can not be natively represented.
286
228
        """
287
229
        operation = OperationWithCleanups(self._commit)
288
230
        self.revprops = revprops or {}
289
231
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
290
 
        self.config_stack = config or self.config_stack
 
232
        self.config = config or self.config
291
233
        return operation.run(
292
 
            message=message,
293
 
            timestamp=timestamp,
294
 
            timezone=timezone,
295
 
            committer=committer,
296
 
            specific_files=specific_files,
297
 
            rev_id=rev_id,
298
 
            allow_pointless=allow_pointless,
299
 
            strict=strict,
300
 
            verbose=verbose,
301
 
            working_tree=working_tree,
302
 
            local=local,
303
 
            reporter=reporter,
304
 
            message_callback=message_callback,
305
 
            recursive=recursive,
306
 
            exclude=exclude,
307
 
            possible_master_transports=possible_master_transports,
308
 
            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)
309
250
 
310
251
    def _commit(self, operation, message, timestamp, timezone, committer,
311
 
                specific_files, rev_id, allow_pointless, strict, verbose,
312
 
                working_tree, local, reporter, message_callback, recursive,
313
 
                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):
314
255
        mutter('preparing to commit')
315
256
 
316
257
        if working_tree is None:
323
264
                    raise errors.RootNotRich()
324
265
        if message_callback is None:
325
266
            if message is not None:
326
 
                if isinstance(message, bytes):
 
267
                if isinstance(message, str):
327
268
                    message = message.decode(get_user_encoding())
328
 
 
329
 
                def message_callback(x):
330
 
                    return message
 
269
                message_callback = lambda x: message
331
270
            else:
332
271
                raise BzrError("The message or message_callback keyword"
333
272
                               " parameter is required for commit().")
350
289
                minimum_path_selection(specific_files))
351
290
        else:
352
291
            self.specific_files = None
353
 
 
 
292
            
354
293
        self.allow_pointless = allow_pointless
355
294
        self.message_callback = message_callback
356
295
        self.timestamp = timestamp
362
301
        self.work_tree.lock_write()
363
302
        operation.add_cleanup(self.work_tree.unlock)
364
303
        self.parents = self.work_tree.get_parent_ids()
365
 
        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()
366
313
        operation.add_cleanup(self.pb.finished)
367
314
        self.basis_revid = self.work_tree.last_revision()
368
315
        self.basis_tree = self.work_tree.basis_tree()
376
323
        self._check_bound_branch(operation, possible_master_transports)
377
324
 
378
325
        # Check that the working tree is up to date
379
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
 
326
        old_revno, new_revno = self._check_out_of_date_tree()
380
327
 
381
328
        # Complete configuration setup
382
329
        if reporter is not None:
383
330
            self.reporter = reporter
384
331
        elif self.reporter is None:
385
332
            self.reporter = self._select_reporter()
386
 
        if self.config_stack is None:
387
 
            self.config_stack = self.work_tree.get_config_stack()
 
333
        if self.config is None:
 
334
            self.config = self.branch.get_config()
 
335
 
 
336
        self._set_specific_file_ids()
388
337
 
389
338
        # Setup the progress bar. As the number of files that need to be
390
339
        # committed in unknown, progress is reported as stages.
394
343
        self.pb_stage_count = 0
395
344
        self.pb_stage_total = 5
396
345
        if self.bound_branch:
397
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
398
 
            # tags to master branch"
399
 
            self.pb_stage_total += 2
 
346
            self.pb_stage_total += 1
400
347
        self.pb.show_pct = False
401
348
        self.pb.show_spinner = False
402
349
        self.pb.show_eta = False
403
350
        self.pb.show_count = True
404
351
        self.pb.show_bar = True
405
352
 
 
353
        self._gather_parents()
406
354
        # After a merge, a selected file commit is not supported.
407
355
        # See 'bzr help merge' for an explanation as to why.
408
356
        if len(self.parents) > 1 and self.specific_files is not None:
409
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
 
357
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
410
358
        # Excludes are a form of selected file commit.
411
359
        if len(self.parents) > 1 and self.exclude:
412
 
            raise CannotCommitSelectedFileMerge(self.exclude)
 
360
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
413
361
 
414
362
        # Collect the changes
415
363
        self._set_progress_stage("Collecting changes", counter=True)
416
 
        self._lossy = lossy
417
 
        self.builder = self.branch.get_commit_builder(
418
 
            self.parents, self.config_stack, timestamp, timezone, committer,
419
 
            self.revprops, rev_id, lossy=lossy)
420
 
 
421
 
        if self.builder.updates_branch and self.bound_branch:
422
 
            self.builder.abort()
423
 
            raise AssertionError(
424
 
                "bound branches not supported for commit builders "
425
 
                "that update the branch")
 
364
        self.builder = self.branch.get_commit_builder(self.parents,
 
365
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
426
366
 
427
367
        try:
 
368
            self.builder.will_record_deletes()
428
369
            # find the location being committed to
429
370
            if self.bound_branch:
430
371
                master_location = self.master_branch.base
451
392
            # Add revision data to the local branch
452
393
            self.rev_id = self.builder.commit(self.message)
453
394
 
454
 
        except Exception:
 
395
        except Exception, e:
455
396
            mutter("aborting commit write group because of exception:")
456
397
            trace.log_exception_quietly()
 
398
            note("aborting commit write group: %r" % (e,))
457
399
            self.builder.abort()
458
400
            raise
459
401
 
460
 
        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)
461
415
 
462
416
        # Make the working tree be up to date with the branch. This
463
417
        # includes automatic changes scheduled to be made to the tree, such
464
418
        # as updating its basis and unversioning paths that were missing.
465
 
        self.work_tree.unversion(self.deleted_paths)
 
419
        self.work_tree.unversion(self.deleted_ids)
466
420
        self._set_progress_stage("Updating the working tree")
467
421
        self.work_tree.update_basis_by_delta(self.rev_id,
468
 
                                             self.builder.get_basis_delta())
 
422
             self.builder.get_basis_delta())
469
423
        self.reporter.completed(new_revno, self.rev_id)
470
424
        self._process_post_hooks(old_revno, new_revno)
471
425
        return self.rev_id
472
426
 
473
 
    def _update_branches(self, old_revno, old_revid, new_revno):
474
 
        """Update the master and local branch to the new revision.
475
 
 
476
 
        This will try to make sure that the master branch is updated
477
 
        before the local branch.
478
 
 
479
 
        :param old_revno: Revision number of master branch before the
480
 
            commit
481
 
        :param old_revid: Tip of master branch before the commit
482
 
        :param new_revno: Revision number of the new commit
483
 
        """
484
 
        if not self.builder.updates_branch:
485
 
            self._process_pre_hooks(old_revno, new_revno)
486
 
 
487
 
            # Upload revision data to the master.
488
 
            # this will propagate merged revisions too if needed.
489
 
            if self.bound_branch:
490
 
                self._set_progress_stage("Uploading data to master branch")
491
 
                # 'commit' to the master first so a timeout here causes the
492
 
                # local branch to be out of date
493
 
                (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
494
 
                    self.branch, new_revno, self.rev_id, lossy=self._lossy)
495
 
                if self._lossy:
496
 
                    self.branch.fetch(self.master_branch, self.rev_id)
497
 
 
498
 
            # and now do the commit locally.
499
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
500
 
        else:
501
 
            try:
502
 
                self._process_pre_hooks(old_revno, new_revno)
503
 
            except BaseException:
504
 
                # The commit builder will already have updated the branch,
505
 
                # revert it.
506
 
                self.branch.set_last_revision_info(old_revno, old_revid)
507
 
                raise
508
 
 
509
 
        # Merge local tags to remote
510
 
        if self.bound_branch:
511
 
            self._set_progress_stage("Merging tags to master branch")
512
 
            tag_updates, tag_conflicts = self.branch.tags.merge_to(
513
 
                self.master_branch.tags)
514
 
            if tag_conflicts:
515
 
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
516
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
517
 
                    "\n".join(warning_lines))))
518
 
 
519
427
    def _select_reporter(self):
520
428
        """Select the CommitReporter to use."""
521
429
        if is_quiet():
528
436
        # A merge with no effect on files
529
437
        if len(self.parents) > 1:
530
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()
531
448
        if self.builder.any_changes():
532
449
            return
533
450
        raise PointlessCommit()
554
471
        # If the master branch is bound, we must fail
555
472
        master_bound_location = self.master_branch.get_bound_location()
556
473
        if master_bound_location:
557
 
            raise errors.CommitToDoubleBoundBranch(
558
 
                self.branch, self.master_branch, master_bound_location)
 
474
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
475
                    self.master_branch, master_bound_location)
559
476
 
560
477
        # TODO: jam 20051230 We could automatically push local
561
478
        #       commits to the remote branch if they would fit.
563
480
        #       to local.
564
481
 
565
482
        # Make sure the local branch is identical to the master
566
 
        master_revid = self.master_branch.last_revision()
567
 
        local_revid = self.branch.last_revision()
568
 
        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:
569
486
            raise errors.BoundBranchOutOfDate(self.branch,
570
 
                                              self.master_branch)
 
487
                    self.master_branch)
571
488
 
572
489
        # Now things are ready to change the master branch
573
490
        # so grab the lock
578
495
    def _check_out_of_date_tree(self):
579
496
        """Check that the working tree is up to date.
580
497
 
581
 
        :return: old_revision_number, old_revision_id, new_revision_number
582
 
            tuple
 
498
        :return: old_revision_number,new_revision_number tuple
583
499
        """
584
500
        try:
585
501
            first_tree_parent = self.work_tree.get_parent_ids()[0]
588
504
            # this is so that we still consider the master branch
589
505
            # - in a checkout scenario the tree may have no
590
506
            # parents but the branch may do.
591
 
            first_tree_parent = breezy.revision.NULL_REVISION
592
 
        try:
593
 
            old_revno, master_last = self.master_branch.last_revision_info()
594
 
        except errors.UnsupportedOperation:
595
 
            master_last = self.master_branch.last_revision()
596
 
            old_revno = self.branch.revision_id_to_revno(master_last)
 
507
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
508
        old_revno, master_last = self.master_branch.last_revision_info()
597
509
        if master_last != first_tree_parent:
598
 
            if master_last != breezy.revision.NULL_REVISION:
 
510
            if master_last != bzrlib.revision.NULL_REVISION:
599
511
                raise errors.OutOfDateTree(self.work_tree)
600
512
        if self.branch.repository.has_revision(first_tree_parent):
601
513
            new_revno = old_revno + 1
602
514
        else:
603
515
            # ghost parents never appear in revision history.
604
516
            new_revno = 1
605
 
        return old_revno, master_last, new_revno
 
517
        return old_revno,new_revno
606
518
 
607
519
    def _process_pre_hooks(self, old_revno, new_revno):
608
520
        """Process any registered pre commit hooks."""
614
526
        # Process the post commit hooks, if any
615
527
        self._set_progress_stage("Running post_commit hooks")
616
528
        # old style commit hooks - should be deprecated ? (obsoleted in
617
 
        # 0.15^H^H^H^H 2.5.0)
618
 
        post_commit = self.config_stack.get('post_commit')
619
 
        if post_commit is not None:
620
 
            hooks = post_commit.split(' ')
 
529
        # 0.15)
 
530
        if self.config.post_commit() is not None:
 
531
            hooks = self.config.post_commit().split(' ')
621
532
            # this would be nicer with twisted.python.reflect.namedAny
622
533
            for hook in hooks:
623
534
                result = eval(hook + '(branch, rev_id)',
624
 
                              {'branch': self.branch,
625
 
                               'breezy': breezy,
626
 
                               'rev_id': self.rev_id})
 
535
                              {'branch':self.branch,
 
536
                               'bzrlib':bzrlib,
 
537
                               'rev_id':self.rev_id})
627
538
        # process new style post commit hooks
628
539
        self._process_hooks("post_commit", old_revno, new_revno)
629
540
 
644
555
        if self.parents:
645
556
            old_revid = self.parents[0]
646
557
        else:
647
 
            old_revid = breezy.revision.NULL_REVISION
 
558
            old_revid = bzrlib.revision.NULL_REVISION
648
559
 
649
560
        if hook_name == "pre_commit":
650
561
            future_tree = self.builder.revision_tree()
651
562
            tree_delta = future_tree.changes_from(self.basis_tree,
652
 
                                                  include_root=True)
 
563
                                             include_root=True)
653
564
 
654
565
        for hook in Branch.hooks[hook_name]:
655
566
            # show the running hook in the progress bar. As hooks may
670
581
                     old_revno, old_revid, new_revno, self.rev_id,
671
582
                     tree_delta, future_tree)
672
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
 
673
600
    def _update_builder_with_changes(self):
674
601
        """Update the commit builder with the data about what has changed.
675
602
        """
 
603
        exclude = self.exclude
676
604
        specific_files = self.specific_files
677
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
605
        mutter("Selecting files for commit with filter %s", specific_files)
678
606
 
679
607
        self._check_strict()
680
 
        iter_changes = self.work_tree.iter_changes(
681
 
            self.basis_tree, specific_files=specific_files)
682
 
        if self.exclude:
683
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
684
 
        iter_changes = self._filter_iter_changes(iter_changes)
685
 
        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(
686
613
                self.work_tree, self.basis_revid, iter_changes):
687
 
            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()
688
620
 
689
621
    def _filter_iter_changes(self, iter_changes):
690
622
        """Process iter_changes.
691
623
 
692
 
        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 
693
625
        converts 'missing' entries in the iter_changes iterator to 'deleted'
694
626
        entries. 'missing' entries have their
695
627
 
698
630
        """
699
631
        reporter = self.reporter
700
632
        report_changes = reporter.is_verbose()
701
 
        deleted_paths = []
 
633
        deleted_ids = []
702
634
        for change in iter_changes:
703
635
            if report_changes:
704
636
                old_path = change[1][0]
710
642
                # 'missing' path
711
643
                if report_changes:
712
644
                    reporter.missing(new_path)
713
 
                if change[6][0] == 'symlink' and not self.work_tree.supports_symlinks():
714
 
                    trace.warning('Ignoring "%s" as symlinks are not '
715
 
                                  'supported on this filesystem.' % (change[1][0],))
716
 
                    continue
717
 
                deleted_paths.append(change[1][1])
 
645
                deleted_ids.append(change[0])
718
646
                # Reset the new path (None) and new versioned flag (False)
719
647
                change = (change[0], (change[1][0], None), change[2],
720
 
                          (change[3][0], False)) + change[4:]
721
 
                new_path = change[1][1]
722
 
                versioned = False
 
648
                    (change[3][0], False)) + change[4:]
723
649
            elif kind == 'tree-reference':
724
650
                if self.recursive == 'down':
725
 
                    self._commit_nested_tree(change[1][1])
 
651
                    self._commit_nested_tree(change[0], change[1][1])
726
652
            if change[3][0] or change[3][1]:
727
653
                yield change
728
654
                if report_changes:
729
655
                    if new_path is None:
730
656
                        reporter.deleted(old_path)
731
657
                    elif old_path is None:
732
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
658
                        reporter.snapshot_change('added', new_path)
733
659
                    elif old_path != new_path:
734
 
                        reporter.renamed(gettext('renamed'),
735
 
                                         old_path, new_path)
 
660
                        reporter.renamed('renamed', old_path, new_path)
736
661
                    else:
737
 
                        if (new_path
738
 
                                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):
739
664
                            # Don't report on changes to '' in non rich root
740
665
                            # repositories.
741
 
                            reporter.snapshot_change(
742
 
                                gettext('modified'), new_path)
 
666
                            reporter.snapshot_change('modified', new_path)
743
667
            self._next_progress_entry()
744
 
        # Unversion files that were found to be deleted
745
 
        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)
746
720
 
747
721
    def _check_strict(self):
748
722
        # XXX: when we use iter_changes this would likely be faster if
753
727
            for unknown in self.work_tree.unknowns():
754
728
                raise StrictCommitFailed()
755
729
 
756
 
    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):
757
833
        "Commit a nested tree."
758
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
834
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
759
835
        # FIXME: be more comprehensive here:
760
836
        # this works when both trees are in --trees repository,
761
837
        # but when both are bound to a different repository,
763
839
        # finally implement the explicit-caches approach design
764
840
        # a while back - RBC 20070306.
765
841
        if sub_tree.branch.repository.has_same_location(
766
 
                self.work_tree.branch.repository):
 
842
            self.work_tree.branch.repository):
767
843
            sub_tree.branch.repository = \
768
844
                self.work_tree.branch.repository
769
845
        try:
770
846
            return sub_tree.commit(message=None, revprops=self.revprops,
771
 
                                   recursive=self.recursive,
772
 
                                   message_callback=self.message_callback,
773
 
                                   timestamp=self.timestamp,
774
 
                                   timezone=self.timezone,
775
 
                                   committer=self.committer,
776
 
                                   allow_pointless=self.allow_pointless,
777
 
                                   strict=self.strict, verbose=self.verbose,
778
 
                                   local=self.local, reporter=self.reporter)
779
 
        except PointlessCommit:
780
 
            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()
781
899
 
782
900
    def _set_progress_stage(self, name, counter=False):
783
901
        """Set the progress stage and emit an update to the progress bar."""
796
914
 
797
915
    def _emit_progress(self):
798
916
        if self.pb_entries_count is not None:
799
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
800
 
                                                       self.pb_entries_count)
 
917
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
918
                self.pb_entries_count)
801
919
        else:
802
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
920
            text = "%s - Stage" % (self.pb_stage_name, )
803
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