← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-01 11:25:12 UTC
  • mfrom: (3211.7.10 protocol-v3-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20080501112512-b9lgs4w8r43evtn1
Add the smart protocol v3 specification to network-protocol.txt

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 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
 
from bzrlib.osutils import (get_user_encoding,
68
 
                            is_inside_any,
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
69
73
                            minimum_path_selection,
 
74
                            quotefn, sha_file, split_lines,
70
75
                            splitpath,
71
76
                            )
72
 
from bzrlib.trace import mutter, note, is_quiet
73
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
77
from bzrlib.testament import Testament
 
78
from bzrlib.trace import mutter, note, warning, is_quiet
 
79
from bzrlib.xml5 import serializer_v5
 
80
from bzrlib.inventory import 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,
227
204
               reporter=None,
228
205
               config=None,
229
206
               message_callback=None,
230
 
               recursive='down',
231
 
               exclude=None,
232
 
               possible_master_transports=None,
233
 
               lossy=False):
 
207
               recursive='down'):
234
208
        """Commit working copy as a new revision.
235
209
 
236
210
        :param message: the commit message (it or message_callback is required)
237
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
238
211
 
239
212
        :param timestamp: if not None, seconds-since-epoch for a
240
213
            postdated/predated commit.
241
214
 
242
 
        :param specific_files: If not None, commit only those files. An empty
243
 
            list means 'commit no files'.
 
215
        :param specific_files: If true, commit only those files.
244
216
 
245
217
        :param rev_id: If set, use this as the new revision id.
246
218
            Useful for test or import commands that need to tightly
260
232
        :param verbose: if True and the reporter is not None, report everything
261
233
        :param recursive: If set to 'down', commit in any subtrees that have
262
234
            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.
268
235
        """
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
236
        mutter('preparing to commit')
297
237
 
298
238
        if working_tree is None:
306
246
        if message_callback is None:
307
247
            if message is not None:
308
248
                if isinstance(message, str):
309
 
                    message = message.decode(get_user_encoding())
 
249
                    message = message.decode(bzrlib.user_encoding)
310
250
                message_callback = lambda x: message
311
251
            else:
312
252
                raise BzrError("The message or message_callback keyword"
313
253
                               " parameter is required for commit().")
314
254
 
315
255
        self.bound_branch = None
 
256
        self.any_entries_changed = False
316
257
        self.any_entries_deleted = False
317
 
        if exclude is not None:
318
 
            self.exclude = sorted(
319
 
                minimum_path_selection(exclude))
320
 
        else:
321
 
            self.exclude = []
322
258
        self.local = local
323
259
        self.master_branch = None
 
260
        self.master_locked = False
324
261
        self.recursive = recursive
325
262
        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
263
        if specific_files is not None:
329
264
            self.specific_files = sorted(
330
265
                minimum_path_selection(specific_files))
331
266
        else:
332
267
            self.specific_files = None
333
 
 
 
268
        self.specific_file_ids = None
334
269
        self.allow_pointless = allow_pointless
 
270
        self.revprops = revprops
335
271
        self.message_callback = message_callback
336
272
        self.timestamp = timestamp
337
273
        self.timezone = timezone
338
274
        self.committer = committer
339
275
        self.strict = strict
340
276
        self.verbose = verbose
 
277
        # accumulates an inventory delta to the basis entry, so we can make
 
278
        # just the necessary updates to the workingtree's cached basis.
 
279
        self._basis_delta = []
341
280
 
342
281
        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)
 
282
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
355
283
        self.basis_revid = self.work_tree.last_revision()
356
284
        self.basis_tree = self.work_tree.basis_tree()
357
285
        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
286
        try:
422
 
            self.builder.will_record_deletes()
423
 
            # find the location being committed to
 
287
            # Cannot commit with conflicts present.
 
288
            if len(self.work_tree.conflicts()) > 0:
 
289
                raise ConflictsInTree
 
290
 
 
291
            # Setup the bound branch variables as needed.
 
292
            self._check_bound_branch()
 
293
 
 
294
            # Check that the working tree is up to date
 
295
            old_revno, new_revno = self._check_out_of_date_tree()
 
