~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Martin Pool
  • Date: 2007-04-04 01:22:11 UTC
  • mfrom: (2393.1.1 bzr.docs)
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404012211-sq269me6bai9m6xk
merge trunk and doc fix from elliot

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
19
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
57
57
from cStringIO import StringIO
58
58
 
59
59
from bzrlib import (
60
 
    debug,
61
60
    errors,
62
 
    revision,
63
 
    trace,
 
61
    inventory,
64
62
    tree,
65
 
    xml_serializer,
66
63
    )
67
64
from bzrlib.branch import Branch
68
65
import bzrlib.config
70
67
                           ConflictsInTree,
71
68
                           StrictCommitFailed
72
69
                           )
73
 
from bzrlib.osutils import (get_user_encoding,
74
 
                            kind_marker, isdir,isfile, is_inside_any,
 
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
75
71
                            is_inside_or_parent_of_any,
76
 
                            minimum_path_selection,
77
 
                            quotefn, sha_file, split_lines,
78
 
                            splitpath,
79
 
                            )
 
72
                            quotefn, sha_file, split_lines)
80
73
from bzrlib.testament import Testament
81
 
from bzrlib.trace import mutter, note, warning, is_quiet
82
 
from bzrlib.inventory import Inventory, InventoryEntry, make_entry
 
74
from bzrlib.trace import mutter, note, warning
 
75
from bzrlib.xml5 import serializer_v5
 
76
from bzrlib.inventory import Inventory, InventoryEntry
83
77
from bzrlib import symbol_versioning
84
78
from bzrlib.symbol_versioning import (deprecated_passed,
85
79
        deprecated_function,
86
80
        DEPRECATED_PARAMETER)
87
81
from bzrlib.workingtree import WorkingTree
88
 
from bzrlib.urlutils import unescape_for_display
89
82
import bzrlib.ui
90
83
 
91
84
 
92
85
class NullCommitReporter(object):
93
86
    """I report on progress of a commit."""
94
87
 
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
 
 
102
88
    def snapshot_change(self, change, path):
103
89
        pass
104
90
 
105
91
    def completed(self, revno, rev_id):
106
92
        pass
107
93
 
108
 
    def deleted(self, path):
 
94
    def deleted(self, file_id):
109
95
        pass
110
96
 
111
97
    def escaped(self, escape_count, message):
117
103
    def renamed(self, change, old_path, new_path):
118
104
        pass
119
105
 
120
 
    def is_verbose(self):
121
 
        return False
122
 
 
123
106
 
124
107
class ReportCommitToLog(NullCommitReporter):
125
108
 
126
 
    def _note(self, format, *args):
127
 
        """Output a message.
128
 
 
129
 
        Subclasses may choose to override this method.
130
 
        """
131
 
        note(format, *args)
 
109
    # this may be more useful if 'note' was replaced by an overridable
 
110
    # method on self, which would allow more trivial subclassing.
 
111
    # alternative, a callable could be passed in, allowing really trivial
 
112
    # reuse for some uis. RBC 20060511
132
113
 
133
114
    def snapshot_change(self, change, path):
134
 
        if path == '' and change in ('added', 'modified'):
135
 
            return
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)
 
115
        if change == 'unchanged':
 
116
            return
 
117
        if change == 'added' and path == '':
 
118
            return
 
119
        note("%s %s", change, path)
149
120
 
150
121
    def completed(self, revno, rev_id):
151
 
        self._note('Committed revision %d.', revno)
152
 
 
153
 
    def deleted(self, path):
154
 
        self._note('deleted %s', path)
 
122
        note('Committed revision %d.', revno)
 
123
    
 
124
    def deleted(self, file_id):
 
125
        note('deleted %s', file_id)
155
126
 
156
127
    def escaped(self, escape_count, message):
157
 
        self._note("replaced %d control characters in message", escape_count)
 
128
        note("replaced %d control characters in message", escape_count)
158
129
 
159
130
    def missing(self, path):
160
 
        self._note('missing %s', path)
 
131
        note('missing %s', path)
161
132
 
