/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 J. Tanner
  • Date: 2009-06-10 03:56:49 UTC
  • mfrom: (4423 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4425.
  • Revision ID: tanner@real-time.com-20090610035649-7rfx4cls4550zc3c
Merge 1.15.1 back to trunk

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):
131
108
    def deleted(self, path):
132
109
        pass
133
110
 
 
111
    def escaped(self, escape_count, message):
 
112
        pass
 
113
 
134
114
    def missing(self, path):
135
115
        pass
136
116
 
151
131
        note(format, *args)
152
132
 
153
133
    def snapshot_change(self, change, path):
154
 
        if path == '' and change in (gettext('added'), gettext('modified')):
 
134
        if path == '' and change in ('added', 'modified'):
155
135
            return
156
136
        self._note("%s %s", change, path)
157
137
 
158
 
    def started(self, revno, rev_id, location):
159
 
        self._note(
160
 
            gettext('Committing to: %s'),
161
 
            unescape_for_display(location, 'utf-8'))
 
138
    def started(self, revno, rev_id, location=None):
 
139
        if location is not None:
 
140
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
141
        else:
 
142
            # When started was added, location was only made optional by
 
143
            # accident.  Matt Nordhoff 20071129
 
144
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
145
                                   "to started.", DeprecationWarning,
 
146
                                   stacklevel=2)
 
147
            location = ''
 
148
        self._note('Committing%s', location)
162
149
 
163
150
    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)
 
151
        self._note('Committed revision %d.', revno)
171
152
 
172
153
    def deleted(self, path):
173
 
        self._note(gettext('deleted %s'), path)
 
154
        self._note('deleted %s', path)
 
155
 
 
156
    def escaped(self, escape_count, message):
 
157
        self._note("replaced %d control characters in message", escape_count)
174
158
 
175
159
    def missing(self, path):
176
 
        self._note(gettext('missing %s'), path)
 
160
        self._note('missing %s', path)
177
161
 
178
162
    def renamed(self, change, old_path, new_path):
179
163
        self._note('%s %s => %s', change, old_path, new_path)
196
180
    """
197
181
    def __init__(self,
198
182
                 reporter=None,
199
 
                 config_stack=None):
 
183
                 config=None):
200
184
        """Create a Commit object.
201
185
 
202
186
        :param reporter: the default reporter to use or None to decide later
203
187
        """
204
188
        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
 
189
        self.config = config
230
190
 
231
191
    def commit(self,
232
192
               message=None,
246
206
               message_callback=None,
247
207
               recursive='down',
248
208
               exclude=None,
249
 
               possible_master_transports=None,
250
 
               lossy=False):
 
209
               possible_master_transports=None):
251
210
        """Commit working copy as a new revision.
252
211
 
253
212
        :param message: the commit message (it or message_callback is required)
254
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
255
213
 
256
214
        :param timestamp: if not None, seconds-since-epoch for a
257
215
            postdated/predated commit.
258
216
 
259
 
        :param specific_files: If not None, commit only those files. An empty
260
 
            list means 'commit no files'.
 
217
        :param specific_files: If true, commit only those files.
261
218
 
262
219
        :param rev_id: If set, use this as the new revision id.
263
220
            Useful for test or import commands that need to tightly
280
237
        :param exclude: None or a list of relative paths to exclude from the
281
238
            commit. Pending changes to excluded files will be ignored by the
282
239
            commit.
283
 
        :param lossy: When committing to a foreign VCS, ignore any
284
 
            data that can not be natively represented.
