← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2011-05-11 11:35:28 UTC
  • mto: This revision was merged to the branch mainline in revision 5851.
  • Revision ID: john@arbash-meinel.com-20110511113528-qepibuwxicjrbb2h
Break compatibility with python <2.6.

This includes auditing the code for places where we were doing
explicit 'sys.version' checks and removing them as appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
49
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
50
# the rest of the code; add a deprecation of the old name.
51
51
 
52
 
import os
53
 
import re
54
 
import sys
55
 
import time
56
 
 
57
 
from cStringIO import StringIO
58
 
 
59
52
from bzrlib import (
60
53
    debug,
61
54
    errors,
62
55
    revision,
 
56
    trace,
63
57
    tree,
 
58
    ui,
64
59
    )
65
60
from bzrlib.branch import Branch
 
61
from bzrlib.cleanup import OperationWithCleanups
66
62
import bzrlib.config
67
63
from bzrlib.errors import (BzrError, PointlessCommit,
68
64
                           ConflictsInTree,
69
65
                           StrictCommitFailed
70
66
                           )
71
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
72
 
                            is_inside_or_parent_of_any,
 
67
from bzrlib.osutils import (get_user_encoding,
 
68
                            is_inside_any,
73
69
                            minimum_path_selection,
74
 
                            quotefn, sha_file, split_lines)
75
 
from bzrlib.testament import Testament
76
 
from bzrlib.trace import mutter, note, warning, is_quiet
77
 
from bzrlib.xml5 import serializer_v5
78
 
from bzrlib.inventory import InventoryEntry, make_entry
 
70
                            splitpath,
 
71
                            )
 
72
from bzrlib.trace import mutter, note, is_quiet
 
73
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
79
74
from bzrlib import symbol_versioning
80
 
from bzrlib.symbol_versioning import (deprecated_passed,
81
 
        deprecated_function,
82
 
        DEPRECATED_PARAMETER)
83
 
from bzrlib.workingtree import WorkingTree
84
75
from bzrlib.urlutils import unescape_for_display
85
 
import bzrlib.ui
86
76
 
87
77
 
88
78
class NullCommitReporter(object):
89
79
    """I report on progress of a commit."""
90
80
 
91
81
    def started(self, revno, revid, location=None):
 
82
        if location is None:
 
83
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
84
                                   "to started.", DeprecationWarning,
 
85
                                   stacklevel=2)
92
86
        pass
93
87
 
94
88
    def snapshot_change(self, change, path):
97
91
    def completed(self, revno, rev_id):
98
92
        pass
99
93
 
100
 
    def deleted(self, file_id):
101
 
        pass
102
 
 
103
 
    def escaped(self, escape_count, message):
 
94
    def deleted(self, path):
104
95
        pass
105
96
 
106
97
    def missing(self, path):
123
114
        note(format, *args)
124
115
 
125
116
    def snapshot_change(self, change, path):
126
 
        if change == 'unchanged':
127
 
            return
128
 
        if change == 'added' and path == '':
 
117
        if path == '' and change in ('added', 'modified'):
129
118
            return
130
119
        self._note("%s %s", change, path)
131
120
 
132
121
    def started(self, revno, rev_id, location=None):
133
122
        if location is not None:
134
 
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
 
123
            location = ' to: ' + unescape_for_display(location, 'utf-8')
135
124
        else:
 
125
            # When started was added, location was only made optional by
 
126
            # accident.  Matt Nordhoff 20071129
 
127
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
128
                                   "to started.", DeprecationWarning,
 
129
                                   stacklevel=2)
136
130
            location = ''
137
 
        self._note('Committing revision %d%s.', revno, location)
 
131
        self._note('Committing%s', location)
138
132
 
139
133
    def completed(self, revno, rev_id):
140
134
        self._note('Committed revision %d.', revno)
141
 
 
142
 
    def deleted(self, file_id):
143
 
        self._note('deleted %s', file_id)
144
 
 
145
 
    def escaped(self, escape_count, message):
146
 
        self._note("replaced %d control characters in message", escape_count)
 
135
        # self._note goes to the console too; so while we want to log the
 
136
        # rev_id, we can't trivially only log it. (See bug 526425). Long
 
137
        # term we should rearrange the reporting structure, but for now
 
138
        # we just mutter seperately. We mutter the revid and revno together
 
139
        # so that concurrent bzr invocations won't lead to confusion.
 
140
        mutter('Committed revid %s as revno %d.', rev_id, revno)
 
141
 
 
142
    def deleted(self, path):
 
143
        self._note('deleted %s', path)
147
144
 
148
145
    def missing(self, path):
149
146
        self._note('missing %s', path)
177
174
        self.reporter = reporter
178
175
        self.config = config
179
176
 
 
177
    @staticmethod
 
178
    def update_revprops(revprops, branch, authors=None, author=None,
 
179
                        local=False, possible_master_transports=None):
 
180
        if revprops is None:
 
181
            revprops = {}
 
182
        if possible_master_transports is None:
 
183
            possible_master_transports = []
 
184
        if not 'branch-nick' in revprops:
 
185
            revprops['branch-nick'] = branch._get_nick(
 
186
                local,
 
187
                possible_master_transports)
 
188
        if authors is not None:
 
189
            if author is not None:
 
190
                raise AssertionError('Specifying both author and authors '
 
191
                        'is not allowed. Specify just authors instead')
 
192
            if 'author' in revprops or 'authors' in revprops:
 
193
                # XXX: maybe we should just accept one of them?
 
194
                raise AssertionError('author property given twice')
 
195
            if authors:
 
196
                for individual in authors:
 
197
                    if '\n' in individual:
 
198
                        raise AssertionError('\\n is not a valid character '
 
199
                                'in an author identity')
 
200
                revprops['authors'] = '\n'.join(authors)
 