162
133
    def renamed(self, 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
 
134
        note('%s %s => %s', change, old_path, new_path)
167
135
 
168
136
 
169
137
class Commit(object):
181
149
    def __init__(self,
182
150
                 reporter=None,
183
151
                 config=None):
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
 
 
 
152
        if reporter is not None:
 
153
            self.reporter = reporter
 
154
        else:
 
155
            self.reporter = NullCommitReporter()
 
156
        if config is not None:
 
157
            self.config = config
 
158
        else:
 
159
            self.config = None
 
160
        
191
161
    def commit(self,
192
162
               message=None,
193
163
               timestamp=None,
204
174
               reporter=None,
205
175
               config=None,
206
176
               message_callback=None,
207
 
               recursive='down',
208
 
               exclude=None,
209
 
               possible_master_transports=None):
 
177
               recursive='down'):
210
178
        """Commit working copy as a new revision.
211
179
 
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.
 
180
        message -- the commit message (it or message_callback is required)
 
181
 
 
182
        timestamp -- if not None, seconds-since-epoch for a
 
183
             postdated/predated commit.
 
184
 
 
185
        specific_files -- If true, commit only those files.
 
186
 
 
187
        rev_id -- If set, use this as the new revision id.
220
188
            Useful for test or import commands that need to tightly
221
189
            control what revisions are assigned.  If you duplicate
222
190
            a revision id that exists elsewhere it is your own fault.
223
191
            If null (default), a time/random revision id is generated.
224
192
 
225
 
        :param allow_pointless: If true (default), commit even if nothing
 
193
        allow_pointless -- If true (default), commit even if nothing
226
194
            has changed and no merges are recorded.
227
195
 
228
 
        :param strict: If true, don't allow a commit if the working tree
 
196
        strict -- If true, don't allow a commit if the working tree
229
197
            contains unknown files.
230
198
 
231
 
        :param revprops: Properties for new revision
 
199
        revprops -- Properties for new revision
232
200
        :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
201
        :param recursive: If set to 'down', commit in any subtrees that have
236
202
            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.
240
203
        """
241
204
        mutter('preparing to commit')
242
205
 
251
214
        if message_callback is None:
252
215
            if message is not None:
253
216
                if isinstance(message, str):
254
 
                    message = message.decode(get_user_encoding())
 
217
                    message = message.decode(bzrlib.user_encoding)
255
218
                message_callback = lambda x: message
256
219
            else:
257
220
                raise BzrError("The message or message_callback keyword"
258
221
                               " parameter is required for commit().")
259
222
 
260
223
        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 = []
267
224
        self.local = local
268
225
        self.master_branch = None
269
226
        self.master_locked = False
270
 
        self.recursive = recursive
271
227
        self.rev_id = None
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
 
            
 
228
        self.specific_files = specific_files
278
229
        self.allow_pointless = allow_pointless
 
230
        self.recursive = recursive
279
231
        self.revprops = revprops
280
232
        self.message_callback = message_callback
281
233
        self.timestamp = timestamp
282
234
        self.timezone = timezone
283
235
        self.committer = committer
 
236
        self.specific_files = specific_files
284
237
        self.strict = strict
285
238
        self.verbose = verbose
 
239
        self.local = local
 
240
 
 
241
        if reporter is None and self.reporter is None:
 
242
            self.reporter = NullCommitReporter()
 
243
        elif reporter is not None:
 
244
            self.reporter = reporter
286
245
 
287
246
        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))
298
247
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
299
 
        self.basis_revid = self.work_tree.last_revision()
300
248
        self.basis_tree = self.work_tree.basis_tree()
301
249
        self.basis_tree.lock_read()
302
250
        try:
303
251
            # Cannot commit with conflicts present.
304
 
            if len(self.work_tree.conflicts()) > 0:
 
252
            if len(self.work_tree.conflicts())>0:
305
253
                raise ConflictsInTree
306
254
 
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()
 
255
            # setup the bound branch variables as needed.
 
256
            self._check_bound_branch()
 
257
 
 
258
            # check for out of date working trees
 
259
            try:
 
260
                first_tree_parent = self.work_tree.get_parent_ids()[0]
 
261
            except IndexError:
 
262
                # if there are no parents, treat our parent as 'None'
 
263
                # this is so that we still consier the master branch
 
264
                # - in a checkout scenario the tree may have no
 
265
                # parents but the branch may do.
 
266
                first_tree_parent = bzrlib.revision.NULL_REVISION
 
267
            old_revno, master_last = self.master_branch.last_revision_info()
 
268
            if master_last != first_tree_parent:
 
269
                if master_last != bzrlib.revision.NULL_REVISION:
 
