/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-22 03:51:03 UTC
  • mfrom: (7192.5.2 remove-more-file-ids)
  • Revision ID: breezy.the.bot@gmail.com-20181122035103-1c5jnbdx2t5yujqb
Stop actually accepting optional file_id in many Tree methods.

Merged from https://code.launchpad.net/~jelmer/brz/remove-more-file-ids/+merge/358950

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
176
205
 
177
206
    @staticmethod
178
 
    def update_revprops(revprops, branch, authors=None, author=None,
 
207
    def update_revprops(revprops, branch, authors=None,
179
208
                        local=False, possible_master_transports=None):
180
209
        if revprops is None:
181
210
            revprops = {}
182
211
        if possible_master_transports is None:
183
212
            possible_master_transports = []
184
 
        if not 'branch-nick' in revprops:
185
 
            revprops['branch-nick'] = branch._get_nick(
 
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(
186
216
                local,
187
217
                possible_master_transports)
188
218
        if authors is not None:
189
 
            if author is not None:
190
 
                raise AssertionError('Specifying both author and authors '
191
 
                        'is not allowed. Specify just authors instead')
192
 
            if 'author' in revprops or 'authors' in revprops:
 
219
            if u'author' in revprops or u'authors' in revprops:
193
220
                # XXX: maybe we should just accept one of them?
194
221
                raise AssertionError('author property given twice')
195
222
            if authors:
196
223
                for individual in authors:
197
224
                    if '\n' in individual:
198
225
                        raise AssertionError('\\n is not a valid character '
199
 
                                'in an author identity')
200
 
                revprops['authors'] = '\n'.join(authors)
201
 
        if author is not None:
202
 
            symbol_versioning.warn('The parameter author was deprecated'
203
 
                   ' in version 1.13. Use authors instead',
204
 
                   DeprecationWarning)
205
 
            if 'author' in revprops or 'authors' in revprops:
206
 
                # XXX: maybe we should just accept one of them?
207
 
                raise AssertionError('author property given twice')
208
 
            if '\n' in author:
209
 
                raise AssertionError('\\n is not a valid character '
210
 
                        'in an author identity')
211
 
            revprops['authors'] = author
 
226
                                             'in an author identity')
 
227
                revprops[u'authors'] = '\n'.join(authors)
212
228
        return revprops
213
229
 
214
230
    def commit(self,
229
245
               message_callback=None,
230
246
               recursive='down',
231
247
               exclude=None,
232
 
               possible_master_transports=None):
 
248
               possible_master_transports=None,
 
249
               lossy=False):
233
250
        """Commit working copy as a new revision.
234
251
 
235
252
        :param message: the commit message (it or message_callback is required)
236
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
 
253
        :param message_callback: A callback: message =
 
254
            message_callback(cmt_obj)
237
255
 
238
256
        :param timestamp: if not None, seconds-since-epoch for a
239
257
            postdated/predated commit.
262
280
        :param exclude: None or a list of relative paths to exclude from the
263
281
            commit. Pending changes to excluded files will be ignored by the
264
282
            commit.
 
283
        :param lossy: When committing to a foreign VCS, ignore any
 
284
            data that can not be natively represented.
265
285
        """
266
286
        operation = OperationWithCleanups(self._commit)
267
287
        self.revprops = revprops or {}
268
288
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
269
 
        self.config = config or self.config
 
289
        self.config_stack = config or self.config_stack
270
290
        return operation.run(
271
 
               message=message,
272
 
               timestamp=timestamp,
273
 
               timezone=timezone,
274
 
               committer=committer,
275
 
               specific_files=specific_files,
276
 
               rev_id=rev_id,
277
 
               allow_pointless=allow_pointless,
278
 
               strict=strict,
279
 
               verbose=verbose,
280
 
               working_tree=working_tree,
281
 
               local=local,
282
 
               reporter=reporter,
283
 
               message_callback=message_callback,
284
 
               recursive=recursive,
285
 
               exclude=exclude,
286
 
               possible_master_transports=possible_master_transports)
 
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)
287
308
 