296
 
 
297
            # Complete configuration setup
 
298
            if reporter is not None:
 
299
                self.reporter = reporter
 
300
            elif self.reporter is None:
 
301
                self.reporter = self._select_reporter()
 
302
            if self.config is None:
 
303
                self.config = self.branch.get_config()
 
304
 
 
305
            # If provided, ensure the specified files are versioned
 
306
            if self.specific_files is not None:
 
307
                # Note: This routine is being called because it raises
 
308
                # PathNotVersionedError as a side effect of finding the IDs. We
 
309
                # later use the ids we found as input to the working tree
 
310
                # inventory iterator, so we only consider those ids rather than
 
311
                # examining the whole tree again.
 
312
                # XXX: Dont we have filter_unversioned to do this more
 
313
                # cheaply?
 
314
                self.specific_file_ids = tree.find_ids_across_trees(
 
315
                    specific_files, [self.basis_tree, self.work_tree])
 
316
 
 
317
            # Setup the progress bar. As the number of files that need to be
 
318
            # committed in unknown, progress is reported as stages.
 
319
            # We keep track of entries separately though and include that
 
320
            # information in the progress bar during the relevant stages.
 
321
            self.pb_stage_name = ""
 
322
            self.pb_stage_count = 0
 
323
            self.pb_stage_total = 5
424
324
            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:
 
325
                self.pb_stage_total += 1
 
326
            self.pb.show_pct = False
 
327
            self.pb.show_spinner = False
 
328
            self.pb.show_eta = False
 
329
            self.pb.show_count = True
 
330
            self.pb.show_bar = True
 
331
 
 
332
            # After a merge, a selected file commit is not supported.
 
333
            # See 'bzr help merge' for an explanation as to why.
 
334
            self.basis_inv = self.basis_tree.inventory
 
335
            self._gather_parents()
 
336
            if len(self.parents) > 1 and self.specific_files:
 
337
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
338
 
 
339
            # Collect the changes
 
340
            self._set_progress_stage("Collecting changes",
 
341
                    entries_title="Directory")
 
342
            self.builder = self.branch.get_commit_builder(self.parents,
 
343
                self.config, timestamp, timezone, committer, revprops, rev_id)
 
344
            
 
345
            try:
 
346
                # find the location being committed to
 
347
                if self.bound_branch:
 
348
                    master_location = self.master_branch.base
 
349
                else:
 
350
                    master_location = self.branch.base
 
351
 
 
352
                # report the start of the commit
 
353
                self.reporter.started(new_revno, self.rev_id, master_location)
 
354
 
 
355
                self._update_builder_with_changes()
 
356
                self._report_and_accumulate_deletes()
 
357
                self._check_pointless()
 
358
 
 
359
                # TODO: Now the new inventory is known, check for conflicts.
 
360
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
361
                # weave lines, because nothing should be recorded until it is known
 
362
                # that commit will succeed.
 
363
                self._set_progress_stage("Saving data locally")
 
364
                self.builder.finish_inventory()
 
365
 
 
366
                # Prompt the user for a commit message if none provided
 
367
                message = message_callback(self)
 
368
                assert isinstance(message, unicode), type(message)
 
369
                self.message = message
 
370
                self._escape_commit_message()
 
371
 
 
372
                # Add revision data to the local branch
 
373
                self.rev_id = self.builder.commit(self.message)
 
374
 
 
375
            except:
 
376
                self.builder.abort()
 
377
                raise
 
378
 
480
379
            self._process_pre_hooks(old_revno, new_revno)
481
380
 
482
381
            # Upload revision data to the master.
483
382
            # this will propagate merged revisions too if needed.
484
383
            if self.bound_branch:
485
 
                self._set_progress_stage("Uploading data to master branch")
 
384
                if not self.master_branch.repository.has_same_location(
 
385
                        self.branch.repository):
 
386
                    self._set_progress_stage("Uploading data to master branch")
 
387
                    self.master_branch.repository.fetch(self.branch.repository,
 
388
                        revision_id=self.rev_id)
 
389
                # now the master has the revision data
486
390
                # 'commit' to the master first so a timeout here causes the
