/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: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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