285
240
        """
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
241
        mutter('preparing to commit')
314
242
 
315
243
        if working_tree is None:
322
250
                    raise errors.RootNotRich()
323
251
        if message_callback is None:
324
252
            if message is not None:
325
 
                if isinstance(message, bytes):
 
253
                if isinstance(message, str):
326
254
                    message = message.decode(get_user_encoding())
327
255
                message_callback = lambda x: message
328
256
            else:
338
266
            self.exclude = []
339
267
        self.local = local
340
268
        self.master_branch = None
 
269
        self.master_locked = False
341
270
        self.recursive = recursive
342
271
        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
272
        if specific_files is not None:
346
273
            self.specific_files = sorted(
347
274
                minimum_path_selection(specific_files))
348
275
        else:
349
276
            self.specific_files = None
350
 
 
 
277
            
351
278
        self.allow_pointless = allow_pointless
 
279
        self.revprops = revprops
352
280
        self.message_callback = message_callback
353
281
        self.timestamp = timestamp
354
282
        self.timezone = timezone
357
285
        self.verbose = verbose
358
286
 
359
287
        self.work_tree.lock_write()
360
 
        operation.add_cleanup(self.work_tree.unlock)
361
288
        self.parents = self.work_tree.get_parent_ids()
362
 
        self.pb = ui.ui_factory.nested_progress_bar()
363
 
        operation.add_cleanup(self.pb.finished)
 
289
        # We can use record_iter_changes IFF iter_changes is compatible with
 
290
        # the command line parameters, and the repository has fast delta
 
291
        # generation. See bug 347649.
 
292
        self.use_record_iter_changes = (
 
293
            not self.specific_files and
 
294
            not self.exclude and 
 
295
            not self.branch.repository._format.supports_tree_reference and
 
296
            (self.branch.repository._format.fast_deltas or
 
297
             len(self.parents) < 2))
 
298
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
364
299
        self.basis_revid = self.work_tree.last_revision()
365
300
        self.basis_tree = self.work_tree.basis_tree()
366
301
        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
302
        try:
425
 
            # find the location being committed to
 
303
            # Cannot commit with conflicts present.
 
304
            if len(self.work_tree.conflicts()) > 0:
 
305
                raise ConflictsInTree
 
306
 
 
307
            # Setup the bound branch variables as needed.
 
308
            self._check_bound_branch(possible_master_transports)
 
309
 
 
310
            # Check that the working tree is up to date
 
311
            old_revno, new_revno = self._check_out_of_date_tree()
 
312
 
 
313
            # Complete configuration setup
 
314
            if reporter is not None:
 
315
                self.reporter = reporter
 
316
            elif self.reporter is None:
 
317
                self.reporter = self._select_reporter()
 
318
            if self.config is None:
 
319
                self.config = self.branch.get_config()
 
320
 
 
321
            self._set_specific_file_ids()
 
322
 
 
323
            # Setup the progress bar. As the number of files that need to be
 
324
            # committed in unknown, progress is reported as stages.
 
325
            # We keep track of entries separately though and include that
 
326
            # information in the progress bar during the relevant stages.
 
327
            self.pb_stage_name = ""
 
328
            self.pb_stage_count = 0
 
329
            self.pb_stage_total = 5
426
330
            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:
 
331
                self.pb_stage_total += 1
 
332
            self.pb.show_pct = False
 
333
            self.pb.show_spinner = False
 
334
            self.pb.show_eta = False
 
335
            self.pb.show_count = True
 
336
            self.pb.show_bar = True
 
337
 
 
338
            self._gather_parents()
 
339
            # After a merge, a selected file commit is not supported.
 
340
            # See 'bzr help merge' for an explanation as to why.
 
341
            if len(self.parents) > 1 and self.specific_files:
 
342
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
343
            # Excludes are a form of selected file commit.
 
344
            if len(self.parents) > 1 and self.exclude:
 
345
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
346
 
 
347
            # Collect the changes
 
348
            self._set_progress_stage("Collecting changes", counter=True)
 
349
            self.builder = self.branch.get_commit_builder(self.parents,
 
350
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
351
 
 
352
            try:
 
353
                self.builder.will_record_deletes()
 
354
                # find the location being committed to
 
355
                if self.bound_branch:
 
356
                    master_location = self.master_branch.base
 
357
                else:
 
358
                    master_location = self.branch.base
 
359
 
 
360
                # report the start of the commit
 
361
                self.reporter.started(new_revno, self.rev_id, master_location)
 
362
 
 
363
                self._update_builder_with_changes()
 
364
                self._check_pointless()
 
365
 
 
366
                # TODO: Now the new inventory is known, check for conflicts.
 
367
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
368
                # weave lines, because nothing should be recorded until it is known
 
369
                # that commit will succeed.
 
370
                self._set_progress_stage("Saving data locally")
 
371
                self.builder.finish_inventory()
 
372
 
 
373
                # Prompt the user for a commit message if none provided
 
374
                message = message_callback(self)
 
375
                self.message = message
 
376
                self._escape_commit_message()
 
377
 
 
378
                # Add revision data to the local branch
 
379
                self.rev_id = self.builder.commit(self.message)
 
380
 
 
381
            except Exception, e:
 
382
                mutter("aborting commit write group because of exception:")
 
383
                trace.log_exception_quietly()
 
384
                note("aborting commit write group: %r" % (e,))
 
385
                self.builder.abort()
 
386
                raise
 
387
 
482
388
            self._process_pre_hooks(old_revno, new_revno)
483
389
 
484
390
            # Upload revision data to the master.
487
393
                self._set_progress_stage("Uploading data to master branch")
488
394
                # 'commit' to the master first so a timeout here causes the
489
395
                # 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)
 
396
                self.master_branch.import_last_revision_info(
 
397
                    self.branch.repository, new_revno, self.rev_id)
494
398
 
495
399
            # and now do the commit locally.
496
400
            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
401
 
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))) )
 
402
            # Make the working tree up to date with the branch
 
403
            self._set_progress_stage("Updating the working tree")
 
404
            self.work_tree.update_basis_by_delta(self.rev_id,
 
405
                 self.builder.get_basis_delta())
 
406
            self.reporter.completed(new_revno, self.rev_id)
 
407
            self._process_post_hooks(old_revno, new_revno)
 
408
        finally:
 
409
            self._cleanup()
 
410
        return self.rev_id
515
411
 
516
412
    def _select_reporter(self):
517
413
        """Select the CommitReporter to use."""
525
421
        # A merge with no effect on files
526
422
        if len(self.parents) > 1:
527
423
            return
 
424
        # TODO: we could simplify this by using self.builder.basis_delta.
 
425
 
 
426
        # The initial commit adds a root directory, but this in itself is not
 
427
        # a worthwhile commit.
 
428
        if (self.basis_revid == revision.NULL_REVISION and
 
429
            ((self.builder.new_inventory is not None and
 
430
             len(self.builder.new_inventory) == 1) or
 
431
            len(self.builder._basis_delta) == 1)):
 
432
            raise PointlessCommit()
528
433
        if self.builder.any_changes():
529
434
            return
530
435
        raise PointlessCommit()
531
436
 
532
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
437
    def _check_bound_branch(self, possible_master_transports=None):
533
438
        """Check to see if the local branch is bound.
