/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Adeodato Simó
  • Date: 2007-07-17 13:47:45 UTC
  • mto: This revision was merged to the branch mainline in revision 2625.
  • Revision ID: dato@net.com.org.es-20070717134745-lex7ggja6p08kzts
Loose python2.4-specific shebangs; use generic python instead.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/commit.py
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
19
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
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
 
    revision,
56
 
    trace,
 
62
    inventory,
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,
68
 
                            minimum_path_selection,
69
 
                            splitpath,
70
 
                            )
71
 
from bzrlib.trace import mutter, note, is_quiet
72
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
72
                            is_inside_or_parent_of_any,
 
73
                            quotefn, sha_file, split_lines)
 
74
from bzrlib.testament import Testament
 
75
from bzrlib.trace import mutter, note, warning
 
76
from bzrlib.xml5 import serializer_v5
 
77
from bzrlib.inventory import Inventory, InventoryEntry
73
78
from bzrlib import symbol_versioning
74
 
from bzrlib.urlutils import unescape_for_display
 
79
from bzrlib.symbol_versioning import (deprecated_passed,
 
80
        deprecated_function,
 
81
        DEPRECATED_PARAMETER)
 
82
from bzrlib.workingtree import WorkingTree
75
83
import bzrlib.ui
76
84
 
77
85
 
78
86
class NullCommitReporter(object):
79
87
    """I report on progress of a commit."""
80
88
 
81
 
    def started(self, revno, revid, location=None):
82
 
        if location is None:
83
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
84
 
                                   "to started.", DeprecationWarning,
85
 
                                   stacklevel=2)
86
 
        pass
87
 
 
88
89
    def snapshot_change(self, change, path):
89
90
        pass
90
91
 
91
92
    def completed(self, revno, rev_id):
92
93
        pass
93
94
 
94
 
    def deleted(self, path):
 
95
    def deleted(self, file_id):
 
96
        pass
 
97
 
 
98
    def escaped(self, escape_count, message):
95
99
        pass
96
100
 
97
101
    def missing(self, path):
100
104
    def renamed(self, change, old_path, new_path):
101
105
        pass
102
106
 
103
 
    def is_verbose(self):
104
 
        return False
105
 
 
106
107
 
107
108
class ReportCommitToLog(NullCommitReporter):
108
109
 
114
115
        note(format, *args)
115
116
 
116
117
    def snapshot_change(self, change, path):
117
 
        if path == '' and change in ('added', 'modified'):
 
118
        if change == 'unchanged':
 
119
            return
 
120
        if change == 'added' and path == '':
118
121
            return
119
122
        self._note("%s %s", change, path)
120
123
 
121
 
    def started(self, revno, rev_id, location=None):
122
 
        if location is not None:
123
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
124
 
        else:
125
 
            # When started was added, location was only made optional by
126
 
            # accident.  Matt Nordhoff 20071129
127
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
128
 
                                   "to started.", DeprecationWarning,
129
 
                                   stacklevel=2)
130
 
            location = ''
131
 
        self._note('Committing%s', location)
132
 
 
133
124
    def completed(self, revno, rev_id):
134
125
        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)
 
126
    
 
127
    def deleted(self, file_id):
 
128
        self._note('deleted %s', file_id)
141
129
 
142
 
    def deleted(self, path):
143
 
        self._note('deleted %s', path)
 
130
    def escaped(self, escape_count, message):
 
131
        self._note("replaced %d control characters in message", escape_count)
144
132
 
145
133
    def missing(self, path):
146
134
        self._note('missing %s', path)
148
136
    def renamed(self, change, old_path, new_path):
149
137
        self._note('%s %s => %s', change, old_path, new_path)
150
138
 
151
 
    def is_verbose(self):
152
 
        return True
153
 
 
154
139
 
155
140
class Commit(object):
156
141
    """Task of committing a new revision.
167
152
    def __init__(self,
168
153
                 reporter=None,
169
154
                 config=None):
170
 
        """Create a Commit object.
171
 
 
172
 
        :param reporter: the default reporter to use or None to decide later
173
 
        """
174
 
        self.reporter = reporter
 
155
        if reporter is not None:
 
156
            self.reporter = reporter
 
157
        else:
 
158
            self.reporter = NullCommitReporter()
175
159
        self.config = config
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
 
 
 
160
        
214
161
    def commit(self,
215
162
               message=None,
216
163
               timestamp=None,
227
174
               reporter=None,
228
175
               config=None,
229
176
               message_callback=None,
230
 
               recursive='down',
231
 
               exclude=None,
232
 
               possible_master_transports=None):
 
177
               recursive='down'):
233
178
        """Commit working copy as a new revision.
234
179
 
235
180
        :param message: the commit message (it or message_callback is required)
236
 
        :param message_callback: A callback: message = message_callback(cmt_obj)
237
181
 
238
182
        :param timestamp: if not None, seconds-since-epoch for a
239
183
            postdated/predated commit.