270
                    raise errors.OutOfDateTree(self.work_tree)
 
271
            if self.branch.repository.has_revision(first_tree_parent):
 
272
                new_revno = old_revno + 1
 
273
            else:
 
274
                # ghost parents never appear in revision history.
 
275
                new_revno = 1
 
276
            if strict:
 
277
                # raise an exception as soon as we find a single unknown.
 
278
                for unknown in self.work_tree.unknowns():
 
279
                    raise StrictCommitFailed()
 
280
                   
318
281
            if self.config is None:
319
282
                self.config = self.branch.get_config()
320
283
 
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
 
284
            self.work_inv = self.work_tree.inventory
 
285
            self.basis_inv = self.basis_tree.inventory
 
286
            if specific_files is not None:
 
287
                # Ensure specified files are versioned
 
288
                # (We don't actually need the ids here)
 
289
                # XXX: Dont we have filter_unversioned to do this more
 
290
                # cheaply?
 
291
                tree.find_ids_across_trees(specific_files,
 
292
                                           [self.basis_tree, self.work_tree])
 
293
            # one to finish, one for rev and inventory, and one for each
 
294
            # inventory entry, and the same for the new inventory.
 
295
            # note that this estimate is too long when we do a partial tree
 
296
            # commit which excludes some new files from being considered.
 
297
            # The estimate is corrected when we populate the new inv.
 
298
            self.pb_total = len(self.work_inv) + 5
 
299
            self.pb_count = 0
337
300
 
338
301
            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.
341
302
            if len(self.parents) > 1 and self.specific_files:
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)
 
303
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
 
304
                        self.specific_files)
 
305
            
349
306
            self.builder = self.branch.get_commit_builder(self.parents,
350
307
                self.config, timestamp, timezone, committer, revprops, rev_id)
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.
 
308
            
 
309
            self._remove_deleted()
 
310
            self._populate_new_inv()
 
311
            self._report_deletes()
 
312
 
 
313
            self._check_pointless()
 
314
 
 
315
            self._emit_progress_update()
 
316
            # TODO: Now the new inventory is known, check for conflicts and
 
317
            # prompt the user for a commit message.
 
318
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
319
            # weave lines, because nothing should be recorded until it is known
 
320
            # that commit will succeed.
 
321
            self.builder.finish_inventory()
 
322
            self._emit_progress_update()
 
323
            message = message_callback(self)
 
324
            assert isinstance(message, unicode), type(message)
 
325
            self.message = message
 
326
            self._escape_commit_message()
 
327
 
 
328
            self.rev_id = self.builder.commit(self.message)
 
329
            self._emit_progress_update()
 
330
            # revision data is in the local branch now.
 
331
            
 
332
            # upload revision data to the master.
391
333
            # this will propagate merged revisions too if needed.
392
334
            if self.bound_branch:
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)
 
335
                self.master_branch.repository.fetch(self.branch.repository,
 
336
                                                    revision_id=self.rev_id)
 
337
                # now the master has the revision data
 
338
                # 'commit' to the master first so a timeout here causes the local
 
339
                # branch to be out of date
 
340
                self.master_branch.set_last_revision_info(new_revno,
 
341
                                                          self.rev_id)
398
342
 
399
343
            # and now do the commit locally.
400
344
            self.branch.set_last_revision_info(new_revno, self.rev_id)
401
345
 
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())
 
346
            rev_tree = self.builder.revision_tree()
 
347
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
 
348
            # now the work tree is up to date with the branch
 
349
            
406
350
            self.reporter.completed(new_revno, self.rev_id)
407
 
            self._process_post_hooks(old_revno, new_revno)
 
351
            # old style commit hooks - should be deprecated ? (obsoleted in
 
352
            # 0.15)
 
353
            if self.config.post_commit() is not None:
 
354
                hooks = self.config.post_commit().split(' ')
 
355
                # this would be nicer with twisted.python.reflect.namedAny
 
356
                for hook in hooks:
 
357
                    result = eval(hook + '(branch, rev_id)',
 
358
                                  {'branch':self.branch,
 
359
                                   'bzrlib':bzrlib,
 
360
                                   'rev_id':self.rev_id})
 
361
            # new style commit hooks:
 
362
            if not self.bound_branch:
 
363
                hook_master = self.branch
 
364
                hook_local = None
 
365
            else:
 