534
439
 
535
440
        If it is bound, then most of the commit will actually be
570
475
        # so grab the lock
571
476
        self.bound_branch = self.branch
572
477
        self.master_branch.lock_write()
573
 
        operation.add_cleanup(self.master_branch.unlock)
 
478
        self.master_locked = True
574
479
 
575
480
    def _check_out_of_date_tree(self):
576
481
        """Check that the working tree is up to date.
577
482
 
578
 
        :return: old_revision_number, old_revision_id, new_revision_number
579
 
            tuple
 
483
        :return: old_revision_number,new_revision_number tuple
580
484
        """
581
485
        try:
582
486
            first_tree_parent = self.work_tree.get_parent_ids()[0]
585
489
            # this is so that we still consider the master branch
586
490
            # - in a checkout scenario the tree may have no
587
491
            # parents but the branch may do.
588
 
            first_tree_parent = breezy.revision.NULL_REVISION
 
492
            first_tree_parent = bzrlib.revision.NULL_REVISION
589
493
        old_revno, master_last = self.master_branch.last_revision_info()
590
494
        if master_last != first_tree_parent:
591
 
            if master_last != breezy.revision.NULL_REVISION:
 
495
            if master_last != bzrlib.revision.NULL_REVISION:
592
496
                raise errors.OutOfDateTree(self.work_tree)
593
497
        if self.branch.repository.has_revision(first_tree_parent):
594
498
            new_revno = old_revno + 1
595
499
        else:
596
500
            # ghost parents never appear in revision history.
597
501
            new_revno = 1
598
 
        return old_revno, master_last, new_revno
 
502
        return old_revno,new_revno
599
503
 
600
504
    def _process_pre_hooks(self, old_revno, new_revno):
601
505
        """Process any registered pre commit hooks."""
607
511
        # Process the post commit hooks, if any
608
512
        self._set_progress_stage("Running post_commit hooks")
609
513
        # 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(' ')
 
514
        # 0.15)
 
515
        if self.config.post_commit() is not None:
 
516
            hooks = self.config.post_commit().split(' ')
614
517
            # this would be nicer with twisted.python.reflect.namedAny
615
518
            for hook in hooks:
616
519
                result = eval(hook + '(branch, rev_id)',
617
520
                              {'branch':self.branch,
618
 
                               'breezy':breezy,
 
521
                               'bzrlib':bzrlib,
619
522
                               'rev_id':self.rev_id})
