← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Aaron Bentley
  • Date: 2008-11-23 16:38:39 UTC
  • mto: This revision was merged to the branch mainline in revision 3892.
  • Revision ID: aaron@aaronbentley.com-20081123163839-ew27m17130fz85v6
Update documentation

Show diffs side-by-side

added added

removed removed

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