/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: 2007-04-19 02:27:44 UTC
  • mto: This revision was merged to the branch mainline in revision 2426.
  • Revision ID: robertc@robertcollins.net-20070419022744-pfdqz42kp1wizh43
``make docs`` now creates a man page at ``man1/bzr.1`` fixing bug 107388.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

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