~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

merge bzr.dev

Show diffs side-by-side

added added

removed removed

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