201
        if author is not None:
 
202
            symbol_versioning.warn('The parameter author was deprecated'
 
203
                   ' in version 1.13. Use authors instead',
 
204
                   DeprecationWarning)
 
205
            if 'author' in revprops or 'authors' in revprops:
 
206
                # XXX: maybe we should just accept one of them?
 
207
                raise AssertionError('author property given twice')
 
208
            if '\n' in author:
 
209
                raise AssertionError('\\n is not a valid character '
 
210
                        'in an author identity')
 
211
            revprops['authors'] = author
 
212
        return revprops
 
213
 
180
214
    def commit(self,
181
215
               message=None,
182
216
               timestamp=None,
193
227
               reporter=None,
194
228
               config=None,
195
229
               message_callback=None,
196
 
               recursive='down'):
 
230
               recursive='down',
 
231
               exclude=None,
 
232
               possible_master_transports=None,
 
233
               lossy=False):
197
234
        """Commit working copy as a new revision.
198
235
 
199
236
        :param message: the commit message (it or message_callback is required)
 
237
        :param message_callback: A callback: message = message_callback(cmt_obj)
200
238
 
201
239
        :param timestamp: if not None, seconds-since-epoch for a
202
240
            postdated/predated commit.
203
241
 
204
 
        :param specific_files: If true, commit only those files.
 
242
        :param specific_files: If not None, commit only those files. An empty
 
243
            list means 'commit no files'.
205
244
 
206
245
        :param rev_id: If set, use this as the new revision id.
207
246
            Useful for test or import commands that need to tightly
221
260
        :param verbose: if True and the reporter is not None, report everything
222
261
        :param recursive: If set to 'down', commit in any subtrees that have
223
262
            pending changes of any sort during this commit.
 
263
        :param exclude: None or a list of relative paths to exclude from the
 
264
            commit. Pending changes to excluded files will be ignored by the
 
265
            commit.
 
266
        :param lossy: When committing to a foreign VCS, ignore any
 
267
            data that can not be natively represented.
224
268
        """
 
269
        operation = OperationWithCleanups(self._commit)
 
270
        self.revprops = revprops or {}
 
271
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
 
272
        self.config = config or self.config
 
273
        return operation.run(
 
274
               message=message,
 
275
               timestamp=timestamp,
 
276
               timezone=timezone,
 
277
               committer=committer,
 
278
               specific_files=specific_files,
 
279
               rev_id=rev_id,
 
280
               allow_pointless=allow_pointless,
 
281
               strict=strict,
 
282
               verbose=verbose,
 
283
               working_tree=working_tree,
 
284
               local=local,
 
285
               reporter=reporter,
 
286
               message_callback=message_callback,
 
287
               recursive=recursive,
 
288
               exclude=exclude,
 
289
               possible_master_transports=possible_master_transports,
 
290
               lossy=lossy)
 
291
 
 
292
    def _commit(self, operation, message, timestamp, timezone, committer,
 
293
            specific_files, rev_id, allow_pointless, strict, verbose,
 
294
            working_tree, local, reporter, message_callback, recursive,
 
295
            exclude, possible_master_transports, lossy):
225
296
        mutter('preparing to commit')
226
297
 
227
298
        if working_tree is None:
235
306
        if message_callback is None:
236
307
            if message is not None:
237
308
                if isinstance(message, str):
238
 
                    message = message.decode(bzrlib.user_encoding)
 
309
                    message = message.decode(get_user_encoding())
239
310
                message_callback = lambda x: message
240
311
            else:
241
312
                raise BzrError("The message or message_callback keyword"
242
313
                               " parameter is required for commit().")
243
314
 
244
315
        self.bound_branch = None
245
 
        self.any_entries_changed = False
246
316
        self.any_entries_deleted = False
 
317
        if exclude is not None:
 
318
            self.exclude = sorted(
 
319
                minimum_path_selection(exclude))
 
320
        else:
 
321
            self.exclude = []
247
322
        self.local = local
248
323
        self.master_branch = None
249
 
        self.master_locked = False
250
324
        self.recursive = recursive
251
325
        self.rev_id = None
 
326
        # self.specific_files is None to indicate no filter, or any iterable to
 
327
        # indicate a filter - [] means no files at all, as per iter_changes.
252
328
        if specific_files is not None:
253
329
            self.specific_files = sorted(
254
330
                minimum_path_selection(specific_files))
255
331
        else:
256
332
            self.specific_files = None
257
 
        self.specific_file_ids = None
 
333
 
258
334
        self.allow_pointless = allow_pointless
259
 
        self.revprops = revprops
260
335
        self.message_callback = message_callback
261
336
        self.timestamp = timestamp
262
337
        self.timezone = timezone
263
338
        self.committer = committer
264
339
        self.strict = strict
265
340
        self.verbose = verbose
266
 
        # accumulates an inventory delta to the basis entry, so we can make
267
 
        # just the necessary updates to the workingtree's cached basis.
268
 
        self._basis_delta = []
269
341
 
270
342
        self.work_tree.lock_write()
271
 
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
343
        operation.add_cleanup(self.work_tree.unlock)
 
344
        self.parents = self.work_tree.get_parent_ids()
 
345
        # We can use record_iter_changes IFF iter_changes is compatible with
 
346
        # the command line parameters, and the repository has fast delta
 
347
        # generation. See bug 347649.
 
348
        self.use_record_iter_changes = (
 
349
            not self.exclude and 
 
350
            not self.branch.repository._format.supports_tree_reference and
 
351
            (self.branch.repository._format.fast_deltas or
 
352
             len(self.parents) < 2))
 
353
        self.pb = ui.ui_factory.nested_progress_bar()
 
354
        operation.add_cleanup(self.pb.finished)
