/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: Richard Wilbur
  • Date: 2016-02-04 19:07:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6618.
  • Revision ID: richard.wilbur@gmail.com-20160204190728-p0zvfii6zase0fw7
Update COPYING.txt from the original http://www.gnu.org/licenses/gpl-2.0.txt  (Only differences were in whitespace.)  Thanks to Petr Stodulka for pointing out the discrepancy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
# The newly committed revision is going to have a shape corresponding
18
20
# to that of the working tree.  Files that are not in the
19
21
# working tree and that were in the predecessor are reported as
48
50
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
49
51
# the rest of the code; add a deprecation of the old name.
50
52
 
51
 
from . import (
 
53
from bzrlib import (
52
54
    debug,
53
55
    errors,
54
56
    trace,
 
57
    tree,
55
58
    ui,
56
59
    )
57
 
from .branch import Branch
58
 
from contextlib import ExitStack
59
 
import breezy.config
60
 
from .errors import (BzrError,
61
 
                     ConflictsInTree,
62
 
                     StrictCommitFailed
63
 
                     )
64
 
from .osutils import (get_user_encoding,
65
 
                      has_symlinks,
66
 
                      is_inside_any,
67
 
                      minimum_path_selection,
68
 
                      )
69
 
from .trace import mutter, note, is_quiet
70
 
from .tree import TreeChange
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
 
        new_excluded = (change.path[1] is not None and
99
 
                        is_inside_any(exclude, change.path[1]))
100
 
 
101
 
        old_excluded = (change.path[0] is not None and
102
 
                        is_inside_any(exclude, change.path[0]))
103
 
 
104
 
        if old_excluded and new_excluded:
105
 
            continue
106
 
 
107
 
        if old_excluded or new_excluded:
108
 
            # TODO(jelmer): Perhaps raise an error here instead?
109
 
            continue
110
 
 
111
 
        yield change
112
 
 
 
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
 
62
import bzrlib.config
 
63
from bzrlib.errors import (BzrError, PointlessCommit,
 
64
                           ConflictsInTree,
 
65
                           StrictCommitFailed
 
66
                           )
 
67
from bzrlib.osutils import (get_user_encoding,
 
68
                            is_inside_any,
 
69
                            minimum_path_selection,
 
70
                            splitpath,
 
71
                            )
 
72
from bzrlib.trace import mutter, note, is_quiet
 
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib import symbol_versioning
 
75
from bzrlib.urlutils import unescape_for_display
 
76
from bzrlib.i18n import gettext
113
77
 
114
78
class NullCommitReporter(object):
115
79
    """I report on progress of a commit."""
116
80
 
117
 
    def started(self, revno, revid, location):
 
81
    def started(self, revno, revid, location=None):
 
82
        if location is None:
 
83
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
84
                                   "to started.", DeprecationWarning,
 
85
                                   stacklevel=2)
118
86
        pass
119
87
 
120
88
    def snapshot_change(self, change, path):
150
118
            return
151
119
        self._note("%s %s", change, path)
152
120
 
153
 
    def started(self, revno, rev_id, location):
154
 
        self._note(
155
 
            gettext('Committing to: %s'),
156
 
            unescape_for_display(location, 'utf-8'))
 
121
    def started(self, revno, rev_id, location=None):
 
122
        if location is not None:
 
123
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
124
        else:
 
125
            # When started was added, location was only made optional by
 
126
            # accident.  Matt Nordhoff 20071129
 
127
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
128
                                   "to started.", DeprecationWarning,
 
129
                                   stacklevel=2)
 
130
            location = ''
 
131
        self._note(gettext('Committing%s'), location)
157
132
 
158
133
    def completed(self, revno, rev_id):
159
 
        if revno is not None:
160
 
            self._note(gettext('Committed revision %d.'), revno)
161
 
            # self._note goes to the console too; so while we want to log the
162
 
            # rev_id, we can't trivially only log it. (See bug 526425). Long
163
 
            # term we should rearrange the reporting structure, but for now
164
 
            # we just mutter seperately. We mutter the revid and revno together
165
 
            # so that concurrent bzr invocations won't lead to confusion.
166
 
            mutter('Committed revid %s as revno %d.', rev_id, revno)
167
 
        else:
168
 
            self._note(gettext('Committed revid %s.'), rev_id)
 
134
        self._note(gettext('Committed revision %d.'), revno)
 
135
        # self._note goes to the console too; so while we want to log the
 
136
        # rev_id, we can't trivially only log it. (See bug 526425). Long
 
137
        # term we should rearrange the reporting structure, but for now
 
138
        # we just mutter seperately. We mutter the revid and revno together
 
139
        # so that concurrent bzr invocations won't lead to confusion.
 
140
        mutter('Committed revid %s as revno %d.', rev_id, revno)
169
141
 
170
142
    def deleted(self, path):
171
143
        self._note(gettext('deleted %s'), path)
192
164
            the working directory; these should be removed from the
193
165
            working inventory.