288
309
    def _commit(self, operation, message, timestamp, timezone, committer,
289
 
            specific_files, rev_id, allow_pointless, strict, verbose,
290
 
            working_tree, local, reporter, message_callback, recursive,
291
 
            exclude, possible_master_transports):
 
310
                specific_files, rev_id, allow_pointless, strict, verbose,
 
311
                working_tree, local, reporter, message_callback, recursive,
 
312
                exclude, possible_master_transports, lossy):
292
313
        mutter('preparing to commit')
293
314
 
294
315
        if working_tree is None:
301
322
                    raise errors.RootNotRich()
302
323
        if message_callback is None:
303
324
            if message is not None:
304
 
                if isinstance(message, str):
 
325
                if isinstance(message, bytes):
305
326
                    message = message.decode(get_user_encoding())
306
 
                message_callback = lambda x: message
 
327
 
 
328
                def message_callback(x):
 
329
                    return message
307
330
            else:
308
331
                raise BzrError("The message or message_callback keyword"
309
332
                               " parameter is required for commit().")
326
349
                minimum_path_selection(specific_files))
327
350
        else:
328
351
            self.specific_files = None
329
 
            
 
352
 
330
353
        self.allow_pointless = allow_pointless
331
354
        self.message_callback = message_callback
332
355
        self.timestamp = timestamp
338
361
        self.work_tree.lock_write()
339
362
        operation.add_cleanup(self.work_tree.unlock)
340
363
        self.parents = self.work_tree.get_parent_ids()
341
 
        # We can use record_iter_changes IFF iter_changes is compatible with
342
 
        # the command line parameters, and the repository has fast delta
343
 
        # generation. See bug 347649.
344
 
        self.use_record_iter_changes = (
345
 
            not self.exclude and 
346
 
            not self.branch.repository._format.supports_tree_reference and
347
 
            (self.branch.repository._format.fast_deltas or
348
 
             len(self.parents) < 2))
349
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
364
        self.pb = ui.ui_factory.nested_progress_bar()
350
365
        operation.add_cleanup(self.pb.finished)
351
366
        self.basis_revid = self.work_tree.last_revision()
352
367
        self.basis_tree = self.work_tree.basis_tree()
360
375
        self._check_bound_branch(operation, possible_master_transports)
361
376
 
362
377
        # Check that the working tree is up to date
363
 
        old_revno, new_revno = self._check_out_of_date_tree()
 
378
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
364
379
 
365
380
        # Complete configuration setup
366
381
        if reporter is not None:
367
382
            self.reporter = reporter
368
383
        elif self.reporter is None:
369
384
            self.reporter = self._select_reporter()
370
 
        if self.config is None:
371
 
            self.config = self.branch.get_config()
372
 
 
373
 
        self._set_specific_file_ids()
 
385
        if self.config_stack is None:
 
386
            self.config_stack = self.work_tree.get_config_stack()
374
387
 
375
388
        # Setup the progress bar. As the number of files that need to be
376
389
        # committed in unknown, progress is reported as stages.
380
393
        self.pb_stage_count = 0
381
394
        self.pb_stage_total = 5
382
395
        if self.bound_branch:
383
 
            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
384
399
        self.pb.show_pct = False
385
400
        self.pb.show_spinner = False
386
401
        self.pb.show_eta = False
387
402
        self.pb.show_count = True
388
403
        self.pb.show_bar = True
389
404
 
390
 
        self._gather_parents()
391
405
        # After a merge, a selected file commit is not supported.
392
406
        # See 'bzr help merge' for an explanation as to why.
393
407
        if len(self.parents) > 1 and self.specific_files is not None:
394
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
408
            raise CannotCommitSelectedFileMerge(self.specific_files)
