/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: Martin Pool
  • Date: 2009-09-11 06:36:50 UTC
  • mto: This revision was merged to the branch mainline in revision 4688.
  • Revision ID: mbp@sourcefrog.net-20090911063650-yvb522sbe6k0i62r
Only mutter extension load errors when they occur, and record for later

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
# XXX: Can we do any better about making interrupted commits change
19
 
# nothing?  
20
 
 
21
 
# TODO: Separate 'prepare' phase where we find a list of potentially
22
 
# committed files.  We then can then pause the commit to prompt for a
23
 
# commit message, knowing the summary will be the same as what's
24
 
# actually used for the commit.  (But perhaps simpler to simply get
25
 
# the tree status, then use that for a selective commit?)
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
26
17
 
27
18
# The newly committed revision is going to have a shape corresponding
28
 
# to that of the working inventory.  Files that are not in the
 
19
# to that of the working tree.  Files that are not in the
29
20
# working tree and that were in the predecessor are reported as
30
21
# removed --- this can include files that were either removed from the
31
22
# inventory or deleted in the working tree.  If they were only
34
25
# We then consider the remaining entries, which will be in the new
35
26
# version.  Directory entries are simply copied across.  File entries
36
27
# must be checked to see if a new version of the file should be
37
 
# recorded.  For each parent revision inventory, we check to see what
 
28
# recorded.  For each parent revision tree, we check to see what
38
29
# version of the file was present.  If the file was present in at
39
30
# least one tree, and if it was the same version in all the trees,
40
31
# then we can just refer to that version.  Otherwise, a new version
55
46
# merges from, then it should still be reported as newly added
56
47
# relative to the basis revision.
57
48
 
58
 
# TODO: Do checks that the tree can be committed *before* running the 
59
 
# editor; this should include checks for a pointless commit and for 
60
 
# unknown or missing files.
61
 
 
62
 
# TODO: If commit fails, leave the message in a file somewhere.
63
 
 
 
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
 
50
# the rest of the code; add a deprecation of the old name.
64
51
 
65
52
import os
66
53
import re
69
56
 
70
57
from cStringIO import StringIO
71
58
 
 
59
from bzrlib import (
 
60
    debug,
 
61
    errors,
 
62
    revision,
 
63
    trace,
 
64
    tree,
 
65
    xml_serializer,
 
66
    )
 
67
from bzrlib.branch import Branch
72
68
import bzrlib.config
73
 
import bzrlib.errors as errors
74
69
from bzrlib.errors import (BzrError, PointlessCommit,
75
70
                           ConflictsInTree,
76
71
                           StrictCommitFailed
77
72
                           )
78
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
 
73
from bzrlib.osutils import (get_user_encoding,
 
74
                            kind_marker, isdir,isfile, is_inside_any,
79
75
                            is_inside_or_parent_of_any,
80
 
                            quotefn, sha_file, split_lines)
 
76
                            minimum_path_selection,
 
77
                            quotefn, sha_file, split_lines,
 
78
                            splitpath,
 
79
                            )
81
80
from bzrlib.testament import Testament
82
 
from bzrlib.trace import mutter, note, warning
83
 
from bzrlib.xml5 import serializer_v5
84
 
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
 
81
from bzrlib.trace import mutter, note, warning, is_quiet
 
82
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
85
83
from bzrlib import symbol_versioning
86
84
from bzrlib.symbol_versioning import (deprecated_passed,
87
85
        deprecated_function,
88
86
        DEPRECATED_PARAMETER)
89
87
from bzrlib.workingtree import WorkingTree
 
88
from bzrlib.urlutils import unescape_for_display
 
89
import bzrlib.ui
90
90
 
91
91
 
92
92
class NullCommitReporter(object):
93
93
    """I report on progress of a commit."""
94
94
 
 
95
    def started(self, revno, revid, location=None):
 
96
        if location is None:
 
97
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
98
                                   "to started.", DeprecationWarning,
 
99
                                   stacklevel=2)
 
100
        pass
 
101
 
95
102
    def snapshot_change(self, change, path):
96
103
        pass
97
104
 
98
105
    def completed(self, revno, rev_id):
99
106
        pass
100
107
 
101
 
    def deleted(self, file_id):
102
 
        pass
103
 
 
104
 
    def escaped(self, escape_count, message):
 
108
    def deleted(self, path):
105
109
        pass
106
110
 
107
111
    def missing(self, path):
110
114
    def renamed(self, change, old_path, new_path):
111
115
        pass
112
116
 
 
117
    def is_verbose(self):
 
118
        return False
 
119
 
113
120
 
114
121
class ReportCommitToLog(NullCommitReporter):
115
122
 
116
 
    # this may be more useful if 'note' was replaced by an overridable
117
 
    # method on self, which would allow more trivial subclassing.
118
 
    # alternative, a callable could be passed in, allowing really trivial
119
 
    # reuse for some uis. RBC 20060511
 
123
    def _note(self, format, *args):
 
124
        """Output a message.
 
125
 
 
126
        Subclasses may choose to override this method.
 
127
        """
 
128
        note(format, *args)
120
129
 
121
130
    def snapshot_change(self, change, path):
122
 
        if change == 'unchanged':
 
131
        if path == '' and change in ('added', 'modified'):
123
132
            return
124
 
        note("%s %s", change, path)
 
133
        self._note("%s %s", change, path)
 
134
 
 
135
    def started(self, revno, rev_id, location=None):
 
136
        if location is not None:
 
137
            location = ' to: ' + unescape_for_display(location, 'utf-8')
 
138
        else:
 
139
            # When started was added, location was only made optional by
 
140
            # accident.  Matt Nordhoff 20071129
 
141
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
 
142
                                   "to started.", DeprecationWarning,
 
143
                                   stacklevel=2)
 
144
            location = ''
 
145
        self._note('Committing%s', location)
125
146
 
126
147
    def completed(self, revno, rev_id):
127
 
        note('Committed revision %d.', revno)
128
 
    
129
 
    def deleted(self, file_id):
130
 
        note('deleted %s', file_id)
 
148
        self._note('Committed revision %d.', revno)
131
149
 
132
 
    def escaped(self, escape_count, message):
133
 
        note("replaced %d control characters in message", escape_count)
 
150
    def deleted(self, path):
 
151
        self._note('deleted %s', path)
134
152
 
135
153
    def missing(self, path):
136
 
        note('missing %s', path)
 
154
        self._note('missing %s', path)
137
155
 
138
156
    def renamed(self, change, old_path, new_path):
