~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: John Arbash Meinel
  • Date: 2008-01-15 21:42:00 UTC
  • mto: This revision was merged to the branch mainline in revision 3188.
  • Revision ID: john@arbash-meinel.com-20080115214200-27y5bnbuf3dbtqnm
Finish the rest of the review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
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
 
52
59
from bzrlib import (
53
60
    debug,
54
61
    errors,
55
62
    revision,
56
 
    trace,
57
63
    tree,
58
64
    )
59
65
from bzrlib.branch import Branch
60
 
from bzrlib.cleanup import OperationWithCleanups
61
66
import bzrlib.config
62
67
from bzrlib.errors import (BzrError, PointlessCommit,
63
68
                           ConflictsInTree,
64
69
                           StrictCommitFailed
65
70
                           )
66
 
from bzrlib.osutils import (get_user_encoding,
67
 
                            is_inside_any,
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
72
                            is_inside_or_parent_of_any,
68
73
                            minimum_path_selection,
 
74
                            quotefn, sha_file, split_lines,
69
75
                            splitpath,
70
76
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
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
73
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
74
86
from bzrlib.urlutils import unescape_for_display
75
87
import bzrlib.ui
76
88
 
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 ('added', '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
 
132
149
 
133
150
    def completed(self, revno, rev_id):
134
151
        self._note('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('deleted %s', path)
 
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
160
        self._note('missing %s', path)
190
204
               reporter=None,
191
205
               config=None,
192
206
               message_callback=None,
193
 
               recursive='down',
194
 
               exclude=None,
195
 
               possible_master_transports=None):
 
207
               recursive='down'):
196
208
        """Commit working copy as a new revision.
197
209
 
198
210
        :param message: the commit message (it or message_callback is required)
199
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
200
211
 
201
212
        :param timestamp: if not None, seconds-since-epoch for a
202
213
            postdated/predated commit.
203
214
 
204
 
        :param specific_files: If not None, commit only those files. An empty
205
 
            list means 'commit no files'.
 
215
        :param specific_files: If true, commit only those files.
206
216
 
207
217
        :param rev_id: If set, use this as the new revision id.
208
218
            Useful for test or import commands that need to tightly
222
232
        :param verbose: if True and the reporter is not None, report everything
223
233
        :param recursive: If set to 'down', commit in any subtrees that have
224
234
            pending changes of any sort during this commit.
225
 
        :param exclude: None or a list of relative paths to exclude from the
226
 
            commit. Pending changes to excluded files will be ignored by the
227
 
            commit.
228
235
        """
229
 
        operation = OperationWithCleanups(self._commit)
230
 
        self.revprops = revprops or {}
231
 
        # XXX: Can be set on __init__ or passed in - this is a bit ugly.
232
 
        self.config = config or self.config
233
 
        return operation.run(
234
 
               message=message,
235
 
               timestamp=timestamp,
236
 
               timezone=timezone,
237
 
               committer=committer,
238
 
               specific_files=specific_files,
239
 
               rev_id=rev_id,
240
 
               allow_pointless=allow_pointless,
241
 
               strict=strict,
242
 
               verbose=verbose,
243
 
               working_tree=working_tree,
244
 
               local=local,
245
 
               reporter=reporter,
246
 
               message_callback=message_callback,
247
 
               recursive=recursive,
248
 
               exclude=exclude,
249
 
               possible_master_transports=possible_master_transports)
250
 
 
251
 
    def _commit(self, operation, message, timestamp, timezone, committer,
252
 
            specific_files, rev_id, allow_pointless, strict, verbose,
253
 
            working_tree, local, reporter, message_callback, recursive,
254
 
            exclude, possible_master_transports):
255
236
        mutter('preparing to commit')
256
237
 
257
238
        if working_tree is None:
265
246
        if message_callback is None:
266
247
            if message is not None:
267
248
                if isinstance(message, str):
268
 
                    message = message.decode(get_user_encoding())
 
249
                    message = message.decode(bzrlib.user_encoding)
269
250
                message_callback = lambda x: message
270
251
            else:
271
252
                raise BzrError("The message or message_callback keyword"
272
253
                               " parameter is required for commit().")
273
254
 
274
255
        self.bound_branch = None
 
256
        self.any_entries_changed = False
275
257
        self.any_entries_deleted = False
276
 
        if exclude is not None:
277
 
            self.exclude = sorted(
278
 
                minimum_path_selection(exclude))
279
 
        else:
280
 
            self.exclude = []
281
258
        self.local = local
282
259
        self.master_branch = None
 
260
        self.master_locked = False
283
261
        self.recursive = recursive
284
262
        self.rev_id = None
285
 
        # self.specific_files is None to indicate no filter, or any iterable to
286
 
        # indicate a filter - [] means no files at all, as per iter_changes.
287
263
        if specific_files is not None:
288
264
            self.specific_files = sorted(
289
265
                minimum_path_selection(specific_files))
290
266
        else:
291
267
            self.specific_files = None
292
 
            
 
268
        self.specific_file_ids = None
293
269
        self.allow_pointless = allow_pointless
 
270
        self.revprops = revprops
294
271
        self.message_callback = message_callback
295
272
        self.timestamp = timestamp
296
273
        self.timezone = timezone
297
274
        self.committer = committer
298
275
        self.strict = strict
299
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 = []
300
280
 
301
281
        self.work_tree.lock_write()
302
 
        operation.add_cleanup(self.work_tree.unlock)
303
 
        self.parents = self.work_tree.get_parent_ids()
304
 
        # We can use record_iter_changes IFF iter_changes is compatible with
305
 
        # the command line parameters, and the repository has fast delta
306
 
        # generation. See bug 347649.
307
 
        self.use_record_iter_changes = (
308
 
            not self.exclude and 
309
 
            not self.branch.repository._format.supports_tree_reference and
310
 
            (self.branch.repository._format.fast_deltas or
311
 
             len(self.parents) < 2))
312
282
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
313
 
        operation.add_cleanup(self.pb.finished)
314
283
        self.basis_revid = self.work_tree.last_revision()
315
284
        self.basis_tree = self.work_tree.basis_tree()
316
285
        self.basis_tree.lock_read()
317
 
        operation.add_cleanup(self.basis_tree.unlock)
318
 
        # Cannot commit with conflicts present.
319
 
        if len(self.work_tree.conflicts()) > 0:
320
 
            raise ConflictsInTree
321
 
 
322
 
        # Setup the bound branch variables as needed.
323
 
        self._check_bound_branch(operation, possible_master_transports)
324
 
 
325
 
        # Check that the working tree is up to date
326
 
        old_revno, new_revno = self._check_out_of_date_tree()
327
 
 
328
 
        # Complete configuration setup
329
 
        if reporter is not None:
330
 
            self.reporter = reporter
331
 
        elif self.reporter is None:
332
 
            self.reporter = self._select_reporter()
333
 
        if self.config is None:
334
 
            self.config = self.branch.get_config()
335
 
 
336
 
        self._set_specific_file_ids()
337
 
 
338
 
        # Setup the progress bar. As the number of files that need to be
339
 
        # committed in unknown, progress is reported as stages.
340
 
        # We keep track of entries separately though and include that
341
 
        # information in the progress bar during the relevant stages.
342
 
        self.pb_stage_name = ""
343
 
        self.pb_stage_count = 0
344
 
        self.pb_stage_total = 5
345
 
        if self.bound_branch:
346
 
            self.pb_stage_total += 1
347
 
        self.pb.show_pct = False
348
 
        self.pb.show_spinner = False
349
 
        self.pb.show_eta = False
350
 
        self.pb.show_count = True
351
 
        self.pb.show_bar = True
352
 
 
353
 
        self._gather_parents()
354
 
        # After a merge, a selected file commit is not supported.
355
 
        # See 'bzr help merge' for an explanation as to why.
356
 
        if len(self.parents) > 1 and self.specific_files is not None:
357
 
            raise errors.CannotCommitSelectedFileMerge(self.specific_files)
358
 
        # Excludes are a form of selected file commit.
359
 
        if len(self.parents) > 1 and self.exclude:
360
 
            raise errors.CannotCommitSelectedFileMerge(self.exclude)
361
 
 
362
 
        # Collect the changes
363
 
        self._set_progress_stage("Collecting changes", counter=True)
364
 
        self.builder = self.branch.get_commit_builder(self.parents,
365
 
            self.config, timestamp, timezone, committer, self.revprops, rev_id)
366
 
 
367
286
        try:
368
 
            self.builder.will_record_deletes()
369
 
            # find the location being committed to
370
 
            if self.bound_branch:
371
 
                master_location = self.master_branch.base
372
 
            else:
373
 
                master_location = self.branch.base
374
 
 
375
 
            # report the start of the commit
376
 
            self.reporter.started(new_revno, self.rev_id, master_location)
377
 
 
378
 
            self._update_builder_with_changes()
379
 
            self._check_pointless()
380
 
 
381
 
            # TODO: Now the new inventory is known, check for conflicts.
382
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
383
 
            # weave lines, because nothing should be recorded until it is known
384
 
            # that commit will succeed.
385
 
            self._set_progress_stage("Saving data locally")
386
 
            self.builder.finish_inventory()
387
 
 
388
 
            # Prompt the user for a commit message if none provided
389
 
            message = message_callback(self)
390
 
            self.message = message
391
 
 
392
 
            # Add revision data to the local branch
393
 
            self.rev_id = self.builder.commit(self.message)
394
 
 
395
 
        except Exception, e:
396
 
            mutter("aborting commit write group because of exception:")
397
 
            trace.log_exception_quietly()
398
 
            note("aborting commit write group: %r" % (e,))
399
 
            self.builder.abort()
400
 
            raise
401
 
 
402
 
        self._process_pre_hooks(old_revno, new_revno)
403
 
 
404
 
        # Upload revision data to the master.
405
 
        # this will propagate merged revisions too if needed.
406
 
        if self.bound_branch:
407
 
            self._set_progress_stage("Uploading data to master branch")
408
 
            # 'commit' to the master first so a timeout here causes the
409
 
            # local branch to be out of date
410
 
            self.master_branch.import_last_revision_info(
411
 
                self.branch.repository, new_revno, self.rev_id)
412
 
 
413
 
        # and now do the commit locally.
414
 
        self.branch.set_last_revision_info(new_revno, self.rev_id)
415
 
 
416
 
        # Make the working tree be up to date with the branch. This
417
 
        # includes automatic changes scheduled to be made to the tree, such
418
 
        # as updating its basis and unversioning paths that were missing.
419
 
        self.work_tree.unversion(self.deleted_ids)
420
 
        self._set_progress_stage("Updating the working tree")
421
 
        self.work_tree.update_basis_by_delta(self.rev_id,
422
 
             self.builder.get_basis_delta())
423
 
        self.reporter.completed(new_revno, self.rev_id)
424
 
        self._process_post_hooks(old_revno, new_revno)
 
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
 
324
            if self.bound_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
 
 
379
            self._process_pre_hooks(old_revno, new_revno)
 
380
 
 
381
            # Upload revision data to the master.
 
382
            # this will propagate merged revisions too if needed.
 
383
            if self.bound_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
 
390
                # 'commit' to the master first so a timeout here causes the
 
391
                # local branch to be out of date
 
392
                self.master_branch.set_last_revision_info(new_revno,
 
393
                                                          self.rev_id)
 
394
 
 
395
            # and now do the commit locally.
 
396
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
397
 
 
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()
425
406
        return self.rev_id
426
407
 
427
408
    def _select_reporter(self):
436
417
        # A merge with no effect on files
437
418
        if len(self.parents) > 1:
438
419
            return
439
 
        # TODO: we could simplify this by using self.builder.basis_delta.
 
420
        # TODO: we could simplify this by using self._basis_delta.
440
421
 
441
422
        # The initial commit adds a root directory, but this in itself is not
442
423
        # a worthwhile commit.
443
424
        if (self.basis_revid == revision.NULL_REVISION and
444
 
            ((self.builder.new_inventory is not None and
445
 
             len(self.builder.new_inventory) == 1) or
446
 
            len(self.builder._basis_delta) == 1)):
 
425
            len(self.builder.new_inventory) == 1):