194
166
    """
195
 
 
196
167
    def __init__(self,
197
168
                 reporter=None,
198
169
                 config_stack=None):
204
175
        self.config_stack = config_stack
205
176
 
206
177
    @staticmethod
207
 
    def update_revprops(revprops, branch, authors=None,
 
178
    def update_revprops(revprops, branch, authors=None, author=None,
208
179
                        local=False, possible_master_transports=None):
209
180
        if revprops is None:
210
181
            revprops = {}
211
182
        if possible_master_transports is None:
212
183
            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(
 
184
        if not 'branch-nick' in revprops:
 
185
            revprops['branch-nick'] = branch._get_nick(
216
186
                local,
217
187
                possible_master_transports)
218
188
        if authors is not None:
219
 
            if u'author' in revprops or u'authors' in revprops:
 
189
            if author is not None:
 
190
                raise AssertionError('Specifying both author and authors '
 
191
                        'is not allowed. Specify just authors instead')
 
192
            if 'author' in revprops or 'authors' in revprops:
220
193
                # XXX: maybe we should just accept one of them?
221
194
                raise AssertionError('author property given twice')
222
195
            if authors:
223
196
                for individual in authors:
224
197
                    if '\n' in individual:
225
198
                        raise AssertionError('\\n is not a valid character '
226
 
                                             'in an author identity')
227
 
                revprops[u'authors'] = '\n'.join(authors)
 
199
                                'in an author identity')
 
200
                revprops['authors'] = '\n'.join(authors)
 
201
        if author is not None:
 
202
            symbol_versioning.warn('The parameter author was deprecated'
 
203
                   ' in version 1.13. Use authors instead',
 
204
                   DeprecationWarning)
 
205
            if 'author' in revprops or 'authors' in revprops:
 
206
                # XXX: maybe we should just accept one of them?
 
207
                raise AssertionError('author property given twice')
 
208
            if '\n' in author:
 
209
                raise AssertionError('\\n is not a valid character '
 
210
                        'in an author identity')
 
211
            revprops['authors'] = author
228
212
        return revprops
229
213
 
230
214
    def commit(self,
250
234
        """Commit working copy as a new revision.
251
235
 
252
236
        :param message: the commit message (it or message_callback is required)
253
 
        :param message_callback: A callback: message =
254
 
            message_callback(cmt_obj)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
238
 
256
239
        :param timestamp: if not None, seconds-since-epoch for a
257
240
            postdated/predated commit.
283
266
        :param lossy: When committing to a foreign VCS, ignore any
284
267
            data that can not be natively represented.