487
391
                # 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)
 
392
                self.master_branch.set_last_revision_info(new_revno,
 
393
                                                          self.rev_id)
492
394
 
493
395
            # and now do the commit locally.
494
396
            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
397
 
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))) )
 
398
            # Make the working tree up to date with the branch
 
399
            self._set_progress_stage("Updating the working tree")
 
400
            self.work_tree.update_basis_by_delta(self.rev_id,
 
401
                 self._basis_delta)
 
402
            self.reporter.completed(new_revno, self.rev_id)
 
403
            self._process_post_hooks(old_revno, new_revno)
 
404
        finally:
 
405
            self._cleanup()
 
406
        return self.rev_id
513
407
 
514
408
    def _select_reporter(self):
515
409
        """Select the CommitReporter to use."""
523
417
        # A merge with no effect on files
524
418
        if len(self.parents) > 1:
525
419
            return
526
 
        if self.builder.any_changes():
 
420
        # TODO: we could simplify this by using self._basis_delta.
 
421
 
 
422
        # The initial commit adds a root directory, but this in itself is not
 
423
        # a worthwhile commit.
 
424
        if (self.basis_revid == revision.NULL_REVISION and
 
425
            len(self.builder.new_inventory) == 1):
 
426
            raise PointlessCommit()
 
427
        # If length == 1, then we only have the root entry. Which means
 
428
        # that there is no real difference (only the root could be different)
 
429
        # unless deletes occured, in which case the length is irrelevant.
 
430
        if (self.any_entries_deleted or 
 
431
            (len(self.builder.new_inventory) != 1 and
 
432
             self.any_entries_changed)):
527
433
            return
528
434
        raise PointlessCommit()
529
435
 
530
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
436
    def _check_bound_branch(self):
531
437
        """Check to see if the local branch is bound.
532
438
 
533
439
        If it is bound, then most of the commit will actually be
538
444
            raise errors.LocalRequiresBoundBranch()
539
445
 
540
446
        if not self.local:
541
 
            self.master_branch = self.branch.get_master_branch(
542
 
                possible_master_transports)
 
447
            self.master_branch = self.branch.get_master_branch()
543
448
 
544
449
        if not self.master_branch:
545
450
            # make this branch the reference branch for out of date checks.
556
461
        #       commits to the remote branch if they would fit.
557
462
        #       But for now, just require remote to be identical
558
463
        #       to local.
559
 
 
 
464
        
560
465
        # Make sure the local branch is identical to the master
561
466
        master_info = self.master_branch.last_revision_info()
562
467
        local_info = self.branch.last_revision_info()
568
473
        # so grab the lock
569
474
        self.bound_branch = self.branch
570
475
        self.master_branch.lock_write()
571
 
        operation.add_cleanup(self.master_branch.unlock)
 
476
        self.master_locked = True
572
477
 
573
478
    def _check_out_of_date_tree(self):
574
479
        """Check that the working tree is up to date.
575
480
 
576
 
        :return: old_revision_number, old_revision_id, new_revision_number
577
 
            tuple
 
481
        :return: old_revision_number,new_revision_number tuple
