/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-06-15 13:39:46 UTC
  • mto: This revision was merged to the branch mainline in revision 7342.
  • Revision ID: jelmer@jelmer.uk-20190615133946-uywh9ix0lfpqw0hy
Install quilt.

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