395
409
        # Excludes are a form of selected file commit.
396
410
        if len(self.parents) > 1 and self.exclude:
397
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
411
            raise CannotCommitSelectedFileMerge(self.exclude)
398
412
 
399
413
        # Collect the changes
400
414
        self._set_progress_stage("Collecting changes", counter=True)
401
 
        self.builder = self.branch.get_commit_builder(self.parents,
402
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
 
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")
403
425
 
404
426
        try:
405
 
            self.builder.will_record_deletes()
406
427
            # find the location being committed to
407
428
            if self.bound_branch:
408
429
                master_location = self.master_branch.base
429
450
            # Add revision data to the local branch
430
451
            self.rev_id = self.builder.commit(self.message)
431
452
 
432
 
        except Exception, e:
 
453
        except Exception:
433
454
            mutter("aborting commit write group because of exception:")
434
455
            trace.log_exception_quietly()
435
 
            note("aborting commit write group: %r" % (e,))
436
456
            self.builder.abort()
437
457
            raise
438
458
 
439
 
        self._process_pre_hooks(old_revno, new_revno)
440
 
 
441
 
        # Upload revision data to the master.
442
 
        # this will propagate merged revisions too if needed.
443
 
        if self.bound_branch:
444
 
            self._set_progress_stage("Uploading data to master branch")
445
 
            # 'commit' to the master first so a timeout here causes the
446
 
            # local branch to be out of date
447
 
            self.master_branch.import_last_revision_info(
448
 
                self.branch.repository, new_revno, self.rev_id)
449
 
 
450
 
        # and now do the commit locally.
451
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
459
        self._update_branches(old_revno, old_revid, new_revno)
452
460
 
453
461
        # Make the working tree be up to date with the branch. This
454
462
        # includes automatic changes scheduled to be made to the tree, such
455
463
        # as updating its basis and unversioning paths that were missing.
456
 
        self.work_tree.unversion(self.deleted_ids)
 
464
        self.work_tree.unversion(self.deleted_paths)
457
465
        self._set_progress_stage("Updating the working tree")
458
466
        self.work_tree.update_basis_by_delta(self.rev_id,
459
 
             self.builder.get_basis_delta())
 
467
                                             self.builder.get_basis_delta())
460
468
        self.reporter.completed(new_revno, self.rev_id)
461
469
        self._process_post_hooks(old_revno, new_revno)
462
470
        return self.rev_id
463
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
 
464
518
    def _select_reporter(self):
465
519
        """Select the CommitReporter to use."""
466
520
        if is_quiet():
473
527
        # A merge with no effect on files
474
528
        if len(self.parents) > 1:
475
529
            return
476
 
        # TODO: we could simplify this by using self.builder.basis_delta.
477
 
 
478
 
        # The initial commit adds a root directory, but this in itself is not
479
 
        # a worthwhile commit.
480
 
        if (self.basis_revid == revision.NULL_REVISION and
481
 
            ((self.builder.new_inventory is not None and
482
 
             len(self.builder.new_inventory) == 1) or
483
 
            len(self.builder._basis_delta) == 1)):
484
 
            raise PointlessCommit()
485
530
        if self.builder.any_changes():
486
531
            return
487
532
        raise PointlessCommit()
508
553
        # If the master branch is bound, we must fail
509
554
        master_bound_location = self.master_branch.get_bound_location()
510
555
        if master_bound_location:
511
 
            raise errors.CommitToDoubleBoundBranch(self.branch,
512
 
                    self.master_branch, master_bound_location)
 
556
            raise errors.CommitToDoubleBoundBranch(
 
557
                self.branch, self.master_branch, master_bound_location)
513
558
 
514
559
        # TODO: jam 20051230 We could automatically push local
515
560
        #       commits to the remote branch if they would fit.
517
562
        #       to local.
518
563
 
519
564
        # Make sure the local branch is identical to the master
