/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2010-04-01 04:38:26 UTC
  • mto: This revision was merged to the branch mainline in revision 5128.
  • Revision ID: mbp@sourcefrog.net-20100401043826-zl8mv33nrmd1hcxp
Lazy-load sign-my-commits

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
18
# The newly committed revision is going to have a shape corresponding
20
19
# to that of the working tree.  Files that are not in the
50
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
51
50
# the rest of the code; add a deprecation of the old name.
52
51
 
53
 
from . import (
 
52
import os
 
53
import re
 
54
import sys
 
55
import time
 
56
 
 
57
from cStringIO import StringIO
 
58
 
 
59
from bzrlib import (
54
60
    debug,
55
61
    errors,
 
62
    revision,
56
63
    trace,
57
 
    ui,
 
64
    tree,
 
65
    xml_serializer,
58
66
    )
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
 
67
from bzrlib.branch import Branch
 
68
from bzrlib.cleanup import OperationWithCleanups
 
69
import bzrlib.config
 
70
from bzrlib.errors import (BzrError, PointlessCommit,
 
71
                           ConflictsInTree,
 
72
                           StrictCommitFailed
 
73
                           )
 
74
from bzrlib.osutils import (get_user_encoding,
 
75
                            kind_marker, isdir,isfile, is_inside_any,
 
76
                            is_inside_or_parent_of_any,
 
77
                            minimum_path_selection,
 
78
                            quotefn, sha_file, split_lines,
 
79
                            splitpath,
 
80
                            )
 
81
from bzrlib.testament import Testament
 
82
from bzrlib.trace import mutter, note, warning, is_quiet
 
83
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
84
from bzrlib import symbol_versioning
 
85
from bzrlib.symbol_versioning import (deprecated_passed,
 
86
        deprecated_function,
 
87
        DEPRECATED_PARAMETER)
 
88
from bzrlib.workingtree import WorkingTree
 
89
from bzrlib.urlutils import unescape_for_display
 
90
import bzrlib.ui
115
91
 
116
92
 
117
93
class NullCommitReporter(object):
118
94
    """I report on progress of a commit."""
119
95
 
120
 
    def started(self, revno, revid, location):
 
96
    def started(self, revno, revid, location=None):
 
97
        if location is None:
 
98
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
99
                                   "to started.", DeprecationWarning,
 
100
                                   stacklevel=2)
121
101
        pass
122
102
 
123
103
    def snapshot_change(self, change, path):
149
129
        note(format, *args)
150
130
 
151
131
    def snapshot_change(self, change, path):
152
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
132
        if path == '' and change in ('added', 'modified'):
153
133
            return
154
134
        self._note("%s %s", change, path)
155
135
 
156
 
    def started(self, revno, rev_id, location):
157
 
        self._note(
158
 
            gettext('Committing to: %s'),
159
 
            unescape_for_display(location, 'utf-8'))
 
136
    def started(self, revno, rev_id, location=None):
 
137
        if location is not None:
 
138
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
139
        else:
 
140
            # When started was added, location was only made optional by
 
141
            # accident.  Matt Nordhoff 20071129
 
142
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
143
                                   "to started.", DeprecationWarning,
 
144
                                   stacklevel=2)
 
145
            location = ''
 
146
        self._note('Committing%s', location)
160
147
 
161
148
    def completed(self, revno, rev_id):
162
 
        self._note(gettext('Committed revision %d.'), revno)
163
 
        # self._note goes to the console too; so while we want to log the
164
 
        # rev_id, we can't trivially only log it. (See bug 526425). Long
165
 
        # term we should rearrange the reporting structure, but for now
166
 
        # we just mutter seperately. We mutter the revid and revno together
167
 
        # so that concurrent bzr invocations won't lead to confusion.
168
 
        mutter('Committed revid %s as revno %d.', rev_id, revno)
 
149
        self._note('Committed revision %d.', revno)
169
150
 
170
151
    def deleted(self, path):
171
 
        self._note(gettext('deleted %s'), path)
 
152
        self._note('deleted %s', path)
172
153
 
173
154
    def missing(self, path):
174
 
        self._note(gettext('missing %s'), path)
 
155
        self._note('missing %s', path)
175
156
 
176
157
    def renamed(self, change, old_path, new_path):
177
158
        self._note('%s %s => %s', change, old_path, new_path)
192
173
            the working directory; these should be removed from the
193
174
            working inventory.