240
184
 
241
 
        :param specific_files: If not None, commit only those files. An empty
242
 
            list means 'commit no files'.
 
185
        :param specific_files: If true, commit only those files.
243
186
 
244
187
        :param rev_id: If set, use this as the new revision id.
245
188
            Useful for test or import commands that need to tightly
255
198
 
256
199
        :param revprops: Properties for new revision
257
200
        :param local: Perform a local only commit.
258
 
        :param reporter: the reporter to use or None for the default
259
 
        :param verbose: if True and the reporter is not None, report everything
260
201
        :param recursive: If set to 'down', commit in any subtrees that have
261
202
            pending changes of any sort during this commit.
262
 
        :param exclude: None or a list of relative paths to exclude from the
263
 
            commit. Pending changes to excluded files will be ignored by the
264
 
            commit.
265
203
        """
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):
292
204
        mutter('preparing to commit')
293
205
 
294
206
        if working_tree is None:
302
214
        if message_callback is None:
303
215
            if message is not None:
304
216
                if isinstance(message, str):
305
 
                    message = message.decode(get_user_encoding())
 
217
                    message = message.decode(bzrlib.user_encoding)
306
218
                message_callback = lambda x: message
307
219
            else:
308
220
                raise BzrError("The message or message_callback keyword"
309
221
                               " parameter is required for commit().")
310
222
 
311
223
        self.bound_branch = None
312
 
        self.any_entries_deleted = False
313
 
        if exclude is not None:
314
 
            self.exclude = sorted(
315
 
                minimum_path_selection(exclude))
316
 
        else:
317
 
            self.exclude = []
318
224
        self.local = local
319
225
        self.master_branch = None
320
 
        self.recursive = recursive
 
226
        self.master_locked = False
321
227
        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.
324
 
        if specific_files is not None:
325
 
            self.specific_files = sorted(
326
 
                minimum_path_selection(specific_files))
327
 
        else:
328
 
            self.specific_files = None
329
 
            
 
228
        self.specific_files = specific_files
330
229
        self.allow_pointless = allow_pointless
 
230
        self.recursive = recursive
 
231
        self.revprops = revprops
331
232
        self.message_callback = message_callback
332
233
        self.timestamp = timestamp
333
234
        self.timezone = timezone
335
236
        self.strict = strict
336
237
        self.verbose = verbose
337
238
 
 
239
        if reporter is None and self.reporter is None:
 
240
            self.reporter = NullCommitReporter()
 
241
        elif reporter is not None:
 
242
            self.reporter = reporter
 
243
 
338
244
        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))
349
245
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
350
 
        operation.add_cleanup(self.pb.finished)
351
 
        self.basis_revid = self.work_tree.last_revision()
352
246
        self.basis_tree = self.work_tree.basis_tree()
353
247
        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
 
 
404
248
        try:
405
 
            self.builder.will_record_deletes()
406
 
            # find the location being committed to
 
249
            # Cannot commit with conflicts present.
 
250
            if len(self.work_tree.conflicts()) > 0:
 
251
                raise ConflictsInTree
 
252
 
 
253
            # Setup the bound branch variables as needed.
 
254
            self._check_bound_branch()
 
255
 
 
256
            # Check that the working tree is up to date
 
257
            old_revno,new_revno = self._check_out_of_date_tree()
 
258
 
 
259
            if strict:
 
260
                # raise an exception as soon as we find a single unknown.
 
261
                for unknown in self.work_tree.unknowns():
 
262
                    raise StrictCommitFailed()
 
263
                   
 
264
            if self.config is None:
 
265
                self.config = self.branch.get_config()
 
266
 
 
267
            # If provided, ensure the specified files are versioned
 
268
            if specific_files is not None:
 
269
                # Note: We don't actually need the IDs here. This routine
 
270
                # is being called because it raises PathNotVerisonedError
 
271
                # as a side effect of finding the IDs.
 
272
                # XXX: Dont we have filter_unversioned to do this more
 
273
                # cheaply?
 
274
                tree.find_ids_across_trees(specific_files,
 
275
                                           [self.basis_tree, self.work_tree])
 
276
 
 
277
            # Setup the progress bar. As the number of files that need to be
 
278
            # committed in unknown, progress is reported as stages.
 
279
            # We keep track of entries separately though and include that
 
280
            # information in the progress bar during the relevant stages.
 
281
            self.pb_stage_name = ""
 
282
            self.pb_stage_count = 0
 
283
            self.pb_stage_total = 4
407
284
            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
 
 
 
285
                self.pb_stage_total += 1
 
286
            self.pb.show_pct = False
 
287
            self.pb.show_spinner = False
 
288
            self.pb.show_eta = False
 
289
            self.pb.show_count = True
 
290
            self.pb.show_bar = True
 
291
 
 
292
            # After a merge, a selected file commit is not supported.
 
293
            # See 'bzr help merge' for an explanation as to why.
 
294
            self.basis_inv = self.basis_tree.inventory
 
295
            self._gather_parents()
 
296
            if len(self.parents) > 1 and self.specific_files:
 
297
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
298
            
 
299
            # Collect the changes
 
300
            self._emit_progress_set_stage("Collecting changes", show_entries=True)
 
301
            self.builder = self.branch.get_commit_builder(self.parents,
 
302
                self.config, timestamp, timezone, committer, revprops, rev_id)
415
303
            self._update_builder_with_changes()
416
304
            self._check_pointless()
417
305
 
419
307
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
420
308
            # weave lines, because nothing should be recorded until it is known
421
309
            # that commit will succeed.
422
 
            self._set_progress_stage("Saving data locally")
 
310
            self._emit_progress_set_stage("Saving data locally")
423
311
            self.builder.finish_inventory()
424
312
 
425
313
            # Prompt the user for a commit message if none provided
426
314
            message = message_callback(self)
 
315
            assert isinstance(message, unicode), type(message)
427
316
            self.message = message
 
317
            self._escape_commit_message()
428
318
 
429
319
            # Add revision data to the local branch
430
320
            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)
 
321
            
 
322
            # Upload revision data to the master.
 
323
            # this will propagate merged revisions too if needed.
 
324
            if self.bound_branch:
 
325
                self._emit_progress_set_stage("Uploading data to master branch")
 
326
                self.master_branch.repository.fetch(self.branch.repository,
 
327
                                                    revision_id=self.rev_id)
 
328
                # now the master has the revision data
 
329
                # 'commit' to the master first so a timeout here causes the
 
330
                # local branch to be out of date
 
331
                self.master_branch.set_last_revision_info(new_revno,
 
332
                                                          self.rev_id)
 
333
 
 
334
            # and now do the commit locally.
 
335
            self.branch.set_last_revision_info(new_revno, self.rev_id)
 
336
 
 
337
            # Make the working tree up to date with the branch
 
338
            self._emit_progress_set_stage("Updating the working tree")
 
339
            rev_tree = self.builder.revision_tree()
 
340
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
341
            self.reporter.completed(new_revno, self.rev_id)
 
342
            self._process_hooks(old_revno, new_revno)
 
343
        finally:
 
344
            self._cleanup()
462
345
        return self.rev_id
463
346
 
464
 
    def _select_reporter(self):
465
 
        """Select the CommitReporter to use."""
466
 
        if is_quiet():
467
 
            return NullCommitReporter()
468
 
        return ReportCommitToLog()
 
347
    def _any_real_changes(self):
 
348
        """Are there real changes between new_inventory and basis?
 