520
 
        master_info = self.master_branch.last_revision_info()
521
 
        local_info = self.branch.last_revision_info()
522
 
        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:
523
568
            raise errors.BoundBranchOutOfDate(self.branch,
524
 
                    self.master_branch)
 
569
                                              self.master_branch)
525
570
 
526
571
        # Now things are ready to change the master branch
527
572
        # so grab the lock
532
577
    def _check_out_of_date_tree(self):
533
578
        """Check that the working tree is up to date.
534
579
 
535
 
        :return: old_revision_number,new_revision_number tuple
 
580
        :return: old_revision_number, old_revision_id, new_revision_number
 
581
            tuple
536
582
        """
537
583
        try:
538
584
            first_tree_parent = self.work_tree.get_parent_ids()[0]
541
587
            # this is so that we still consider the master branch
542
588
            # - in a checkout scenario the tree may have no
543
589
            # parents but the branch may do.
544
 
            first_tree_parent = bzrlib.revision.NULL_REVISION
545
 
        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)
546
596
        if master_last != first_tree_parent:
547
 
            if master_last != bzrlib.revision.NULL_REVISION:
 
597
            if master_last != breezy.revision.NULL_REVISION:
548
598
                raise errors.OutOfDateTree(self.work_tree)
549
599
        if self.branch.repository.has_revision(first_tree_parent):
550
600
            new_revno = old_revno + 1
551
601
        else:
552
602
            # ghost parents never appear in revision history.
553
603
            new_revno = 1
554
 
        return old_revno,new_revno
 
604
        return old_revno, master_last, new_revno
555
605
 
556
606
    def _process_pre_hooks(self, old_revno, new_revno):
557
607
        """Process any registered pre commit hooks."""
563
613
        # Process the post commit hooks, if any
564
614
        self._set_progress_stage("Running post_commit hooks")
565
615
        # old style commit hooks - should be deprecated ? (obsoleted in
566
 
        # 0.15)
567
 
        if self.config.post_commit() is not None:
568
 
            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(' ')
569
620
            # this would be nicer with twisted.python.reflect.namedAny
570
621
            for hook in hooks:
571
622
                result = eval(hook + '(branch, rev_id)',
572
 
                              {'branch':self.branch,
573
 
                               'bzrlib':bzrlib,
574
 
                               'rev_id':self.rev_id})
 
623
                              {'branch': self.branch,
 
624
                               'breezy': breezy,
 
625
                               'rev_id': self.rev_id})
575
626
        # process new style post commit hooks
576
627
        self._process_hooks("post_commit", old_revno, new_revno)
577
628
 
592
643
        if self.parents:
593
644
            old_revid = self.parents[0]
594
645
        else:
595
 
            old_revid = bzrlib.revision.NULL_REVISION
 
646
            old_revid = breezy.revision.NULL_REVISION
596
647
 
597
648
        if hook_name == "pre_commit":
598
649
            future_tree = self.builder.revision_tree()
599
650
            tree_delta = future_tree.changes_from(self.basis_tree,
600
 
                                             include_root=True)
 
651
                                                  include_root=True)
601
652
 
602
653
        for hook in Branch.hooks[hook_name]:
603
654
            # show the running hook in the progress bar. As hooks may
618
669
                     old_revno, old_revid, new_revno, self.rev_id,
619
670
                     tree_delta, future_tree)
620
671
 
621
 
    def _gather_parents(self):
622
 
        """Record the parents of a merge for merge detection."""
623
 
        # TODO: Make sure that this list doesn't contain duplicate
624
 
        # entries and the order is preserved when doing this.
625
 
        if self.use_record_iter_changes:
626
 
            return
627
 
        self.basis_inv = self.basis_tree.inventory
628
 
        self.parent_invs = [self.basis_inv]
629
 
        for revision in self.parents[1:]:
630
 
            if self.branch.repository.has_revision(revision):
631
 
                mutter('commit parent revision {%s}', revision)