139
 
        note('%s %s => %s', change, old_path, new_path)
 
157
        self._note('%s %s => %s', change, old_path, new_path)
 
158
 
 
159
    def is_verbose(self):
 
160
        return True
140
161
 
141
162
 
142
163
class Commit(object):
154
175
    def __init__(self,
155
176
                 reporter=None,
156
177
                 config=None):
157
 
        if reporter is not None:
158
 
            self.reporter = reporter
159
 
        else:
160
 
            self.reporter = NullCommitReporter()
161
 
        if config is not None:
162
 
            self.config = config
163
 
        else:
164
 
            self.config = None
165
 
        
 
178
        """Create a Commit object.
 
179
 
 
180
        :param reporter: the default reporter to use or None to decide later
 
181
        """
 
182
        self.reporter = reporter
 
183
        self.config = config
 
184
 
166
185
    def commit(self,
167
 
               branch=DEPRECATED_PARAMETER, message=None,
 
186
               message=None,
168
187
               timestamp=None,
169
188
               timezone=None,
170
189
               committer=None,
177
196
               working_tree=None,
178
197
               local=False,
179
198
               reporter=None,
180
 
               config=None):
 
199
               config=None,
 
200
               message_callback=None,
 
201
               recursive='down',
 
202
               exclude=None,
 
203
               possible_master_transports=None):
181
204
        """Commit working copy as a new revision.
182
205
 
183
 
        branch -- the deprecated branch to commit to. New callers should pass in 
184
 
                  working_tree instead
185
 
 
186
 
        message -- the commit message, a mandatory parameter
187
 
 
188
 
        timestamp -- if not None, seconds-since-epoch for a
189
 
             postdated/predated commit.
190
 
 
191
 
        specific_files -- If true, commit only those files.
192
 
 
193
 
        rev_id -- If set, use this as the new revision id.
 
206
        :param message: the commit message (it or message_callback is required)
 
207
        :param message_callback: A callback: message = message_callback(cmt_obj)
 
208
 
 
209
        :param timestamp: if not None, seconds-since-epoch for a
 
210
            postdated/predated commit.
 
211
 
 
212
        :param specific_files: If true, commit only those files.
 
213
 
 
214
        :param rev_id: If set, use this as the new revision id.
194
215
            Useful for test or import commands that need to tightly
195
216
            control what revisions are assigned.  If you duplicate
196
217
            a revision id that exists elsewhere it is your own fault.
197
218
            If null (default), a time/random revision id is generated.
198
219
 
199
 
        allow_pointless -- If true (default), commit even if nothing
 
220
        :param allow_pointless: If true (default), commit even if nothing
200
221
            has changed and no merges are recorded.
201
222
 
202
 
        strict -- If true, don't allow a commit if the working tree
 
223
        :param strict: If true, don't allow a commit if the working tree
203
224
            contains unknown files.
204
225
 
205
 
        revprops -- Properties for new revision
 
226
        :param revprops: Properties for new revision
206
227
        :param local: Perform a local only commit.
 
228
        :param reporter: the reporter to use or None for the default
 
229
        :param verbose: if True and the reporter is not None, report everything
 
230
        :param recursive: If set to 'down', commit in any subtrees that have
 
231
            pending changes of any sort during this commit.
 
232
        :param exclude: None or a list of relative paths to exclude from the
 
233
            commit. Pending changes to excluded files will be ignored by the
 
234
            commit.
207
235
        """
208
236
        mutter('preparing to commit')
209
237
 
210
 
        if deprecated_passed(branch):
211
 
            symbol_versioning.warn("Commit.commit (branch, ...): The branch parameter is "
212
 
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
213
 
                 DeprecationWarning, stacklevel=2)
214
 
            self.branch = branch
215
 
            self.work_tree = self.branch.bzrdir.open_workingtree()
216
 
        elif working_tree is None:
217
 
            raise BzrError("One of branch and working_tree must be passed into commit().")
 
238
        if working_tree is None:
 
239
            raise BzrError("working_tree must be passed into commit().")
218
240
        else:
219
241
            self.work_tree = working_tree
220
242
            self.branch = self.work_tree.branch
221
 
        if message is None:
222
 
            raise BzrError("The message keyword parameter is required for commit().")
 
243
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
 
244
                if not self.branch.repository.supports_rich_root():
 
245
                    raise errors.RootNotRich()
 
246
        if message_callback is None:
 
247
            if message is not None:
 
248
                if isinstance(message, str):
 
249
                    message = message.decode(get_user_encoding())
 
250
                message_callback = lambda x: message
 
251
            else:
 
252
                raise BzrError("The message or message_callback keyword"
 
253
                               " parameter is required for commit().")
223
254
 
224
255
        self.bound_branch = None
 
256
        self.any_entries_deleted = False
 
257
        if exclude is not None:
 
258
            self.exclude = sorted(
 
259
                minimum_path_selection(exclude))
 
260
        else:
 
261
            self.exclude = []
225
262
        self.local = local
226
263
        self.master_branch = None
227
264
        self.master_locked = False
 
265
        self.recursive = recursive
228
266
        self.rev_id = None
229
 
        self.specific_files = specific_files
 
267
        if specific_files is not None:
 
268
            self.specific_files = sorted(
 
269
                minimum_path_selection(specific_files))
 
270
        else:
 
271
            self.specific_files = None
 
272
            
230
273
        self.allow_pointless = allow_pointless
231
 
 
232
 
        if reporter is None and self.reporter is None:
233
 
            self.reporter = NullCommitReporter()
234
 
        elif reporter is not None:
235
 
            self.reporter = reporter
 
274
        self.revprops = revprops
 
275
        self.message_callback = message_callback
 
276
        self.timestamp = timestamp
 
277
        self.timezone = timezone
 
278
        self.committer = committer
 
279
        self.strict = strict
 
280
        self.verbose = verbose
236
281
 
237
282
        self.work_tree.lock_write()
 
283
        self.parents = self.work_tree.get_parent_ids()
 
284
        # We can use record_iter_changes IFF iter_changes is compatible with
 
285
        # the command line parameters, and the repository has fast delta
 
286
        # generation. See bug 347649.
 
287
        self.use_record_iter_changes = (
 
288
            not self.specific_files and
 
289
            not self.exclude and 
 
290
            not self.branch.repository._format.supports_tree_reference and
 
291
            (self.branch.repository._format.fast_deltas or
 
292
             len(self.parents) < 2))
238
293
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
294
        self.basis_revid = self.work_tree.last_revision()
 
295
        self.basis_tree = self.work_tree.basis_tree()
 