349
 
 
350
        For trees without rich roots, inv.root.revision changes every commit.
 
351
        But if that is the only change, we want to treat it as though there
 
352
        are *no* changes.
 
353
        """
 
354
        new_entries = self.builder.new_inventory.iter_entries()
 
355
        basis_entries = self.basis_inv.iter_entries()
 
356
        new_path, new_root_ie = new_entries.next()
 
357
        basis_path, basis_root_ie = basis_entries.next()
 
358
 
 
359
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
360
        def ie_equal_no_revision(this, other):
 
361
            return ((this.file_id == other.file_id)
 
362
                    and (this.name == other.name)
 
363
                    and (this.symlink_target == other.symlink_target)
 
364
                    and (this.text_sha1 == other.text_sha1)
 
365
                    and (this.text_size == other.text_size)
 
366
                    and (this.text_id == other.text_id)
 
367
                    and (this.parent_id == other.parent_id)
 
368
                    and (this.kind == other.kind)
 
369
                    and (this.executable == other.executable)
 
370
                    and (this.reference_revision == other.reference_revision)
 
371
                    )
 
372
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
373
            return True
 
374
 
 
375
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
376
            if new_ie != basis_ie:
 
377
                return True
 
378
 
 
379
        # No actual changes present
 
380
        return False
469
381
 
470
382
    def _check_pointless(self):
471
383
        if self.allow_pointless:
473
385
        # A merge with no effect on files
474
386
        if len(self.parents) > 1:
475
387
            return
476
 
        # TODO: we could simplify this by using self.builder.basis_delta.
477
 
 
478
 
        # The initial commit adds a root directory, but this in itself is not
479
 
        # a worthwhile commit.
480
 
        if (self.basis_revid == revision.NULL_REVISION and
481
 
            ((self.builder.new_inventory is not None and
482
 
             len(self.builder.new_inventory) == 1) or
483
 
            len(self.builder._basis_delta) == 1)):
 
388
        # work around the fact that a newly-initted tree does differ from its
 
389
        # basis
 
390
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
484
391
            raise PointlessCommit()
485
 
        if self.builder.any_changes():
 
392
        # Shortcut, if the number of entries changes, then we obviously have
 
393
        # a change
 
394
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
395
            return
 
396
        # If length == 1, then we only have the root entry. Which means
 
397
        # that there is no real difference (only the root could be different)
 
398
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
486
399
            return
487
400
        raise PointlessCommit()
488
401
 
489
 
    def _check_bound_branch(self, operation, possible_master_transports=None):
 
402
    def _check_bound_branch(self):
490
403
        """Check to see if the local branch is bound.
