/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: Robert Collins
  • Date: 2009-05-12 03:50:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4593.
  • Revision ID: robertc@robertcollins.net-20090512035039-6x0pahpjpkdnm9zb
Note another possible error.

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