296
        self.basis_tree.lock_read()
239
297
        try:
240
298
            # Cannot commit with conflicts present.
241
 
            if len(self.work_tree.conflicts())>0:
 
299
            if len(self.work_tree.conflicts()) > 0:
242
300
                raise ConflictsInTree
243
301
 
244
 
            # setup the bound branch variables as needed.
245
 
            self._check_bound_branch()
246
 
 
247
 
            # check for out of date working trees
248
 
            try:
249
 
                first_tree_parent = self.work_tree.get_parent_ids()[0]
250
 
            except IndexError:
251
 
                # if there are no parents, treat our parent as 'None'
252
 
                # this is so that we still consier the master branch
253
 
                # - in a checkout scenario the tree may have no
254
 
                # parents but the branch may do.
255
 
                first_tree_parent = None
256
 
            master_last = self.master_branch.last_revision()
257
 
            if (master_last is not None and
258
 
                master_last != first_tree_parent):
259
 
                raise errors.OutOfDateTree(self.work_tree)
260
 
    
261
 
            if strict:
262
 
                # raise an exception as soon as we find a single unknown.
263
 
                for unknown in self.work_tree.unknowns():
264
 
                    raise StrictCommitFailed()
265
 
                   
 
302
            # Setup the bound branch variables as needed.
 
303
            self._check_bound_branch(possible_master_transports)
 
304
 
 
305
            # Check that the working tree is up to date
 
306
            old_revno, new_revno = self._check_out_of_date_tree()
 
307
 
 
308
            # Complete configuration setup
 
309
            if reporter is not None:
 
310
                self.reporter = reporter
 
311
            elif self.reporter is None:
 
312
                self.reporter = self._select_reporter()
266
313
            if self.config is None:
267
314
                self.config = self.branch.get_config()
268
 
      
269
 
            if isinstance(message, str):
270
 
                message = message.decode(bzrlib.user_encoding)
271
 
            assert isinstance(message, unicode), type(message)
272
 
            self.message = message
273
 
            self._escape_commit_message()
274
 
 
275
 
            self.work_inv = self.work_tree.inventory
276
 
            self.basis_tree = self.work_tree.basis_tree()
277
 
            self.basis_inv = self.basis_tree.inventory
278
 
            # one to finish, one for rev and inventory, and one for each
279
 
            # inventory entry, and the same for the new inventory.
280
 
            # note that this estimate is too long when we do a partial tree
281
 
            # commit which excludes some new files from being considered.
282
 
            # The estimate is corrected when we populate the new inv.
283
 
            self.pb_total = len(self.work_inv) + 5
284
 
            self.pb_count = 0
 
315
 
 
316
            self._set_specific_file_ids()
 
317
 
 
318
            # Setup the progress bar. As the number of files that need to be
 
319
            # committed in unknown, progress is reported as stages.
 
320
            # We keep track of entries separately though and include that
 
321
            # information in the progress bar during the relevant stages.
 
322
            self.pb_stage_name = ""
 
323
            self.pb_stage_count = 0
 
324
            self.pb_stage_total = 5
 
325
            if self.bound_branch:
 
326
                self.pb_stage_total += 1
 
327
            self.pb.show_pct = False
 
328
            self.pb.show_spinner = False
 
329
            self.pb.show_eta = False
 
330
            self.pb.show_count = True
 
331
            self.pb.show_bar = True
285
332
 
286
333
            self._gather_parents()
 
334
            # After a merge, a selected file commit is not supported.
 
335
            # See 'bzr help merge' for an explanation as to why.
287
336
            if len(self.parents) > 1 and self.specific_files:
288
 
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
289
 
                        self.specific_files)