578
482
        """
579
483
        try:
580
484
            first_tree_parent = self.work_tree.get_parent_ids()[0]
593
497
        else:
594
498
            # ghost parents never appear in revision history.
595
499
            new_revno = 1
596
 
        return old_revno, master_last, new_revno
 
500
        return old_revno,new_revno
597
501
 
598
502
    def _process_pre_hooks(self, old_revno, new_revno):
599
503
        """Process any registered pre commit hooks."""
605
509
        # Process the post commit hooks, if any
606
510
        self._set_progress_stage("Running post_commit hooks")
607
511
        # 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(' ')
 
512
        # 0.15)
 
513
        if self.config.post_commit() is not None:
 
514
            hooks = self.config.post_commit().split(' ')
612
515
            # this would be nicer with twisted.python.reflect.namedAny
613
516
            for hook in hooks:
614
517
                result = eval(hook + '(branch, rev_id)',
621
524
    def _process_hooks(self, hook_name, old_revno, new_revno):
622
525
        if not Branch.hooks[hook_name]:
623
526
            return
624
 
 
 
527
        
625
528
        # new style commit hooks:
626
529
        if not self.bound_branch:
627
530
            hook_master = self.branch
636
539
            old_revid = self.parents[0]
637
540
        else:
638
541
            old_revid = bzrlib.revision.NULL_REVISION
639
 
 
 
542
        
640
543
        if hook_name == "pre_commit":
641
544
            future_tree = self.builder.revision_tree()
642
545
            tree_delta = future_tree.changes_from(self.basis_tree,
643
546
                                             include_root=True)
644
 
 
 
547
        
645
548
        for hook in Branch.hooks[hook_name]:
646
549
            # show the running hook in the progress bar. As hooks may
647
550
            # end up doing nothing (e.g. because they are not configured by
661
564
                     old_revno, old_revid, new_revno, self.rev_id,
662
565
                     tree_delta, future_tree)
663
566
 
 
567
    def _cleanup(self):
 
568
        """Cleanup any open locks, progress bars etc."""
 
569
        cleanups = [self._cleanup_bound_branch,
 
570
                    self.basis_tree.unlock,
 
571
                    self.work_tree.unlock,
 
572
                    self.pb.finished]
 
573
        found_exception = None
 
574
        for cleanup in cleanups:
 
575
            try:
 
576
                cleanup()
 
577
            # we want every cleanup to run no matter what.
 
578
            # so we have a catchall here, but we will raise the
 
579
            # last encountered exception up the stack: and
 
580
            # typically this will be useful enough.
 
581
            except Exception, e:
 
582
                found_exception = e
 
583
        if found_exception is not None: 
 
584
            # don't do a plan raise, because the last exception may have been
 
585
            # trashed, e is our sure-to-work exception even though it loses the
 
586
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
587
            # exc_info and if its the same one do a plain raise otherwise 
 
588
            # 'raise e' as we do now.
 
589
            raise e
 
590
 
 
591
    def _cleanup_bound_branch(self):
 
592
        """Executed at the end of a try/finally to cleanup a bound branch.
 
593
 
 
594
        If the branch wasn't bound, this is a no-op.
 
595
        If it was, it resents self.branch to the local branch, instead
 
596
        of being the master.
 
597
        """
 
598
        if not self.bound_branch:
 
599
            return
 
600
        if self.master_locked:
 
601
            self.master_branch.unlock()
 
602
 
 
603
    def _escape_commit_message(self):
 
604
        """Replace xml-incompatible control characters."""
 
605
        # FIXME: RBC 20060419 this should be done by the revision
 
606
        # serialiser not by commit. Then we can also add an unescaper
 
607
        # in the deserializer and start roundtripping revision messages
 
608
        # precisely. See repository_implementations/test_repository.py
 
609
        
 
610
        # Python strings can include characters that can't be
 
611
        # represented in well-formed XML; escape characters that
 
612
        # aren't listed in the XML specification
 
613
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
614
        self.message, escape_count = re.subn(
 
615
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
616
            lambda match: match.group(0).encode('unicode_escape'),
 
617
            self.message)
 
618
        if escape_count:
 
619
            self.reporter.escaped(escape_count, self.message)
 
620
 
664
621
    def _gather_parents(self):
665
622
        """Record the parents of a merge for merge detection."""
666
 
        # TODO: Make sure that this list doesn't contain duplicate
 
623
        # TODO: Make sure that this list doesn't contain duplicate 
667
624
        # 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.inventory
 
625
        self.parents = self.work_tree.get_parent_ids()
671
626
        self.parent_invs = [self.basis_inv]
672
627
        for revision in self.parents[1:]:
673
628
            if self.branch.repository.has_revision(revision):
680
635
    def _update_builder_with_changes(self):
681
636
        """Update the commit builder with the data about what has changed.