194
175
    """
195
 
 
196
176
    def __init__(self,
197
177
                 reporter=None,
198
 
                 config_stack=None):
 
178
                 config=None):
199
179
        """Create a Commit object.
200
180
 
201
181
        :param reporter: the default reporter to use or None to decide later
202
182
        """
203
183
        self.reporter = reporter
204
 
        self.config_stack = config_stack
205
 
 
206
 
    @staticmethod
207
 
    def update_revprops(revprops, branch, authors=None,
208
 
                        local=False, possible_master_transports=None):
209
 
        if revprops is None:
210
 
            revprops = {}
211
 
        if possible_master_transports is None:
212
 
            possible_master_transports = []
213
 
        if (u'branch-nick' not in revprops and
214
 
                branch.repository._format.supports_storing_branch_nick):
215
 
            revprops[u'branch-nick'] = branch._get_nick(
216
 
                local,
217
 
                possible_master_transports)
218
 
        if authors is not None:
219
 
            if u'author' in revprops or u'authors' in revprops:
220
 
                # XXX: maybe we should just accept one of them?
221
 
                raise AssertionError('author property given twice')
222
 
            if authors:
223
 
                for individual in authors:
224
 
                    if '\n' in individual:
225
 
                        raise AssertionError('\\n is not a valid character '
226
 
                                             'in an author identity')
227
 
                revprops[u'authors'] = '\n'.join(authors)
228
 
        return revprops
 
184
        self.config = config
229
185
 
230
186
    def commit(self,
231
187
               message=None,
245
201
               message_callback=None,
246
202
               recursive='down',
247
203
               exclude=None,
248
 
               possible_master_transports=None,
249
 
               lossy=False):
 
204
               possible_master_transports=None):
250
205
        """Commit working copy as a new revision.
251
206
 
252
207
        :param message: the commit message (it or message_callback is required)
253
 
        :param message_callback: A callback: message =
254
 
            message_callback(cmt_obj)
 
208
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
209
 
256
210
        :param timestamp: if not None, seconds-since-epoch for a
257
211
            postdated/predated commit.
280
234
        :param exclude: None or a list of relative paths to exclude from the
281
235
            commit. Pending changes to excluded files will be ignored by the