272
355
        self.basis_revid = self.work_tree.last_revision()
273
356
        self.basis_tree = self.work_tree.basis_tree()
274
357
        self.basis_tree.lock_read()
 
358
        operation.add_cleanup(self.basis_tree.unlock)
 
359
        # Cannot commit with conflicts present.
 
360
        if len(self.work_tree.conflicts()) > 0:
 
361
            raise ConflictsInTree
 
362
 
 
363
        # Setup the bound branch variables as needed.
 
364
        self._check_bound_branch(operation, possible_master_transports)
 
365
 
 
366
        # Check that the working tree is up to date
 
367
        old_revno, new_revno = self._check_out_of_date_tree()
 
368
 
 
369
        # Complete configuration setup
 
370
        if reporter is not None:
 
371
            self.reporter = reporter
 
372
        elif self.reporter is None:
 
373
            self.reporter = self._select_reporter()
 
374
        if self.config is None:
 
375
            self.config = self.branch.get_config()
 
376
 
 
377
        self._set_specific_file_ids()
 
378
 
 
379
        # Setup the progress bar. As the number of files that need to be
 
380
        # committed in unknown, progress is reported as stages.
 
381
        # We keep track of entries separately though and include that
 
382
        # information in the progress bar during the relevant stages.
 
383
        self.pb_stage_name = ""
 
384
        self.pb_stage_count = 0
 
385
        self.pb_stage_total = 5
 
386
        if self.bound_branch:
 
387
            # 2 extra stages: "Uploading data to master branch" and "Merging
 
388
            # tags to master branch"
 
389
            self.pb_stage_total += 2
 
390
        self.pb.show_pct = False
 
391
        self.pb.show_spinner = False
 
392
        self.pb.show_eta = False
 
393
        self.pb.show_count = True
 
394
        self.pb.show_bar = True
 
395
 
 
396
        self._gather_parents()
 
397
        # After a merge, a selected file commit is not supported.
 
398
        # See 'bzr help merge' for an explanation as to why.
 
399
        if len(self.parents) > 1 and self.specific_files is not None:
 
400
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
401
        # Excludes are a form of selected file commit.
 
402
        if len(self.parents) > 1 and self.exclude:
 
403
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
404
 
 
405
        # Collect the changes
 
406
        self._set_progress_stage("Collecting changes", counter=True)
 
407
        self._lossy = lossy
 
408
        self.builder = self.branch.get_commit_builder(self.parents,
 
409
            self.config, timestamp, timezone, committer, self.revprops,
 
410
            rev_id, lossy=lossy)
 
411
        if not self.builder.supports_record_entry_contents and self.exclude:
 
412
            self.builder.abort()
 
413
            raise errors.ExcludesUnsupported(self.branch.repository)
 
414
 
275
415
        try:
276
 
            # Cannot commit with conflicts present.
277
 
            if len(self.work_tree.conflicts()) > 0:
278
 
                raise ConflictsInTree
279
 
 
280
 
            # Setup the bound branch variables as needed.
281
 
            self._check_bound_branch()
282
 
 
283
 
            # Check that the working tree is up to date
284
 
            old_revno, new_revno = self._check_out_of_date_tree()
285
 
 
286
 
            # Complete configuration setup
287
 
            if reporter is not None:
288
 
                self.reporter = reporter
289
 
            elif self.reporter is None:
290
 
                self.reporter = self._select_reporter()
291
 
            if self.config is None:
292
 
                self.config = self.branch.get_config()
293
 
 
294
 
            # If provided, ensure the specified files are versioned
295
 
            if self.specific_files is not None:
296
 
                # Note: This routine is being called because it raises
297
 
                # PathNotVersionedError as a side effect of finding the IDs. We
298
 
                # later use the ids we found as input to the working tree
299
 
                # inventory iterator, so we only consider those ids rather than
300
 
                # examining the whole tree again.
301
 
                # XXX: Dont we have filter_unversioned to do this more
302
 
                # cheaply?
303
 
                self.specific_file_ids = tree.find_ids_across_trees(
304
 
                    specific_files, [self.basis_tree, self.work_tree])
305
 
 
306
 
            # Setup the progress bar. As the number of files that need to be
307
 
            # committed in unknown, progress is reported as stages.
308
 
            # We keep track of entries separately though and include that
309
 
            # information in the progress bar during the relevant stages.
310
 
            self.pb_stage_name = ""
311
 
            self.pb_stage_count = 0
312
 
            self.pb_stage_total = 5
313
 
            if self.bound_branch:
314
 
                self.pb_stage_total += 1
315
 
            self.pb.show_pct = False
316
 
            self.pb.show_spinner = False
317
 
            self.pb.show_eta = False
318
 
            self.pb.show_count = True
319
 
            self.pb.show_bar = True
320
 
 
321
 
            # After a merge, a selected file commit is not supported.
322
 
            # See 'bzr help merge' for an explanation as to why.
323
 
            self.basis_inv = self.basis_tree.inventory
324
 
            self._gather_parents()
325
 
            if len(self.parents) > 1 and self.specific_files:
326
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
327
 
 
328
 
            # Collect the changes
329
 
            self._set_progress_stage("Collecting changes",
330
 
                    entries_title="Directory")
331
 
            self.builder = self.branch.get_commit_builder(self.parents,
332
 
                self.config, timestamp, timezone, committer, revprops, rev_id)
333
 
            
334
 
            try:
335
 
                # find the location being committed to
336
 
                if self.bound_branch:
337
 
                    master_location = self.master_branch.base
338
 
                else:
339
 
                    master_location = self.branch.base
340
 
 
341
 
                # report the start of the commit
342
 
                self.reporter.started(new_revno, self.rev_id, master_location)
343
 
 
344
 
                self._update_builder_with_changes()
345
 
                self._report_and_accumulate_deletes()