366
                hook_master = self.master_branch
 
367
                hook_local = self.branch
 
368
            # With bound branches, when the master is behind the local branch,
 
369
            # the 'old_revno' and old_revid values here are incorrect.
 
370
            # XXX: FIXME ^. RBC 20060206
 
371
            if self.parents:
 
372
                old_revid = self.parents[0]
 
373
            else:
 
374
                old_revid = bzrlib.revision.NULL_REVISION
 
375
            for hook in Branch.hooks['post_commit']:
 
376
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
 
377
                    self.rev_id)
 
378
            self._emit_progress_update()
408
379
        finally:
409
380
            self._cleanup()
410
381
        return self.rev_id
411
382
 
412
 
    def _select_reporter(self):
413
 
        """Select the CommitReporter to use."""
414
 
        if is_quiet():
415
 
            return NullCommitReporter()
416
 
        return ReportCommitToLog()
 
383
    def _any_real_changes(self):
 
384
        """Are there real changes between new_inventory and basis?
 
385
 
 
386
        For trees without rich roots, inv.root.revision changes every commit.
 
387
        But if that is the only change, we want to treat it as though there
 
388
        are *no* changes.
 
389
        """
 
390
        new_entries = self.builder.new_inventory.iter_entries()
 
391
        basis_entries = self.basis_inv.iter_entries()
 
392
        new_path, new_root_ie = new_entries.next()
 
393
        basis_path, basis_root_ie = basis_entries.next()
 
394
 
 
395
        # This is a copy of InventoryEntry.__eq__ only leaving out .revision
 
396
        def ie_equal_no_revision(this, other):
 
397
            return ((this.file_id == other.file_id)
 
398
                    and (this.name == other.name)
 
399
                    and (this.symlink_target == other.symlink_target)
 
400
                    and (this.text_sha1 == other.text_sha1)
 
401
                    and (this.text_size == other.text_size)
 
402
                    and (this.text_id == other.text_id)
 
403
                    and (this.parent_id == other.parent_id)
 
404
                    and (this.kind == other.kind)
 
405
                    and (this.executable == other.executable)
 
406
                    and (this.reference_revision == other.reference_revision)
 
407
                    )
 
408
        if not ie_equal_no_revision(new_root_ie, basis_root_ie):
 
409
            return True
 
410
 
 
411
        for new_ie, basis_ie in zip(new_entries, basis_entries):
 
412
            if new_ie != basis_ie:
 
413
                return True
 
414
 
 
415
        # No actual changes present
 
416
        return False
417
417
 
418
418
    def _check_pointless(self):
419
419
        if self.allow_pointless:
421
421
        # A merge with no effect on files
422
422
        if len(self.parents) > 1:
423
423
            return
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)):
 
424
        # work around the fact that a newly-initted tree does differ from its
 
425
        # basis
 
426
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
432
427
            raise PointlessCommit()
433
 
        if self.builder.any_changes():
 
428
        # Shortcut, if the number of entries changes, then we obviously have
 
429
        # a change
 
430
        if len(self.builder.new_inventory) != len(self.basis_inv):
 
431
            return
 
432
        # If length == 1, then we only have the root entry. Which means
 
433
        # that there is no real difference (only the root could be different)
 
434
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
434
435
            return
435
436
        raise PointlessCommit()
436
437
 
437
 
    def _check_bound_branch(self, possible_master_transports=None):
 
438
    def _check_bound_branch(self):