282
236
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
285
237
        """
286
238
        operation = OperationWithCleanups(self._commit)
287
 
        self.revprops = revprops or {}
288
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
289
 
        self.config_stack = config or self.config_stack
290
239
        return operation.run(
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)
 
240
               message=message,
 
241
               timestamp=timestamp,
 
242
               timezone=timezone,
 
243
               committer=committer,
 
244
               specific_files=specific_files,
 
245
               rev_id=rev_id,
 
246
               allow_pointless=allow_pointless,
 
247
               strict=strict,
 
248
               verbose=verbose,
 
249
               revprops=revprops,
 
250
               working_tree=working_tree,
 
251
               local=local,
 
252
               reporter=reporter,
 
253
               config=config,
 
254
               message_callback=message_callback,
 
255
               recursive=recursive,
 
256
               exclude=exclude,
 
257
               possible_master_transports=possible_master_transports)
308
258
 
309
259
    def _commit(self, operation, message, timestamp, timezone, committer,
310
 
                specific_files, rev_id, allow_pointless, strict, verbose,
311
 
                working_tree, local, reporter, message_callback, recursive,
312
 
                exclude, possible_master_transports, lossy):
 
260
            specific_files, rev_id, allow_pointless, strict, verbose, revprops,
 
261
            working_tree, local, reporter, config, message_callback, recursive,
 
262
            exclude, possible_master_transports):
313
263
        mutter('preparing to commit')
314
264
 
315
265
        if working_tree is None:
322
272
                    raise errors.RootNotRich()
323
273
        if message_callback is None:
324
274
            if message is not None:
325
 
                if isinstance(message, bytes):
 
275
                if isinstance(message, str):
326
276
                    message = message.decode(get_user_encoding())
327
 
 
328
 
                def message_callback(x):
329
 
                    return message
 
277
                message_callback = lambda x: message
330
278
            else:
331
279
                raise BzrError("The message or message_callback keyword"
332
280
                               " parameter is required for commit().")
349
297
                minimum_path_selection(specific_files))
350
298
        else:
351
299
            self.specific_files = None
352
 
 
 
300
            
353
301
        self.allow_pointless = allow_pointless
 
302
        self.revprops = revprops
354
303
        self.message_callback = message_callback
355
304
        self.timestamp = timestamp
356
305
        self.timezone = timezone
361
310
        self.work_tree.lock_write()
362
311
        operation.add_cleanup(self.work_tree.unlock)
363
312
        self.parents = self.work_tree.get_parent_ids()
364
 
        self.pb = ui.ui_factory.nested_progress_bar()
 
313
        # We can use record_iter_changes IFF iter_changes is compatible with
 
314
        # the command line parameters, and the repository has fast delta
 
315
        # generation. See bug 347649.
 
316
        self.use_record_iter_changes = (
 
317
            not self.exclude and 
 
318
            not self.branch.repository._format.supports_tree_reference and
 
319
            (self.branch.repository._format.fast_deltas or
 
320
             len(self.parents) < 2))
 
321
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
365
322
        operation.add_cleanup(self.pb.finished)
366
323
        self.basis_revid = self.work_tree.last_revision()
367
324
        self.basis_tree = self.work_tree.basis_tree()
375
332
        self._check_bound_branch(operation, possible_master_transports)
376
333
 
377
334
        # Check that the working tree is up to date
378
 
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
 
335
        old_revno, new_revno = self._check_out_of_date_tree()
379
336
 
380
337
        # Complete configuration setup
381
338
        if reporter is not None:
382
339
            self.reporter = reporter
383
340
        elif self.reporter is None:
384
341
            self.reporter = self._select_reporter()
385
 
        if self.config_stack is None:
386
 
            self.config_stack = self.work_tree.get_config_stack()
 
342
        if self.config is None:
 
343
            self.config = self.branch.get_config()
 
344
 
 
345
        self._set_specific_file_ids()
387
346
 
388
347
        # Setup the progress bar. As the number of files that need to be
389
348
        # committed in unknown, progress is reported as stages.
393
352
        self.pb_stage_count = 0
394
353
        self.pb_stage_total = 5
395
354
        if self.bound_branch:
396
 
            # 2 extra stages: "Uploading data to master branch" and "Merging
397
 
            # tags to master branch"
398
 
            self.pb_stage_total += 2
 
355
            self.pb_stage_total += 1
399
356
        self.pb.show_pct = False
400
357
        self.pb.show_spinner = False
401
358
        self.pb.show_eta = False
402
359
        self.pb.show_count = True
403
360
        self.pb.show_bar = True
404
361
 
 
362
        self._gather_parents()
405
363
        # After a merge, a selected file commit is not supported.
406
364
        # See 'bzr help merge' for an explanation as to why.
407
365
        if len(self.parents) > 1 and self.specific_files is not None:
408
 
            raise CannotCommitSelectedFileMerge(self.specific_files)
 
366
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
409
367
        # Excludes are a form of selected file commit.
410
368
        if len(self.parents) > 1 and self.exclude:
411
 
            raise CannotCommitSelectedFileMerge(self.exclude)
 
369
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
412
370
 
413
371
        # Collect the changes
414
372
        self._set_progress_stage("Collecting changes", counter=True)
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")
 
373
        self.builder = self.branch.get_commit_builder(self.parents,
 
374
            self.config, timestamp, timezone, committer, revprops, rev_id)
425
375
 
426
376
        try:
 
377
            self.builder.will_record_deletes()
427
378
            # find the location being committed to
428
379
            if self.bound_branch:
429
380
                master_location = self.master_branch.base
450
401
            # Add revision data to the local branch
451
402
            self.rev_id = self.builder.commit(self.message)
452
403
 
453
 
        except Exception:
 
404
        except Exception, e:
454
405
            mutter("aborting commit write group because of exception:")
455
406
            trace.log_exception_quietly()
 
407
            note("aborting commit write group: %r" % (e,))
456
408
            self.builder.abort()
457
409
            raise
458
410
 
459
 
        self._update_branches(old_revno, old_revid, new_revno)
 
411
        self._process_pre_hooks(old_revno, new_revno)
 
412
 
 
413
        # Upload revision data to the master.
 
414
        # this will propagate merged revisions too if needed.
 
415
        if self.bound_branch:
 
416
            self._set_progress_stage("Uploading data to master branch")
 
417
            # 'commit' to the master first so a timeout here causes the
 
418
            # local branch to be out of date
 
419
            self.master_branch.import_last_revision_info(
 
420
                self.branch.repository, new_revno, self.rev_id)
 
421
 
 
422
        # and now do the commit locally.
 
423
        self.branch.set_last_revision_info(new_revno, self.rev_id)
460
424
 
461
425
        # Make the working tree be up to date with the branch. This
462
426
        # includes automatic changes scheduled to be made to the tree, such
463
427
        # as updating its basis and unversioning paths that were missing.
464
 
        self.work_tree.unversion(self.deleted_paths)
 
428
        self.work_tree.unversion(self.deleted_ids)
465
429
        self._set_progress_stage("Updating the working tree")
466
430
        self.work_tree.update_basis_by_delta(self.rev_id,
467
 
                                             self.builder.get_basis_delta())
 
431
             self.builder.get_basis_delta())
468
432
        self.reporter.completed(new_revno, self.rev_id)
469
433
        self._process_post_hooks(old_revno, new_revno)
470
434
        return self.rev_id
471
435
 
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
 
 
518
436
    def _select_reporter(self):
519
437
        """Select the CommitReporter to use."""
520
438
        if is_quiet():
527
445
        # A merge with no effect on files
528
446
        if len(self.parents) > 1:
529
447
            return
 
448
        # TODO: we could simplify this by using self.builder.basis_delta.
 
449
 
 
450
        # The initial commit adds a root directory, but this in itself is not
 
451
        # a worthwhile commit.
 
452
        if (self.basis_revid == revision.NULL_REVISION and
 
453
            ((self.builder.new_inventory is not None and
 
454
             len(self.builder.new_inventory) == 1) or
 
455
            len(self.builder._basis_delta) == 1)):
 
456
            raise PointlessCommit()
530
457
        if self.builder.any_changes():
531
458
            return
532
459
        raise PointlessCommit()
553
480
        # If the master branch is bound, we must fail
554
481
        master_bound_location = self.master_branch.get_bound_location()
555
482
        if master_bound_location:
556
 
            raise errors.CommitToDoubleBoundBranch(
557
 
                self.branch, self.master_branch, master_bound_location)
 
483
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
484
                    self.master_branch, master_bound_location)
558
485
 
559
486
        # TODO: jam 20051230 We could automatically push local
560
487
        #       commits to the remote branch if they would fit.
562
489
        #       to local.
563
490
 
564
491
        # Make sure the local branch is identical to the master
565
 
        master_revid = self.master_branch.last_revision()
566
 
        local_revid = self.branch.last_revision()
567
 
        if local_revid != master_revid:
 
492
        master_info = self.master_branch.last_revision_info()
 
493
        local_info = self.branch.last_revision_info()
 
494
        if local_info != master_info:
568
495
            raise errors.BoundBranchOutOfDate(self.branch,
569
 
                                              self.master_branch)
 
496
                    self.master_branch)
570
497
 
571
498
        # Now things are ready to change the master branch
572
499
        # so grab the lock
577
504
    def _check_out_of_date_tree(self):
578
505
        """Check that the working tree is up to date.