346
 
                self._check_pointless()
347
 
 
348
 
                # TODO: Now the new inventory is known, check for conflicts.
349
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
350
 
                # weave lines, because nothing should be recorded until it is known
351
 
                # that commit will succeed.
352
 
                self._set_progress_stage("Saving data locally")
353
 
                self.builder.finish_inventory()
354
 
 
355
 
                # Prompt the user for a commit message if none provided
356
 
                message = message_callback(self)
357
 
                assert isinstance(message, unicode), type(message)
358
 
                self.message = message
359
 
                self._escape_commit_message()
360
 
 
361
 
                # Add revision data to the local branch
362
 
                self.rev_id = self.builder.commit(self.message)
363
 
 
364
 
            except:
365
 
                self.builder.abort()
366
 
                raise
367
 
 
368
 
            self._process_pre_hooks(old_revno, new_revno)
369
 
 
370
 
            # Upload revision data to the master.
371
 
            # this will propagate merged revisions too if needed.
372
 
            if self.bound_branch:
373
 
                self._set_progress_stage("Uploading data to master branch")
374
 
                self.master_branch.repository.fetch(self.branch.repository,
375
 
                                                    revision_id=self.rev_id)
376
 
                # now the master has the revision data
377
 
                # 'commit' to the master first so a timeout here causes the
378
 
                # local branch to be out of date
379
 
                self.master_branch.set_last_revision_info(new_revno,
380
 
                                                          self.rev_id)
381
 
 
382
 
            # and now do the commit locally.
383
 
            self.branch.set_last_revision_info(new_revno, self.rev_id)
384
 
 
385
 
            # Make the working tree up to date with the branch
386
 
            self._set_progress_stage("Updating the working tree")
387
 
            self.work_tree.update_basis_by_delta(self.rev_id,
388
 
                 self._basis_delta)
389
 
            self.reporter.completed(new_revno, self.rev_id)
390
 
            self._process_post_hooks(old_revno, new_revno)
391
 
        finally:
392
 
            self._cleanup()
 
416
            self.builder.will_record_deletes()
 
417
            # find the location being committed to
 
418
            if self.bound_branch:
 
419
                master_location = self.master_branch.base
 
420
            else:
 
421
                master_location = self.branch.base
 
422
 
 
423
            # report the start of the commit
 
424
            self.reporter.started(new_revno, self.rev_id, master_location)
 
425
 
 
426
            self._update_builder_with_changes()
 
427
            self._check_pointless()
 
428
 
 
429
            # TODO: Now the new inventory is known, check for conflicts.
 
430
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
431
            # weave lines, because nothing should be recorded until it is known
 
432
            # that commit will succeed.
 
433
            self._set_progress_stage("Saving data locally")
 
434
            self.builder.finish_inventory()
 
435
 
 
436
            # Prompt the user for a commit message if none provided
 
437
            message = message_callback(self)
 
438
            self.message = message
 
439
 
 
440
            # Add revision data to the local branch
 
441
            self.rev_id = self.builder.commit(self.message)
 
442
 
 
443
        except Exception, e:
 
444
            mutter("aborting commit write group because of exception:")
 
445
            trace.log_exception_quietly()
 
446
            note("aborting commit write group: %r" % (e,))
 
447
            self.builder.abort()
 
448
            raise
 
449
 
 
450
        self._process_pre_hooks(old_revno, new_revno)
 
451
 
 
452
        # Upload revision data to the master.
 
453
        # this will propagate merged revisions too if needed.
 
454
        if self.bound_branch:
 
455
            self._set_progress_stage("Uploading data to master branch")
 
456
            # 'commit' to the master first so a timeout here causes the
 
457
            # local branch to be out of date
 
458
            (new_revno, self.rev_id) = self.master_branch.import_last_revision_info_and_tags(
 
459
                self.branch, new_revno, self.rev_id, lossy=lossy)
 
460
            if lossy:
 
461
                self.branch.fetch(self.master_branch, self.rev_id)
 
462
 
 
463
        # and now do the commit locally.
 
464
        self.branch.set_last_revision_info(new_revno, self.rev_id)
 
465
 
 
466
        # Merge local tags to remote
 
467
        if self.bound_branch:
 
468
            self._set_progress_stage("Merging tags to master branch")
 
469
            tag_conflicts = self.branch.tags.merge_to(self.master_branch.tags)
 
470
            if tag_conflicts:
 
471
                warning_lines = ['    ' + name for name, _, _ in tag_conflicts]
 
472
                note("Conflicting tags in bound branch:\n" +
 
473
                    "\n".join(warning_lines))
 
474
 
 
475
        # Make the working tree be up to date with the branch. This
 
476
        # includes automatic changes scheduled to be made to the tree, such
 
477
        # as updating its basis and unversioning paths that were missing.
 
478
        self.work_tree.unversion(self.deleted_ids)
 
479
        self._set_progress_stage("Updating the working tree")
 
480
        self.work_tree.update_basis_by_delta(self.rev_id,
 
481
             self.builder.get_basis_delta())
 
482
        self.reporter.completed(new_revno, self.rev_id)
 
483
        self._process_post_hooks(old_revno, new_revno)
393
484
        return self.rev_id
394
485
 
395
486
    def _select_reporter(self):
404
495
        # A merge with no effect on files
405
496
        if len(self.parents) > 1:
406
497
            return
407
 
        # TODO: we could simplify this by using self._basis_delta.
 
498
        # TODO: we could simplify this by using self.builder.basis_delta.
408
499
 
409
500
        # The initial commit adds a root directory, but this in itself is not
410
501
        # a worthwhile commit.
411
502
        if (self.basis_revid == revision.NULL_REVISION and
412
 
            len(self.builder.new_inventory) == 1):
 