632
 
                inventory = self.branch.repository.get_inventory(revision)
633
 
                self.parent_invs.append(inventory)
634
 
            else:
635
 
                mutter('commit parent ghost revision {%s}', revision)
636
 
 
637
672
    def _update_builder_with_changes(self):
638
673
        """Update the commit builder with the data about what has changed.
639
674
        """
640
 
        exclude = self.exclude
641
675
        specific_files = self.specific_files
642
 
        mutter("Selecting files for commit with filter %s", specific_files)
 
676
        mutter("Selecting files for commit with filter %r", specific_files)
643
677
 
644
678
        self._check_strict()
645
 
        if self.use_record_iter_changes:
646
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
647
 
                specific_files=specific_files)
648
 
            iter_changes = self._filter_iter_changes(iter_changes)
649
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
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 file_id, path, fs_hash in self.builder.record_iter_changes(
650
685
                self.work_tree, self.basis_revid, iter_changes):
651
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
652
 
        else:
653
 
            # Build the new inventory
654
 
            self._populate_from_inventory()
655
 
            self._record_unselected()
656
 
            self._report_and_accumulate_deletes()
 
686
            self.work_tree._observed_sha1(path, fs_hash)
657
687
 
658
688
    def _filter_iter_changes(self, iter_changes):
659
689
        """Process iter_changes.
660
690
 
661
 
        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
662
692
        converts 'missing' entries in the iter_changes iterator to 'deleted'
663
693
        entries. 'missing' entries have their
664
694
 
667
697
        """
668
698
        reporter = self.reporter
669
699
        report_changes = reporter.is_verbose()
670
 
        deleted_ids = []
 
700
        deleted_paths = []
671
701
        for change in iter_changes:
672
702
            if report_changes:
673
703
                old_path = change[1][0]
679
709
                # 'missing' path
680
710
                if report_changes:
681
711
                    reporter.missing(new_path)
682
 
                deleted_ids.append(change[0])
 
712
                deleted_paths.append(change[1][1])
683
713
                # Reset the new path (None) and new versioned flag (False)
684
714
                change = (change[0], (change[1][0], None), change[2],
685
 
                    (change[3][0], False)) + change[4:]
 
715
                          (change[3][0], False)) + change[4:]
 
716
                new_path = change[1][1]
 
717
                versioned = False
686
718
            elif kind == 'tree-reference':
687
719
                if self.recursive == 'down':
688
 
                    self._commit_nested_tree(change[0], change[1][1])
 
720
                    self._commit_nested_tree(change[1][1])
689
721
            if change[3][0] or change[3][1]:
690
722
                yield change
691
723
                if report_changes:
692
724
                    if new_path is None:
693
725
                        reporter.deleted(old_path)
694
726
                    elif old_path is None:
695
 
                        reporter.snapshot_change('added', new_path)
 
727
                        reporter.snapshot_change(gettext('added'), new_path)
696
728
                    elif old_path != new_path:
697
 
                        reporter.renamed('renamed', old_path, new_path)
 
729
                        reporter.renamed(gettext('renamed'),
 
730
                                         old_path, new_path)
698
731
                    else:
699
 
                        if (new_path or 
700
 
                            self.work_tree.branch.repository._format.rich_root_data):
 
732
                        if (new_path
 
733
                                or self.work_tree.branch.repository._format.rich_root_data):
701
734
                            # Don't report on changes to '' in non rich root
702
735
                            # repositories.
703
 
                            reporter.snapshot_change('modified', new_path)
 
736
                            reporter.snapshot_change(
 
737
                                gettext('modified'), new_path)
704
738
            self._next_progress_entry()
705
 
        # Unversion IDs that were found to be deleted
706
 
        self.deleted_ids = deleted_ids
707
 
 
708
 
    def _record_unselected(self):
709
 
        # If specific files are selected, then all un-selected files must be
