/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: Robert Collins
  • Date: 2009-08-24 21:05:09 UTC
  • mto: This revision was merged to the branch mainline in revision 4645.
  • Revision ID: robertc@robertcollins.net-20090824210509-pproia2q9evq1nsl
lsprof support.

Show diffs side-by-side

added added

removed removed

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