503
            ((self.builder.new_inventory is not None and
 
504
             len(self.builder.new_inventory) == 1) or
 
505
            len(self.builder._basis_delta) == 1)):
413
506
            raise PointlessCommit()
414
 
        # If length == 1, then we only have the root entry. Which means
415
 
        # that there is no real difference (only the root could be different)
416
 
        # unless deletes occured, in which case the length is irrelevant.
417
 
        if (self.any_entries_deleted or 
418
 
            (len(self.builder.new_inventory) != 1 and
419
 
             self.any_entries_changed)):
 
507
        if self.builder.any_changes():
420
508
            return
421
509
        raise PointlessCommit()
422
510
 
423
 
    def _check_bound_branch(self):
 
511
    def _check_bound_branch(self, operation, possible_master_transports=None):
424
512
        """Check to see if the local branch is bound.
425
513
 
426
514
        If it is bound, then most of the commit will actually be
431
519
            raise errors.LocalRequiresBoundBranch()
432
520
 
433
521
        if not self.local:
434
 
            self.master_branch = self.branch.get_master_branch()
 
522
            self.master_branch = self.branch.get_master_branch(
 
523
                possible_master_transports)
435
524
 
436
525
        if not self.master_branch:
437
526
            # make this branch the reference branch for out of date checks.
448
537
        #       commits to the remote branch if they would fit.
449
538
        #       But for now, just require remote to be identical
450
539
        #       to local.
451
 
        
 
540
 
452
541
        # Make sure the local branch is identical to the master
453
542
        master_info = self.master_branch.last_revision_info()
454
543
        local_info = self.branch.last_revision_info()
460
549
        # so grab the lock
461
550
        self.bound_branch = self.branch
462
551
        self.master_branch.lock_write()
463
 
        self.master_locked = True
 
552
        operation.add_cleanup(self.master_branch.unlock)
464
553
 
465
554
    def _check_out_of_date_tree(self):
466
555
        """Check that the working tree is up to date.
511
600
    def _process_hooks(self, hook_name, old_revno, new_revno):
512
601
        if not Branch.hooks[hook_name]:
513
602
            return
514
 
        
 
603
 
515
604
        # new style commit hooks:
516
605
        if not self.bound_branch:
517
606
            hook_master = self.branch
526
615
            old_revid = self.parents[0]
527
616
        else:
528
617
            old_revid = bzrlib.revision.NULL_REVISION
529
 
        
 
618
 
530
619
        if hook_name == "pre_commit":
531
620
            future_tree = self.builder.revision_tree()
532
621
            tree_delta = future_tree.changes_from(self.basis_tree,
533
622
                                             include_root=True)
534
 
        
 
623
 
535
624
        for hook in Branch.hooks[hook_name]:
536
625
            # show the running hook in the progress bar. As hooks may
537
626
            # end up doing nothing (e.g. because they are not configured by
551
640
                     old_revno, old_revid, new_revno, self.rev_id,
552
641
                     tree_delta, future_tree)
553
642
 
554
 
    def _cleanup(self):
555
 
        """Cleanup any open locks, progress bars etc."""
556
 
        cleanups = [self._cleanup_bound_branch,
557
 
                    self.basis_tree.unlock,
558
 
                    self.work_tree.unlock,
559
 
                    self.pb.finished]
560
 
        found_exception = None
561
 
        for cleanup in cleanups:
562
 
            try:
563
 
                cleanup()
564
 
            # we want every cleanup to run no matter what.
565
 
            # so we have a catchall here, but we will raise the
566
 
            # last encountered exception up the stack: and
567
 
            # typically this will be useful enough.
568
 
            except Exception, e:
569
 
                found_exception = e
570
 
        if found_exception is not None: 
571
 
            # don't do a plan raise, because the last exception may have been
572
 
            # trashed, e is our sure-to-work exception even though it loses the
573
 
            # full traceback. XXX: RBC 20060421 perhaps we could check the
574
 
            # exc_info and if its the same one do a plain raise otherwise 
575
 
            # 'raise e' as we do now.
576
 
            raise e
577
 
 
578
 
    def _cleanup_bound_branch(self):
579
 
        """Executed at the end of a try/finally to cleanup a bound branch.
580
 
 
581
 
        If the branch wasn't bound, this is a no-op.
582
 
        If it was, it resents self.branch to the local branch, instead
583
 
        of being the master.
584
 
        """
585
 
        if not self.bound_branch:
586
 
            return
587
 
        if self.master_locked:
588
 
            self.master_branch.unlock()
589
 
 
590
 
    def _escape_commit_message(self):
591
 
        """Replace xml-incompatible control characters."""
592
 
        # FIXME: RBC 20060419 this should be done by the revision
593
 
        # serialiser not by commit. Then we can also add an unescaper
594
 
        # in the deserializer and start roundtripping revision messages
595
 
        # precisely. See repository_implementations/test_repository.py
596
 
        
597
 
        # Python strings can include characters that can't be
598
 
        # represented in well-formed XML; escape characters that
599
 
        # aren't listed in the XML specification
600
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
601
 
        self.message, escape_count = re.subn(
602
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
603
 
            lambda match: match.group(0).encode('unicode_escape'),
604
 
            self.message)
605
 
        if escape_count:
606
 
            self.reporter.escaped(escape_count, self.message)
607
 
 
608
643
    def _gather_parents(self):
609
644
        """Record the parents of a merge for merge detection."""
610
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
645
        # TODO: Make sure that this list doesn't contain duplicate
611
646
        # entries and the order is preserved when doing this.
612
 
        self.parents = self.work_tree.get_parent_ids()
 
647
        if self.use_record_iter_changes:
 
648
            return
 
649
        self.basis_inv = self.basis_tree.inventory
613
650
        self.parent_invs = [self.basis_inv]