620
523
        # process new style post commit hooks
621
524
        self._process_hooks("post_commit", old_revno, new_revno)
637
540
        if self.parents:
638
541
            old_revid = self.parents[0]
639
542
        else:
640
 
            old_revid = breezy.revision.NULL_REVISION
 
543
            old_revid = bzrlib.revision.NULL_REVISION
641
544
 
642
545
        if hook_name == "pre_commit":
643
546
            future_tree = self.builder.revision_tree()
663
566
                     old_revno, old_revid, new_revno, self.rev_id,
664
567
                     tree_delta, future_tree)
665
568
 
 
569
    def _cleanup(self):
 
570
        """Cleanup any open locks, progress bars etc."""
 
571
        cleanups = [self._cleanup_bound_branch,
 
572
                    self.basis_tree.unlock,
 
573
                    self.work_tree.unlock,
 
574
                    self.pb.finished]
 
575
        found_exception = None
 
576
        for cleanup in cleanups:
 
577
            try:
 
578
                cleanup()
 
579
            # we want every cleanup to run no matter what.
 
580
            # so we have a catchall here, but we will raise the
 
581
            # last encountered exception up the stack: and
 
582
            # typically this will be useful enough.
 
583
            except Exception, e:
 
584
                found_exception = e
 
585
        if found_exception is not None:
 
586
            # don't do a plan raise, because the last exception may have been
 
587
            # trashed, e is our sure-to-work exception even though it loses the
 
588
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
589
            # exc_info and if its the same one do a plain raise otherwise
 
590
            # 'raise e' as we do now.
 
591
            raise e
 
592
 
 
593
    def _cleanup_bound_branch(self):
 
594
        """Executed at the end of a try/finally to cleanup a bound branch.
 
595
 
 
596
        If the branch wasn't bound, this is a no-op.
 
597
        If it was, it resents self.branch to the local branch, instead
 
598
        of being the master.
 
599
        """
 
600
        if not self.bound_branch:
 
601
            return
 
602
        if self.master_locked:
 
603
            self.master_branch.unlock()
 
604
 
 
605
    def _escape_commit_message(self):
 
606
        """Replace xml-incompatible control characters."""
 
607
        # FIXME: RBC 20060419 this should be done by the revision
 
608
        # serialiser not by commit. Then we can also add an unescaper
 
609
        # in the deserializer and start roundtripping revision messages
 
610
        # precisely. See repository_implementations/test_repository.py
 
611
        self.message, escape_count = xml_serializer.escape_invalid_chars(
 
612
            self.message)
 
613
        if escape_count:
 
614
            self.reporter.escaped(escape_count, self.message)
 
615
 
 
616
    def _gather_parents(self):
 
617
        """Record the parents of a merge for merge detection."""
 
618
        # TODO: Make sure that this list doesn't contain duplicate
 
619
        # entries and the order is preserved when doing this.
 
620
        if self.use_record_iter_changes:
 
621
            return
 
622
        self.basis_inv = self.basis_tree.inventory
 
623
        self.parent_invs = [self.basis_inv]
 
624
        for revision in self.parents[1:]:
 
625
            if self.branch.repository.has_revision(revision):
 
626
                mutter('commit parent revision {%s}', revision)
 
627
                inventory = self.branch.repository.get_inventory(revision)
 
628
                self.parent_invs.append(inventory)
 
629
            else:
 
630
                mutter('commit parent ghost revision {%s}', revision)
 
631
 
666
632
    def _update_builder_with_changes(self):
667
633
        """Update the commit builder with the data about what has changed.
668
634
        """
669
 
        specific_files = self.specific_files
670
 
        mutter("Selecting files for commit with filter %r", specific_files)
 
635
        exclude = self.exclude
 
636
        specific_files = self.specific_files or []
 
637
        mutter("Selecting files for commit with filter %s", specific_files)
671
638
 
672
639
        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)
 
640
        if self.use_record_iter_changes:
 
641
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
642
            iter_changes = self._filter_iter_changes(iter_changes)
 
643
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
644
                self.work_tree, self.basis_revid, iter_changes):
 
645
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
646
        else:
 
647
            # Build the new inventory
 
648
            self._populate_from_inventory()
 
649
            self._record_unselected()
 
650
            self._report_and_accumulate_deletes()
681
651
 
682
652
    def _filter_iter_changes(self, iter_changes):
683
653
        """Process iter_changes.
691
661
        """