491
404
 
492
405
        If it is bound, then most of the commit will actually be
497
410
            raise errors.LocalRequiresBoundBranch()
498
411
 
499
412
        if not self.local:
500
 
            self.master_branch = self.branch.get_master_branch(
501
 
                possible_master_transports)
 
413
            self.master_branch = self.branch.get_master_branch()
502
414
 
503
415
        if not self.master_branch:
504
416
            # make this branch the reference branch for out of date checks.
515
427
        #       commits to the remote branch if they would fit.
516
428
        #       But for now, just require remote to be identical
517
429
        #       to local.
518
 
 
 
430
        
519
431
        # Make sure the local branch is identical to the master
520
432
        master_info = self.master_branch.last_revision_info()
521
433
        local_info = self.branch.last_revision_info()
527
439
        # so grab the lock
528
440
        self.bound_branch = self.branch
529
441
        self.master_branch.lock_write()
530
 
        operation.add_cleanup(self.master_branch.unlock)
 
442
        self.master_locked = True
531
443
 
532
444
    def _check_out_of_date_tree(self):
533
445
        """Check that the working tree is up to date.
553
465
            new_revno = 1
554
466
        return old_revno,new_revno
555
467
 
556
 
    def _process_pre_hooks(self, old_revno, new_revno):
557
 
        """Process any registered pre commit hooks."""
558
 
        self._set_progress_stage("Running pre_commit hooks")
559
 
        self._process_hooks("pre_commit", old_revno, new_revno)
560
 
 
561
 
    def _process_post_hooks(self, old_revno, new_revno):
562
 
        """Process any registered post commit hooks."""
 
468
    def _process_hooks(self, old_revno, new_revno):
 
469
        """Process any registered commit hooks."""
563
470
        # Process the post commit hooks, if any
564
 
        self._set_progress_stage("Running post_commit hooks")
 
471
        self._emit_progress_set_stage("Running post commit hooks")
565
472
        # old style commit hooks - should be deprecated ? (obsoleted in
566
473
        # 0.15)
567
474
        if self.config.post_commit() is not None:
572
479
                              {'branch':self.branch,
573
480
                               'bzrlib':bzrlib,
574
481
                               'rev_id':self.rev_id})
575
 
        # process new style post commit hooks
576
 
        self._process_hooks("post_commit", old_revno, new_revno)
577
 
 
578
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
579
 
        if not Branch.hooks[hook_name]:
580
 
            return
581
 
 
582
482
        # new style commit hooks:
583
483
        if not self.bound_branch:
584
484
            hook_master = self.branch
593
493
            old_revid = self.parents[0]
594
494
        else:
595
495
            old_revid = bzrlib.revision.NULL_REVISION
596
 
 
597
 
        if hook_name == "pre_commit":
598
 
            future_tree = self.builder.revision_tree()
599
 
            tree_delta = future_tree.changes_from(self.basis_tree,
600
 
                                             include_root=True)
601
 
 
602
 
        for hook in Branch.hooks[hook_name]:
 
496
        for hook in Branch.hooks['post_commit']:
603
497
            # show the running hook in the progress bar. As hooks may
604
498
            # end up doing nothing (e.g. because they are not configured by
605
499
            # the user) this is still showing progress, not showing overall
606
500
            # actions - its up to each plugin to show a UI if it want's to
607
501
            # (such as 'Emailing diff to foo@example.com').
608
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
609
 
                (hook_name, Branch.hooks.get_hook_name(hook))
 
502
            self.pb_stage_name = "Running post commit hooks [%s]" % \
 
503
                Branch.hooks.get_hook_name(hook)
610
504
            self._emit_progress()
611
505
            if 'hooks' in debug.debug_flags:
612
506
                mutter("Invoking commit hook: %r", hook)
613
 
            if hook_name == "post_commit":
614
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
615
 
                     self.rev_id)
616
 
            elif hook_name == "pre_commit":
617
 
                hook(hook_local, hook_master,
618
 
                     old_revno, old_revid, new_revno, self.rev_id,
619
 
                     tree_delta, future_tree)
 
507
            hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
508
                self.rev_id)
 
509
 
 
510
    def _cleanup(self):
 
511
        """Cleanup any open locks, progress bars etc."""
 
512
        cleanups = [self._cleanup_bound_branch,
 
513
                    self.basis_tree.unlock,
 
514
                    self.work_tree.unlock,
 
515
                    self.pb.finished]
 
516
        found_exception = None
 
517
        for cleanup in cleanups:
 
518
            try:
 
519
                cleanup()
 
520
            # we want every cleanup to run no matter what.
 
521
            # so we have a catchall here, but we will raise the
 
522
            # last encountered exception up the stack: and
 
523
            # typically this will be useful enough.
 
524
            except Exception, e:
 
525
                found_exception = e
 
526
        if found_exception is not None: 
 
527
            # don't do a plan raise, because the last exception may have been
 
528
            # trashed, e is our sure-to-work exception even though it loses the
 
529
            # full traceback. XXX: RBC 20060421 perhaps we could check the
 
530
            # exc_info and if its the same one do a plain raise otherwise 
 
531
            # 'raise e' as we do now.
 
532
            raise e
 
533
 
 
534
    def _cleanup_bound_branch(self):
 
535
        """Executed at the end of a try/finally to cleanup a bound branch.
 