614
651
        for revision in self.parents[1:]:
615
652
            if self.branch.repository.has_revision(revision):
622
659
    def _update_builder_with_changes(self):
623
660
        """Update the commit builder with the data about what has changed.
624
661
        """
625
 
        # Build the revision inventory.
626
 
        #
627
 
        # This starts by creating a new empty inventory. Depending on
628
 
        # which files are selected for commit, and what is present in the
629
 
        # current tree, the new inventory is populated. inventory entries 
630
 
        # which are candidates for modification have their revision set to
631
 
        # None; inventory entries that are carried over untouched have their
632
 
        # revision set to their prior value.
633
 
        #
634
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
635
 
        # results to create a new inventory at the same time, which results
636
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
637
 
        # ADHB 11-07-2006
638
 
 
 
662
        exclude = self.exclude
639
663
        specific_files = self.specific_files
640
664
        mutter("Selecting files for commit with filter %s", specific_files)
641
665
 
642
 
        # Build the new inventory
643
 
        self._populate_from_inventory(specific_files)
644
 
 
 
666
        self._check_strict()
 
667
        if self.use_record_iter_changes:
 
668
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
 
669
                specific_files=specific_files)
 
670
            iter_changes = self._filter_iter_changes(iter_changes)
 
671
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
672
                self.work_tree, self.basis_revid, iter_changes):
 
673
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
674
        else:
 
675
            # Build the new inventory
 
676
            self._populate_from_inventory()
 
677
            self._record_unselected()
 
678
            self._report_and_accumulate_deletes()
 
679
 
 
680
    def _filter_iter_changes(self, iter_changes):
 
681
        """Process iter_changes.
 
682
 
 
683
        This method reports on the changes in iter_changes to the user, and 
 
684
        converts 'missing' entries in the iter_changes iterator to 'deleted'
 
685
        entries. 'missing' entries have their
 
686
 
 
687
        :param iter_changes: An iter_changes to process.
 
688
        :return: A generator of changes.
 
689
        """
 
690
        reporter = self.reporter
 
691
        report_changes = reporter.is_verbose()
 
692
        deleted_ids = []
 
693
        for change in iter_changes:
 
694
            if report_changes:
 
695
                old_path = change[1][0]
 
696
                new_path = change[1][1]
 
697
                versioned = change[3][1]
 
698
            kind = change[6][1]
 
699
            versioned = change[3][1]
 
700
            if kind is None and versioned:
 
701
                # 'missing' path
 
702
                if report_changes:
 
703
                    reporter.missing(new_path)
 
704
                deleted_ids.append(change[0])
 
705
                # Reset the new path (None) and new versioned flag (False)
 
706
                change = (change[0], (change[1][0], None), change[2],
 
707
                    (change[3][0], False)) + change[4:]
 
708
            elif kind == 'tree-reference':
 
709
                if self.recursive == 'down':
 
710
                    self._commit_nested_tree(change[0], change[1][1])
 
711
            if change[3][0] or change[3][1]:
 
712
                yield change
 
713
                if report_changes:
 
714
                    if new_path is None:
 
715
                        reporter.deleted(old_path)
 
716
                    elif old_path is None:
 
717
                        reporter.snapshot_change('added', new_path)
 
718
                    elif old_path != new_path:
 
719
                        reporter.renamed('renamed', old_path, new_path)
 
720
                    else:
 
721
                        if (new_path or 
 
722
                            self.work_tree.branch.repository._format.rich_root_data):
 
723
                            # Don't report on changes to '' in non rich root
 
724
                            # repositories.
 
725
                            reporter.snapshot_change('modified', new_path)
 
726
            self._next_progress_entry()
 
727
        # Unversion IDs that were found to be deleted
 
728
        self.deleted_ids = deleted_ids
 
729
 
 
730
    def _record_unselected(self):
645
731
        # If specific files are selected, then all un-selected files must be
646
732
        # recorded in their previous state. For more details, see
647
733
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
648
 
        if specific_files:
 
734
        if self.specific_files or self.exclude:
 
735
            specific_files = self.specific_files or []
649
736
            for path, old_ie in self.basis_inv.iter_entries():
650
737
                if old_ie.file_id in self.builder.new_inventory:
651
738
                    # already added - skip.
652
739
                    continue
653
 
                if is_inside_any(specific_files, path):
654
 
                    # was inside the selected path, if not present it has been
655
 
                    # deleted so skip.
 
740
                if (is_inside_any(specific_files, path)
 
741
                    and not is_inside_any(self.exclude, path)):
 
742
                    # was inside the selected path, and not excluded - if not
 
743
                    # present it has been deleted so skip.
656
744
                    continue
657
 
                if old_ie.kind == 'directory':
658
 
                    self._next_progress_entry()
659
 
                # not in final inv yet, was not in the selected files, so is an
660
 
                # entry to be preserved unaltered.
 
745
                # From here down it was either not selected, or was excluded:
 
746
                # We preserve the entry unaltered.
661
747
                ie = old_ie.copy()
662
748
                # Note: specific file commits after a merge are currently
663
749
                # prohibited. This test is for sanity/safety in case it's
664
750
                # required after that changes.
665
751
                if len(self.parents) > 1:
666
752
                    ie.revision = None
667
 
                delta, version_recorded = self.builder.record_entry_contents(
668
 
                    ie, self.parent_invs, path, self.basis_tree, None)
669
 
                if version_recorded:
670
 
                    self.any_entries_changed = True
671
 
                if delta: self._basis_delta.append(delta)
 
753
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
754
                    self.basis_tree, None)
672
755
 
673
756
    def _report_and_accumulate_deletes(self):
674
 
        # XXX: Could the list of deleted paths and ids be instead taken from
675
 
        # _populate_from_inventory?