447
426
            raise PointlessCommit()
448
 
        if self.builder.any_changes():
 
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)):
449
433
            return
450
434
        raise PointlessCommit()
451
435
 
452
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
436
    def _check_bound_branch(self):
453
437
        """Check to see if the local branch is bound.
454
438
 
455
439
        If it is bound, then most of the commit will actually be
460
444
            raise errors.LocalRequiresBoundBranch()
461
445
 
462
446
        if not self.local:
463
 
            self.master_branch = self.branch.get_master_branch(
464
 
                possible_master_transports)
 
447
            self.master_branch = self.branch.get_master_branch()
465
448
 
466
449
        if not self.master_branch:
467
450
            # make this branch the reference branch for out of date checks.
478
461
        #       commits to the remote branch if they would fit.
479
462
        #       But for now, just require remote to be identical
480
463
        #       to local.
481
 
 
 
464
        
482
465
        # Make sure the local branch is identical to the master
483
466
        master_info = self.master_branch.last_revision_info()
484
467
        local_info = self.branch.last_revision_info()
490
473
        # so grab the lock
491
474
        self.bound_branch = self.branch
492
475
        self.master_branch.lock_write()
493
 
        operation.add_cleanup(self.master_branch.unlock)
 
476
        self.master_locked = True
494
477
 
495
478
    def _check_out_of_date_tree(self):
496
479
        """Check that the working tree is up to date.