692
662
        reporter = self.reporter
693
663
        report_changes = reporter.is_verbose()
694
 
        deleted_paths = []
 
664
        deleted_ids = []
695
665
        for change in iter_changes:
696
666
            if report_changes:
697
667
                old_path = change[1][0]
703
673
                # 'missing' path
704
674
                if report_changes:
705
675
                    reporter.missing(new_path)
706
 
                deleted_paths.append(change[1][1])
 
676
                deleted_ids.append(change[0])
707
677
                # Reset the new path (None) and new versioned flag (False)
708
678
                change = (change[0], (change[1][0], None), change[2],
709
679
                    (change[3][0], False)) + change[4:]
710
 
                new_path = change[1][1]
711
 
                versioned = False
712
680
            elif kind == 'tree-reference':
713
681
                if self.recursive == 'down':
714
682
                    self._commit_nested_tree(change[0], change[1][1])
718
686
                    if new_path is None:
719
687
                        reporter.deleted(old_path)
720
688
                    elif old_path is None:
721
 
                        reporter.snapshot_change(gettext('added'), new_path)
 
689
                        reporter.snapshot_change('added', new_path)
722
690
                    elif old_path != new_path:
723
 
                        reporter.renamed(gettext('renamed'), old_path, new_path)
 
691
                        reporter.renamed('renamed', old_path, new_path)
724
692
                    else:
725
693
                        if (new_path or 
726
694
                            self.work_tree.branch.repository._format.rich_root_data):
727
695
                            # Don't report on changes to '' in non rich root
728
696
                            # repositories.
729
 
                            reporter.snapshot_change(gettext('modified'), new_path)
 
697
                            reporter.snapshot_change('modified', new_path)
730
698
            self._next_progress_entry()
731
 
        # Unversion files that were found to be deleted
732
 
        self.deleted_paths = deleted_paths
 
699
        # Unversion IDs that were found to be deleted
 
700
        self.work_tree.unversion(deleted_ids)
 
701
 
 
702
    def _record_unselected(self):
 
703
        # If specific files are selected, then all un-selected files must be
 
704
        # recorded in their previous state. For more details, see
 
705
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
706
        if self.specific_files or self.exclude:
 
707
            specific_files = self.specific_files or []
 
708
            for path, old_ie in self.basis_inv.iter_entries():
 
709
                if old_ie.file_id in self.builder.new_inventory:
 
710
                    # already added - skip.
 
711
                    continue
 
712
                if (is_inside_any(specific_files, path)
 
713
                    and not is_inside_any(self.exclude, path)):
 
714
                    # was inside the selected path, and not excluded - if not
 
715
                    # present it has been deleted so skip.
 
716
                    continue
 
717
                # From here down it was either not selected, or was excluded:
 
718
                # We preserve the entry unaltered.
 
719
                ie = old_ie.copy()
 
720
                # Note: specific file commits after a merge are currently
 
721
                # prohibited. This test is for sanity/safety in case it's
 
722
                # required after that changes.
 
723
                if len(self.parents) > 1:
 
724
                    ie.revision = None
 
725
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
726
                    self.basis_tree, None)
 
727
 
 
728
    def _report_and_accumulate_deletes(self):
 
729
        if (isinstance(self.basis_inv, Inventory)
 
730
            and isinstance(self.builder.new_inventory, Inventory)):
 
731
            # the older Inventory classes provide a _byid dict, and building a
 
732
            # set from the keys of this dict is substantially faster than even
 
733
            # getting a set of ids from the inventory
 
734
            #
 
735
            # <lifeless> set(dict) is roughly the same speed as
 
736
            # set(iter(dict)) and both are significantly slower than
 
737
            # set(dict.keys())
 
738
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
739
               set(self.builder.new_inventory._byid.keys())
 
740
        else:
 
741
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
742
        if deleted_ids:
 
743
            self.any_entries_deleted = True
 
744
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
745
                for file_id in deleted_ids]
 
746
            deleted.sort()
 
747
            # XXX: this is not quite directory-order sorting
 
748
            for path, file_id in deleted:
 
749
                self.builder.record_delete(path, file_id)
 
750
                self.reporter.deleted(path)
733
751
 
734
752
    def _check_strict(self):
735
753
        # XXX: when we use iter_changes this would likely be faster if
740
758
            for unknown in self.work_tree.unknowns():
741
759
                raise StrictCommitFailed()