285
268
        """
286
 
        with ExitStack() as stack:
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
 
            mutter('preparing to commit')
291
 
 
292
 
            if working_tree is None:
293
 
                raise BzrError("working_tree must be passed into commit().")
294
 
            else:
295
 
                self.work_tree = working_tree
296
 
                self.branch = self.work_tree.branch
297
 
                if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
298
 
                    if not self.branch.repository.supports_rich_root():
299
 
                        raise errors.RootNotRich()
300
 
            if message_callback is None:
301
 
                if message is not None:
302
 
                    if isinstance(message, bytes):
303
 
                        message = message.decode(get_user_encoding())
304
 
 
305
 
                    def message_callback(x):
306
 
                        return message
307
 
                else:
308
 
                    raise BzrError("The message or message_callback keyword"
309
 
                                   " parameter is required for commit().")
310
 
 
311
 
            self.bound_branch = None
312
 
            self.any_entries_deleted = False
313
 
            if exclude is not None:
314
 
                self.exclude = sorted(
315
 
                    minimum_path_selection(exclude))
316
 
            else:
317
 
                self.exclude = []
318
 
            self.local = local
319
 
            self.master_branch = None
320
 
            self.recursive = recursive
321
 
            self.rev_id = None
322
 
            # self.specific_files is None to indicate no filter, or any iterable to
323
 
            # indicate a filter - [] means no files at all, as per iter_changes.
324
 
            if specific_files is not None:
325
 
                self.specific_files = sorted(
326
 
                    minimum_path_selection(specific_files))
327
 
            else:
328
 
                self.specific_files = None
329
 
 
330
 
            self.allow_pointless = allow_pointless
331
 
            self.message_callback = message_callback
332
 
            self.timestamp = timestamp
333
 
            self.timezone = timezone
334
 
            self.committer = committer
335
 
            self.strict = strict
336
 
            self.verbose = verbose
337
 
 
338
 
            stack.enter_context(self.work_tree.lock_write())
339
 
            self.parents = self.work_tree.get_parent_ids()
340
 
            self.pb = ui.ui_factory.nested_progress_bar()
341
 
            stack.callback(self.pb.finished)
342
 
            self.basis_revid = self.work_tree.last_revision()
343
 
            self.basis_tree = self.work_tree.basis_tree()
344
 
            stack.enter_context(self.basis_tree.lock_read())
345
 
            # Cannot commit with conflicts present.
346
 
            if len(self.work_tree.conflicts()) > 0:
347
 
                raise ConflictsInTree
348
 
 
349
 
            # Setup the bound branch variables as needed.
350
 
            self._check_bound_branch(stack, possible_master_transports)
351
 
            if self.config_stack is None:
352
 
                self.config_stack = self.work_tree.get_config_stack()
353
 
 
354
 
            # Check that the working tree is up to date
355
 
            old_revno, old_revid, new_revno = self._check_out_of_date_tree()
356
 
 
357
 
            # Complete configuration setup
358
 
            if reporter is not None:
359
 
                self.reporter = reporter
360
 
            elif self.reporter is None:
361
 
                self.reporter = self._select_reporter()
362
 
 
363
 
            # Setup the progress bar. As the number of files that need to be
364
 
            # committed in unknown, progress is reported as stages.
365
 
            # We keep track of entries separately though and include that
366
 
            # information in the progress bar during the relevant stages.
367
 
            self.pb_stage_name = ""
368
 
            self.pb_stage_count = 0
369
 
            self.pb_stage_total = 5
 
269
        operation = OperationWithCleanups(self._commit)
 
270
        self.revprops = revprops or {}
 
271
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
272
        self.config_stack = config or self.config_stack
 
273
        return operation.run(
 
274
               message=message,
 
275
               timestamp=timestamp,
 
276
               timezone=timezone,
 
277
               committer=committer,
 
278
               specific_files=specific_files,
 
279
               rev_id=rev_id,
 
280
               allow_pointless=allow_pointless,
 
281
               strict=strict,
 
282
               verbose=verbose,
 
283
               working_tree=working_tree,
 
284
               local=local,
 
285
               reporter=reporter,
 
286
               message_callback=message_callback,
 
287
               recursive=recursive,
 
288
               exclude=exclude,
 
289
               possible_master_transports=possible_master_transports,
 
290
               lossy=lossy)
 
291
 
 
292
    def _commit(self, operation, message, timestamp, timezone, committer,
 
293
            specific_files, rev_id, allow_pointless, strict, verbose,
 
294
            working_tree, local, reporter, message_callback, recursive,
 
295
            exclude, possible_master_transports, lossy):
 
296
        mutter('preparing to commit')
 
297
 
 
298
        if working_tree is None:
 
299
            raise BzrError("working_tree must be passed into commit().")
 
300
        else:
 
301
            self.work_tree = working_tree
 
302
            self.branch = self.work_tree.branch
 
303
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
304
                if not self.branch.repository.supports_rich_root():
 
305
                    raise errors.RootNotRich()
 
306
        if message_callback is None:
 
307
            if message is not None:
 
308
                if isinstance(message, str):
 
309
                    message = message.decode(get_user_encoding())
 
310
                message_callback = lambda x: message
 
311
            else:
 
312
                raise BzrError("The message or message_callback keyword"
 
313
                               " parameter is required for commit().")
 
314
 
 
315
        self.bound_branch = None
 
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
 
322
        self.local = local
 
323
        self.master_branch = None
 
324
        self.recursive = recursive
 
325
        self.rev_id = None
 
326
        # self.specific_files is None to indicate no filter, or any iterable to
 
327
        # indicate a filter - [] means no files at all, as per iter_changes.
 
328
        if specific_files is not None:
 
329
            self.specific_files = sorted(
 
330
                minimum_path_selection(specific_files))
 
331
        else:
 
332
            self.specific_files = None
 
333
 
 
334
        self.allow_pointless = allow_pointless
 
335
        self.message_callback = message_callback
 
336
        self.timestamp = timestamp
 
337
        self.timezone = timezone
 
338
        self.committer = committer
 
339
        self.strict = strict
 
340
        self.verbose = verbose
 
341
 
 
342
        self.work_tree.lock_write()
 
343
        operation.add_cleanup(self.work_tree.unlock)
 
344
        self.parents = self.work_tree.get_parent_ids()
 
345
        # We can use record_iter_changes IFF iter_changes is compatible with
 
346
        # the command line parameters, and the repository has fast delta
 
347
        # generation. See bug 347649.
 
348
        self.use_record_iter_changes = (
 
349
            not self.exclude and 
 
350
            not self.branch.repository._format.supports_tree_reference and
 
351
            (self.branch.repository._format.fast_deltas or
 
352
             len(self.parents) < 2))
 
353
        self.pb = ui.ui_factory.nested_progress_bar()
 
354
        operation.add_cleanup(self.pb.finished)
 
355
        self.basis_revid = self.work_tree.last_revision()
 
356
        self.basis_tree = self.work_tree.basis_tree()
 
357
        self.basis_tree.lock_read()
 
358
        operation.add_cleanup(self.basis_tree.unlock)
 
359
        # Cannot commit with conflicts present.
 
360
        if len(self.work_tree.conflicts()) > 0:
 
361
            raise ConflictsInTree
 
362
 
 
363
        # Setup the bound branch variables as needed.
 
364
        self._check_bound_branch(operation, possible_master_transports)
 
365
 
 
366
        # Check that the working tree is up to date
 
367
        old_revno, old_revid, new_revno = self._check_out_of_date_tree()
 
368
 
 
369
        # Complete configuration setup
 
370
        if reporter is not None:
 
371
            self.reporter = reporter
 
372
        elif self.reporter is None:
 
373
            self.reporter = self._select_reporter()
 
374
        if self.config_stack is None:
 
375
            self.config_stack = self.work_tree.get_config_stack()
 
376
 
 
377
        self._set_specific_file_ids()
 
378
 
 
379
        # Setup the progress bar. As the number of files that need to be
 
380
        # committed in unknown, progress is reported as stages.
 
381
        # We keep track of entries separately though and include that
 
382
        # information in the progress bar during the relevant stages.
 
383
        self.pb_stage_name = ""
 
384
        self.pb_stage_count = 0
 
385
        self.pb_stage_total = 5
 
386
        if self.bound_branch:
 
387
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
388
            # tags to master branch"
 
389
            self.pb_stage_total += 2
 
390
        self.pb.show_pct = False
 
391
        self.pb.show_spinner = False
 
392
        self.pb.show_eta = False
 
393
        self.pb.show_count = True
 
394
        self.pb.show_bar = True
 
395
 
 
396
        self._gather_parents()
 
397
        # After a merge, a selected file commit is not supported.
 
398
        # See 'bzr help merge' for an explanation as to why.
 
399
        if len(self.parents) > 1 and self.specific_files is not None:
 
400
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
401
        # Excludes are a form of selected file commit.
 
402
        if len(self.parents) > 1 and self.exclude:
 
403
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
404
 
 
405
        # Collect the changes
 
406
        self._set_progress_stage("Collecting changes", counter=True)
 
407
        self._lossy = lossy
 
408
        self.builder = self.branch.get_commit_builder(self.parents,
 
409
            self.config_stack, timestamp, timezone, committer, self.revprops,
 
410
            rev_id, lossy=lossy)
 
411
        if not self.builder.supports_record_entry_contents and self.exclude:
 
412
            self.builder.abort()
 
413
            raise errors.ExcludesUnsupported(self.branch.repository)
 
414
 
 
415
        if self.builder.updates_branch and self.bound_branch:
 
416
            self.builder.abort()
 
417
            raise AssertionError(
 
418
                "bound branches not supported for commit builders "
 
419
                "that update the branch")
 
420
 
 
421
        try:
 
422
            self.builder.will_record_deletes()
 
423
            # find the location being committed to
370
424
            if self.bound_branch:
371
 
                # 2 extra stages: "Uploading data to master branch" and "Merging
372
 
                # tags to master branch"
373
 
                self.pb_stage_total += 2
374
 
            self.pb.show_pct = False
375
 
            self.pb.show_spinner = False
376
 
            self.pb.show_eta = False
377
 
            self.pb.show_count = True
378
 
            self.pb.show_bar = True
379
 
 
380
 
            # After a merge, a selected file commit is not supported.
381
 
            # See 'bzr help merge' for an explanation as to why.
382
 
            if len(self.parents) > 1 and self.specific_files is not None:
383
 
                raise CannotCommitSelectedFileMerge(self.specific_files)
384
 
            # Excludes are a form of selected file commit.
385
 
            if len(self.parents) > 1 and self.exclude:
386
 
                raise CannotCommitSelectedFileMerge(self.exclude)
387
 
 
388
 
            # Collect the changes
389
 
            self._set_progress_stage("Collecting changes", counter=True)
390
 
            self._lossy = lossy
391
 
            self.builder = self.branch.get_commit_builder(
392
 
                self.parents, self.config_stack, timestamp, timezone, committer,
393
 
                self.revprops, rev_id, lossy=lossy)
394
 
 
395
 
            if self.builder.updates_branch and self.bound_branch:
396
 
                self.builder.abort()
397
 
                raise AssertionError(
398
 
                    "bound branches not supported for commit builders "
399
 
                    "that update the branch")
400
 
 
401
 
            try:
402
 
                # find the location being committed to
403
 
                if self.bound_branch:
404
 
                    master_location = self.master_branch.base
405
 
                else:
406
 
                    master_location = self.branch.base
407
 
 
408
 
                # report the start of the commit
409
 
                self.reporter.started(new_revno, self.rev_id, master_location)
410
 
 
411
 
                self._update_builder_with_changes()
412
 
                self._check_pointless()
413
 
 
414
 
                # TODO: Now the new inventory is known, check for conflicts.
415
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
416
 
                # weave lines, because nothing should be recorded until it is known
417
 
                # that commit will succeed.
418
 
                self._set_progress_stage("Saving data locally")
419
 
                self.builder.finish_inventory()
420
 
 
421
 
                # Prompt the user for a commit message if none provided
422
 
                message = message_callback(self)
423
 
                self.message = message
424
 
 
425
 
                # Add revision data to the local branch
426
 
                self.rev_id = self.builder.commit(self.message)
427
 
 
428
 
            except Exception:
429
 
                mutter("aborting commit write group because of exception:")
430
 
                trace.log_exception_quietly()
431
 
                self.builder.abort()
432
 
                raise
433
 
 
434
 
            self._update_branches(old_revno, old_revid, new_revno)
435
 
 
436
 
            # Make the working tree be up to date with the branch. This
437
 
            # includes automatic changes scheduled to be made to the tree, such
438
 
            # as updating its basis and unversioning paths that were missing.
439
 
            self.work_tree.unversion(self.deleted_paths)
440
 
            self._set_progress_stage("Updating the working tree")
441
 
            self.work_tree.update_basis_by_delta(
442
 
                self.rev_id, self.builder.get_basis_delta())
443
 
            self.reporter.completed(new_revno, self.rev_id)
444
 
            self._process_post_hooks(old_revno, new_revno)
445
 
            return self.rev_id
 
425
                master_location = self.master_branch.base
 
426
            else:
 
427
                master_location = self.branch.base
 
428
 
 
429
            # report the start of the commit
 
430
            self.reporter.started(new_revno, self.rev_id, master_location)
 
431
 
 
432
            self._update_builder_with_changes()
 
433
            self._check_pointless()
 
434
 
 
435
            # TODO: Now the new inventory is known, check for conflicts.
 
436
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
437
            # weave lines, because nothing should be recorded until it is known
 
438
            # that commit will succeed.
 
439
            self._set_progress_stage("Saving data locally")
 
440
            self.builder.finish_inventory()
 
441
 
 
442
            # Prompt the user for a commit message if none provided
 
443
            message = message_callback(self)
 
444
            self.message = message
 
445
 
 
446
            # Add revision data to the local branch
 
447
            self.rev_id = self.builder.commit(self.message)
 
448
 
 
449
        except Exception, e:
 
450
            mutter("aborting commit write group because of exception:")
 
451
            trace.log_exception_quietly()
 
452
            self.builder.abort()
 
453
            raise
 
454
 
 
455
        self._update_branches(old_revno, old_revid, new_revno)
 
456
 
 
457
        # Make the working tree be up to date with the branch. This
 
458
        # includes automatic changes scheduled to be made to the tree, such
 
459
        # as updating its basis and unversioning paths that were missing.
 
460
        self.work_tree.unversion(self.deleted_ids)
 
461
        self._set_progress_stage("Updating the working tree")
 
462
        self.work_tree.update_basis_by_delta(self.rev_id,
 
463
             self.builder.get_basis_delta())
 
464
        self.reporter.completed(new_revno, self.rev_id)
 
465
        self._process_post_hooks(old_revno, new_revno)
 
466
        return self.rev_id
446
467
 
447
468
    def _update_branches(self, old_revno, old_revid, new_revno):
448
469
        """Update the master and local branch to the new revision.