710
 
        # recorded in their previous state. For more details, see
711
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
 
        if self.specific_files or self.exclude:
713
 
            specific_files = self.specific_files or []
714
 
            for path, old_ie in self.basis_inv.iter_entries():
715
 
                if old_ie.file_id in self.builder.new_inventory:
716
 
                    # already added - skip.
717
 
                    continue
718
 
                if (is_inside_any(specific_files, path)
719
 
                    and not is_inside_any(self.exclude, path)):
720
 
                    # was inside the selected path, and not excluded - if not
721
 
                    # present it has been deleted so skip.
722
 
                    continue
723
 
                # From here down it was either not selected, or was excluded:
724
 
                # We preserve the entry unaltered.
725
 
                ie = old_ie.copy()
726
 
                # Note: specific file commits after a merge are currently
727
 
                # prohibited. This test is for sanity/safety in case it's
728
 
                # required after that changes.
729
 
                if len(self.parents) > 1:
730
 
                    ie.revision = None
731
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
732
 
                    self.basis_tree, None)
733
 
 
734
 
    def _report_and_accumulate_deletes(self):
735
 
        if (isinstance(self.basis_inv, Inventory)
736
 
            and isinstance(self.builder.new_inventory, Inventory)):
737
 
            # the older Inventory classes provide a _byid dict, and building a
738
 
            # set from the keys of this dict is substantially faster than even
739
 
            # getting a set of ids from the inventory
740
 
            #
741
 
            # <lifeless> set(dict) is roughly the same speed as
742
 
            # set(iter(dict)) and both are significantly slower than
743
 
            # set(dict.keys())
744
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
745
 
               set(self.builder.new_inventory._byid.keys())
746
 
        else:
747
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
748
 
        if deleted_ids:
749
 
            self.any_entries_deleted = True
750
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
751
 
                for file_id in deleted_ids]
752
 
            deleted.sort()
753
 
            # XXX: this is not quite directory-order sorting
754
 
            for path, file_id in deleted:
755
 
                self.builder.record_delete(path, file_id)
756
 
                self.reporter.deleted(path)
 
739
        # Unversion files that were found to be deleted
 
740
        self.deleted_paths = deleted_paths
757
741
 
758
742
    def _check_strict(self):
759
743
        # XXX: when we use iter_changes this would likely be faster if
764
748
            for unknown in self.work_tree.unknowns():
765
749
                raise StrictCommitFailed()
766
750
 
767
 
    def _populate_from_inventory(self):
768
 
        """Populate the CommitBuilder by walking the working tree inventory."""
769
 
        # Build the revision inventory.
770
 
        #
771
 
        # This starts by creating a new empty inventory. Depending on
772
 
        # which files are selected for commit, and what is present in the
773
 
        # current tree, the new inventory is populated. inventory entries
774
 
        # which are candidates for modification have their revision set to
775
 
        # None; inventory entries that are carried over untouched have their
776
 
        # revision set to their prior value.
777
 
        #
778
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
779
 
        # results to create a new inventory at the same time, which results
780
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
781
 
        # ADHB 11-07-2006
782
 
 
783
 
        specific_files = self.specific_files
784
 
        exclude = self.exclude
785
 
        report_changes = self.reporter.is_verbose()
786
 
        deleted_ids = []
787
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
788
 
        # deleted, then we have {'foo':{'bar':{}}}
789
 
        deleted_paths = {}
790
 
        # XXX: Note that entries may have the wrong kind because the entry does
791
 
        # not reflect the status on disk.
792
 
        work_inv = self.work_tree.inventory
793
 
        # NB: entries will include entries within the excluded ids/paths
794
 
        # because iter_entries_by_dir has no 'exclude' facility today.