579
506
 
580
 
        :return: old_revision_number, old_revision_id, new_revision_number
581
 
            tuple
 
507
        :return: old_revision_number,new_revision_number tuple
582
508
        """
583
509
        try:
584
510
            first_tree_parent = self.work_tree.get_parent_ids()[0]
587
513
            # this is so that we still consider the master branch
588
514
            # - in a checkout scenario the tree may have no
589
515
            # parents but the branch may do.
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)
 
516
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
517
        old_revno, master_last = self.master_branch.last_revision_info()
596
518
        if master_last != first_tree_parent:
597
 
            if master_last != breezy.revision.NULL_REVISION:
 
519
            if master_last != bzrlib.revision.NULL_REVISION:
598
520
                raise errors.OutOfDateTree(self.work_tree)
599
521
        if self.branch.repository.has_revision(first_tree_parent):
600
522
            new_revno = old_revno + 1
601
523
        else:
602
524
            # ghost parents never appear in revision history.
603
525
            new_revno = 1
604
 
        return old_revno, master_last, new_revno
 
526
        return old_revno,new_revno
605
527
 
606
528
    def _process_pre_hooks(self, old_revno, new_revno):
607
529
        """Process any registered pre commit hooks."""
613
535
        # Process the post commit hooks, if any
614
536
        self._set_progress_stage("Running post_commit hooks")
615
537
        # old style commit hooks - should be deprecated ? (obsoleted in
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(' ')
 
538
        # 0.15)
 
539
        if self.config.post_commit() is not None:
 
540
            hooks = self.config.post_commit().split(' ')
620
541
            # this would be nicer with twisted.python.reflect.namedAny
621
542
            for hook in hooks:
622
543
                result = eval(hook + '(branch, rev_id)',
623
 
                              {'branch': self.branch,
624
 
                               'breezy': breezy,
625
 
                               'rev_id': self.rev_id})
 
544
                              {'branch':self.branch,
 
545
                               'bzrlib':bzrlib,
 
546
                               'rev_id':self.rev_id})
626
547
        # process new style post commit hooks
627
548
        self._process_hooks("post_commit", old_revno, new_revno)
628
549
 
643
564
        if self.parents:
644
565
            old_revid = self.parents[0]
645
566
        else:
646
 
            old_revid = breezy.revision.NULL_REVISION
 
567
            old_revid = bzrlib.revision.NULL_REVISION
647
568
 
648
569
        if hook_name == "pre_commit":
649
570
            future_tree = self.builder.revision_tree()
650
571
            tree_delta = future_tree.changes_from(self.basis_tree,
651
 
                                                  include_root=True)
 
572
                                             include_root=True)
652
573
 
653
574
        for hook in Branch.hooks[hook_name]:
654
575
            # show the running hook in the progress bar. As hooks may
669
590
                     old_revno, old_revid, new_revno, self.rev_id,
670
591
                     tree_delta, future_tree)
671
592
 
 
593
    def _gather_parents(self):
 
594
        """Record the parents of a merge for merge detection."""
 
595
        # TODO: Make sure that this list doesn't contain duplicate
 
596
        # entries and the order is preserved when doing this.
 
597
        if self.use_record_iter_changes:
 
598
            return
 
599
        self.basis_inv = self.basis_tree.inventory
 
600
        self.parent_invs = [self.basis_inv]
 
601
        for revision in self.parents[1:]:
 
602
            if self.branch.repository.has_revision(revision):
 
603
                mutter('commit parent revision {%s}', revision)
 
604
                inventory = self.branch.repository.get_inventory(revision)
 
605
                self.parent_invs.append(inventory)
 
606
            else:
 
607
                mutter('commit parent ghost revision {%s}', revision)
 
608
 
672
609
    def _update_builder_with_changes(self):
673
610
        """Update the commit builder with the data about what has changed.
