← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Andrew Bennetts
  • Date: 2010-06-25 06:47:40 UTC
  • mto: (5050.3.16 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100625064740-k93ngat248kdcqdm
Remove merge_into_helper for now, as it currently has no callers.

Show diffs side-by-side

added added

removed removed

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