541
524
    def _process_hooks(self, hook_name, old_revno, new_revno):
542
525
        if not Branch.hooks[hook_name]:
543
526
            return
544
 
 
 
527
        
545
528
        # new style commit hooks:
546
529
        if not self.bound_branch:
547
530
            hook_master = self.branch
556
539
            old_revid = self.parents[0]
557
540
        else:
558
541
            old_revid = bzrlib.revision.NULL_REVISION
559
 
 
 
542
        
560
543
        if hook_name == "pre_commit":
561
544
            future_tree = self.builder.revision_tree()
562
545
            tree_delta = future_tree.changes_from(self.basis_tree,
563
546
                                             include_root=True)
564
 
 
 
547
        
565
548
        for hook in Branch.hooks[hook_name]:
566
549
            # show the running hook in the progress bar. As hooks may
567
550
            # end up doing nothing (e.g. because they are not configured by
581
564
                     old_revno, old_revid, new_revno, self.rev_id,
582
565
                     tree_delta, future_tree)
583
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
 
584
621
    def _gather_parents(self):
585
622
        """Record the parents of a merge for merge detection."""
586
 
        # TODO: Make sure that this list doesn't contain duplicate
 
623
        # TODO: Make sure that this list doesn't contain duplicate 
587
624
        # entries and the order is preserved when doing this.