536
 
 
537
        If the branch wasn't bound, this is a no-op.
 
538
        If it was, it resents self.branch to the local branch, instead
 
539
        of being the master.
 
540
        """
 
541
        if not self.bound_branch:
 
542
            return
 
543
        if self.master_locked:
 
544
            self.master_branch.unlock()
 
545
 
 
546
    def _escape_commit_message(self):
 
547
        """Replace xml-incompatible control characters."""
 
548
        # FIXME: RBC 20060419 this should be done by the revision
 
549
        # serialiser not by commit. Then we can also add an unescaper
 
550
        # in the deserializer and start roundtripping revision messages
 
551
        # precisely. See repository_implementations/test_repository.py
 
552
        
 
553
        # Python strings can include characters that can't be
 
554
        # represented in well-formed XML; escape characters that
 
555
        # aren't listed in the XML specification
 
556
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
557
        self.message, escape_count = re.subn(
 
558
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
559
            lambda match: match.group(0).encode('unicode_escape'),
 
560
            self.message)
 
561
        if escape_count:
 
562
            self.reporter.escaped(escape_count, self.message)
620
563
 
621
564
    def _gather_parents(self):
622
565
        """Record the parents of a merge for merge detection."""
623
 
        # TODO: Make sure that this list doesn't contain duplicate
 
566
        # TODO: Make sure that this list doesn't contain duplicate 
624
567
        # entries and the order is preserved when doing this.
625
 
        if self.use_record_iter_changes:
626
 
            return
627
 
        self.basis_inv = self.basis_tree.inventory
 
568
        self.parents = self.work_tree.get_parent_ids()
628
569
        self.parent_invs = [self.basis_inv]
629
570
        for revision in self.parents[1:]:
630
571
            if self.branch.repository.has_revision(revision):
637
578
    def _update_builder_with_changes(self):
638
579
        """Update the commit builder with the data about what has changed.