742
760
 
 
761
    def _populate_from_inventory(self):
 
762
        """Populate the CommitBuilder by walking the working tree inventory."""
 
763
        # Build the revision inventory.
 
764
        #
 
765
        # This starts by creating a new empty inventory. Depending on
 
766
        # which files are selected for commit, and what is present in the
 
767
        # current tree, the new inventory is populated. inventory entries
 
768
        # which are candidates for modification have their revision set to
 
769
        # None; inventory entries that are carried over untouched have their
 
770
        # revision set to their prior value.
 
771
        #
 
772
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
773
        # results to create a new inventory at the same time, which results
 
774
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
775
        # ADHB 11-07-2006
 
776
 
 
777
        specific_files = self.specific_files
 
778
        exclude = self.exclude
 
779
        report_changes = self.reporter.is_verbose()
 
780
        deleted_ids = []
 
781
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
782
        # deleted, then we have {'foo':{'bar':{}}}
 
783
        deleted_paths = {}
 
784
        # XXX: Note that entries may have the wrong kind because the entry does
 
785
        # not reflect the status on disk.
 
786
        work_inv = self.work_tree.inventory
 
787
        # NB: entries will include entries within the excluded ids/paths
 
788
        # because iter_entries_by_dir has no 'exclude' facility today.
 
789
        entries = work_inv.iter_entries_by_dir(
 
790
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
791
        for path, existing_ie in entries:
 
792
            file_id = existing_ie.file_id
 
793
            name = existing_ie.name
 
794
            parent_id = existing_ie.parent_id
 
795
            kind = existing_ie.kind
 
796
            # Skip files that have been deleted from the working tree.
 
797
            # The deleted path ids are also recorded so they can be explicitly
 
798
            # unversioned later.
 
799
            if deleted_paths:
 
800
                path_segments = splitpath(path)
 
801
                deleted_dict = deleted_paths
 
802
                for segment in path_segments:
 
803
                    deleted_dict = deleted_dict.get(segment, None)
 
804
                    if not deleted_dict:
 
805
                        # We either took a path not present in the dict
 
806
                        # (deleted_dict was None), or we've reached an empty
 
807
                        # child dir in the dict, so are now a sub-path.
 
808
                        break
 
809
                else:
 
810
                    deleted_dict = None
 
811
                if deleted_dict is not None:
 
812
                    # the path has a deleted parent, do not add it.
 
813
                    continue
 
814
            if exclude and is_inside_any(exclude, path):
 
815
                # Skip excluded paths. Excluded paths are processed by
 
816
                # _update_builder_with_changes.
 
817
                continue
 
818
            content_summary = self.work_tree.path_content_summary(path)
 
819
            # Note that when a filter of specific files is given, we must only
 
820
            # skip/record deleted files matching that filter.
 
821
            if not specific_files or is_inside_any(specific_files, path):
 
822
                if content_summary[0] == 'missing':
 
823
                    if not deleted_paths:
 
824
                        # path won't have been split yet.
 
825
                        path_segments = splitpath(path)
 
826
                    deleted_dict = deleted_paths
 
827
                    for segment in path_segments:
 
828
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
829
                    self.reporter.missing(path)
 
830
                    self._next_progress_entry()
 
831
                    deleted_ids.append(file_id)
 
832
                    continue
 
833
            # TODO: have the builder do the nested commit just-in-time IF and
 
834
            # only if needed.
 
835
            if content_summary[0] == 'tree-reference':
 
836
                # enforce repository nested tree policy.
 
837
                if (not self.work_tree.supports_tree_reference() or
 
838
                    # repository does not support it either.
 
839
                    not self.branch.repository._format.supports_tree_reference):
 
840
                    content_summary = ('directory',) + content_summary[1:]
 
841
            kind = content_summary[0]
 
842
            # TODO: specific_files filtering before nested tree processing
 
843
            if kind == 'tree-reference':
 
844
                if self.recursive == 'down':
 
845
                    nested_revision_id = self._commit_nested_tree(
 
846
                        file_id, path)
 
847
                    content_summary = content_summary[:3] + (
 
848
                        nested_revision_id,)
 
849
                else:
 
850
                    content_summary = content_summary[:3] + (
 
851
                        self.work_tree.get_reference_revision(file_id),)
 
852
 
 
853
            # Record an entry for this item
 
854
            # Note: I don't particularly want to have the existing_ie
 
855
            # parameter but the test suite currently (28-Jun-07) breaks
 
856
            # without it thanks to a unicode normalisation issue. :-(
 
857
            definitely_changed = kind != existing_ie.kind
 
858
            self._record_entry(path, file_id, specific_files, kind, name,
 
859
                parent_id, definitely_changed, existing_ie, report_changes,
 
860
                content_summary)
 
861
 
 
862
        # Unversion IDs that were found to be deleted
 
863
        self.work_tree.unversion(deleted_ids)
 
864
 
743
865
    def _commit_nested_tree(self, file_id, path):
744
866
        "Commit a nested tree."
745
 
        sub_tree = self.work_tree.get_nested_tree(path, file_id)
 
867
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
746
868
        # FIXME: be more comprehensive here:
747
869
        # this works when both trees are in --trees repository,
748
870
        # but when both are bound to a different repository,
762
884
                allow_pointless=self.allow_pointless,
763
885
                strict=self.strict, verbose=self.verbose,
764
886
                local=self.local, reporter=self.reporter)