588
 
        if self.use_record_iter_changes:
589
 
            return
590
 
        self.basis_inv = self.basis_tree.inventory
 
625
        self.parents = self.work_tree.get_parent_ids()
591
626
        self.parent_invs = [self.basis_inv]
592
627
        for revision in self.parents[1:]:
593
628
            if self.branch.repository.has_revision(revision):
600
635
    def _update_builder_with_changes(self):
601
636
        """Update the commit builder with the data about what has changed.
602
637
        """
603
 
        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
 
604
652
        specific_files = self.specific_files
605
653
        mutter("Selecting files for commit with filter %s", specific_files)
606
654
 
607
 
        self._check_strict()
608
 
        if self.use_record_iter_changes:
609
 
            iter_changes = self.work_tree.iter_changes(self.basis_tree,
610
 
                specific_files=specific_files)
611
 
            iter_changes = self._filter_iter_changes(iter_changes)
612
 
            for file_id, path, fs_hash in self.builder.record_iter_changes(
613
 
                self.work_tree, self.basis_revid, iter_changes):
614
 
                self.work_tree._observed_sha1(file_id, path, fs_hash)
615
 
        else:
616
 
            # Build the new inventory
617
 
            self._populate_from_inventory()
618
 
            self._record_unselected()
619
 
            self._report_and_accumulate_deletes()
620
 
 
621
 
    def _filter_iter_changes(self, iter_changes):
622
 
        """Process iter_changes.
623
 
 
624
 
        This method reports on the changes in iter_changes to the user, and 
625
 
        converts 'missing' entries in the iter_changes iterator to 'deleted'
626
 
        entries. 'missing' entries have their
627
 
 
628
 
        :param iter_changes: An iter_changes to process.
629
 
        :return: A generator of changes.
630
 
        """