470
491
                    self.branch.fetch(self.master_branch, self.rev_id)
471
492
 
472
493
            # and now do the commit locally.
473
 
            if new_revno is None:
474
 
                # Keep existing behaviour around ghosts
475
 
                new_revno = 1
476
494
            self.branch.set_last_revision_info(new_revno, self.rev_id)
477
495
        else:
478
496
            try:
479
497
                self._process_pre_hooks(old_revno, new_revno)
480
 
            except BaseException:
 
498
            except:
481
499
                # The commit builder will already have updated the branch,
482
500
                # revert it.
483
501
                self.branch.set_last_revision_info(old_revno, old_revid)
490
508
                self.master_branch.tags)
491
509
            if tag_conflicts:
492
510
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
493
 
                note(gettext("Conflicting tags in bound branch:\n{0}".format(
494
 
                    "\n".join(warning_lines))))
 
511
                note( gettext("Conflicting tags in bound branch:\n{0}".format(
 
512
                    "\n".join(warning_lines))) )
495
513
 
496
514
    def _select_reporter(self):
497
515
        """Select the CommitReporter to use."""
509
527
            return
510
528
        raise PointlessCommit()
511
529
 
512
 
    def _check_bound_branch(self, stack, possible_master_transports=None):
 
530
    def _check_bound_branch(self, operation, possible_master_transports=None):