765
 
        except PointlessCommit:
766
 
            return self.work_tree.get_reference_revision(path, file_id)
 
887
        except errors.PointlessCommit:
 
888
            return self.work_tree.get_reference_revision(file_id)
 
889
 
 
890
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
891
        parent_id, definitely_changed, existing_ie, report_changes,
 
892
        content_summary):
 
893
        "Record the new inventory entry for a path if any."
 
894
        # mutter('check %s {%s}', path, file_id)
 
895
        # mutter('%s selected for commit', path)
 
896
        if definitely_changed or existing_ie is None:
 
897
            ie = make_entry(kind, name, parent_id, file_id)
 
898
        else:
 
899
            ie = existing_ie.copy()
 
900
            ie.revision = None
 
901
        # For carried over entries we don't care about the fs hash - the repo
 
902
        # isn't generating a sha, so we're not saving computation time.
 
903
        _, _, fs_hash = self.builder.record_entry_contents(
 
904
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
905
        if report_changes:
 
906
            self._report_change(ie, path)
 
907
        if fs_hash:
 
908
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
909
        return ie
 
910
 
 
911
    def _report_change(self, ie, path):
 
912
        """Report a change to the user.
 
913
 
 
914
        The change that has occurred is described relative to the basis
 
915
        inventory.
 
916
        """
 
917
        if (self.basis_inv.has_id(ie.file_id)):
 
918
            basis_ie = self.basis_inv[ie.file_id]
 
919
        else:
 
920
            basis_ie = None
 
921
        change = ie.describe_change(basis_ie, ie)
 
922
        if change in (InventoryEntry.RENAMED,
 
923
            InventoryEntry.MODIFIED_AND_RENAMED):
 
924
            old_path = self.basis_inv.id2path(ie.file_id)
 
925
            self.reporter.renamed(change, old_path, path)
 
926
            self._next_progress_entry()
 
927
        else:
 
928
            if change == 'unchanged':
 
929
                return
 
930
            self.reporter.snapshot_change(change, path)
 
931
            self._next_progress_entry()
767
932
 
768
933
    def _set_progress_stage(self, name, counter=False):
769
934
        """Set the progress stage and emit an update to the progress bar."""
782
947
 
783
948
    def _emit_progress(self):
784
949
        if self.pb_entries_count is not None:
785
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
 
950
            text = "%s [%d] - Stage" % (self.pb_stage_name,
786
951
                self.pb_entries_count)
787
952
        else:
788
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
953
            text = "%s - Stage" % (self.pb_stage_name, )
789
954
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
955
 
 
956
    def _set_specific_file_ids(self):
 
957
        """populate self.specific_file_ids if we will use it."""
 
958
        if not self.use_record_iter_changes:
 
959
            # If provided, ensure the specified files are versioned
 
960
            if self.specific_files is not None:
 
961
                # Note: This routine is being called because it raises
 
962
                # PathNotVersionedError as a side effect of finding the IDs. We
 
963
                # later use the ids we found as input to the working tree
 
964
                # inventory iterator, so we only consider those ids rather than
 
965
                # examining the whole tree again.
 
966
                # XXX: Dont we have filter_unversioned to do this more
 
967
                # cheaply?
 
968
                self.specific_file_ids = tree.find_ids_across_trees(
 
969
                    self.specific_files, [self.basis_tree, self.work_tree])
 
970
            else:
 
971
                self.specific_file_ids = None