631
 
        reporter = self.reporter
632
 
        report_changes = reporter.is_verbose()
633
 
        deleted_ids = []
634
 
        for change in iter_changes:
635
 
            if report_changes:
636
 
                old_path = change[1][0]
637
 
                new_path = change[1][1]
638
 
                versioned = change[3][1]
639
 
            kind = change[6][1]
640
 
            versioned = change[3][1]
641
 
            if kind is None and versioned:
642
 
                # 'missing' path
643
 
                if report_changes:
644
 
                    reporter.missing(new_path)
645
 
                deleted_ids.append(change[0])
646
 
                # Reset the new path (None) and new versioned flag (False)
647
 
                change = (change[0], (change[1][0], None), change[2],
648
 
                    (change[3][0], False)) + change[4:]
649
 
            elif kind == 'tree-reference':
650
 
                if self.recursive == 'down':
651
 
                    self._commit_nested_tree(change[0], change[1][1])
652
 
            if change[3][0] or change[3][1]:
653
 
                yield change
654
 
                if report_changes:
655
 
                    if new_path is None:
656
 
                        reporter.deleted(old_path)
657
 
                    elif old_path is None:
658
 
                        reporter.snapshot_change('added', new_path)
659
 
                    elif old_path != new_path:
660
 
                        reporter.renamed('renamed', old_path, new_path)
661
 
                    else:
662
 
                        if (new_path or 
663
 
                            self.work_tree.branch.repository._format.rich_root_data):
664
 
                            # Don't report on changes to '' in non rich root
665
 
                            # repositories.
666
 
                            reporter.snapshot_change('modified', new_path)
667
 
            self._next_progress_entry()
668
 
        # Unversion IDs that were found to be deleted
669
 
        self.deleted_ids = deleted_ids
670
 
 
671
 
    def _record_unselected(self):
 
655
        # Build the new inventory
 
656
        self._populate_from_inventory(specific_files)
 
657
 
672
658
        # If specific files are selected, then all un-selected files must be
673
659
        # recorded in their previous state. For more details, see
674
660
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
675
 
        if self.specific_files or self.exclude:
676
 
            specific_files = self.specific_files or []
 
661
        if specific_files:
677
662
            for path, old_ie in self.basis_inv.iter_entries():
678
663
                if old_ie.file_id in self.builder.new_inventory:
679
664
                    # already added - skip.
680
665
                    continue
681
 
                if (is_inside_any(specific_files, path)
682
 
                    and not is_inside_any(self.exclude, path)):
683
 
                    # was inside the selected path, and not excluded - if not
684
 
                    # 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.
685
669
                    continue
686
 
                # From here down it was either not selected, or was excluded:
687
 
                # 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.
688
674
                ie = old_ie.copy()
689
675
                # Note: specific file commits after a merge are currently
690
676
                # prohibited. This test is for sanity/safety in case it's
691
677
                # required after that changes.
692
678
                if len(self.parents) > 1:
693
679
                    ie.revision = None
694
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
695
 
                    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)
696
685
 
697
686
    def _report_and_accumulate_deletes(self):
698
 
        if (isinstance(self.basis_inv, Inventory)
699
 
            and isinstance(self.builder.new_inventory, Inventory)):
700
 
            # the older Inventory classes provide a _byid dict, and building a
701
 
            # set from the keys of this dict is substantially faster than even
702
 
            # getting a set of ids from the inventory
703
 
            #
704
 
            # <lifeless> set(dict) is roughly the same speed as
705
 
            # set(iter(dict)) and both are significantly slower than
706
 
            # set(dict.keys())
707
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
708
 
               set(self.builder.new_inventory._byid.keys())
709
 
        else:
710
 
            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())
711
691
        if deleted_ids:
712
692
            self.any_entries_deleted = True