639
580
        """
640
 
        exclude = self.exclude
641
 
        specific_files = self.specific_files
642
 
        mutter("Selecting files for commit with filter %s", specific_files)
643
 
 
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):
709
 
        # If specific files are selected, then all un-selected files must be
710
 
        # recorded in their previous state. For more details, see
711
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
712
 
        if self.specific_files or self.exclude:
713
 
            specific_files = self.specific_files or []
714
 
            for path, old_ie in self.basis_inv.iter_entries():
715
 
                if old_ie.file_id in self.builder.new_inventory:
716
 
                    # already added - skip.
717
 
                    continue
718
 
                if (is_inside_any(specific_files, path)
719
 
                    and not is_inside_any(self.exclude, path)):
720
 
                    # was inside the selected path, and not excluded - if not
721
 
                    # present it has been deleted so skip.
722
 
                    continue
723
 
                # From here down it was either not selected, or was excluded:
724
 
                # We preserve the entry unaltered.
725
 
                ie = old_ie.copy()
726
 
                # Note: specific file commits after a merge are currently
727
 
                # prohibited. This test is for sanity/safety in case it's
728
 
                # required after that changes.
729
 
                if len(self.parents) > 1:
730
 
                    ie.revision = None
731
 
                self.builder.record_entry_contents(ie, self.parent_invs, path,
732
 
                    self.basis_tree, None)
733
 
 
734
 
    def _report_and_accumulate_deletes(self):
735
 
        if (isinstance(self.basis_inv, Inventory)
736
 
            and isinstance(self.builder.new_inventory, Inventory)):
737
 
            # the older Inventory classes provide a _byid dict, and building a
738
 
            # set from the keys of this dict is substantially faster than even
739
 
            # getting a set of ids from the inventory
740
 
            #
741
 
            # <lifeless> set(dict) is roughly the same speed as
742
 
            # set(iter(dict)) and both are significantly slower than
743
 
            # set(dict.keys())
744
 
            deleted_ids = set(self.basis_inv._byid.keys()) - \
745
 
               set(self.builder.new_inventory._byid.keys())
746
 
        else:
747
 
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
748
 
        if deleted_ids:
749
 
            self.any_entries_deleted = True
750
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
751
 
                for file_id in deleted_ids]
752
 
            deleted.sort()
753
 
            # XXX: this is not quite directory-order sorting
754
 
            for path, file_id in deleted:
755
 
                self.builder.record_delete(path, file_id)
756
 
                self.reporter.deleted(path)
757
 
 
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).
762
 
        if self.strict:
763
 
            # raise an exception as soon as we find a single unknown.
764
 
            for unknown in self.work_tree.unknowns():
765
 
                raise StrictCommitFailed()
766
 
 
767
 
    def _populate_from_inventory(self):
768
 
        """Populate the CommitBuilder by walking the working tree inventory."""
769
581
        # Build the revision inventory.
770
582
        #
771
583
        # This starts by creating a new empty inventory. Depending on
772
584
        # which files are selected for commit, and what is present in the
773
 
        # current tree, the new inventory is populated. inventory entries
 
585
        # current tree, the new inventory is populated. inventory entries 
774
586
        # which are candidates for modification have their revision set to
775
587
        # None; inventory entries that are carried over untouched have their
776
588
        # revision set to their prior value.
781
593
        # ADHB 11-07-2006
782
594
 
783
595
        specific_files = self.specific_files
784
 
        exclude = self.exclude
785
 
        report_changes = self.reporter.is_verbose()
786
 
        deleted_ids = []
787
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
788
 
        # deleted, then we have {'foo':{'bar':{}}}
789
 
        deleted_paths = {}
790
 
        # XXX: Note that entries may have the wrong kind because the entry does
791
 
        # not reflect the status on disk.
 
596
        mutter("Selecting files for commit with filter %s", specific_files)
792
597
        work_inv = self.work_tree.inventory
793
 
        # NB: entries will include entries within the excluded ids/paths
794
 
        # because iter_entries_by_dir has no 'exclude' facility today.
795
 
        entries = work_inv.iter_entries_by_dir(
796
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
797
 
        for path, existing_ie in entries:
798
 
            file_id = existing_ie.file_id
799
 
            name = existing_ie.name
800
 
            parent_id = existing_ie.parent_id
801
 
            kind = existing_ie.kind
 
598
        assert work_inv.root is not None
 
599
        self.pb_entries_total = len(work_inv)
 
600
 
 
601
        # Check and warn about old CommitBuilders
 
602
        entries = work_inv.iter_entries()
 
603
        if not self.builder.record_root_entry:
 
604
            symbol_versioning.warn('CommitBuilders should support recording'
 
605
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
606
                stacklevel=1)
 
607
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
608
            entries.next()
 
609
 
 
610
        deleted_ids = []
 
611
        deleted_paths = set()
 
612
        for path, new_ie in entries:
 
613
            self._emit_progress_next_entry()
 
614
            file_id = new_ie.file_id
 
615
 
802
616
            # Skip files that have been deleted from the working tree.
803
 
            # The deleted path ids are also recorded so they can be explicitly
804
 
            # unversioned later.
805
 
            if deleted_paths:
806
 
                path_segments = splitpath(path)
807
 
                deleted_dict = deleted_paths
808
 
                for segment in path_segments:
809
 
                    deleted_dict = deleted_dict.get(segment, None)
810
 
                    if not deleted_dict:
811
 
                        # We either took a path not present in the dict
812
 
                        # (deleted_dict was None), or we've reached an empty
813
 
                        # child dir in the dict, so are now a sub-path.
814
 
                        break
815
 
                else:
816
 
                    deleted_dict = None
817
 
                if deleted_dict is not None:
818
 
                    # the path has a deleted parent, do not add it.
819
 
                    continue
820
 
            if exclude and is_inside_any(exclude, path):
821
 
                # Skip excluded paths. Excluded paths are processed by
822
 
                # _update_builder_with_changes.
 
617
            # The deleted files/directories are also recorded so they
 
618
            # can be explicitly unversioned later. Note that when a
 
619
            # filter of specific files is given, we must only skip/record
 
620
            # deleted files matching that filter.
 
621
            if is_inside_any(deleted_paths, path):
823
622
                continue
824
 
            content_summary = self.work_tree.path_content_summary(path)
825
 
            kind = content_summary[0]
826
 
            # Note that when a filter of specific files is given, we must only
827
 
            # skip/record deleted files matching that filter.
828
623
            if not specific_files or is_inside_any(specific_files, path):
829
 
                if kind == 'missing':
830
 
                    if not deleted_paths:
831
 
                        # path won't have been split yet.
832
 
                        path_segments = splitpath(path)
833
 
                    deleted_dict = deleted_paths
834
 
                    for segment in path_segments:
835
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
624
                if not self.work_tree.has_filename(path):
 
625
                    deleted_paths.add(path)
836
626
                    self.reporter.missing(path)
837
 
                    self._next_progress_entry()
838
627
                    deleted_ids.append(file_id)
839
628
                    continue
840
 
            # TODO: have the builder do the nested commit just-in-time IF and
841
 
            # only if needed.
842
 
            if kind == 'tree-reference':
843
 
                # enforce repository nested tree policy.
844
 
                if (not self.work_tree.supports_tree_reference() or
845
 
                    # repository does not support it either.
846
 
                    not self.branch.repository._format.supports_tree_reference):
847
 
                    kind = 'directory'
848
 
                    content_summary = (kind, None, None, None)
849
 
                elif self.recursive == 'down':
850
 
                    nested_revision_id = self._commit_nested_tree(
851
 
                        file_id, path)
852
 
                    content_summary = (kind, None, None, nested_revision_id)
 
629
            try:
 
630
                kind = self.work_tree.kind(file_id)
 
631
                if kind == 'tree-reference' and self.recursive == 'down':
 
632
                    # nested tree: commit in it
 
633
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
634
                    # FIXME: be more comprehensive here:
 
635
                    # this works when both trees are in --trees repository,
 
636
                    # but when both are bound to a different repository,
 
637
                    # it fails; a better way of approaching this is to 
 
638
                    # finally implement the explicit-caches approach design
 
639
                    # a while back - RBC 20070306.
 
640
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
641
                        ==
 
642
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
643
                        sub_tree.branch.repository = \
 
644
                            self.work_tree.branch.repository
 
645
                    try:
 
646
                        sub_tree.commit(message=None, revprops=self.revprops,
 
647
                            recursive=self.recursive,
 
648
                            message_callback=self.message_callback,
 
649
                            timestamp=self.timestamp, timezone=self.timezone,
 
650
                            committer=self.committer,
 
651
                            allow_pointless=self.allow_pointless,
 
652
                            strict=self.strict, verbose=self.verbose,
 
653
                            local=self.local, reporter=self.reporter)
 
654
                    except errors.PointlessCommit:
 
655
                        pass
 
656
                if kind != new_ie.kind:
 
657
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
658
                                                  new_ie.parent_id, file_id)
 
659
            except errors.NoSuchFile:
 
660
                pass
 
661
            # mutter('check %s {%s}', path, file_id)
 
662
            if (not specific_files or 
 
663
                is_inside_or_parent_of_any(specific_files, path)):
 
664
                    # mutter('%s selected for commit', path)
 
665
                    ie = new_ie.copy()
 
666
                    ie.revision = None
 
667
            else:
 
668
                # mutter('%s not selected for commit', path)
 
669
                if self.basis_inv.has_id(file_id):
 
670
                    ie = self.basis_inv[file_id].copy()
853
671
                else:
854
 
                    nested_revision_id = self.work_tree.get_reference_revision(file_id)
855
 
                    content_summary = (kind, None, None, nested_revision_id)
856
 
 
857
 
            # Record an entry for this item
858
 
            # Note: I don't particularly want to have the existing_ie
859
 
            # parameter but the test suite currently (28-Jun-07) breaks
860
 
            # without it thanks to a unicode normalisation issue. :-(
861
 
            definitely_changed = kind != existing_ie.kind
862
 
            self._record_entry(path, file_id, specific_files, kind, name,
863
 
                parent_id, definitely_changed, existing_ie, report_changes,
864
 
                content_summary)
 
672
                    # this entry is new and not being committed
 
673
                    continue
 
674
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
675
                path, self.work_tree)
 
676
            # describe the nature of the change that has occurred relative to
 
677
            # the basis inventory.
 
678
            if (self.basis_inv.has_id(ie.file_id)):
 
679
                basis_ie = self.basis_inv[ie.file_id]
 
680
            else:
 
681
                basis_ie = None
 
682
            change = ie.describe_change(basis_ie, ie)
 
683
            if change in (InventoryEntry.RENAMED, 
 
684
                InventoryEntry.MODIFIED_AND_RENAMED):
 
685
                old_path = self.basis_inv.id2path(ie.file_id)
 
686
                self.reporter.renamed(change, old_path, path)
 
687
            else:
 
688
                self.reporter.snapshot_change(change, path)
865
689
 
866
690
        # Unversion IDs that were found to be deleted
867
 
        self.deleted_ids = deleted_ids
868
 
 
869
 
    def _commit_nested_tree(self, file_id, path):
870
 
        "Commit a nested tree."
871
 
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
872
 
        # FIXME: be more comprehensive here:
873
 
        # this works when both trees are in --trees repository,
874
 
        # but when both are bound to a different repository,
875
 
        # it fails; a better way of approaching this is to
876
 
        # finally implement the explicit-caches approach design
877
 
        # a while back - RBC 20070306.
878
 
        if sub_tree.branch.repository.has_same_location(
879
 
            self.work_tree.branch.repository):
880
 
            sub_tree.branch.repository = \
881
 
                self.work_tree.branch.repository
882
 
        try:
883
 
            return sub_tree.commit(message=None, revprops=self.revprops,
884
 
                recursive=self.recursive,
885
 
                message_callback=self.message_callback,
886
 
                timestamp=self.timestamp, timezone=self.timezone,
887
 
                committer=self.committer,
888
 
                allow_pointless=self.allow_pointless,
889
 
                strict=self.strict, verbose=self.verbose,
890
 
                local=self.local, reporter=self.reporter)
891
 
        except errors.PointlessCommit:
892
 
            return self.work_tree.get_reference_revision(file_id)
893
 
 
894
 
    def _record_entry(self, path, file_id, specific_files, kind, name,
895
 
        parent_id, definitely_changed, existing_ie, report_changes,
896
 
        content_summary):
897
 
        "Record the new inventory entry for a path if any."
898
 
        # mutter('check %s {%s}', path, file_id)
899
 
        # mutter('%s selected for commit', path)
900
 
        if definitely_changed or existing_ie is None:
901
 
            ie = make_entry(kind, name, parent_id, file_id)
902
 
        else:
903
 
            ie = existing_ie.copy()
904
 
            ie.revision = None
905
 
        # For carried over entries we don't care about the fs hash - the repo
906
 
        # isn't generating a sha, so we're not saving computation time.
907
 
        _, _, fs_hash = self.builder.record_entry_contents(
908
 
            ie, self.parent_invs, path, self.work_tree, content_summary)
909
 
        if report_changes:
910
 
            self._report_change(ie, path)
911
 
        if fs_hash:
912
 
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
913
 
        return ie
914
 
 
915
 
    def _report_change(self, ie, path):
916
 
        """Report a change to the user.