795
 
        entries = work_inv.iter_entries_by_dir(
796
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
797
 
        for path, existing_ie in entries:
798
 
            file_id = existing_ie.file_id
799
 
            name = existing_ie.name
800
 
            parent_id = existing_ie.parent_id
801
 
            kind = existing_ie.kind
802
 
            # Skip files that have been deleted from the working tree.
803
 
            # The deleted path ids are also recorded so they can be explicitly
804
 
            # unversioned later.
805
 
            if deleted_paths:
806
 
                path_segments = splitpath(path)
807
 
                deleted_dict = deleted_paths
808
 
                for segment in path_segments:
809
 
                    deleted_dict = deleted_dict.get(segment, None)
810
 
                    if not deleted_dict:
811
 
                        # We either took a path not present in the dict
812
 
                        # (deleted_dict was None), or we've reached an empty
813
 
                        # child dir in the dict, so are now a sub-path.
814
 
                        break
815
 
                else:
816
 
                    deleted_dict = None
817
 
                if deleted_dict is not None:
818
 
                    # the path has a deleted parent, do not add it.
819
 
                    continue
820
 
            if exclude and is_inside_any(exclude, path):
821
 
                # Skip excluded paths. Excluded paths are processed by
822
 
                # _update_builder_with_changes.
823
 
                continue
824
 
            content_summary = self.work_tree.path_content_summary(path)
825
 
            kind = content_summary[0]
826
 
            # Note that when a filter of specific files is given, we must only
827
 
            # skip/record deleted files matching that filter.
828
 
            if not specific_files or is_inside_any(specific_files, path):
829
 
                if kind == 'missing':
830
 
                    if not deleted_paths:
831
 
                        # path won't have been split yet.
832
 
                        path_segments = splitpath(path)
833
 
                    deleted_dict = deleted_paths
834
 
                    for segment in path_segments:
835
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
836
 
                    self.reporter.missing(path)
837
 
                    self._next_progress_entry()
838
 
                    deleted_ids.append(file_id)
839
 
                    continue
840
 
            # TODO: have the builder do the nested commit just-in-time IF and
841
 
            # only if needed.
842
 
            if kind == 'tree-reference':
843
 
                # enforce repository nested tree policy.
844
 
                if (not self.work_tree.supports_tree_reference() or
845
 
                    # repository does not support it either.
846
 
                    not self.branch.repository._format.supports_tree_reference):
847
 
                    kind = 'directory'
848
 
                    content_summary = (kind, None, None, None)
849
 
                elif self.recursive == 'down':
850
 
                    nested_revision_id = self._commit_nested_tree(
851
 
                        file_id, path)
852
 
                    content_summary = (kind, None, None, nested_revision_id)
853
 
                else:
854
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
 
                    content_summary = (kind, None, None, nested_revision_id)
856
 
 
857
 
            # Record an entry for this item
858
 
            # Note: I don't particularly want to have the existing_ie
859
 
            # parameter but the test suite currently (28-Jun-07) breaks
860
 
            # without it thanks to a unicode normalisation issue. :-(
861
 
            definitely_changed = kind != existing_ie.kind
862
 
            self._record_entry(path, file_id, specific_files, kind, name,
863
 
                parent_id, definitely_changed, existing_ie, report_changes,
864
 
                content_summary)
865
 
 
866
 
        # Unversion IDs that were found to be deleted
867
 
        self.deleted_ids = deleted_ids
868
 
 
869
 
    def _commit_nested_tree(self, file_id, path):
 
751
    def _commit_nested_tree(self, path):
870
752
        "Commit a nested tree."
871
 
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
753
        sub_tree = self.work_tree.get_nested_tree(path)
872
754
        # FIXME: be more comprehensive here:
873
755
        # this works when both trees are in --trees repository,
874
756
        # but when both are bound to a different repository,
876
758
        # finally implement the explicit-caches approach design
877
759
        # a while back - RBC 20070306.
878
760
        if sub_tree.branch.repository.has_same_location(
879
 
            self.work_tree.branch.repository):
 
761
                self.work_tree.branch.repository):