674
611
        """
 
612
        exclude = self.exclude
675
613
        specific_files = self.specific_files
676
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
614
        mutter("Selecting files for commit with filter %s", specific_files)
677
615
 
678
616
        self._check_strict()
679
 
        iter_changes = self.work_tree.iter_changes(
680
 
            self.basis_tree, specific_files=specific_files)
681
 
        if self.exclude:
682
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
683
 
        iter_changes = self._filter_iter_changes(iter_changes)
684
 
        for path, fs_hash in self.builder.record_iter_changes(
 
617
        if self.use_record_iter_changes:
 
618
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
619
                specific_files=specific_files)
 
620
            iter_changes = self._filter_iter_changes(iter_changes)
 
621
            for file_id, path, fs_hash in self.builder.record_iter_changes(
685
622
                self.work_tree, self.basis_revid, iter_changes):
686
 
            self.work_tree._observed_sha1(path, fs_hash)
 
623
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
624
        else:
 
625
            # Build the new inventory
 
626
            self._populate_from_inventory()
 
627
            self._record_unselected()
 
628
            self._report_and_accumulate_deletes()
687
629
 
688
630
    def _filter_iter_changes(self, iter_changes):
689
631
        """Process iter_changes.
690
632
 
691
 
        This method reports on the changes in iter_changes to the user, and
 
633
        This method reports on the changes in iter_changes to the user, and 
692
634
        converts 'missing' entries in the iter_changes iterator to 'deleted'
693
635
        entries. 'missing' entries have their
694
636
 