713
693
            deleted = [(self.basis_tree.id2path(file_id), file_id)
715
695
            deleted.sort()
716
696
            # XXX: this is not quite directory-order sorting
717
697
            for path, file_id in deleted:
718
 
                self.builder.record_delete(path, file_id)
 
698
                self._basis_delta.append((path, None, file_id, None))
719
699
                self.reporter.deleted(path)
720
700
 
721
 
    def _check_strict(self):
722
 
        # XXX: when we use iter_changes this would likely be faster if
723
 
        # iter_changes would check for us (even in the presence of
724
 
        # selected_files).
 
701
    def _populate_from_inventory(self, specific_files):
 
702
        """Populate the CommitBuilder by walking the working tree inventory."""
725
703
        if self.strict:
726
704
            # raise an exception as soon as we find a single unknown.
727
705
            for unknown in self.work_tree.unknowns():
728
706
                raise StrictCommitFailed()
729
 
 
730
 
    def _populate_from_inventory(self):
731
 
        """Populate the CommitBuilder by walking the working tree inventory."""
732
 
        # Build the revision inventory.
733
 
        #
734
 
        # This starts by creating a new empty inventory. Depending on
735
 
        # which files are selected for commit, and what is present in the
736
 
        # current tree, the new inventory is populated. inventory entries
737
 
        # which are candidates for modification have their revision set to
738
 
        # None; inventory entries that are carried over untouched have their
739
 
        # revision set to their prior value.
740
 
        #
741
 
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
742
 
        # results to create a new inventory at the same time, which results
743
 
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
744
 
        # ADHB 11-07-2006
745
 
 
746
 
        specific_files = self.specific_files
747
 
        exclude = self.exclude
 
707
               
748
708
        report_changes = self.reporter.is_verbose()
749
709
        deleted_ids = []
750
710
        # A tree of paths that have been deleted. E.g. if foo/bar has been
753
713
        # XXX: Note that entries may have the wrong kind because the entry does
754
714
        # not reflect the status on disk.
755
715
        work_inv = self.work_tree.inventory
756
 
        # NB: entries will include entries within the excluded ids/paths
757
 
        # because iter_entries_by_dir has no 'exclude' facility today.
758
716
        entries = work_inv.iter_entries_by_dir(
759
717
            specific_file_ids=self.specific_file_ids, yield_parents=True)
760
718
        for path, existing_ie in entries:
762
720
            name = existing_ie.name
763
721
            parent_id = existing_ie.parent_id
764
722
            kind = existing_ie.kind
 
723
            if kind == 'directory':
 
724
                self._next_progress_entry()
765
725
            # Skip files that have been deleted from the working tree.
766
726
            # The deleted path ids are also recorded so they can be explicitly
767
727
            # unversioned later.
780
740
                if deleted_dict is not None:
781
741
                    # the path has a deleted parent, do not add it.
782
742
                    continue
783
 
            if exclude and is_inside_any(exclude, path):
784
 
                # Skip excluded paths. Excluded paths are processed by
785
 
                # _update_builder_with_changes.
786
 
                continue
787
743
            content_summary = self.work_tree.path_content_summary(path)
788
 
            kind = content_summary[0]
789
744
            # Note that when a filter of specific files is given, we must only
790
745
            # skip/record deleted files matching that filter.
791
746
            if not specific_files or is_inside_any(specific_files, path):
792
 
                if kind == 'missing':
 
747
                if content_summary[0] == 'missing':
793
748
                    if not deleted_paths:
794
749
                        # path won't have been split yet.
795
750
                        path_segments = splitpath(path)
797
752
                    for segment in path_segments:
798
753
                        deleted_dict = deleted_dict.setdefault(segment, {})
799
754
                    self.reporter.missing(path)
800
 
                    self._next_progress_entry()
801
755
                    deleted_ids.append(file_id)
802
756
                    continue
803
757
            # TODO: have the builder do the nested commit just-in-time IF and
804
758
            # only if needed.
805
 
            if kind == 'tree-reference':
 
759
            if content_summary[0] == 'tree-reference':
806
760
                # enforce repository nested tree policy.
807
761
                if (not self.work_tree.supports_tree_reference() or
808
762
                    # repository does not support it either.
809
763
                    not self.branch.repository._format.supports_tree_reference):
810
 
                    kind = 'directory'
811
 
                    content_summary = (kind, None, None, None)
812
 
                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':
813
769
                    nested_revision_id = self._commit_nested_tree(
814
770
                        file_id, path)
815
 
                    content_summary = (kind, None, None, nested_revision_id)
 
771
                    content_summary = content_summary[:3] + (
 
772
                        nested_revision_id,)
816
773
                else:
817
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
818
 
                    content_summary = (kind, None, None, nested_revision_id)
 
774
                    content_summary = content_summary[:3] + (
 
775
                        self.work_tree.get_reference_revision(file_id),)
819
776
 
820
777
            # Record an entry for this item
821
778
            # Note: I don't particularly want to have the existing_ie
827
784
                content_summary)