676
 
        deleted_ids = set(self.basis_inv._byid.keys()) - \
677
 
            set(self.builder.new_inventory._byid.keys())
 
757
        if (isinstance(self.basis_inv, Inventory)
 
758
            and isinstance(self.builder.new_inventory, Inventory)):
 
759
            # the older Inventory classes provide a _byid dict, and building a
 
760
            # set from the keys of this dict is substantially faster than even
 
761
            # getting a set of ids from the inventory
 
762
            #
 
763
            # <lifeless> set(dict) is roughly the same speed as
 
764
            # set(iter(dict)) and both are significantly slower than
 
765
            # set(dict.keys())
 
766
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
767
               set(self.builder.new_inventory._byid.keys())
 
768
        else:
 
769
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
678
770
        if deleted_ids:
679
771
            self.any_entries_deleted = True
680
772
            deleted = [(self.basis_tree.id2path(file_id), file_id)
682
774
            deleted.sort()
683
775
            # XXX: this is not quite directory-order sorting
684
776
            for path, file_id in deleted:
685
 
                self._basis_delta.append((path, None, file_id, None))
 
777
                self.builder.record_delete(path, file_id)
686
778
                self.reporter.deleted(path)
687
779
 
688
 
    def _populate_from_inventory(self, specific_files):
689
 
        """Populate the CommitBuilder by walking the working tree inventory."""
 
780
    def _check_strict(self):
 
781
        # XXX: when we use iter_changes this would likely be faster if
 
782
        # iter_changes would check for us (even in the presence of
 
783
        # selected_files).
690
784
        if self.strict:
691
785
            # raise an exception as soon as we find a single unknown.
692
786
            for unknown in self.work_tree.unknowns():
693
787
                raise StrictCommitFailed()
694
 
               
 
788
 
 
789
    def _populate_from_inventory(self):
 
790
        """Populate the CommitBuilder by walking the working tree inventory."""
 
791
        # Build the revision inventory.
 
792
        #
 
793
        # This starts by creating a new empty inventory. Depending on
 
794
        # which files are selected for commit, and what is present in the
 
795
        # current tree, the new inventory is populated. inventory entries
 
796
        # which are candidates for modification have their revision set to
 
797
        # None; inventory entries that are carried over untouched have their
 
798
        # revision set to their prior value.
 
799
        #
 
800
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
801
        # results to create a new inventory at the same time, which results
 
802
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
803
        # ADHB 11-07-2006
 
804
 
 
805
        specific_files = self.specific_files
 
806
        exclude = self.exclude
695
807
        report_changes = self.reporter.is_verbose()
696
808
        deleted_ids = []
697
 
        deleted_paths = set()
 
809
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
810
        # deleted, then we have {'foo':{'bar':{}}}
 
811
        deleted_paths = {}
698
812
        # XXX: Note that entries may have the wrong kind because the entry does
699
813
        # not reflect the status on disk.
700
814
        work_inv = self.work_tree.inventory
 
815
        # NB: entries will include entries within the excluded ids/paths
 
816
        # because iter_entries_by_dir has no 'exclude' facility today.
701
817
        entries = work_inv.iter_entries_by_dir(
702
818
            specific_file_ids=self.specific_file_ids, yield_parents=True)
703
819
        for path, existing_ie in entries:
705
821
            name = existing_ie.name
706
822
            parent_id = existing_ie.parent_id
707
823
            kind = existing_ie.kind
708
 
            if kind == 'directory':
709
 
                self._next_progress_entry()
710
824
            # Skip files that have been deleted from the working tree.
711
 
            # The deleted files/directories are also recorded so they
712
 
            # can be explicitly unversioned later. Note that when a
713
 
            # filter of specific files is given, we must only skip/record
714
 
            # deleted files matching that filter.
715
 
            if is_inside_any(deleted_paths, path):
 
825
            # The deleted path ids are also recorded so they can be explicitly
 
826
            # unversioned later.
 
827
            if deleted_paths:
 
828
                path_segments = splitpath(path)
 
829
                deleted_dict = deleted_paths
 
830
                for segment in path_segments:
 
831
                    deleted_dict = deleted_dict.get(segment, None)
 
832
                    if not deleted_dict:
 
833
                        # We either took a path not present in the dict
 
834
                        # (deleted_dict was None), or we've reached an empty
 
835
                        # child dir in the dict, so are now a sub-path.
 
836
                        break
 
837
                else:
 
838
                    deleted_dict = None
 
839
                if deleted_dict is not None:
 
840
                    # the path has a deleted parent, do not add it.
 
841
                    continue
 
842
            if exclude and is_inside_any(exclude, path):
 
843
                # Skip excluded paths. Excluded paths are processed by
 
844
                # _update_builder_with_changes.
716
845
                continue
717
846
            content_summary = self.work_tree.path_content_summary(path)
 
847
            kind = content_summary[0]
 
848
            # Note that when a filter of specific files is given, we must only
 
849
            # skip/record deleted files matching that filter.
718
850
            if not specific_files or is_inside_any(specific_files, path):
719
 
                if content_summary[0] == 'missing':
720
 
                    deleted_paths.add(path)
 
851
                if kind == 'missing':
 
852
                    if not deleted_paths:
 
853
                        # path won't have been split yet.
 
854
                        path_segments = splitpath(path)
 
855
                    deleted_dict = deleted_paths
 
856
                    for segment in path_segments:
 
857
                        deleted_dict = deleted_dict.setdefault(segment, {})
721
858
                    self.reporter.missing(path)
 
859
                    self._next_progress_entry()
722
860
                    deleted_ids.append(file_id)
723
861
                    continue
724
862
            # TODO: have the builder do the nested commit just-in-time IF and
725
863
            # only if needed.
726
 
            if content_summary[0] == 'tree-reference':
 
864
            if kind == 'tree-reference':
727
865
                # enforce repository nested tree policy.
728
866
                if (not self.work_tree.supports_tree_reference() or
729
867
                    # repository does not support it either.
730
868
                    not self.branch.repository._format.supports_tree_reference):
731
 
                    content_summary = ('directory',) + content_summary[1:]
732
 
            kind = content_summary[0]
733
 
            # TODO: specific_files filtering before nested tree processing
734
 
            if kind == 'tree-reference':
735
 
                if self.recursive == 'down':
 
869
                    kind = 'directory'
 
870
                    content_summary = (kind, None, None, None)
 
871
                elif self.recursive == 'down':
736
872
                    nested_revision_id = self._commit_nested_tree(
737
873
                        file_id, path)
738
 
                    content_summary = content_summary[:3] + (
739
 
                        nested_revision_id,)
 
874
                    content_summary = (kind, None, None, nested_revision_id)
740
875
                else:
741
 
                    content_summary = content_summary[:3] + (
742
 
                        self.work_tree.get_reference_revision(file_id),)
 
876
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
 
877
                    content_summary = (kind, None, None, nested_revision_id)
743
878
 
744
879
            # Record an entry for this item
745
880
            # Note: I don't particularly want to have the existing_ie
751
886
                content_summary)