917
 
 
918
 
        The change that has occurred is described relative to the basis
919
 
        inventory.
920
 
        """
921
 
        if (self.basis_inv.has_id(ie.file_id)):
922
 
            basis_ie = self.basis_inv[ie.file_id]
923
 
        else:
924
 
            basis_ie = None
925
 
        change = ie.describe_change(basis_ie, ie)
926
 
        if change in (InventoryEntry.RENAMED,
927
 
            InventoryEntry.MODIFIED_AND_RENAMED):
928
 
            old_path = self.basis_inv.id2path(ie.file_id)
929
 
            self.reporter.renamed(change, old_path, path)
930
 
            self._next_progress_entry()
931
 
        else:
932
 
            if change == 'unchanged':
933
 
                return
934
 
            self.reporter.snapshot_change(change, path)
935
 
            self._next_progress_entry()
936
 
 
937
 
    def _set_progress_stage(self, name, counter=False):
 
691
        self.work_tree.unversion(deleted_ids)
 
692
 
 
693
        # If specific files/directories were nominated, it is possible
 
694
        # that some data from outside those needs to be preserved from
 
695
        # the basis tree. For example, if a file x is moved from out of
 
696
        # directory foo into directory bar and the user requests
 
697
        # ``commit foo``, then information about bar/x must also be
 
698
        # recorded.
 
699
        if specific_files:
 
700
            for path, new_ie in self.basis_inv.iter_entries():
 
701
                if new_ie.file_id in work_inv:
 
702
                    continue
 
703
                if is_inside_any(specific_files, path):
 
704
                    continue
 
705
                ie = new_ie.copy()
 
706
                ie.revision = None
 
707
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
708
                                                   self.basis_tree)
 
709
 
 
710
        # Report what was deleted. We could skip this when no deletes are
 
711
        # detected to gain a performance win, but it arguably serves as a
 
712
        # 'safety check' by informing the user whenever anything disappears.
 
713
        for path, ie in self.basis_inv.iter_entries():
 
714
            if ie.file_id not in self.builder.new_inventory:
 
715
                self.reporter.deleted(path)
 
716
 
 
717
    def _emit_progress_set_stage(self, name, show_entries=False):
938
718
        """Set the progress stage and emit an update to the progress bar."""
939
719
        self.pb_stage_name = name
940
720
        self.pb_stage_count += 1
941
 
        if counter:
 
721
        self.pb_entries_show = show_entries
 
722
        if show_entries:
942
723
            self.pb_entries_count = 0
943
 
        else:
944
 
            self.pb_entries_count = None
 
724
            self.pb_entries_total = '?'
945
725
        self._emit_progress()
946
726
 
947
 
    def _next_progress_entry(self):
948
 
        """Emit an update to the progress bar and increment the entry count."""
 
727
    def _emit_progress_next_entry(self):
 
728
        """Emit an update to the progress bar and increment the file count."""
949
729
        self.pb_entries_count += 1
950
730
        self._emit_progress()
951
731
 
952
732
    def _emit_progress(self):
953
 
        if self.pb_entries_count is not None:
954
 
            text = "%s [%d] - Stage" % (self.pb_stage_name,
955
 
                self.pb_entries_count)
 
733
        if self.pb_entries_show:
 
734
            text = "%s [Entry %d/%s] - Stage" % (self.pb_stage_name,
 
735
                self.pb_entries_count,str(self.pb_entries_total))
956
736
        else:
957
 
            text = "%s - Stage" % (self.pb_stage_name, )
 
737
            text = "%s - Stage" % (self.pb_stage_name)
958
738
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
959
739
 
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