828
785
 
829
786
        # Unversion IDs that were found to be deleted
830
 
        self.deleted_ids = deleted_ids
 
787
        self.work_tree.unversion(deleted_ids)
831
788
 
832
789
    def _commit_nested_tree(self, file_id, path):
833
790
        "Commit a nested tree."
835
792
        # FIXME: be more comprehensive here:
836
793
        # this works when both trees are in --trees repository,
837
794
        # but when both are bound to a different repository,
838
 
        # it fails; a better way of approaching this is to
 
795
        # it fails; a better way of approaching this is to 
839
796
        # finally implement the explicit-caches approach design
840
797
        # a while back - RBC 20070306.
841
798
        if sub_tree.branch.repository.has_same_location(
865
822
        else:
866
823
            ie = existing_ie.copy()
867
824
            ie.revision = None
868
 
        # For carried over entries we don't care about the fs hash - the repo
869
 
        # isn't generating a sha, so we're not saving computation time.
870
 
        _, _, fs_hash = self.builder.record_entry_contents(
871
 
            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
872
831
        if report_changes:
873
832
            self._report_change(ie, path)
874
 
        if fs_hash:
875
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
876
833
        return ie
877
834
 
878
835
    def _report_change(self, ie, path):
886
843
        else:
887
844
            basis_ie = None
888
845
        change = ie.describe_change(basis_ie, ie)
889
 
        if change in (InventoryEntry.RENAMED,
 
846
        if change in (InventoryEntry.RENAMED, 
890
847
            InventoryEntry.MODIFIED_AND_RENAMED):
891
848
            old_path = self.basis_inv.id2path(ie.file_id)
892
849
            self.reporter.renamed(change, old_path, path)
893
 
            self._next_progress_entry()
894
850
        else:
895
 
            if change == 'unchanged':
896
 
                return
897
851
            self.reporter.snapshot_change(change, path)
898
 
            self._next_progress_entry()
899
852
 
900
 
    def _set_progress_stage(self, name, counter=False):
 
853
    def _set_progress_stage(self, name, entries_title=None):
901
854
        """Set the progress stage and emit an update to the progress bar."""
902
855
        self.pb_stage_name = name
903
856
        self.pb_stage_count += 1
904
 
        if counter:
 
857
        self.pb_entries_title = entries_title
 
858
        if entries_title is not None:
905
859
            self.pb_entries_count = 0
906
 
        else:
907
 
            self.pb_entries_count = None
 
860
            self.pb_entries_total = '?'
908
861
        self._emit_progress()
909
862
 
910
863
    def _next_progress_entry(self):
913
866
        self._emit_progress()
914
867
 
915
868
    def _emit_progress(self):
916
 
        if self.pb_entries_count is not None:
917
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
918
 
                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))
919
877
        else:
920
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
878
            text = "%s - Stage" % (self.pb_stage_name)
921
879
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
922
880
 
923
 
    def _set_specific_file_ids(self):
924
 
        """populate self.specific_file_ids if we will use it."""
925
 
        if not self.use_record_iter_changes:
926
 
            # If provided, ensure the specified files are versioned
927
 
            if self.specific_files is not None:
928
 
                # Note: This routine is being called because it raises
929
 
                # PathNotVersionedError as a side effect of finding the IDs. We
930
 
                # later use the ids we found as input to the working tree
931
 
                # inventory iterator, so we only consider those ids rather than
932
 
                # examining the whole tree again.
933
 
                # XXX: Dont we have filter_unversioned to do this more
934
 
                # cheaply?
935
 
                self.specific_file_ids = tree.find_ids_across_trees(
936
 
                    self.specific_files, [self.basis_tree, self.work_tree])
937
 
            else:
938
 
                self.specific_file_ids = None