752
887
 
753
888
        # Unversion IDs that were found to be deleted
754
 
        self.work_tree.unversion(deleted_ids)
 
889
        self.deleted_ids = deleted_ids
755
890
 
756
891
    def _commit_nested_tree(self, file_id, path):
757
892
        "Commit a nested tree."
759
894
        # FIXME: be more comprehensive here:
760
895
        # this works when both trees are in --trees repository,
761
896
        # but when both are bound to a different repository,
762
 
        # it fails; a better way of approaching this is to 
 
897
        # it fails; a better way of approaching this is to
763
898
        # finally implement the explicit-caches approach design
764
899
        # a while back - RBC 20070306.
765
900
        if sub_tree.branch.repository.has_same_location(
789
924
        else:
790
925
            ie = existing_ie.copy()
791
926
            ie.revision = None
792
 
        delta, version_recorded = self.builder.record_entry_contents(ie,
793
 
            self.parent_invs, path, self.work_tree, content_summary)
794
 
        if delta:
795
 
            self._basis_delta.append(delta)
796
 
        if version_recorded:
797
 
            self.any_entries_changed = True
 
927
        # For carried over entries we don't care about the fs hash - the repo
 
928
        # isn't generating a sha, so we're not saving computation time.
 
929
        _, _, fs_hash = self.builder.record_entry_contents(
 
930
            ie, self.parent_invs, path, self.work_tree, content_summary)
798
931
        if report_changes:
799
932
            self._report_change(ie, path)
 
933
        if fs_hash:
 
934
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
800
935
        return ie
801
936
 
802
937
    def _report_change(self, ie, path):
810
945
        else:
811
946
            basis_ie = None
812
947
        change = ie.describe_change(basis_ie, ie)
813
 
        if change in (InventoryEntry.RENAMED, 
 
948
        if change in (InventoryEntry.RENAMED,
814
949
            InventoryEntry.MODIFIED_AND_RENAMED):
815
950
            old_path = self.basis_inv.id2path(ie.file_id)
816
951
            self.reporter.renamed(change, old_path, path)
 
952
            self._next_progress_entry()
817
953
        else:
 
954
            if change == 'unchanged':
 
955
                return
818
956
            self.reporter.snapshot_change(change, path)
 
957
            self._next_progress_entry()
819
958
 
820
 
    def _set_progress_stage(self, name, entries_title=None):
 
959
    def _set_progress_stage(self, name, counter=False):
821
960
        """Set the progress stage and emit an update to the progress bar."""
822
961
        self.pb_stage_name = name
823
962
        self.pb_stage_count += 1
824
 
        self.pb_entries_title = entries_title
825
 
        if entries_title is not None:
 
963
        if counter:
826
964
            self.pb_entries_count = 0
827
 
            self.pb_entries_total = '?'
 
965
        else:
 
966
            self.pb_entries_count = None
828
967
        self._emit_progress()
829
968
 
830
969
    def _next_progress_entry(self):
833
972
        self._emit_progress()
834
973
 
835
974
    def _emit_progress(self):
836
 
        if self.pb_entries_title:
837
 
            if self.pb_entries_total == '?':
838
 
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
839
 
                    self.pb_entries_title, self.pb_entries_count)
840
 
            else:
841
 
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
842
 
                    self.pb_entries_title, self.pb_entries_count,
843
 
                    str(self.pb_entries_total))
 
975
        if self.pb_entries_count is not None:
 
976
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
977
                self.pb_entries_count)
844
978
        else:
845
 
            text = "%s - Stage" % (self.pb_stage_name)
 
979
            text = "%s - Stage" % (self.pb_stage_name, )
846
980
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
847
981
 
 
982
    def _set_specific_file_ids(self):
 
983
        """populate self.specific_file_ids if we will use it."""
 
984
        if not self.use_record_iter_changes:
 
985
            # If provided, ensure the specified files are versioned
 
986
            if self.specific_files is not None:
 
987
                # Note: This routine is being called because it raises
 
988
                # PathNotVersionedError as a side effect of finding the IDs. We
 
989
                # later use the ids we found as input to the working tree
 
990
                # inventory iterator, so we only consider those ids rather than
 
991
                # examining the whole tree again.
 
992
                # XXX: Dont we have filter_unversioned to do this more
 
993
                # cheaply?
 
994
                self.specific_file_ids = tree.find_ids_across_trees(
 
995
                    self.specific_files, [self.basis_tree, self.work_tree])
 
996
            else:
 
997
                self.specific_file_ids = None