438
439
        """Check to see if the local branch is bound.
439
440
 
440
441
        If it is bound, then most of the commit will actually be
445
446
            raise errors.LocalRequiresBoundBranch()
446
447
 
447
448
        if not self.local:
448
 
            self.master_branch = self.branch.get_master_branch(
449
 
                possible_master_transports)
 
449
            self.master_branch = self.branch.get_master_branch()
450
450
 
451
451
        if not self.master_branch:
452
452
            # make this branch the reference branch for out of date checks.
463
463
        #       commits to the remote branch if they would fit.
464
464
        #       But for now, just require remote to be identical
465
465
        #       to local.
466
 
 
 
466
        
467
467
        # Make sure the local branch is identical to the master
468
468
        master_info = self.master_branch.last_revision_info()
469
469
        local_info = self.branch.last_revision_info()
477
477
        self.master_branch.lock_write()
478
478
        self.master_locked = True
479
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
 
 
569
480
    def _cleanup(self):
570
481
        """Cleanup any open locks, progress bars etc."""
571
482
        cleanups = [self._cleanup_bound_branch,
582
493
            # typically this will be useful enough.
583
494
            except Exception, e:
584
495
                found_exception = e
585
 
        if found_exception is not None:
 
496
        if found_exception is not None: 
586
497
            # don't do a plan raise, because the last exception may have been
587
498
            # trashed, e is our sure-to-work exception even though it loses the
588
499
            # full traceback. XXX: RBC 20060421 perhaps we could check the
589
 
            # exc_info and if its the same one do a plain raise otherwise
 
500
            # exc_info and if its the same one do a plain raise otherwise 
590
501
            # 'raise e' as we do now.
591
502
            raise e
592
503
 
608
519
        # serialiser not by commit. Then we can also add an unescaper
609
520
        # in the deserializer and start roundtripping revision messages
610
521
        # precisely. See repository_implementations/test_repository.py
611
 
        self.message, escape_count = xml_serializer.escape_invalid_chars(
 
522
        
 
523
        # Python strings can include characters that can't be
 
524
        # represented in well-formed XML; escape characters that
 
525
        # aren't listed in the XML specification
 
526
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
 
527
        self.message, escape_count = re.subn(
 
528
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
 
529
            lambda match: match.group(0).encode('unicode_escape'),
612
530
            self.message)
613
531
        if escape_count:
614
532
            self.reporter.escaped(escape_count, self.message)
615
533
 
616
534
    def _gather_parents(self):
617
535
        """Record the parents of a merge for merge detection."""
618
 
        # TODO: Make sure that this list doesn't contain duplicate
 
536
        # TODO: Make sure that this list doesn't contain duplicate 
619
537
        # entries and the order is preserved when doing this.
620
 
        if self.use_record_iter_changes:
621
 
            return
622
 
        self.basis_inv = self.basis_tree.inventory
 
538
        self.parents = self.work_tree.get_parent_ids()
623
539
        self.parent_invs = [self.basis_inv]
624
540
        for revision in self.parents[1:]:
625
541
            if self.branch.repository.has_revision(revision):
629
545
            else:
630
546
                mutter('commit parent ghost revision {%s}', revision)
631
547
 
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()
 
548
    def _remove_deleted(self):
 
549
        """Remove deleted files from the working inventories.
 
550
 
 
551
        This is done prior to taking the working inventory as the
 
552
        basis for the new committed inventory.
 
553
 
 
554
        This returns true if any files
 
555
        *that existed in the basis inventory* were deleted.
 
556
        Files that were added and deleted
 
557
        in the working copy don't matter.
 
558
        """
 
559
        specific = self.specific_files
664
560
        deleted_ids = []
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
 
561
        deleted_paths = set()
 
562
        for path, ie in self.work_inv.iter_entries():
 
563
            if is_inside_any(deleted_paths, path):
 
564
                # The tree will delete the required ids recursively.
 
565
                continue
 
566
            if specific and not is_inside_any(specific, path):
 
567
                continue
 
568
            if not self.work_tree.has_filename(path):
 
569
                deleted_paths.add(path)
 
570
                self.reporter.missing(path)
 
571
                deleted_ids.append(ie.file_id)
700
572
        self.work_tree.unversion(deleted_ids)
701
573
 
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
 
        #
 
574
    def _populate_new_inv(self):
 
575
        """Build revision inventory.
 
576
 
 
577
        This creates a new empty inventory. Depending on
 
578
        which files are selected for commit, and what is present in the
 
579
        current tree, the new inventory is populated. inventory entries 
 
580
        which are candidates for modification have their revision set to
 
581
        None; inventory entries that are carried over untouched have their
 
582
        revision set to their prior value.
 