513
531
        """Check to see if the local branch is bound.
514
532
 
515
533
        If it is bound, then most of the commit will actually be
531
549
        # If the master branch is bound, we must fail
532
550
        master_bound_location = self.master_branch.get_bound_location()
533
551
        if master_bound_location:
534
 
            raise errors.CommitToDoubleBoundBranch(
535
 
                self.branch, self.master_branch, master_bound_location)
 
552
            raise errors.CommitToDoubleBoundBranch(self.branch,
 
553
                    self.master_branch, master_bound_location)
536
554
 
537
555
        # TODO: jam 20051230 We could automatically push local
538
556
        #       commits to the remote branch if they would fit.
540
558
        #       to local.
541
559
 
542
560
        # Make sure the local branch is identical to the master
543
 
        master_revid = self.master_branch.last_revision()
544
 
        local_revid = self.branch.last_revision()
545
 
        if local_revid != master_revid:
 
561
        master_info = self.master_branch.last_revision_info()
 
562
        local_info = self.branch.last_revision_info()
 
563
        if local_info != master_info:
546
564
            raise errors.BoundBranchOutOfDate(self.branch,
547
 
                                              self.master_branch)
 
565
                    self.master_branch)
548
566
 
549
567
        # Now things are ready to change the master branch
550
568
        # so grab the lock
551
569
        self.bound_branch = self.branch
552
 
        stack.enter_context(self.master_branch.lock_write())
 
570
        self.master_branch.lock_write()
 
571
        operation.add_cleanup(self.master_branch.unlock)
553
572
 
554
573
    def _check_out_of_date_tree(self):
555
574
        """Check that the working tree is up to date.
564
583
            # this is so that we still consider the master branch
565
584
            # - in a checkout scenario the tree may have no
566
585
            # parents but the branch may do.
567
 
            first_tree_parent = breezy.revision.NULL_REVISION
568
 
        if (self.master_branch._format.stores_revno() or
569
 
                self.config_stack.get('calculate_revnos')):
570
 
            try:
571
 
                old_revno, master_last = self.master_branch.last_revision_info()
572
 
            except errors.UnsupportedOperation:
573
 
                master_last = self.master_branch.last_revision()
574
 
                old_revno = self.branch.revision_id_to_revno(master_last)
575
 
        else:
576
 
            master_last = self.master_branch.last_revision()
577
 
            old_revno = None
 
586
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
587
        old_revno, master_last = self.master_branch.last_revision_info()
578
588
        if master_last != first_tree_parent:
579
 
            if master_last != breezy.revision.NULL_REVISION:
 
589
            if master_last != bzrlib.revision.NULL_REVISION:
580
590
                raise errors.OutOfDateTree(self.work_tree)
581
 
        if (old_revno is not None and
582
 
                self.branch.repository.has_revision(first_tree_parent)):
 
591
        if self.branch.repository.has_revision(first_tree_parent):
583
592
            new_revno = old_revno + 1
584
593
        else:
585
594
            # ghost parents never appear in revision history.
586
 
            new_revno = None
 
595
            new_revno = 1
587
596
        return old_revno, master_last, new_revno
588
597
 
589
598
    def _process_pre_hooks(self, old_revno, new_revno):
603
612
            # this would be nicer with twisted.python.reflect.namedAny
604
613
            for hook in hooks:
605
614
                result = eval(hook + '(branch, rev_id)',
606
 
                              {'branch': self.branch,
607
 
                               'breezy': breezy,
608
 
                               'rev_id': self.rev_id})
 
615
                              {'branch':self.branch,
 
616
                               'bzrlib':bzrlib,
 
617
                               'rev_id':self.rev_id})
609
618
        # process new style post commit hooks
610
619
        self._process_hooks("post_commit", old_revno, new_revno)
611
620
 
626
635
        if self.parents:
627
636
            old_revid = self.parents[0]
628
637
        else:
629
 
            old_revid = breezy.revision.NULL_REVISION
 
638
            old_revid = bzrlib.revision.NULL_REVISION
630
639
 
631
640
        if hook_name == "pre_commit":
632
641
            future_tree = self.builder.revision_tree()
633
642
            tree_delta = future_tree.changes_from(self.basis_tree,
634
 
                                                  include_root=True)
 
643
                                             include_root=True)
635
644
 
636
645
        for hook in Branch.hooks[hook_name]:
637
646
            # show the running hook in the progress bar. As hooks may
652
661
                     old_revno, old_revid, new_revno, self.rev_id,
653
662
                     tree_delta, future_tree)
654
663
 
 
664
    def _gather_parents(self):
 
665
        """Record the parents of a merge for merge detection."""
 
666
        # TODO: Make sure that this list doesn't contain duplicate
 
667
        # entries and the order is preserved when doing this.
 
668
        if self.use_record_iter_changes:
 