290
 
            
291
 
            self.builder = self.branch.get_commit_builder(self.parents, 
 
337
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
 
338
            # Excludes are a form of selected file commit.
 
339
            if len(self.parents) > 1 and self.exclude:
 
340
                raise errors.CannotCommitSelectedFileMerge(self.exclude)
 
341
 
 
342
            # Collect the changes
 
343
            self._set_progress_stage("Collecting changes", counter=True)
 
344
            self.builder = self.branch.get_commit_builder(self.parents,
292
345
                self.config, timestamp, timezone, committer, revprops, rev_id)
293
 
            
294
 
            self._remove_deleted()
295
 
            self._populate_new_inv()
296
 
            self._report_deletes()
297
 
 
298
 
            self._check_pointless()
299
 
 
300
 
            self._emit_progress_update()
301
 
            # TODO: Now the new inventory is known, check for conflicts and
302
 
            # prompt the user for a commit message.
303
 
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
304
 
            # weave lines, because nothing should be recorded until it is known
305
 
            # that commit will succeed.
306
 
            self.builder.finish_inventory()
307
 
            self._emit_progress_update()
308
 
            self.rev_id = self.builder.commit(self.message)
309
 
            self._emit_progress_update()
310
 
            # revision data is in the local branch now.
311
 
            
312
 
            # upload revision data to the master.
 
346
 
 
347
            try:
 
348
                self.builder.will_record_deletes()
 
349
                # find the location being committed to
 
350
                if self.bound_branch:
 
351
                    master_location = self.master_branch.base
 
352
                else:
 
353
                    master_location = self.branch.base
 
354
 
 
355
                # report the start of the commit
 
356
                self.reporter.started(new_revno, self.rev_id, master_location)
 
357
 
 
358
                self._update_builder_with_changes()
 
359
                self._check_pointless()
 
360
 
 
361
                # TODO: Now the new inventory is known, check for conflicts.
 
362
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
363
                # weave lines, because nothing should be recorded until it is known
 
364
                # that commit will succeed.
 
365
                self._set_progress_stage("Saving data locally")
 
366
                self.builder.finish_inventory()
 
367
 
 
368
                # Prompt the user for a commit message if none provided
 
369
                message = message_callback(self)
 
370
                self.message = message
 
371
 
 
372
                # Add revision data to the local branch
 
373
                self.rev_id = self.builder.commit(self.message)
 
374
 
 
375
            except Exception, e:
 
376
                mutter("aborting commit write group because of exception:")
 
377
                trace.log_exception_quietly()
 
378
                note("aborting commit write group: %r" % (e,))
 
379
                self.builder.abort()
 
380
                raise
 
381
 
 
382
            self._process_pre_hooks(old_revno, new_revno)
 
383
 
 
384
            # Upload revision data to the master.
313
385
            # this will propagate merged revisions too if needed.
314
386
            if self.bound_branch:
315
 
                self.master_branch.repository.fetch(self.branch.repository,
316
 
                                                    revision_id=self.rev_id)
317
 
                # now the master has the revision data
318
 
                # 'commit' to the master first so a timeout here causes the local
319
 
                # branch to be out of date
320
 
                self.master_branch.append_revision(self.rev_id)
 
387
                self._set_progress_stage("Uploading data to master branch")
 
388
                # 'commit' to the master first so a timeout here causes the
 
389
                # local branch to be out of date
 
390
                self.master_branch.import_last_revision_info(
 
391
                    self.branch.repository, new_revno, self.rev_id)
321
392
 
322
393
            # and now do the commit locally.
323
 
            self.branch.append_revision(self.rev_id)
 
394
            self.branch.set_last_revision_info(new_revno, self.rev_id)
324
395
 
325
 
            # if the builder gave us the revisiontree it created back, we
326
 
            # could use it straight away here.
327
 
            # TODO: implement this.
328
 
            self.work_tree.set_parent_trees([(self.rev_id,
329
 
                self.branch.repository.revision_tree(self.rev_id))])
330
 
            # now the work tree is up to date with the branch
331
 
            
332
 
            self.reporter.completed(self.branch.revno(), self.rev_id)
333
 
            if self.config.post_commit() is not None:
334
 
                hooks = self.config.post_commit().split(' ')
335
 
                # this would be nicer with twisted.python.reflect.namedAny
336
 
                for hook in hooks:
337
 
                    result = eval(hook + '(branch, rev_id)',
338
 
                                  {'branch':self.branch,
339
 
                                   'bzrlib':bzrlib,
340
 
                                   'rev_id':self.rev_id})
341
 
            self._emit_progress_update()
 
396
            # Make the working tree be up to date with the branch. This
 
397
            # includes automatic changes scheduled to be made to the tree, such
 
398
            # as updating its basis and unversioning paths that were missing.
 
399
            self.work_tree.unversion(self.deleted_ids)
 
400
            self._set_progress_stage("Updating the working tree")
 
401
            self.work_tree.update_basis_by_delta(self.rev_id,
 
402
                 self.builder.get_basis_delta())
 
403
            self.reporter.completed(new_revno, self.rev_id)
 
404
            self._process_post_hooks(old_revno, new_revno)
342
405
        finally:
343
406
            self._cleanup()
344
407
        return self.rev_id
345
408
 
 
409
    def _select_reporter(self):
 
410
        """Select the CommitReporter to use."""
 
411
        if is_quiet():
 
412
            return NullCommitReporter()
 
413
        return ReportCommitToLog()
 
414
 
346
415
    def _check_pointless(self):
347
416
        if self.allow_pointless:
348
417
            return
349
418
        # A merge with no effect on files
350
419
        if len(self.parents) > 1:
351
420
            return
352
 
        # work around the fact that a newly-initted tree does differ from its
353
 
        # basis
354
 
        if len(self.builder.new_inventory) != len(self.basis_inv):
355
 
            return
356
 
        if (len(self.builder.new_inventory) != 1 and
357
 
            self.builder.new_inventory != self.basis_inv):
 
421
        # TODO: we could simplify this by using self.builder.basis_delta.
 
422
 
 
423
        # The initial commit adds a root directory, but this in itself is not
 
424
        # a worthwhile commit.
 
425
        if (self.basis_revid == revision.NULL_REVISION and
 
426
            ((self.builder.new_inventory is not None and
 
427
             len(self.builder.new_inventory) == 1) or
 
428
            len(self.builder._basis_delta) == 1)):
 
429
            raise PointlessCommit()
 
430
        if self.builder.any_changes():
358
431
            return
359
432
        raise PointlessCommit()
360
433
 
361
 
    def _check_bound_branch(self):
 
434
    def _check_bound_branch(self, possible_master_transports=None):
362
435
        """Check to see if the local branch is bound.
363
436
 
364
437
        If it is bound, then most of the commit will actually be
369
442
            raise errors.LocalRequiresBoundBranch()
370
443
 
371
444
        if not self.local:
372
 
            self.master_branch = self.branch.get_master_branch()
 
445
            self.master_branch = self.branch.get_master_branch(
 
446
                possible_master_transports)
373
447
 
374
448
        if not self.master_branch:
375
449
            # make this branch the reference branch for out of date checks.
386
460
        #       commits to the remote branch if they would fit.
387
461
        #       But for now, just require remote to be identical
388
462
        #       to local.
389
 
        
 
463
 
390
464
        # Make sure the local branch is identical to the master
391
 
        master_rh = self.master_branch.revision_history()
392
 
        local_rh = self.branch.revision_history()
393
 
        if local_rh != master_rh:
 
465
        master_info = self.master_branch.last_revision_info()
 
466
        local_info = self.branch.last_revision_info()
 
467
        if local_info != master_info:
394
468
            raise errors.BoundBranchOutOfDate(self.branch,
395
469
                    self.master_branch)
396
470
 
400
474
        self.master_branch.lock_write()
401
475
        self.master_locked = True
402
476
 
 
477
    def _check_out_of_date_tree(self):
 
478
        """Check that the working tree is up to date.
 
479
 
 
480
        :return: old_revision_number,new_revision_number tuple
 
481
        """
 
482
        try:
 
483
            first_tree_parent = self.work_tree.get_parent_ids()[0]
 
484
        except IndexError:
 
485
            # if there are no parents, treat our parent as 'None'
 
486
            # this is so that we still consider the master branch
 
487
            # - in a checkout scenario the tree may have no
 
488
            # parents but the branch may do.
 
489
            first_tree_parent = bzrlib.revision.NULL_REVISION
 
490
        old_revno, master_last = self.master_branch.last_revision_info()
 
491
        if master_last != first_tree_parent:
 
492
            if master_last != bzrlib.revision.NULL_REVISION:
 
493
                raise errors.OutOfDateTree(self.work_tree)
 
494
        if self.branch.repository.has_revision(first_tree_parent):
 
495
            new_revno = old_revno + 1
 
496
        else:
 
497
            # ghost parents never appear in revision history.
 
498
            new_revno = 1
 
499
        return old_revno,new_revno
 
500
 
 
501
    def _process_pre_hooks(self, old_revno, new_revno):
 
502
        """Process any registered pre commit hooks."""
 
503
        self._set_progress_stage("Running pre_commit hooks")
 
504
        self._process_hooks("pre_commit", old_revno, new_revno)
 
505
 
 
506
    def _process_post_hooks(self, old_revno, new_revno):
 
507
        """Process any registered post commit hooks."""
 
508
        # Process the post commit hooks, if any
 
509
        self._set_progress_stage("Running post_commit hooks")
 
510
        # old style commit hooks - should be deprecated ? (obsoleted in
 
511
        # 0.15)
 
512
        if self.config.post_commit() is not None:
 
513
            hooks = self.config.post_commit().split(' ')
 
514
            # this would be nicer with twisted.python.reflect.namedAny
 
515
            for hook in hooks:
 
516
                result = eval(hook + '(branch, rev_id)',
 
517
                              {'branch':self.branch,
 
518
                               'bzrlib':bzrlib,
 
519
                               'rev_id':self.rev_id})
 
520
        # process new style post commit hooks
 
521
        self._process_hooks("post_commit", old_revno, new_revno)
 
522
 
 
523
    def _process_hooks(self, hook_name, old_revno, new_revno):
 
524
        if not Branch.hooks[hook_name]:
 
525
            return
 
526
 
 
527
        # new style commit hooks:
 
528
        if not self.bound_branch:
 
529
            hook_master = self.branch
 
530
            hook_local = None
 
531
        else:
 
532
            hook_master = self.master_branch
 
533
            hook_local = self.branch
 
534
        # With bound branches, when the master is behind the local branch,
 
535
        # the 'old_revno' and old_revid values here are incorrect.
 
536
        # XXX: FIXME ^. RBC 20060206
 
537
        if self.parents:
 
538
            old_revid = self.parents[0]
 
539
        else:
 
540
            old_revid = bzrlib.revision.NULL_REVISION
 
541
 
 
542
        if hook_name == "pre_commit":
 
543
            future_tree = self.builder.revision_tree()
 
544
            tree_delta = future_tree.changes_from(self.basis_tree,
 
545
                                             include_root=True)
 
546
 
 
547
        for hook in Branch.hooks[hook_name]:
 
548
            # show the running hook in the progress bar. As hooks may
 
549
            # end up doing nothing (e.g. because they are not configured by
 
550
            # the user) this is still showing progress, not showing overall
 
551
            # actions - its up to each plugin to show a UI if it want's to
 
552
            # (such as 'Emailing diff to foo@example.com').
 
553
            self.pb_stage_name = "Running %s hooks [%s]" % \
 
554
                (hook_name, Branch.hooks.get_hook_name(hook))
 
555
            self._emit_progress()
 
556
            if 'hooks' in debug.debug_flags:
 
557
                mutter("Invoking commit hook: %r", hook)
 
558
            if hook_name == "post_commit":
 
559
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
560
                     self.rev_id)
 
561
            elif hook_name == "pre_commit":
 
562
                hook(hook_local, hook_master,
 
563
                     old_revno, old_revid, new_revno, self.rev_id,
 
564
                     tree_delta, future_tree)
 
565
 
403
566
    def _cleanup(self):
404
567
        """Cleanup any open locks, progress bars etc."""
405
568
        cleanups = [self._cleanup_bound_branch,
 
569
                    self.basis_tree.unlock,
406
570
                    self.work_tree.unlock,
407
571
                    self.pb.finished]
408
572
        found_exception = None
415
579
            # typically this will be useful enough.
416
580
            except Exception, e:
417
581
                found_exception = e
418
 
        if found_exception is not None: 
 
582
        if found_exception is not None:
419
583
            # don't do a plan raise, because the last exception may have been
420
584
            # trashed, e is our sure-to-work exception even though it loses the
421
585
            # full traceback. XXX: RBC 20060421 perhaps we could check the
422
 
            # exc_info and if its the same one do a plain raise otherwise 
 
586
            # exc_info and if its the same one do a plain raise otherwise
423
587
            # 'raise e' as we do now.
424
588
            raise e
425
589
 
435
599
        if self.master_locked:
436
600
            self.master_branch.unlock()
437
601
 
438
 
    def _escape_commit_message(self):
439
 
        """Replace xml-incompatible control characters."""
440
 
        # FIXME: RBC 20060419 this should be done by the revision
441
 
        # serialiser not by commit. Then we can also add an unescaper
442
 
        # in the deserializer and start roundtripping revision messages
443
 
        # precisely. See repository_implementations/test_repository.py
444
 
        
445
 
        # Python strings can include characters that can't be
446
 
        # represented in well-formed XML; escape characters that
447
 
        # aren't listed in the XML specification
448
 
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
449
 
        self.message, escape_count = re.subn(
450
 
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
451
 
            lambda match: match.group(0).encode('unicode_escape'),
452
 
            self.message)
453
 
        if escape_count:
454
 
            self.reporter.escaped(escape_count, self.message)
455
 
 
456
602
    def _gather_parents(self):
457
603
        """Record the parents of a merge for merge detection."""
458
 
        # TODO: Make sure that this list doesn't contain duplicate 
 
604
        # TODO: Make sure that this list doesn't contain duplicate
459
605
        # entries and the order is preserved when doing this.
460
 
        self.parents = self.work_tree.get_parent_ids()
461
 
        self.parent_invs = []
462
 
        for revision in self.parents:
 
606
        if self.use_record_iter_changes:
 
607
            return
 
608
        self.basis_inv = self.basis_tree.inventory
 
609
        self.parent_invs = [self.basis_inv]
 
610
        for revision in self.parents[1:]:
463
611
            if self.branch.repository.has_revision(revision):
464
612
                mutter('commit parent revision {%s}', revision)
465
613
                inventory = self.branch.repository.get_inventory(revision)
467
615
            else:
468
616
                mutter('commit parent ghost revision {%s}', revision)
469
617
 
470
 
    def _remove_deleted(self):
471
 
        """Remove deleted files from the working inventories.
472
 
 
473
 
        This is done prior to taking the working inventory as the
474
 
        basis for the new committed inventory.
475
 
 
476
 
        This returns true if any files
477
 
        *that existed in the basis inventory* were deleted.
478
 
        Files that were added and deleted
479
 
        in the working copy don't matter.
480
 
        """
481
 
        specific = self.specific_files
 
618
    def _update_builder_with_changes(self):
 
619
        """Update the commit builder with the data about what has changed.
 
620
        """
 
621
        exclude = self.exclude
 
622
        specific_files = self.specific_files or []
 
623
        mutter("Selecting files for commit with filter %s", specific_files)
 
624
 
 
625
        self._check_strict()
 
626
        if self.use_record_iter_changes:
 
627
            iter_changes = self.work_tree.iter_changes(self.basis_tree)
 
628
            iter_changes = self._filter_iter_changes(iter_changes)
 
629
            for file_id, path, fs_hash in self.builder.record_iter_changes(
 
630
                self.work_tree, self.basis_revid, iter_changes):
 
631
                self.work_tree._observed_sha1(file_id, path, fs_hash)
 
632
        else:
 
633
            # Build the new inventory
 
634
            self._populate_from_inventory()
 
635
            self._record_unselected()
 
636
            self._report_and_accumulate_deletes()
 
637
 
 
638
    def _filter_iter_changes(self, iter_changes):
 
639
        """Process iter_changes.
 
640
 
 
641
        This method reports on the changes in iter_changes to the user, and 
 
642
        converts 'missing' entries in the iter_changes iterator to 'deleted'
 
643
        entries. 'missing' entries have their
 
644
 
 
645
        :param iter_changes: An iter_changes to process.
 
646
        :return: A generator of changes.
 
647
        """
 
648
        reporter = self.reporter
 
649
        report_changes = reporter.is_verbose()
482
650
        deleted_ids = []
483
 
        deleted_paths = set()
484
 
        for path, ie in self.work_inv.iter_entries():
485
 
            if is_inside_any(deleted_paths, path):
486
 
                # The tree will delete the required ids recursively.
487
 
                continue
488
 
            if specific and not is_inside_any(specific, path):
489
 
                continue
490
 
            if not self.work_tree.has_filename(path):
491
 
                deleted_paths.add(path)
492
 
                self.reporter.missing(path)
493
 
                deleted_ids.append(ie.file_id)
494
 
        self.work_tree.unversion(deleted_ids)
495
 
 
496
 
    def _populate_new_inv(self):
497
 
        """Build revision inventory.
498
 
 
499
 
        This creates a new empty inventory. Depending on
500
 
        which files are selected for commit, and what is present in the
501
 
        current tree, the new inventory is populated. inventory entries 
502
 
        which are candidates for modification have their revision set to
503
 
        None; inventory entries that are carried over untouched have their
504
 
        revision set to their prior value.
505
 
        """
 
651
        for change in iter_changes:
 
652
            if report_changes:
 
653
                old_path = change[1][0]
 
654
                new_path = change[1][1]
 
655
                versioned = change[3][1]
 
656
            kind = change[6][1]
 
657
            versioned = change[3][1]
 
658
            if kind is None and versioned:
 
659
                # 'missing' path
 
660
                if report_changes:
 
661
                    reporter.missing(new_path)
 
662
                deleted_ids.append(change[0])
 
663
                # Reset the new path (None) and new versioned flag (False)
 
664
                change = (change[0], (change[1][0], None), change[2],
 
665
                    (change[3][0], False)) + change[4:]
 
666
            elif kind == 'tree-reference':
 
667
                if self.recursive == 'down':
 
668
                    self._commit_nested_tree(change[0], change[1][1])
 
669
            if change[3][0] or change[3][1]:
 
670
                yield change
 
671
                if report_changes:
 
672
                    if new_path is None:
 
673
                        reporter.deleted(old_path)
 
674
                    elif old_path is None:
 
675
                        reporter.snapshot_change('added', new_path)
 
676
                    elif old_path != new_path:
 
677
                        reporter.renamed('renamed', old_path, new_path)
 
678
                    else:
 
679
                        if (new_path or 
 
680
                            self.work_tree.branch.repository._format.rich_root_data):
 
681
                            # Don't report on changes to '' in non rich root
 
682
                            # repositories.
 
683
                            reporter.snapshot_change('modified', new_path)
 
684
            self._next_progress_entry()
 
685
        # Unversion IDs that were found to be deleted
 
686
        self.deleted_ids = deleted_ids
 
687
 
 
688
    def _record_unselected(self):
 
689
        # If specific files are selected, then all un-selected files must be
 
690
        # recorded in their previous state. For more details, see
 
691
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
 
692
        if self.specific_files or self.exclude:
 
693
            specific_files = self.specific_files or []
 
694
            for path, old_ie in self.basis_inv.iter_entries():
 
695
                if old_ie.file_id in self.builder.new_inventory:
 
696
                    # already added - skip.
 
697
                    continue
 
698
                if (is_inside_any(specific_files, path)
 
699
                    and not is_inside_any(self.exclude, path)):
 
700
                    # was inside the selected path, and not excluded - if not
 
701
                    # present it has been deleted so skip.
 
702
                    continue
 
703
                # From here down it was either not selected, or was excluded:
 
704
                # We preserve the entry unaltered.
 
705
                ie = old_ie.copy()
 
706
                # Note: specific file commits after a merge are currently
 
707
                # prohibited. This test is for sanity/safety in case it's
 
708
                # required after that changes.
 
709
                if len(self.parents) > 1:
 
710
                    ie.revision = None
 
711
                self.builder.record_entry_contents(ie, self.parent_invs, path,
 
712
                    self.basis_tree, None)
 
713
 
 
714
    def _report_and_accumulate_deletes(self):
 
715
        if (isinstance(self.basis_inv, Inventory)
 
716
            and isinstance(self.builder.new_inventory, Inventory)):
 
717
            # the older Inventory classes provide a _byid dict, and building a
 
718
            # set from the keys of this dict is substantially faster than even
 
719
            # getting a set of ids from the inventory
 
720
            #
 
721
            # <lifeless> set(dict) is roughly the same speed as
 
722
            # set(iter(dict)) and both are significantly slower than
 
723
            # set(dict.keys())
 
724
            deleted_ids = set(self.basis_inv._byid.keys()) - \
 
725
               set(self.builder.new_inventory._byid.keys())
 
726
        else:
 
727
            deleted_ids = set(self.basis_inv) - set(self.builder.new_inventory)
 
728
        if deleted_ids:
 
729
            self.any_entries_deleted = True
 
730
            deleted = [(self.basis_tree.id2path(file_id), file_id)
 
731
                for file_id in deleted_ids]
 
732
            deleted.sort()
 
733
            # XXX: this is not quite directory-order sorting
 
734
            for path, file_id in deleted:
 
735
                self.builder.record_delete(path, file_id)
 
736
                self.reporter.deleted(path)
 
737
 
 
738
    def _check_strict(self):
 
739
        # XXX: when we use iter_changes this would likely be faster if
 
740
        # iter_changes would check for us (even in the presence of
 
741
        # selected_files).
 
742
        if self.strict:
 
743
            # raise an exception as soon as we find a single unknown.
 
744
            for unknown in self.work_tree.unknowns():
 
745
                raise StrictCommitFailed()
 
746
 
 
747
    def _populate_from_inventory(self):
 
748
        """Populate the CommitBuilder by walking the working tree inventory."""
 
749
        # Build the revision inventory.
 
750
        #
 
751
        # This starts by creating a new empty inventory. Depending on
 
752
        # which files are selected for commit, and what is present in the
 
753
        # current tree, the new inventory is populated. inventory entries
 
754
        # which are candidates for modification have their revision set to
 
755
        # None; inventory entries that are carried over untouched have their
 
756
        # revision set to their prior value.
 
757
        #
506
758
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
507
759
        # results to create a new inventory at the same time, which results
508
760
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
509
761
        # ADHB 11-07-2006
510
 
        mutter("Selecting files for commit with filter %s", self.specific_files)
511
 
        entries = self.work_inv.iter_entries()
512
 
        if not self.builder.record_root_entry:
513
 
            symbol_versioning.warn('CommitBuilders should support recording'
514
 
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
515
 
                stacklevel=1)
516
 
            self.builder.new_inventory.add(self.basis_inv.root.copy())
517
 
            entries.next()
518
 
            self._emit_progress_update()
519
 
        for path, new_ie in entries:
520
 
            self._emit_progress_update()
521
 
            file_id = new_ie.file_id
522
 
            # mutter('check %s {%s}', path, file_id)
523
 
            if (not self.specific_files or 
524
 
                is_inside_or_parent_of_any(self.specific_files, path)):
525
 
                    # mutter('%s selected for commit', path)
526
 
                    ie = new_ie.copy()
527
 
                    ie.revision = None
528
 
            else:
529
 
                # mutter('%s not selected for commit', path)
530
 
                if self.basis_inv.has_id(file_id):
531
 
                    ie = self.basis_inv[file_id].copy()
532
 
                else:
533
 
                    # this entry is new and not being committed
534
 
                    continue
535
 
 
536
 
            self.builder.record_entry_contents(ie, self.parent_invs, 
537
 
                path, self.work_tree)
538
 
            # describe the nature of the change that has occurred relative to
539
 
            # the basis inventory.
540
 
            if (self.basis_inv.has_id(ie.file_id)):
541
 
                basis_ie = self.basis_inv[ie.file_id]
542
 
            else:
543
 
                basis_ie = None
544
 
            change = ie.describe_change(basis_ie, ie)
545
 
            if change in (InventoryEntry.RENAMED, 
546
 
                InventoryEntry.MODIFIED_AND_RENAMED):
547
 
                old_path = self.basis_inv.id2path(ie.file_id)
548
 
                self.reporter.renamed(change, old_path, path)
549
 
            else:
550
 
                self.reporter.snapshot_change(change, path)
551
 
 
552
 
        if not self.specific_files:
553
 
            return
554
 
 
555
 
        # ignore removals that don't match filespec
556
 
        for path, new_ie in self.basis_inv.iter_entries():
557
 
            if new_ie.file_id in self.work_inv:
558
 
                continue
559
 
            if is_inside_any(self.specific_files, path):
560
 
                continue
561
 
            ie = new_ie.copy()
 
762
 
 
763
        specific_files = self.specific_files
 
764
        exclude = self.exclude
 
765
        report_changes = self.reporter.is_verbose()
 
766
        deleted_ids = []
 
767
        # A tree of paths that have been deleted. E.g. if foo/bar has been
 
768
        # deleted, then we have {'foo':{'bar':{}}}
 
769
        deleted_paths = {}
 
770
        # XXX: Note that entries may have the wrong kind because the entry does
 
771
        # not reflect the status on disk.
 
772
        work_inv = self.work_tree.inventory
 
773
        # NB: entries will include entries within the excluded ids/paths
 
774
        # because iter_entries_by_dir has no 'exclude' facility today.
 
775
        entries = work_inv.iter_entries_by_dir(
 
776
            specific_file_ids=self.specific_file_ids, yield_parents=True)
 
777
        for path, existing_ie in entries:
 
778
            file_id = existing_ie.file_id
 
779
            name = existing_ie.name
 
780
            parent_id = existing_ie.parent_id
 
781
            kind = existing_ie.kind
 
782
            # Skip files that have been deleted from the working tree.
 
783
            # The deleted path ids are also recorded so they can be explicitly
 
784
            # unversioned later.
 
785
            if deleted_paths:
 
786
                path_segments = splitpath(path)
 
787
                deleted_dict = deleted_paths
 
788
                for segment in path_segments:
 
789
                    deleted_dict = deleted_dict.get(segment, None)
 
790
                    if not deleted_dict:
 
791
                        # We either took a path not present in the dict
 
792
                        # (deleted_dict was None), or we've reached an empty
 
793
                        # child dir in the dict, so are now a sub-path.
 
794
                        break
 
795
                else:
 
796
                    deleted_dict = None
 
797
                if deleted_dict is not None:
 
798
                    # the path has a deleted parent, do not add it.
 
799
                    continue
 
800
            if exclude and is_inside_any(exclude, path):
 
801
                # Skip excluded paths. Excluded paths are processed by
 
802
                # _update_builder_with_changes.
 
803
                continue
 
804
            content_summary = self.work_tree.path_content_summary(path)
 
805
            # Note that when a filter of specific files is given, we must only
 
806
            # skip/record deleted files matching that filter.
 
807
            if not specific_files or is_inside_any(specific_files, path):
 
808
                if content_summary[0] == 'missing':
 
809
                    if not deleted_paths:
 
810
                        # path won't have been split yet.
 
811
                        path_segments = splitpath(path)
 
812
                    deleted_dict = deleted_paths
 
813
                    for segment in path_segments:
 
814
                        deleted_dict = deleted_dict.setdefault(segment, {})
 
815
                    self.reporter.missing(path)
 
816
                    self._next_progress_entry()
 
817
                    deleted_ids.append(file_id)
 
818
                    continue
 
819
            # TODO: have the builder do the nested commit just-in-time IF and
 
820
            # only if needed.
 
821
            if content_summary[0] == 'tree-reference':
 
822
                # enforce repository nested tree policy.
 
823
                if (not self.work_tree.supports_tree_reference() or
 
824
                    # repository does not support it either.
 
825
                    not self.branch.repository._format.supports_tree_reference):
 
826
                    content_summary = ('directory',) + content_summary[1:]
 
827
            kind = content_summary[0]
 
828
            # TODO: specific_files filtering before nested tree processing
 
829
            if kind == 'tree-reference':
 
830
                if self.recursive == 'down':
 
831
                    nested_revision_id = self._commit_nested_tree(
 
832
                        file_id, path)
 
833
                    content_summary = content_summary[:3] + (
 
834
                        nested_revision_id,)
 
835
                else:
 
836
                    content_summary = content_summary[:3] + (
 
837
                        self.work_tree.get_reference_revision(file_id),)
 
838
 
 
839
            # Record an entry for this item
 
840
            # Note: I don't particularly want to have the existing_ie
 
841
            # parameter but the test suite currently (28-Jun-07) breaks
 
842
            # without it thanks to a unicode normalisation issue. :-(
 
843
            definitely_changed = kind != existing_ie.kind
 
844
            self._record_entry(path, file_id, specific_files, kind, name,
 
845
                parent_id, definitely_changed, existing_ie, report_changes,
 
846
                content_summary)
 
847
 
 
848
        # Unversion IDs that were found to be deleted
 
849
        self.deleted_ids = deleted_ids
 
850
 
 
851
    def _commit_nested_tree(self, file_id, path):
 
852
        "Commit a nested tree."
 
853
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
 
854
        # FIXME: be more comprehensive here:
 
855
        # this works when both trees are in --trees repository,
 
856
        # but when both are bound to a different repository,
 
857
        # it fails; a better way of approaching this is to
 
858
        # finally implement the explicit-caches approach design
 
859
        # a while back - RBC 20070306.
 
860
        if sub_tree.branch.repository.has_same_location(
 
861
            self.work_tree.branch.repository):
 
862
            sub_tree.branch.repository = \
 
863
                self.work_tree.branch.repository
 
864
        try:
 
865
            return sub_tree.commit(message=None, revprops=self.revprops,
 
866
                recursive=self.recursive,
 
867
                message_callback=self.message_callback,
 
868
                timestamp=self.timestamp, timezone=self.timezone,
 
869
                committer=self.committer,
 
870
                allow_pointless=self.allow_pointless,
 
871
                strict=self.strict, verbose=self.verbose,
 
872
                local=self.local, reporter=self.reporter)
 
873
        except errors.PointlessCommit:
 
874
            return self.work_tree.get_reference_revision(file_id)
 
875
 
 
876
    def _record_entry(self, path, file_id, specific_files, kind, name,
 
877
        parent_id, definitely_changed, existing_ie, report_changes,
 
878
        content_summary):
 
879
        "Record the new inventory entry for a path if any."
 
880
        # mutter('check %s {%s}', path, file_id)
 
881
        # mutter('%s selected for commit', path)
 
882
        if definitely_changed or existing_ie is None:
 
883
            ie = make_entry(kind, name, parent_id, file_id)
 
884
        else:
 
885
            ie = existing_ie.copy()
562
886
            ie.revision = None
563
 
            self.builder.record_entry_contents(ie, self.parent_invs, path,
564
 
                                               self.basis_tree)
565
 
 
566
 
    def _emit_progress_update(self):
567
 
        """Emit an update to the progress bar."""
568
 
        self.pb.update("Committing", self.pb_count, self.pb_total)
569
 
        self.pb_count += 1
570
 
 
571
 
    def _report_deletes(self):
572
 
        for path, ie in self.basis_inv.iter_entries():
573
 
            if ie.file_id not in self.builder.new_inventory:
574
 
                self.reporter.deleted(path)
575
 
 
576
 
 
 
887
        # For carried over entries we don't care about the fs hash - the repo
 
888
        # isn't generating a sha, so we're not saving computation time.
 
889
        _, _, fs_hash = self.builder.record_entry_contents(
 
890
            ie, self.parent_invs, path, self.work_tree, content_summary)
 
891
        if report_changes:
 
892
            self._report_change(ie, path)
 
893
        if fs_hash:
 
894
            self.work_tree._observed_sha1(ie.file_id, path, fs_hash)
 
895
        return ie
 
896
 
 
897
    def _report_change(self, ie, path):
 
898
        """Report a change to the user.
 
899
 
 
900
        The change that has occurred is described relative to the basis
 
901
        inventory.
 
902
        """
 
903
        if (self.basis_inv.has_id(ie.file_id)):
 
904
            basis_ie = self.basis_inv[ie.file_id]
 
905
        else:
 
906
            basis_ie = None
 
907
        change = ie.describe_change(basis_ie, ie)
 
908
        if change in (InventoryEntry.RENAMED,
 
909
            InventoryEntry.MODIFIED_AND_RENAMED):
 
910
            old_path = self.basis_inv.id2path(ie.file_id)
 
911
            self.reporter.renamed(change, old_path, path)
 
912
            self._next_progress_entry()
 
913
        else:
 
914
            if change == 'unchanged':
 
915
                return
 
916
            self.reporter.snapshot_change(change, path)
 
917
            self._next_progress_entry()
 
918
 
 
919
    def _set_progress_stage(self, name, counter=False):
 
920
        """Set the progress stage and emit an update to the progress bar."""
 
921
        self.pb_stage_name = name
 
922
        self.pb_stage_count += 1
 
923
        if counter:
 
924
            self.pb_entries_count = 0
 
925
        else:
 
926
            self.pb_entries_count = None
 
927
        self._emit_progress()
 
928
 
 
929
    def _next_progress_entry(self):
 
930
        """Emit an update to the progress bar and increment the entry count."""
 
931
        self.pb_entries_count += 1
 
932
        self._emit_progress()
 
933
 
 
934
    def _emit_progress(self):
 
935
        if self.pb_entries_count is not None:
 
936
            text = "%s [%d] - Stage" % (self.pb_stage_name,
 
937
                self.pb_entries_count)
 
938
        else:
 
939
            text = "%s - Stage" % (self.pb_stage_name, )
 
940
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
 
941
 
 
942
    def _set_specific_file_ids(self):
 
943
        """populate self.specific_file_ids if we will use it."""
 
944
        if not self.use_record_iter_changes:
 
945
            # If provided, ensure the specified files are versioned
 
946
            if self.specific_files is not None:
 
947
                # Note: This routine is being called because it raises
 
948
                # PathNotVersionedError as a side effect of finding the IDs. We
 
949
                # later use the ids we found as input to the working tree
 
950
                # inventory iterator, so we only consider those ids rather than
 
951
                # examining the whole tree again.
 
952
                # XXX: Dont we have filter_unversioned to do this more
 
953
                # cheaply?
 
954
                self.specific_file_ids = tree.find_ids_across_trees(
 
955
                    self.specific_files, [self.basis_tree, self.work_tree])
 
956
            else:
 
957
                self.specific_file_ids = None