697
639
        """
698
640
        reporter = self.reporter
699
641
        report_changes = reporter.is_verbose()
700
 
        deleted_paths = []
 
642
        deleted_ids = []
701
643
        for change in iter_changes:
702
644
            if report_changes:
703
645
                old_path = change[1][0]
709
651
                # 'missing' path
710
652
                if report_changes:
711
653
                    reporter.missing(new_path)
712
 
                deleted_paths.append(change[1][1])
 
654
                deleted_ids.append(change[0])
713
655
                # Reset the new path (None) and new versioned flag (False)
714
656
                change = (change[0], (change[1][0], None), change[2],
715
 
                          (change[3][0], False)) + change[4:]
716
 
                new_path = change[1][1]
717
 
                versioned = False
 
657
                    (change[3][0], False)) + change[4:]
718
658
            elif kind == 'tree-reference':
719
659
                if self.recursive == 'down':
720
 
                    self._commit_nested_tree(change[1][1])
 
660
                    self._commit_nested_tree(change[0], change[1][1])
721
661
            if change[3][0] or change[3][1]:
722
662
                yield change
723
663
                if report_changes:
724
664
                    if new_path is None:
725
665
                        reporter.deleted(old_path)
726
666
                    elif old_path is None:
727
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
667
                        reporter.snapshot_change('added', new_path)
728
668
                    elif old_path != new_path:
729
 
                        reporter.renamed(gettext('renamed'),
730
 
                                         old_path, new_path)
 
669
                        reporter.renamed('renamed', old_path, new_path)
731
670
                    else:
732
 
                        if (new_path
733
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
671
                        if (new_path or 
 
672
                            self.work_tree.branch.repository._format.rich_root_data):
734
673
                            # Don't report on changes to '' in non rich root
735
674
                            # repositories.
736
 
                            reporter.snapshot_change(
737
 
                                gettext('modified'), new_path)
 
675
                            reporter.snapshot_change('modified', new_path)
738
676
            self._next_progress_entry()
739
 
        # Unversion files that were found to be deleted
740
 
        self.deleted_paths = deleted_paths
 
677
        # Unversion IDs that were found to be deleted
 
678
        self.deleted_ids = deleted_ids
 
679
 
 
680
    def _record_unselected(self):
 
681
        # If specific files are selected, then all un-selected files must be
 
682
        # recorded in their previous state. For more details, see
 
683
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
684
        if self.specific_files or self.exclude:
 
685
            specific_files = self.specific_files or []
 
686
            for path, old_ie in self.basis_inv.iter_entries():
 
687
                if old_ie.file_id in self.builder.new_inventory:
 
688
                    # already added - skip.
 
689
                    continue
 
690
                if (is_inside_any(specific_files, path)
 
691
                    and not is_inside_any(self.exclude, path)):
 
692
                    # was inside the selected path, and not excluded - if not
 
693
                    # present it has been deleted so skip.
 
694
                    continue
 
695
                # From here down it was either not selected, or was excluded:
 
696
                # We preserve the entry unaltered.
 
697
                ie = old_ie.copy()
 
698
                # Note: specific file commits after a merge are currently
 
699
                # prohibited. This test is for sanity/safety in case it's
 
700
                # required after that changes.
 
701
                if len(self.parents) > 1:
 
702
                    ie.revision = None
 
703
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
704
                    self.basis_tree, None)
 
705
 
 
706
    def _report_and_accumulate_deletes(self):
 
707
        if (isinstance(self.basis_inv, Inventory)
 
708
            and isinstance(self.builder.new_inventory, Inventory)):
 
709
            # the older Inventory classes provide a _byid dict, and building a
 
710
            # set from the keys of this dict is substantially faster than even
 
711
            # getting a set of ids from the inventory
 
712
            #
 
713
            # <lifeless> set(dict) is roughly the same speed as
 
714
            # set(iter(dict)) and both are significantly slower than
 
715
            # set(dict.keys())
 
716
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
717
               set(self.builder.new_inventory._byid.keys())
 
718
        else:
 
719
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
720
        if deleted_ids:
 
721
            self.any_entries_deleted = True
 
722
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
723
                for file_id in deleted_ids]
 
724
            deleted.sort()
 
725
            # XXX: this is not quite directory-order sorting
 
726
            for path, file_id in deleted:
 
727
                self.builder.record_delete(path, file_id)
 
728
                self.reporter.deleted(path)
741
729
 
742
730
    def _check_strict(self):
743
731
        # XXX: when we use iter_changes this would likely be faster if
748
736
            for unknown in self.work_tree.unknowns():
749
737
                raise StrictCommitFailed()
750
738
 
751
 
    def _commit_nested_tree(self, path):
 
739
    def _populate_from_inventory(self):
 
740
        """Populate the CommitBuilder by walking the working tree inventory."""
 
741
        # Build the revision inventory.
 
742
        #
 
743
        # This starts by creating a new empty inventory. Depending on
 
744
        # which files are selected for commit, and what is present in the
 
745
        # current tree, the new inventory is populated. inventory entries
 
746
        # which are candidates for modification have their revision set to
 
747
        # None; inventory entries that are carried over untouched have their
 
748
        # revision set to their prior value.
 
749
        #
 
750
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
751
        # results to create a new inventory at the same time, which results
 
752
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
753
        # ADHB 11-07-2006
 
754
 
 
755
        specific_files = self.specific_files
 
756
        exclude = self.exclude
 
757
        report_changes = self.reporter.is_verbose()
 
758
        deleted_ids = []
 
759
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
760
        # deleted, then we have {'foo':{'bar':{}}}
 
761
        deleted_paths = {}
 
762
        # XXX: Note that entries may have the wrong kind because the entry does
 
763
        # not reflect the status on disk.
 
764
        work_inv = self.work_tree.inventory
 
765
        # NB: entries will include entries within the excluded ids/paths
 
766
        # because iter_entries_by_dir has no 'exclude' facility today.
 
767
        entries = work_inv.iter_entries_by_dir(
 
768
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
769
        for path, existing_ie in entries:
 
770
            file_id = existing_ie.file_id
 
771
            name = existing_ie.name
 
772
            parent_id = existing_ie.parent_id
 
773
            kind = existing_ie.kind
 
774
            # Skip files that have been deleted from the working tree.
 
775
            # The deleted path ids are also recorded so they can be explicitly
 
776
            # unversioned later.
 
777
            if deleted_paths:
 
778
                path_segments = splitpath(path)
 
779
                deleted_dict = deleted_paths
 
780
                for segment in path_segments:
 
781
                    deleted_dict = deleted_dict.get(segment, None)
 
782
                    if not deleted_dict:
 
783
                        # We either took a path not present in the dict
 
784
                        # (deleted_dict was None), or we've reached an empty
 
785
                        # child dir in the dict, so are now a sub-path.
 
786
                        break
 
787
                else:
 
788
                    deleted_dict = None
 
789
                if deleted_dict is not None:
 
790
                    # the path has a deleted parent, do not add it.
 
791
                    continue
 
792
            if exclude and is_inside_any(exclude, path):
 
793
                # Skip excluded paths. Excluded paths are processed by
 
794
                # _update_builder_with_changes.
 
795
                continue
 
796
            content_summary = self.work_tree.path_content_summary(path)
 
797
            kind = content_summary[0]
 
798
            # Note that when a filter of specific files is given, we must only
 
799
            # skip/record deleted files matching that filter.
 
800
            if not specific_files or is_inside_any(specific_files, path):
 
801
                if kind == 'missing':
 
802
                    if not deleted_paths:
 
803
                        # path won't have been split yet.
 
804
                        path_segments = splitpath(path)
 
805
                    deleted_dict = deleted_paths
 
806
                    for segment in path_segments:
 
807
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
808
                    self.reporter.missing(path)
 
809
                    self._next_progress_entry()
 
810
                    deleted_ids.append(file_id)
 
811
                    continue
 
812
            # TODO: have the builder do the nested commit just-in-time IF and
 
813
            # only if needed.
 
814
            if kind == 'tree-reference':
 
815
                # enforce repository nested tree policy.
 
816
                if (not self.work_tree.supports_tree_reference() or
 
817
                    # repository does not support it either.
 
818
                    not self.branch.repository._format.supports_tree_reference):
 
819
                    kind = 'directory'
 
820
                    content_summary = (kind, None, None, None)
 
821
                elif self.recursive == 'down':
 
822
                    nested_revision_id = self._commit_nested_tree(
 
823
                        file_id, path)
 
824
                    content_summary = (kind, None, None, nested_revision_id)
 
825
                else:
 
826
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
827
                    content_summary = (kind, None, None, nested_revision_id)
 
828
 
 
829
            # Record an entry for this item
 
830
            # Note: I don't particularly want to have the existing_ie
 
831
            # parameter but the test suite currently (28-Jun-07) breaks
 
832
            # without it thanks to a unicode normalisation issue. :-(
 
833
            definitely_changed = kind != existing_ie.kind
 
834
            self._record_entry(path, file_id, specific_files, kind, name,
 
835
                parent_id, definitely_changed, existing_ie, report_changes,
 
836
                content_summary)
 
837
 
 
838
        # Unversion IDs that were found to be deleted
 
839
        self.deleted_ids = deleted_ids
 
840
 
 
841
    def _commit_nested_tree(self, file_id, path):
752
842
        "Commit a nested tree."
753
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
843
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
754
844
        # FIXME: be more comprehensive here:
755
845
        # this works when both trees are in --trees repository,
756
846
        # but when both are bound to a different repository,
758
848
        # finally implement the explicit-caches approach design
759
849
        # a while back - RBC 20070306.
760
850
        if sub_tree.branch.repository.has_same_location(
761
 
                self.work_tree.branch.repository):
 
851
            self.work_tree.branch.repository):
762
852
            sub_tree.branch.repository = \
763
853
                self.work_tree.branch.repository
764
854
        try:
765
855
            return sub_tree.commit(message=None, revprops=self.revprops,
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)
 
856
                recursive=self.recursive,
 
857
                message_callback=self.message_callback,
 
858
                timestamp=self.timestamp, timezone=self.timezone,
 
859
                committer=self.committer,
 
860
                allow_pointless=self.allow_pointless,
 
861
                strict=self.strict, verbose=self.verbose,
 
862
                local=self.local, reporter=self.reporter)
 
863
        except errors.PointlessCommit:
 
864
            return self.work_tree.get_reference_revision(file_id)
 
865
 
 
866
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
867
        parent_id, definitely_changed, existing_ie, report_changes,
 
868
        content_summary):
 
869
        "Record the new inventory entry for a path if any."
 
870
        # mutter('check %s {%s}', path, file_id)
 
871
        # mutter('%s selected for commit', path)
 
872
        if definitely_changed or existing_ie is None:
 
873
            ie = make_entry(kind, name, parent_id, file_id)
 
874
        else:
 
875
            ie = existing_ie.copy()
 
876
            ie.revision = None
 
877
        # For carried over entries we don't care about the fs hash - the repo
 
878
        # isn't generating a sha, so we're not saving computation time.
 
879
        _, _, fs_hash = self.builder.record_entry_contents(
 
880
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
881
        if report_changes:
 
882
            self._report_change(ie, path)
 
883
        if fs_hash:
 
884
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
885
        return ie
 
886
 
 
887
    def _report_change(self, ie, path):
 
888
        """Report a change to the user.
 