669
            return
 
670
        self.basis_inv = self.basis_tree.root_inventory
 
671
        self.parent_invs = [self.basis_inv]
 
672
        for revision in self.parents[1:]:
 
673
            if self.branch.repository.has_revision(revision):
 
674
                mutter('commit parent revision {%s}', revision)
 
675
                inventory = self.branch.repository.get_inventory(revision)
 
676
                self.parent_invs.append(inventory)
 
677
            else:
 
678
                mutter('commit parent ghost revision {%s}', revision)
 
679
 
655
680
    def _update_builder_with_changes(self):
656
681
        """Update the commit builder with the data about what has changed.
657
682
        """
 
683
        exclude = self.exclude
658
684
        specific_files = self.specific_files
659
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
685
        mutter("Selecting files for commit with filter %s", specific_files)
660
686
 
661
687
        self._check_strict()
662
 
        iter_changes = self.work_tree.iter_changes(
663
 
            self.basis_tree, specific_files=specific_files)
664
 
        if self.exclude:
665
 
            iter_changes = filter_excluded(iter_changes, self.exclude)
666
 
        iter_changes = self._filter_iter_changes(iter_changes)
667
 
        for path, fs_hash in self.builder.record_iter_changes(
 
688
        if self.use_record_iter_changes:
 
689
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
690
                specific_files=specific_files)
 
691
            iter_changes = self._filter_iter_changes(iter_changes)
 
692
            for file_id, path, fs_hash in self.builder.record_iter_changes(
668
693
                self.work_tree, self.basis_revid, iter_changes):
669
 
            self.work_tree._observed_sha1(path, fs_hash)
 
694
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
695
        else:
 
696
            # Build the new inventory
 
697
            self._populate_from_inventory()
 
698
            self._record_unselected()
 
699
            self._report_and_accumulate_deletes()
670
700
 
671
701
    def _filter_iter_changes(self, iter_changes):
672
702
        """Process iter_changes.
673
703
 
674
 
        This method reports on the changes in iter_changes to the user, and
 
704
        This method reports on the changes in iter_changes to the user, and 
675
705
        converts 'missing' entries in the iter_changes iterator to 'deleted'
676
706
        entries. 'missing' entries have their
677
707
 
680
710
        """
681
711
        reporter = self.reporter
682
712
        report_changes = reporter.is_verbose()
683
 
        deleted_paths = []
 
713
        deleted_ids = []
684
714
        for change in iter_changes:
685
715
            if report_changes:
686
 
                old_path = change.path[0]
687
 
                new_path = change.path[1]
688
 
                versioned = change.versioned[1]
689
 
            kind = change.kind[1]
690
 
            versioned = change.versioned[1]
 
716
                old_path = change[1][0]
 
717
                new_path = change[1][1]
 
718
                versioned = change[3][1]
 
719
            kind = change[6][1]
 
720
            versioned = change[3][1]
691
721
            if kind is None and versioned:
692
722
                # 'missing' path
693
723
                if report_changes:
694
724
                    reporter.missing(new_path)
695
 
                if change.kind[0] == 'symlink' and not self.work_tree.supports_symlinks():
696
 
                    trace.warning('Ignoring "%s" as symlinks are not '
697
 
                                  'supported on this filesystem.' % (change.path[0],))
698
 
                    continue
699
 
                deleted_paths.append(change.path[1])
 
725
                deleted_ids.append(change[0])
700
726
                # Reset the new path (None) and new versioned flag (False)
701
 
                change = change.discard_new()
702
 
                new_path = change.path[1]
 
727
                change = (change[0], (change[1][0], None), change[2],
 
728
                    (change[3][0], False)) + change[4:]
 
729
                new_path = change[1][1]
703
730
                versioned = False
704
731
            elif kind == 'tree-reference':
705
732
                if self.recursive == 'down':
706
 
                    self._commit_nested_tree(change.path[1])
707
 
            if change.versioned[0] or change.versioned[1]:
 
733
                    self._commit_nested_tree(change[0], change[1][1])
 
734
            if change[3][0] or change[3][1]:
708
735
                yield change
709
736
                if report_changes:
710
737
                    if new_path is None:
712
739
                    elif old_path is None:
713
740
                        reporter.snapshot_change(gettext('added'), new_path)
714
741
                    elif old_path != new_path:
715
 
                        reporter.renamed(gettext('renamed'),
716
 
                                         old_path, new_path)
 
742
                        reporter.renamed(gettext('renamed'), old_path, new_path)
717
743
                    else:
718
 
                        if (new_path
719
 
                                or self.work_tree.branch.repository._format.rich_root_data):
 
744
                        if (new_path or 
 
745
                            self.work_tree.branch.repository._format.rich_root_data):
720
746
                            # Don't report on changes to '' in non rich root
721
747
                            # repositories.
722
 
                            reporter.snapshot_change(
723
 
                                gettext('modified'), new_path)
 
748
                            reporter.snapshot_change(gettext('modified'), new_path)
724
749
            self._next_progress_entry()
725
 
        # Unversion files that were found to be deleted
726
 
        self.deleted_paths = deleted_paths
 
750
        # Unversion IDs that were found to be deleted
 
751
        self.deleted_ids = deleted_ids
 
752
 
 
753
    def _record_unselected(self):
 
754
        # If specific files are selected, then all un-selected files must be
 
755
        # recorded in their previous state. For more details, see
 
756
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
757
        if self.specific_files or self.exclude:
 
758
            specific_files = self.specific_files or []
 
759
            for path, old_ie in self.basis_inv.iter_entries():
 
760
                if self.builder.new_inventory.has_id(old_ie.file_id):
 
761
                    # already added - skip.
 
762
                    continue
 
763
                if (is_inside_any(specific_files, path)
 
764
                    and not is_inside_any(self.exclude, path)):
 