880
762
            sub_tree.branch.repository = \
881
763
                self.work_tree.branch.repository
882
764
        try:
883
765
            return sub_tree.commit(message=None, revprops=self.revprops,
884
 
                recursive=self.recursive,
885
 
                message_callback=self.message_callback,
886
 
                timestamp=self.timestamp, timezone=self.timezone,
887
 
                committer=self.committer,
888
 
                allow_pointless=self.allow_pointless,
889
 
                strict=self.strict, verbose=self.verbose,
890
 
                local=self.local, reporter=self.reporter)
891
 
        except errors.PointlessCommit:
892
 
            return self.work_tree.get_reference_revision(file_id)
893
 
 
894
 
    def _record_entry(self, path, file_id, specific_files, kind, name,
895
 
        parent_id, definitely_changed, existing_ie, report_changes,
896
 
        content_summary):
897
 
        "Record the new inventory entry for a path if any."
898
 
        # mutter('check %s {%s}', path, file_id)
899
 
        # mutter('%s selected for commit', path)
900
 
        if definitely_changed or existing_ie is None:
901
 
            ie = make_entry(kind, name, parent_id, file_id)
902
 
        else:
903
 
            ie = existing_ie.copy()
904
 
            ie.revision = None
905
 
        # For carried over entries we don't care about the fs hash - the repo
906
 
        # isn't generating a sha, so we're not saving computation time.
907
 
        _, _, fs_hash = self.builder.record_entry_contents(
908
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
909
 
        if report_changes:
910
 
            self._report_change(ie, path)
911
 
        if fs_hash:
912
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
913
 
        return ie
914
 
 
915
 
    def _report_change(self, ie, path):
916
 
        """Report a change to the user.
917
 
 
918
 
        The change that has occurred is described relative to the basis
919
 
        inventory.
920
 
        """
921
 
        if (self.basis_inv.has_id(ie.file_id)):
922
 
            basis_ie = self.basis_inv[ie.file_id]
923
 
        else:
924
 
            basis_ie = None
925
 
        change = ie.describe_change(basis_ie, ie)
926
 
        if change in (InventoryEntry.RENAMED,
927
 
            InventoryEntry.MODIFIED_AND_RENAMED):
928
 
            old_path = self.basis_inv.id2path(ie.file_id)
929
 
            self.reporter.renamed(change, old_path, path)
930
 
            self._next_progress_entry()
931
 
        else:
932
 
            if change == 'unchanged':
933
 
                return
934
 
            self.reporter.snapshot_change(change, path)
935
 
            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)
936
776
 
937
777
    def _set_progress_stage(self, name, counter=False):
938
778
        """Set the progress stage and emit an update to the progress bar."""
951
791
 
952
792
    def _emit_progress(self):
953
793
        if self.pb_entries_count is not None:
954
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
955
 
                self.pb_entries_count)
 
794
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
 
795
                                                       self.pb_entries_count)
956
796
        else:
957
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
797
            text = gettext("%s - Stage") % (self.pb_stage_name, )
958
798
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
959
 
 
960
 
    def _set_specific_file_ids(self):
961
 
        """populate self.specific_file_ids if we will use it."""
962
 
        if not self.use_record_iter_changes:
963
 
            # If provided, ensure the specified files are versioned
964
 
            if self.specific_files is not None:
965
 
                # Note: This routine is being called because it raises
966
 
                # PathNotVersionedError as a side effect of finding the IDs. We
967
 
                # later use the ids we found as input to the working tree
968
 
                # inventory iterator, so we only consider those ids rather than
969
 
                # examining the whole tree again.
970
 
                # XXX: Dont we have filter_unversioned to do this more
971
 
                # cheaply?
972
 
                self.specific_file_ids = tree.find_ids_across_trees(
973
 
                    self.specific_files, [self.basis_tree, self.work_tree])
974
 
            else:
975
 
                self.specific_file_ids = None