/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 breezy/commit.py

  • Committer: Jelmer Vernooij
  • Date: 2019-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

Show diffs side-by-side

added added

removed removed

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