765
                    # was inside the selected path, and not excluded - if not
 
766
                    # present it has been deleted so skip.
 
767
                    continue
 
768
                # From here down it was either not selected, or was excluded:
 
769
                # We preserve the entry unaltered.
 
770
                ie = old_ie.copy()
 
771
                # Note: specific file commits after a merge are currently
 
772
                # prohibited. This test is for sanity/safety in case it's
 
773
                # required after that changes.
 
774
                if len(self.parents) > 1:
 
775
                    ie.revision = None
 
776
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
777
                    self.basis_tree, None)
 
778
 
 
779
    def _report_and_accumulate_deletes(self):
 
780
        if (isinstance(self.basis_inv, Inventory)
 
781
            and isinstance(self.builder.new_inventory, Inventory)):
 
782
            # the older Inventory classes provide a _byid dict, and building a
 
783
            # set from the keys of this dict is substantially faster than even
 
784
            # getting a set of ids from the inventory
 
785
            #
 
786
            # <lifeless> set(dict) is roughly the same speed as
 
787
            # set(iter(dict)) and both are significantly slower than
 
788
            # set(dict.keys())
 
789
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
790
               set(self.builder.new_inventory._byid.keys())
 
791
        else:
 
792
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
793
        if deleted_ids:
 
794
            self.any_entries_deleted = True
 
795
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
796
                for file_id in deleted_ids]
 
797
            deleted.sort()
 
798
            # XXX: this is not quite directory-order sorting
 
799
            for path, file_id in deleted:
 
800
                self.builder.record_delete(path, file_id)
 
801
                self.reporter.deleted(path)
727
802
 
728
803
    def _check_strict(self):
729
804
        # XXX: when we use iter_changes this would likely be faster if
734
809
            for unknown in self.work_tree.unknowns():
735
810
                raise StrictCommitFailed()
736
811
 
737
 
    def _commit_nested_tree(self, path):
 
812
    def _populate_from_inventory(self):
 
813
        """Populate the CommitBuilder by walking the working tree inventory."""
 
814
        # Build the revision inventory.
 
815
        #
 
816
        # This starts by creating a new empty inventory. Depending on
 
817
        # which files are selected for commit, and what is present in the
 
818
        # current tree, the new inventory is populated. inventory entries
 
819
        # which are candidates for modification have their revision set to
 
820
        # None; inventory entries that are carried over untouched have their
 
821
        # revision set to their prior value.
 
822
        #
 
823
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
824
        # results to create a new inventory at the same time, which results
 
825
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
826
        # ADHB 11-07-2006
 
827
 
 
828
        specific_files = self.specific_files
 
829
        exclude = self.exclude
 
830
        report_changes = self.reporter.is_verbose()
 
831
        deleted_ids = []
 
832
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
833
        # deleted, then we have {'foo':{'bar':{}}}
 
834
        deleted_paths = {}
 
835
        # XXX: Note that entries may have the wrong kind because the entry does
 
836
        # not reflect the status on disk.
 
837
        # NB: entries will include entries within the excluded ids/paths
 
838
        # because iter_entries_by_dir has no 'exclude' facility today.
 
839
        entries = self.work_tree.iter_entries_by_dir(
 
840
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
841
        for path, existing_ie in entries:
 
842
            file_id = existing_ie.file_id
 
843
            name = existing_ie.name
 
844
            parent_id = existing_ie.parent_id
 
845
            kind = existing_ie.kind
 
846
            # Skip files that have been deleted from the working tree.
 
847
            # The deleted path ids are also recorded so they can be explicitly
 
848
            # unversioned later.
 
849
            if deleted_paths:
 
850
                path_segments = splitpath(path)
 
851
                deleted_dict = deleted_paths
 
852
                for segment in path_segments:
 
853
                    deleted_dict = deleted_dict.get(segment, None)
 
854
                    if not deleted_dict:
 
855
                        # We either took a path not present in the dict
 
856
                        # (deleted_dict was None), or we've reached an empty
 
857
                        # child dir in the dict, so are now a sub-path.
 
858
                        break
 
859
                else:
 
860
                    deleted_dict = None
 
861
                if deleted_dict is not None:
 
862
                    # the path has a deleted parent, do not add it.
 
863
                    continue
 
864
            if exclude and is_inside_any(exclude, path):
 
865
                # Skip excluded paths. Excluded paths are processed by
 
866
                # _update_builder_with_changes.
 
867
                continue
 
868
            content_summary = self.work_tree.path_content_summary(path)
 
869
            kind = content_summary[0]
 
870
            # Note that when a filter of specific files is given, we must only
 
871
            # skip/record deleted files matching that filter.
 
872
            if not specific_files or is_inside_any(specific_files, path):
 
873
                if kind == 'missing':
 
874
                    if not deleted_paths:
 
875
                        # path won't have been split yet.
 
876
                        path_segments = splitpath(path)
 
877
                    deleted_dict = deleted_paths
 
878
                    for segment in path_segments:
 
879
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
880
                    self.reporter.missing(path)
 
881
                    self._next_progress_entry()
 
882
                    deleted_ids.append(file_id)
 
883
                    continue
 
884
            # TODO: have the builder do the nested commit just-in-time IF and
 
885
            # only if needed.
 
886
            if kind == 'tree-reference':
 
887
                # enforce repository nested tree policy.
 
888
                if (not self.work_tree.supports_tree_reference() or
 
889
                    # repository does not support it either.
 
890
                    not self.branch.repository._format.supports_tree_reference):
 
891
                    kind = 'directory'
 
892
                    content_summary = (kind, None, None, None)
 
893
                elif self.recursive == 'down':
 
894
                    nested_revision_id = self._commit_nested_tree(
 
895
                        file_id, path)
 
896
                    content_summary = (kind, None, None, nested_revision_id)
 
897
                else:
 
898
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
899
                    content_summary = (kind, None, None, nested_revision_id)
 
900
 
 
901
            # Record an entry for this item
 
902
            # Note: I don't particularly want to have the existing_ie
 
903
            # parameter but the test suite currently (28-Jun-07) breaks
 
904
            # without it thanks to a unicode normalisation issue. :-(
 
905
            definitely_changed = kind != existing_ie.kind
 
906
            self._record_entry(path, file_id, specific_files, kind, name,
 
907
                parent_id, definitely_changed, existing_ie, report_changes,
 
908
                content_summary)
 
909
 
 
910
        # Unversion IDs that were found to be deleted
 
911
        self.deleted_ids = deleted_ids
 
912
 
 
913
    def _commit_nested_tree(self, file_id, path):
738
914
        "Commit a nested tree."
739
 
        sub_tree = self.work_tree.get_nested_tree(path)
 
915
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
740
916
        # FIXME: be more comprehensive here:
741
917
        # this works when both trees are in --trees repository,
742
918
        # but when both are bound to a different repository,
744
920
        # finally implement the explicit-caches approach design
745
921
        # a while back - RBC 20070306.
746
922
        if sub_tree.branch.repository.has_same_location(
747
 
                self.work_tree.branch.repository):
 
923
            self.work_tree.branch.repository):