583
        """
772
584
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
773
585
        # results to create a new inventory at the same time, which results
774
586
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
775
587
        # ADHB 11-07-2006
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()
 
588
        mutter("Selecting files for commit with filter %s", self.specific_files)
 
589
        assert self.work_inv.root is not None
 
590
        entries = self.work_inv.iter_entries()
 
591
        if not self.builder.record_root_entry:
 
592
            symbol_versioning.warn('CommitBuilders should support recording'
 
593
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
 
594
                stacklevel=1)
 
595
            self.builder.new_inventory.add(self.basis_inv.root.copy())
 
596
            entries.next()
 
597
            self._emit_progress_update()
 
598
        for path, new_ie in entries:
 
599
            self._emit_progress_update()
 
600
            file_id = new_ie.file_id
 
601
            try:
 
602
                kind = self.work_tree.kind(file_id)
 
603
                if kind == 'tree-reference' and self.recursive == 'down':
 
604
                    # nested tree: commit in it
 
605
                    sub_tree = WorkingTree.open(self.work_tree.abspath(path))
 
606
                    # FIXME: be more comprehensive here:
 
607
                    # this works when both trees are in --trees repository,
 
608
                    # but when both are bound to a different repository,
 
609
                    # it fails; a better way of approaching this is to 
 
610
                    # finally implement the explicit-caches approach design
 
611
                    # a while back - RBC 20070306.
 
612
                    if (sub_tree.branch.repository.bzrdir.root_transport.base
 
613
                        ==
 
614
                        self.work_tree.branch.repository.bzrdir.root_transport.base):
 
615
                        sub_tree.branch.repository = \
 
616
                            self.work_tree.branch.repository
 
617
                    try:
 
618
                        sub_tree.commit(message=None, revprops=self.revprops,
 
619
                            recursive=self.recursive,
 
620
                            message_callback=self.message_callback,
 
621
                            timestamp=self.timestamp, timezone=self.timezone,
 
622
                            committer=self.committer,
 
623
                            allow_pointless=self.allow_pointless,
 
624
                            strict=self.strict, verbose=self.verbose,
 
625
                            local=self.local, reporter=self.reporter)
 
626
                    except errors.PointlessCommit:
 
627
                        pass
 
628
                if kind != new_ie.kind:
 
629
                    new_ie = inventory.make_entry(kind, new_ie.name,
 
630
                                                  new_ie.parent_id, file_id)
 
631
            except errors.NoSuchFile:
 
632
                pass
 
633
            # mutter('check %s {%s}', path, file_id)
 
634
            if (not self.specific_files or 
 
635
                is_inside_or_parent_of_any(self.specific_files, path)):
 
636
                    # mutter('%s selected for commit', path)
 
637
                    ie = new_ie.copy()
 
638
                    ie.revision = None
 
639
            else:
 
640
                # mutter('%s not selected for commit', path)
 
641
                if self.basis_inv.has_id(file_id):
 
642
                    ie = self.basis_inv[file_id].copy()
 
643
                else:
 
644
                    # this entry is new and not being committed
 
645
                    continue
 
646
            self.builder.record_entry_contents(ie, self.parent_invs, 
 
647
                path, self.work_tree)
 
648
            # describe the nature of the change that has occurred relative to
 
649
            # the basis inventory.
 
650
            if (self.basis_inv.has_id(ie.file_id)):
 
651
                basis_ie = self.basis_inv[ie.file_id]
 
652
            else:
 
653
                basis_ie = None
 
654
            change = ie.describe_change(basis_ie, ie)
 
655
            if change in (InventoryEntry.RENAMED, 
 
656
                InventoryEntry.MODIFIED_AND_RENAMED):
 
657
                old_path = self.basis_inv.id2path(ie.file_id)
 
658
                self.reporter.renamed(change, old_path, path)
 
659
            else:
 
660
                self.reporter.snapshot_change(change, path)
 
661
 
 
662
        if not self.specific_files:
 
663
            return
 
664
 
 
665
        # ignore removals that don't match filespec
 
666
        for path, new_ie in self.basis_inv.iter_entries():
 
667
            if new_ie.file_id in self.work_inv:
 
668
                continue
 
669
            if is_inside_any(self.specific_files, path):
 
670
                continue
 
671
            ie = new_ie.copy()
900
672
            ie.revision = None
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
 
673
            self.builder.record_entry_contents(ie, self.parent_invs, path,
 
674
                                               self.basis_tree)
 
675
 
 
676
    def _emit_progress_update(self):
 
677
        """Emit an update to the progress bar."""
 
678
        self.pb.update("Committing", self.pb_count, self.pb_total)
 
679
        self.pb_count += 1
 
680
 
 
681
    def _report_deletes(self):
 
682
        for path, ie in self.basis_inv.iter_entries():
 
683
            if ie.file_id not in self.builder.new_inventory:
 
684
                self.reporter.deleted(path)
 
685
 
 
686