682
637
        """
683
 
        exclude = self.exclude
 
638
        # Build the revision inventory.
 
639
        #
 
640
        # This starts by creating a new empty inventory. Depending on
 
641
        # which files are selected for commit, and what is present in the
 
642
        # current tree, the new inventory is populated. inventory entries 
 
643
        # which are candidates for modification have their revision set to
 
644
        # None; inventory entries that are carried over untouched have their
 
645
        # revision set to their prior value.
 
646
        #
 
647
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
 
648
        # results to create a new inventory at the same time, which results
 
649
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
 
650
        # ADHB 11-07-2006
 
651
 
684
652
        specific_files = self.specific_files
685
653
        mutter("Selecting files for commit with filter %s", specific_files)
686
654
 
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):
 
655
        # Build the new inventory
 
656
        self._populate_from_inventory(specific_files)
 
657
 
754
658
        # If specific files are selected, then all un-selected files must be
755
659
        # recorded in their previous state. For more details, see
756
660
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
757
 
        if self.specific_files or self.exclude:
758
 
            specific_files = self.specific_files or []
 
661
        if specific_files:
759
662
            for path, old_ie in self.basis_inv.iter_entries():
760
 
                if self.builder.new_inventory.has_id(old_ie.file_id):
 
663
                if old_ie.file_id in self.builder.new_inventory:
761
664
                    # already added - skip.
762
665
                    continue
763
 
                if (is_inside_any(specific_files, path)
764
 
                    and not is_inside_any(self.exclude, path)):
765
 
                    # was inside the selected path, and not excluded - if not
766
 
                    # present it has been deleted so skip.
 
666
                if is_inside_any(specific_files, path):
 
667
                    # was inside the selected path, if not present it has been
 
668
                    # deleted so skip.
767
669
                    continue
768
 
                # From here down it was either not selected, or was excluded:
769
 
                # We preserve the entry unaltered.
 
670
                if old_ie.kind == 'directory':
 
671
                    self._next_progress_entry()
 
672
                # not in final inv yet, was not in the selected files, so is an
 
673
                # entry to be preserved unaltered.
770
674
                ie = old_ie.copy()
771
675
                # Note: specific file commits after a merge are currently
772
676
                # prohibited. This test is for sanity/safety in case it's
773
677
                # required after that changes.
774
678
                if len(self.parents) > 1:
775
679
                    ie.revision = None
776
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
777
 
                    self.basis_tree, None)
 
680
                delta, version_recorded = self.builder.record_entry_contents(
 
681
                    ie, self.parent_invs, path, self.basis_tree, None)
 
682
                if version_recorded:
 
683
                    self.any_entries_changed = True
 
684
                if delta: self._basis_delta.append(delta)
778
685
 
779
686
    def _report_and_accumulate_deletes(self):
780
 
        if (isinstance(self.basis_inv, Inventory)
781
 
            and isinstance(self.builder.new_inventory, Inventory)):
782
 
            # the older Inventory classes provide a _byid dict, and building a
783
 
            # set from the keys of this dict is substantially faster than even
784
 
            # getting a set of ids from the inventory
785
 
            #
786
 
            # <lifeless> set(dict) is roughly the same speed as
787
 
            # set(iter(dict)) and both are significantly slower than
788
 
            # set(dict.keys())
789
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
790
 
               set(self.builder.new_inventory._byid.keys())
791
 
        else:
792
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
687
        # XXX: Could the list of deleted paths and ids be instead taken from
 
688
        # _populate_from_inventory?
 
689
        deleted_ids = set(self.basis_inv._byid.keys()) - \
 
690
            set(self.builder.new_inventory._byid.keys())
793
691
        if deleted_ids:
794
692
            self.any_entries_deleted = True
795
693
            deleted = [(self.basis_tree.id2path(file_id), file_id)
797
695
            deleted.sort()
798
696
            # XXX: this is not quite directory-order sorting
799
697
            for path, file_id in deleted:
800
 
                self.builder.record_delete(path, file_id)
 
698
                self._basis_delta.append((path, None, file_id, None))
801
699
                self.reporter.deleted(path)
802
700
 
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).
 
701
    def _populate_from_inventory(self, specific_files):
 
702
        """Populate the CommitBuilder by walking the working tree inventory."""
807
703
        if self.strict:
808
704
            # raise an exception as soon as we find a single unknown.
809
705
            for unknown in self.work_tree.unknowns():
810
706
                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
 
 
828
 
        specific_files = self.specific_files
829
 
        exclude = self.exclude
 
707
               
830
708
        report_changes = self.reporter.is_verbose()
831
709
        deleted_ids = []
832
710
        # A tree of paths that have been deleted. E.g. if foo/bar has been
835
713
        # XXX: Note that entries may have the wrong kind because the entry does
836
714
        # not reflect the status on disk.
837
715
        work_inv = self.work_tree.inventory
838
 
        # NB: entries will include entries within the excluded ids/paths
839
 
        # because iter_entries_by_dir has no 'exclude' facility today.
840
716
        entries = work_inv.iter_entries_by_dir(
841
717
            specific_file_ids=self.specific_file_ids, yield_parents=True)
842
718
        for path, existing_ie in entries:
844
720
            name = existing_ie.name
845
721
            parent_id = existing_ie.parent_id
846
722
            kind = existing_ie.kind
 
723
            if kind == 'directory':
 
724
                self._next_progress_entry()
847
725
            # Skip files that have been deleted from the working tree.
848
726
            # The deleted path ids are also recorded so they can be explicitly
849
727
            # unversioned later.
862
740
                if deleted_dict is not None:
863
741
                    # the path has a deleted parent, do not add it.
864
742
                    continue
865
 
            if exclude and is_inside_any(exclude, path):
866
 
                # Skip excluded paths. Excluded paths are processed by
867
 
                # _update_builder_with_changes.
868
 
                continue
869
743
            content_summary = self.work_tree.path_content_summary(path)
870
 
            kind = content_summary[0]
871
744
            # Note that when a filter of specific files is given, we must only
872
745
            # skip/record deleted files matching that filter.
873
746
            if not specific_files or is_inside_any(specific_files, path):
874
 
                if kind == 'missing':
 
747
                if content_summary[0] == 'missing':
875
748
                    if not deleted_paths:
876
749
                        # path won't have been split yet.
877
750
                        path_segments = splitpath(path)
879
752
                    for segment in path_segments:
880
753
                        deleted_dict = deleted_dict.setdefault(segment, {})
881
754
                    self.reporter.missing(path)
882
 
                    self._next_progress_entry()
883
755
                    deleted_ids.append(file_id)
884
756
                    continue
885
757
            # TODO: have the builder do the nested commit just-in-time IF and
886
758
            # only if needed.
887
 
            if kind == 'tree-reference':
 
759
            if content_summary[0] == 'tree-reference':
888
760
                # enforce repository nested tree policy.
889
761
                if (not self.work_tree.supports_tree_reference() or
890
762
                    # repository does not support it either.
891
763
                    not self.branch.repository._format.supports_tree_reference):
892
 
                    kind = 'directory'
893
 
                    content_summary = (kind, None, None, None)
894
 
                elif self.recursive == 'down':
 
764
                    content_summary = ('directory',) + content_summary[1:]
 
765
            kind = content_summary[0]
 
766
            # TODO: specific_files filtering before nested tree processing
 
767
            if kind == 'tree-reference':
 
768
                if self.recursive == 'down':
895
769
                    nested_revision_id = self._commit_nested_tree(
896
770
                        file_id, path)
897
 
                    content_summary = (kind, None, None, nested_revision_id)
 
771
                    content_summary = content_summary[:3] + (
 
772
                        nested_revision_id,)
898
773
                else:
899
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
900
 
                    content_summary = (kind, None, None, nested_revision_id)
 
774
                    content_summary = content_summary[:3] + (
 
775
                        self.work_tree.get_reference_revision(file_id),)
901
776
 
902
777
            # Record an entry for this item
903
778
            # Note: I don't particularly want to have the existing_ie
909
784
                content_summary)
910
785
 
911
786
        # Unversion IDs that were found to be deleted
912
 
        self.deleted_ids = deleted_ids
 
787
        self.work_tree.unversion(deleted_ids)
913
788
 
914
789
    def _commit_nested_tree(self, file_id, path):
915
790
        "Commit a nested tree."
917
792
        # FIXME: be more comprehensive here:
918
793
        # this works when both trees are in --trees repository,
919
794
        # but when both are bound to a different repository,
920
 
        # it fails; a better way of approaching this is to
 
795
        # it fails; a better way of approaching this is to 
921
796
        # finally implement the explicit-caches approach design
922
797
        # a while back - RBC 20070306.
923
798
        if sub_tree.branch.repository.has_same_location(
947
822
        else:
948
823
            ie = existing_ie.copy()
949
824
            ie.revision = None
950
 
        # For carried over entries we don't care about the fs hash - the repo
951
 
        # isn't generating a sha, so we're not saving computation time.
952
 
        _, _, fs_hash = self.builder.record_entry_contents(
953
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
825
        delta, version_recorded = self.builder.record_entry_contents(ie,
 
826
            self.parent_invs, path, self.work_tree, content_summary)
 
827
        if delta:
 
828
            self._basis_delta.append(delta)
 
829
        if version_recorded:
 
830
            self.any_entries_changed = True
954
831
        if report_changes:
955
832
            self._report_change(ie, path)
956
 
        if fs_hash:
957
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
958
833
        return ie
959
834
 
960
835
    def _report_change(self, ie, path):
968
843
        else:
969
844
            basis_ie = None
970
845
        change = ie.describe_change(basis_ie, ie)
971
 
        if change in (InventoryEntry.RENAMED,
 
846
        if change in (InventoryEntry.RENAMED, 
972
847
            InventoryEntry.MODIFIED_AND_RENAMED):
973
848
            old_path = self.basis_inv.id2path(ie.file_id)
974
849
            self.reporter.renamed(change, old_path, path)
975
 
            self._next_progress_entry()
976
850
        else:
977
 
            if change == gettext('unchanged'):
978
 
                return
979
851
            self.reporter.snapshot_change(change, path)
980
 
            self._next_progress_entry()
981
852
 
982
 
    def _set_progress_stage(self, name, counter=False):
 
853
    def _set_progress_stage(self, name, entries_title=None):
983
854
        """Set the progress stage and emit an update to the progress bar."""
984
855
        self.pb_stage_name = name
985
856
        self.pb_stage_count += 1
986
 
        if counter:
 
857
        self.pb_entries_title = entries_title
 
858
        if entries_title is not None:
987
859
            self.pb_entries_count = 0
988
 
        else:
989
 
            self.pb_entries_count = None
 
860
            self.pb_entries_total = '?'
990
861
        self._emit_progress()
991
862
 
992
863
    def _next_progress_entry(self):
995
866
        self._emit_progress()
996
867
 
997
868
    def _emit_progress(self):
998
 
        if self.pb_entries_count is not None:
999
 
            text = gettext("{0} [{1}] - Stage").format(self.pb_stage_name,
1000
 
                self.pb_entries_count)
 
869
        if self.pb_entries_title:
 
870
            if self.pb_entries_total == '?':
 
871
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
 
872
                    self.pb_entries_title, self.pb_entries_count)
 
873
            else:
 
874
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
 
875
                    self.pb_entries_title, self.pb_entries_count,
 
876
                    str(self.pb_entries_total))
1001
877
        else:
1002
 
            text = gettext("%s - Stage") % (self.pb_stage_name, )
 
878
            text = "%s - Stage" % (self.pb_stage_name)
1003
879
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
1004
880
 
1005
 
    def _set_specific_file_ids(self):
1006
 
        """populate self.specific_file_ids if we will use it."""
1007
 
        if not self.use_record_iter_changes:
1008
 
            # If provided, ensure the specified files are versioned
1009
 
            if self.specific_files is not None:
1010
 
                # Note: This routine is being called because it raises
1011
 
                # PathNotVersionedError as a side effect of finding the IDs. We
1012
 
                # later use the ids we found as input to the working tree
1013
 
                # inventory iterator, so we only consider those ids rather than
1014
 
                # examining the whole tree again.
1015
 
                # XXX: Dont we have filter_unversioned to do this more
1016
 
                # cheaply?
1017
 
                self.specific_file_ids = tree.find_ids_across_trees(
1018
 
                    self.specific_files, [self.basis_tree, self.work_tree])
1019
 
            else:
1020
 
                self.specific_file_ids = None