748
924
            sub_tree.branch.repository = \
749
925
                self.work_tree.branch.repository
750
926
        try:
751
927
            return sub_tree.commit(message=None, revprops=self.revprops,
752
 
                                   recursive=self.recursive,
753
 
                                   message_callback=self.message_callback,
754
 
                                   timestamp=self.timestamp,
755
 
                                   timezone=self.timezone,
756
 
                                   committer=self.committer,
757
 
                                   allow_pointless=self.allow_pointless,
758
 
                                   strict=self.strict, verbose=self.verbose,
759
 
                                   local=self.local, reporter=self.reporter)
760
 
        except PointlessCommit:
761
 
            return self.work_tree.get_reference_revision(path)
 
928
                recursive=self.recursive,
 
929
                message_callback=self.message_callback,
 
930
                timestamp=self.timestamp, timezone=self.timezone,
 
931
                committer=self.committer,
 
932
                allow_pointless=self.allow_pointless,
 
933
                strict=self.strict, verbose=self.verbose,
 
934
                local=self.local, reporter=self.reporter)
 
935
        except errors.PointlessCommit:
 
936
            return self.work_tree.get_reference_revision(file_id)
 
937
 
 
938
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
939
        parent_id, definitely_changed, existing_ie, report_changes,
 
940
        content_summary):
 
941
        "Record the new inventory entry for a path if any."
 
942
        # mutter('check %s {%s}', path, file_id)
 
943
        # mutter('%s selected for commit', path)
 
944
        if definitely_changed or existing_ie is None:
 
945
            ie = make_entry(kind, name, parent_id, file_id)
 
946
        else:
 
947
            ie = existing_ie.copy()
 
948
            ie.revision = None
 
949
        # For carried over entries we don't care about the fs hash - the repo
 
950
        # isn't generating a sha, so we're not saving computation time.
 
951
        _, _, fs_hash = self.builder.record_entry_contents(
 
952
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
953
        if report_changes:
 
954
            self._report_change(ie, path)
 
955
        if fs_hash:
 
956
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
957
        return ie
 
958
 
 
959
    def _report_change(self, ie, path):
 
960
        """Report a change to the user.
 
961
 
 
962
        The change that has occurred is described relative to the basis
 
963
        inventory.
 
964
        """
 
965
        if (self.basis_inv.has_id(ie.file_id)):
 
966
            basis_ie = self.basis_inv[ie.file_id]
 
967
        else:
 
968
            basis_ie = None
 
969
        change = ie.describe_change(basis_ie, ie)
 
970
        if change in (InventoryEntry.RENAMED,
 
971
            InventoryEntry.MODIFIED_AND_RENAMED):
 
972
            old_path = self.basis_inv.id2path(ie.file_id)
 
973
            self.reporter.renamed(change, old_path, path)
 
974
            self._next_progress_entry()
 
975
        else:
 
976
            if change == gettext('unchanged'):
 
977
                return
 
978
            self.reporter.snapshot_change(change, path)
 
979
            self._next_progress_entry()
762
980
 
763
981
    def _set_progress_stage(self, name, counter=False):
764
982
        """Set the progress stage and emit an update to the progress bar."""
778
996
    def _emit_progress(self):
779
997
        if self.pb_entries_count is not None:
780
998
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
781
 
                                                       self.pb_entries_count)
 
999
                self.pb_entries_count)
782
1000
        else:
783
1001
            text = gettext("%s - Stage") % (self.pb_stage_name, )
784
1002
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
1003
 
 
1004
    def _set_specific_file_ids(self):
 
1005
        """populate self.specific_file_ids if we will use it."""
 
1006
        if not self.use_record_iter_changes:
 
1007
            # If provided, ensure the specified files are versioned
 
1008
            if self.specific_files is not None:
 
1009
                # Note: This routine is being called because it raises
 
1010
                # PathNotVersionedError as a side effect of finding the IDs. We
 
1011
                # later use the ids we found as input to the working tree
 
1012
                # inventory iterator, so we only consider those ids rather than
 
1013
                # examining the whole tree again.
 
1014
                # XXX: Dont we have filter_unversioned to do this more
 
1015
                # cheaply?
 
1016
                self.specific_file_ids = tree.find_ids_across_trees(
 
1017
                    self.specific_files, [self.basis_tree, self.work_tree])
 
1018
            else:
 
1019
                self.specific_file_ids = None