889
 
 
890
        The change that has occurred is described relative to the basis
 
891
        inventory.
 
892
        """
 
893
        if (self.basis_inv.has_id(ie.file_id)):
 
894
            basis_ie = self.basis_inv[ie.file_id]
 
895
        else:
 
896
            basis_ie = None
 
897
        change = ie.describe_change(basis_ie, ie)
 
898
        if change in (InventoryEntry.RENAMED,
 
899
            InventoryEntry.MODIFIED_AND_RENAMED):
 
900
            old_path = self.basis_inv.id2path(ie.file_id)
 
901
            self.reporter.renamed(change, old_path, path)
 
902
            self._next_progress_entry()
 
903
        else:
 
904
            if change == 'unchanged':
 
905
                return
 
906
            self.reporter.snapshot_change(change, path)
 
907
            self._next_progress_entry()
776
908
 
777
909
    def _set_progress_stage(self, name, counter=False):
778
910
        """Set the progress stage and emit an update to the progress bar."""
791
923
 
792
924
    def _emit_progress(self):
793
925
        if self.pb_entries_count is not None:
794
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
795
 
                                                       self.pb_entries_count)
 
926
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
927
                self.pb_entries_count)
796
928
        else:
797
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
929
            text = "%s - Stage" % (self.pb_stage_name, )
798
930
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
931
 
 
932
    def _set_specific_file_ids(self):
 
933
        """populate self.specific_file_ids if we will use it."""
 
934
        if not self.use_record_iter_changes:
 
935
            # If provided, ensure the specified files are versioned
 
936
            if self.specific_files is not None:
 
937
                # Note: This routine is being called because it raises
 
938
                # PathNotVersionedError as a side effect of finding the IDs. We
 
939
                # later use the ids we found as input to the working tree
 
940
                # inventory iterator, so we only consider those ids rather than
 
941
                # examining the whole tree again.
 
942
                # XXX: Dont we have filter_unversioned to do this more
 
943
                # cheaply?
 
944
                self.specific_file_ids = tree.find_ids_across_trees(
 
945
                    self.specific_files, [self.basis_tree, self.work_tree])
 
946
            else:
 
947
                self.specific_file_ids = None