/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
  • Date: 2010-04-14 00:11:32 UTC
  • mto: This revision was merged to the branch mainline in revision 5164.
  • Revision ID: gzlist@googlemail.com-20100414001132-6m1ru11mbfu87x6m
Fix os.utime test failures, three on FAT filesystems and one with readonly files

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