~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commit.py

  • Committer: Andrew Bennetts
  • Date: 2007-03-26 06:24:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2376.
  • Revision ID: andrew.bennetts@canonical.com-20070326062401-k3nbefzje5332jaf
Deal with review comments from Robert:

  * Add my name to the NEWS file
  * Move the test case to a new module in branch_implementations
  * Remove revision_history cruft from identitymap and test_identitymap
  * Improve some docstrings

Also, this fixes a bug where revision_history was not returning a copy of the
cached data, allowing the cache to be corrupted.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 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
16
16
 
17
17
 
18
18
# The newly committed revision is going to have a shape corresponding
19
 
# to that of the working tree.  Files that are not in the
 
19
# to that of the working inventory.  Files that are not in the
20
20
# working tree and that were in the predecessor are reported as
21
21
# removed --- this can include files that were either removed from the
22
22
# inventory or deleted in the working tree.  If they were only
25
25
# We then consider the remaining entries, which will be in the new
26
26
# version.  Directory entries are simply copied across.  File entries
27
27
# must be checked to see if a new version of the file should be
28
 
# recorded.  For each parent revision tree, we check to see what
 
28
# recorded.  For each parent revision inventory, we check to see what
29
29
# version of the file was present.  If the file was present in at
30
30
# least one tree, and if it was the same version in all the trees,
31
31
# then we can just refer to that version.  Otherwise, a new version
57
57
from cStringIO import StringIO
58
58
 
59
59
from bzrlib import (
60
 
    debug,
61
60
    errors,
62
 
    revision,
 
61
    inventory,
63
62
    tree,
64
63
    )
65
64
from bzrlib.branch import Branch
68
67
                           ConflictsInTree,
69
68
                           StrictCommitFailed
70
69
                           )
71
 
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
 
70
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
72
71
                            is_inside_or_parent_of_any,
73
 
                            minimum_path_selection,
74
 
                            quotefn, sha_file, split_lines,
75
 
                            splitpath,
76
 
                            )
 
72
                            quotefn, sha_file, split_lines)
77
73
from bzrlib.testament import Testament
78
 
from bzrlib.trace import mutter, note, warning, is_quiet
 
74
from bzrlib.trace import mutter, note, warning
79
75
from bzrlib.xml5 import serializer_v5
80
 
from bzrlib.inventory import InventoryEntry, make_entry
 
76
from bzrlib.inventory import Inventory, InventoryEntry
81
77
from bzrlib import symbol_versioning
82
78
from bzrlib.symbol_versioning import (deprecated_passed,
83
79
        deprecated_function,
84
80
        DEPRECATED_PARAMETER)
85
81
from bzrlib.workingtree import WorkingTree
86
 
from bzrlib.urlutils import unescape_for_display
87
82
import bzrlib.ui
88
83
 
89
84
 
90
85
class NullCommitReporter(object):
91
86
    """I report on progress of a commit."""
92
87
 
93
 
    def started(self, revno, revid, location=None):
94
 
        if location is None:
95
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
96
 
                                   "to started.", DeprecationWarning,
97
 
                                   stacklevel=2)
98
 
        pass
99
 
 
100
88
    def snapshot_change(self, change, path):
101
89
        pass
102
90
 
115
103
    def renamed(self, change, old_path, new_path):
116
104
        pass
117
105
 
118
 
    def is_verbose(self):
119
 
        return False
120
 
 
121
106
 
122
107
class ReportCommitToLog(NullCommitReporter):
123
108
 
124
 
    def _note(self, format, *args):
125
 
        """Output a message.
126
 
 
127
 
        Subclasses may choose to override this method.
128
 
        """
129
 
        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
130
113
 
131
114
    def snapshot_change(self, change, path):
132
115
        if change == 'unchanged':
133
116
            return
134
117
        if change == 'added' and path == '':
135
118
            return
136
 
        self._note("%s %s", change, path)
137
 
 
138
 
    def started(self, revno, rev_id, location=None):
139
 
        if location is not None:
140
 
            location = ' to: ' + unescape_for_display(location, 'utf-8')
141
 
        else:
142
 
            # When started was added, location was only made optional by
143
 
            # accident.  Matt Nordhoff 20071129
144
 
            symbol_versioning.warn("As of bzr 1.0 you must pass a location "
145
 
                                   "to started.", DeprecationWarning,
146
 
                                   stacklevel=2)
147
 
            location = ''
148
 
        self._note('Committing%s', location)
 
119
        note("%s %s", change, path)
149
120
 
150
121
    def completed(self, revno, rev_id):
151
 
        self._note('Committed revision %d.', revno)
152
 
 
 
122
        note('Committed revision %d.', revno)
 
123
    
153
124
    def deleted(self, file_id):
154
 
        self._note('deleted %s', file_id)
 
125
        note('deleted %s', file_id)
155
126
 
156
127
    def escaped(self, escape_count, message):
157
 
        self._note("replaced %d control characters in message", escape_count)
 
128
        note("replaced %d control characters in message", escape_count)
158
129
 
159
130
    def missing(self, path):
160
 
        self._note('missing %s', path)
 
131
        note('missing %s', path)
161
132
 
162
133
    def renamed(self, change, old_path, new_path):
163
 
        self._note('%s %s => %s', change, old_path, new_path)
164
 
 
165
 
    def is_verbose(self):
166
 
        return True
 
134
        note('%s %s => %s', change, old_path, new_path)
167
135
 
168
136
 
169
137
class Commit(object):
181
149
    def __init__(self,
182
150
                 reporter=None,
183
151
                 config=None):
184
 
        """Create a Commit object.
185
 
 
186
 
        :param reporter: the default reporter to use or None to decide later
187
 
        """
188
 
        self.reporter = reporter
189
 
        self.config = config
190
 
 
 
152
        if reporter is not None:
 
153
            self.reporter = reporter
 
154
        else:
 
155
            self.reporter = NullCommitReporter()
 
156
        if config is not None:
 
157
            self.config = config
 
158
        else:
 
159
            self.config = None
 
160
        
191
161
    def commit(self,
192
 
               message=None,
 
162
               branch=DEPRECATED_PARAMETER, message=None,
193
163
               timestamp=None,
194
164
               timezone=None,
195
165
               committer=None,
207
177
               recursive='down'):
208
178
        """Commit working copy as a new revision.
209
179
 
210
 
        :param message: the commit message (it or message_callback is required)
211
 
 
212
 
        :param timestamp: if not None, seconds-since-epoch for a
213
 
            postdated/predated commit.
214
 
 
215
 
        :param specific_files: If true, commit only those files.
216
 
 
217
 
        :param rev_id: If set, use this as the new revision id.
 
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.
218
191
            Useful for test or import commands that need to tightly
219
192
            control what revisions are assigned.  If you duplicate
220
193
            a revision id that exists elsewhere it is your own fault.
221
194
            If null (default), a time/random revision id is generated.
222
195
 
223
 
        :param allow_pointless: If true (default), commit even if nothing
 
196
        allow_pointless -- If true (default), commit even if nothing
224
197
            has changed and no merges are recorded.
225
198
 
226
 
        :param strict: If true, don't allow a commit if the working tree
 
199
        strict -- If true, don't allow a commit if the working tree
227
200
            contains unknown files.
228
201
 
229
 
        :param revprops: Properties for new revision
 
202
        revprops -- Properties for new revision
230
203
        :param local: Perform a local only commit.
231
 
        :param reporter: the reporter to use or None for the default
232
 
        :param verbose: if True and the reporter is not None, report everything
233
204
        :param recursive: If set to 'down', commit in any subtrees that have
234
205
            pending changes of any sort during this commit.
235
206
        """
236
207
        mutter('preparing to commit')
237
208
 
238
 
        if working_tree is None:
239
 
            raise BzrError("working_tree must be passed into commit().")
 
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().")
240
217
        else:
241
218
            self.work_tree = working_tree
242
219
            self.branch = self.work_tree.branch
253
230
                               " parameter is required for commit().")
254
231
 
255
232
        self.bound_branch = None
256
 
        self.any_entries_changed = False
257
 
        self.any_entries_deleted = False
258
233
        self.local = local
259
234
        self.master_branch = None
260
235
        self.master_locked = False
261
 
        self.recursive = recursive
262
236
        self.rev_id = None
263
 
        if specific_files is not None:
264
 
            self.specific_files = sorted(
265
 
                minimum_path_selection(specific_files))
266
 
        else:
267
 
            self.specific_files = None
268
 
        self.specific_file_ids = None
 
237
        self.specific_files = specific_files
269
238
        self.allow_pointless = allow_pointless
 
239
        self.recursive = recursive
270
240
        self.revprops = revprops
271
241
        self.message_callback = message_callback
272
242
        self.timestamp = timestamp
273
243
        self.timezone = timezone
274
244
        self.committer = committer
 
245
        self.specific_files = specific_files
275
246
        self.strict = strict
276
247
        self.verbose = verbose
277
 
        # accumulates an inventory delta to the basis entry, so we can make
278
 
        # just the necessary updates to the workingtree's cached basis.
279
 
        self._basis_delta = []
 
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
280
254
 
281
255
        self.work_tree.lock_write()
282
256
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
283
 
        self.basis_revid = self.work_tree.last_revision()
284
257
        self.basis_tree = self.work_tree.basis_tree()
285
258
        self.basis_tree.lock_read()
286
259
        try:
287
260
            # Cannot commit with conflicts present.
288
 
            if len(self.work_tree.conflicts()) > 0:
 
261
            if len(self.work_tree.conflicts())>0:
289
262
                raise ConflictsInTree
290
263
 
291
 
            # Setup the bound branch variables as needed.
 
264
            # setup the bound branch variables as needed.
292
265
            self._check_bound_branch()
293
266
 
294
 
            # Check that the working tree is up to date
295
 
            old_revno, new_revno = self._check_out_of_date_tree()
296
 
 
297
 
            # Complete configuration setup
298
 
            if reporter is not None:
299
 
                self.reporter = reporter
300
 
            elif self.reporter is None:
301
 
                self.reporter = self._select_reporter()
 
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
 
282
            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
                   
302
290
            if self.config is None:
303
291
                self.config = self.branch.get_config()
304
292
 
305
 
            # If provided, ensure the specified files are versioned
306
 
            if self.specific_files is not None:
307
 
                # Note: This routine is being called because it raises
308
 
                # PathNotVersionedError as a side effect of finding the IDs. We
309
 
                # later use the ids we found as input to the working tree
310
 
                # inventory iterator, so we only consider those ids rather than
311
 
                # examining the whole tree again.
 
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)
312
298
                # XXX: Dont we have filter_unversioned to do this more
313
299
                # cheaply?
314
 
                self.specific_file_ids = tree.find_ids_across_trees(
315
 
                    specific_files, [self.basis_tree, self.work_tree])
316
 
 
317
 
            # Setup the progress bar. As the number of files that need to be
318
 
            # committed in unknown, progress is reported as stages.
319
 
            # We keep track of entries separately though and include that
320
 
            # information in the progress bar during the relevant stages.
321
 
            self.pb_stage_name = ""
322
 
            self.pb_stage_count = 0
323
 
            self.pb_stage_total = 5
324
 
            if self.bound_branch:
325
 
                self.pb_stage_total += 1
326
 
            self.pb.show_pct = False
327
 
            self.pb.show_spinner = False
328
 
            self.pb.show_eta = False
329
 
            self.pb.show_count = True
330
 
            self.pb.show_bar = True
331
 
 
332
 
            # After a merge, a selected file commit is not supported.
333
 
            # See 'bzr help merge' for an explanation as to why.
334
 
            self.basis_inv = self.basis_tree.inventory
 
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
 
335
310
            self._gather_parents()
336
311
            if len(self.parents) > 1 and self.specific_files:
337
 
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
338
 
 
339
 
            # Collect the changes
340
 
            self._set_progress_stage("Collecting changes",
341
 
                    entries_title="Directory")
 
312
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
 
313
                        self.specific_files)
 
314
            
342
315
            self.builder = self.branch.get_commit_builder(self.parents,
343
316
                self.config, timestamp, timezone, committer, revprops, rev_id)
344
317
            
345
 
            try:
346
 
                # find the location being committed to
347
 
                if self.bound_branch:
348
 
                    master_location = self.master_branch.base
349
 
                else:
350
 
                    master_location = self.branch.base
351
 
 
352
 
                # report the start of the commit
353
 
                self.reporter.started(new_revno, self.rev_id, master_location)
354
 
 
355
 
                self._update_builder_with_changes()
356
 
                self._report_and_accumulate_deletes()
357
 
                self._check_pointless()
358
 
 
359
 
                # TODO: Now the new inventory is known, check for conflicts.
360
 
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
361
 
                # weave lines, because nothing should be recorded until it is known
362
 
                # that commit will succeed.
363
 
                self._set_progress_stage("Saving data locally")
364
 
                self.builder.finish_inventory()
365
 
 
366
 
                # Prompt the user for a commit message if none provided
367
 
                message = message_callback(self)
368
 
                self.message = message
369
 
                self._escape_commit_message()
370
 
 
371
 
                # Add revision data to the local branch
372
 
                self.rev_id = self.builder.commit(self.message)
373
 
 
374
 
            except:
375
 
                self.builder.abort()
376
 
                raise
377
 
 
378
 
            self._process_pre_hooks(old_revno, new_revno)
379
 
 
380
 
            # Upload revision data to the master.
 
318
            self._remove_deleted()
 
319
            self._populate_new_inv()
 
320
            self._report_deletes()
 
321
 
 
322
            self._check_pointless()
 
323
 
 
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.
 
327
            # ADHB 2006-08-08: If this is done, populate_new_inv should not add
 
328
            # weave lines, because nothing should be recorded until it is known
 
329
            # that commit will succeed.
 
330
            self.builder.finish_inventory()
 
331
            self._emit_progress_update()
 
332
            message = message_callback(self)
 
333
            assert isinstance(message, unicode), type(message)
 
334
            self.message = message
 
335
            self._escape_commit_message()
 
336
 
 
337
            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.
381
342
            # this will propagate merged revisions too if needed.
382
343
            if self.bound_branch:
383
 
                if not self.master_branch.repository.has_same_location(
384
 
                        self.branch.repository):
385
 
                    self._set_progress_stage("Uploading data to master branch")
386
 
                    self.master_branch.repository.fetch(self.branch.repository,
387
 
                        revision_id=self.rev_id)
 
344
                self.master_branch.repository.fetch(self.branch.repository,
 
345
                                                    revision_id=self.rev_id)
388
346
                # now the master has the revision data
389
 
                # 'commit' to the master first so a timeout here causes the
390
 
                # local branch to be out of date
 
347
                # 'commit' to the master first so a timeout here causes the local
 
348
                # branch to be out of date
391
349
                self.master_branch.set_last_revision_info(new_revno,
392
350
                                                          self.rev_id)
393
351
 
394
352
            # and now do the commit locally.
395
353
            self.branch.set_last_revision_info(new_revno, self.rev_id)
396
354
 
397
 
            # Make the working tree up to date with the branch
398
 
            self._set_progress_stage("Updating the working tree")
399
 
            self.work_tree.update_basis_by_delta(self.rev_id,
400
 
                 self._basis_delta)
 
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
            
401
359
            self.reporter.completed(new_revno, self.rev_id)
402
 
            self._process_post_hooks(old_revno, new_revno)
 
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()
403
388
        finally:
404
389
            self._cleanup()
405
390
        return self.rev_id
406
391
 
407
 
    def _select_reporter(self):
408
 
        """Select the CommitReporter to use."""
409
 
        if is_quiet():
410
 
            return NullCommitReporter()
411
 
        return ReportCommitToLog()
 
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
412
426
 
413
427
    def _check_pointless(self):
414
428
        if self.allow_pointless:
416
430
        # A merge with no effect on files
417
431
        if len(self.parents) > 1:
418
432
            return
419
 
        # TODO: we could simplify this by using self._basis_delta.
420
 
 
421
 
        # The initial commit adds a root directory, but this in itself is not
422
 
        # a worthwhile commit.
423
 
        if (self.basis_revid == revision.NULL_REVISION and
424
 
            len(self.builder.new_inventory) == 1):
 
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:
425
436
            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
426
441
        # If length == 1, then we only have the root entry. Which means
427
442
        # that there is no real difference (only the root could be different)
428
 
        # unless deletes occured, in which case the length is irrelevant.
429
 
        if (self.any_entries_deleted or 
430
 
            (len(self.builder.new_inventory) != 1 and
431
 
             self.any_entries_changed)):
 
443
        if (len(self.builder.new_inventory) != 1 and self._any_real_changes()):
432
444
            return
433
445
        raise PointlessCommit()
434
446
 
474
486
        self.master_branch.lock_write()
475
487
        self.master_locked = True
476
488
 
477
 
    def _check_out_of_date_tree(self):
478
 
        """Check that the working tree is up to date.
479
 
 
480
 
        :return: old_revision_number,new_revision_number tuple
481
 
        """
482
 
        try:
483
 
            first_tree_parent = self.work_tree.get_parent_ids()[0]
484
 
        except IndexError:
485
 
            # if there are no parents, treat our parent as 'None'
486
 
            # this is so that we still consider the master branch
487
 
            # - in a checkout scenario the tree may have no
488
 
            # parents but the branch may do.
489
 
            first_tree_parent = bzrlib.revision.NULL_REVISION
490
 
        old_revno, master_last = self.master_branch.last_revision_info()
491
 
        if master_last != first_tree_parent:
492
 
            if master_last != bzrlib.revision.NULL_REVISION:
493
 
                raise errors.OutOfDateTree(self.work_tree)
494
 
        if self.branch.repository.has_revision(first_tree_parent):
495
 
            new_revno = old_revno + 1
496
 
        else:
497
 
            # ghost parents never appear in revision history.
498
 
            new_revno = 1
499
 
        return old_revno,new_revno
500
 
 
501
 
    def _process_pre_hooks(self, old_revno, new_revno):
502
 
        """Process any registered pre commit hooks."""
503
 
        self._set_progress_stage("Running pre_commit hooks")
504
 
        self._process_hooks("pre_commit", old_revno, new_revno)
505
 
 
506
 
    def _process_post_hooks(self, old_revno, new_revno):
507
 
        """Process any registered post commit hooks."""
508
 
        # Process the post commit hooks, if any
509
 
        self._set_progress_stage("Running post_commit hooks")
510
 
        # old style commit hooks - should be deprecated ? (obsoleted in
511
 
        # 0.15)
512
 
        if self.config.post_commit() is not None:
513
 
            hooks = self.config.post_commit().split(' ')
514
 
            # this would be nicer with twisted.python.reflect.namedAny
515
 
            for hook in hooks:
516
 
                result = eval(hook + '(branch, rev_id)',
517
 
                              {'branch':self.branch,
518
 
                               'bzrlib':bzrlib,
519
 
                               'rev_id':self.rev_id})
520
 
        # process new style post commit hooks
521
 
        self._process_hooks("post_commit", old_revno, new_revno)
522
 
 
523
 
    def _process_hooks(self, hook_name, old_revno, new_revno):
524
 
        if not Branch.hooks[hook_name]:
525
 
            return
526
 
        
527
 
        # new style commit hooks:
528
 
        if not self.bound_branch:
529
 
            hook_master = self.branch
530
 
            hook_local = None
531
 
        else:
532
 
            hook_master = self.master_branch
533
 
            hook_local = self.branch
534
 
        # With bound branches, when the master is behind the local branch,
535
 
        # the 'old_revno' and old_revid values here are incorrect.
536
 
        # XXX: FIXME ^. RBC 20060206
537
 
        if self.parents:
538
 
            old_revid = self.parents[0]
539
 
        else:
540
 
            old_revid = bzrlib.revision.NULL_REVISION
541
 
        
542
 
        if hook_name == "pre_commit":
543
 
            future_tree = self.builder.revision_tree()
544
 
            tree_delta = future_tree.changes_from(self.basis_tree,
545
 
                                             include_root=True)
546
 
        
547
 
        for hook in Branch.hooks[hook_name]:
548
 
            # show the running hook in the progress bar. As hooks may
549
 
            # end up doing nothing (e.g. because they are not configured by
550
 
            # the user) this is still showing progress, not showing overall
551
 
            # actions - its up to each plugin to show a UI if it want's to
552
 
            # (such as 'Emailing diff to foo@example.com').
553
 
            self.pb_stage_name = "Running %s hooks [%s]" % \
554
 
                (hook_name, Branch.hooks.get_hook_name(hook))
555
 
            self._emit_progress()
556
 
            if 'hooks' in debug.debug_flags:
557
 
                mutter("Invoking commit hook: %r", hook)
558
 
            if hook_name == "post_commit":
559
 
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
560
 
                     self.rev_id)
561
 
            elif hook_name == "pre_commit":
562
 
                hook(hook_local, hook_master,
563
 
                     old_revno, old_revid, new_revno, self.rev_id,
564
 
                     tree_delta, future_tree)
565
 
 
566
489
    def _cleanup(self):
567
490
        """Cleanup any open locks, progress bars etc."""
568
491
        cleanups = [self._cleanup_bound_branch,
631
554
            else:
632
555
                mutter('commit parent ghost revision {%s}', revision)
633
556
 
634
 
    def _update_builder_with_changes(self):
635
 
        """Update the commit builder with the data about what has changed.
636
 
        """
637
 
        # Build the revision inventory.
638
 
        #
639
 
        # This starts by creating a new empty inventory. Depending on
640
 
        # which files are selected for commit, and what is present in the
641
 
        # current tree, the new inventory is populated. inventory entries 
642
 
        # which are candidates for modification have their revision set to
643
 
        # None; inventory entries that are carried over untouched have their
644
 
        # revision set to their prior value.
645
 
        #
 
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
 
569
        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
        """
646
593
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
647
594
        # results to create a new inventory at the same time, which results
648
595
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
649
596
        # ADHB 11-07-2006
650
 
 
651
 
        specific_files = self.specific_files
652
 
        mutter("Selecting files for commit with filter %s", specific_files)
653
 
 
654
 
        # Build the new inventory
655
 
        self._populate_from_inventory(specific_files)
656
 
 
657
 
        # If specific files are selected, then all un-selected files must be
658
 
        # recorded in their previous state. For more details, see
659
 
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
660
 
        if specific_files:
661
 
            for path, old_ie in self.basis_inv.iter_entries():
662
 
                if old_ie.file_id in self.builder.new_inventory:
663
 
                    # already added - skip.
664
 
                    continue
665
 
                if is_inside_any(specific_files, path):
666
 
                    # was inside the selected path, if not present it has been
667
 
                    # deleted so skip.
668
 
                    continue
669
 
                if old_ie.kind == 'directory':
670
 
                    self._next_progress_entry()
671
 
                # not in final inv yet, was not in the selected files, so is an
672
 
                # entry to be preserved unaltered.
673
 
                ie = old_ie.copy()
674
 
                # Note: specific file commits after a merge are currently
675
 
                # prohibited. This test is for sanity/safety in case it's
676
 
                # required after that changes.
677
 
                if len(self.parents) > 1:
 
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()
678
647
                    ie.revision = None
679
 
                delta, version_recorded = self.builder.record_entry_contents(
680
 
                    ie, self.parent_invs, path, self.basis_tree, None)
681
 
                if version_recorded:
682
 
                    self.any_entries_changed = True
683
 
                if delta: self._basis_delta.append(delta)
684
 
 
685
 
    def _report_and_accumulate_deletes(self):
686
 
        # XXX: Could the list of deleted paths and ids be instead taken from
687
 
        # _populate_from_inventory?
688
 
        deleted_ids = set(self.basis_inv._byid.keys()) - \
689
 
            set(self.builder.new_inventory._byid.keys())
690
 
        if deleted_ids:
691
 
            self.any_entries_deleted = True
692
 
            deleted = [(self.basis_tree.id2path(file_id), file_id)
693
 
                for file_id in deleted_ids]
694
 
            deleted.sort()
695
 
            # XXX: this is not quite directory-order sorting
696
 
            for path, file_id in deleted:
697
 
                self._basis_delta.append((path, None, file_id, 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()
 
681
            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:
698
693
                self.reporter.deleted(path)
699
694
 
700
 
    def _populate_from_inventory(self, specific_files):
701
 
        """Populate the CommitBuilder by walking the working tree inventory."""
702
 
        if self.strict:
703
 
            # raise an exception as soon as we find a single unknown.
704
 
            for unknown in self.work_tree.unknowns():
705
 
                raise StrictCommitFailed()
706
 
               
707
 
        report_changes = self.reporter.is_verbose()
708
 
        deleted_ids = []
709
 
        # A tree of paths that have been deleted. E.g. if foo/bar has been
710
 
        # deleted, then we have {'foo':{'bar':{}}}
711
 
        deleted_paths = {}
712
 
        # XXX: Note that entries may have the wrong kind because the entry does
713
 
        # not reflect the status on disk.
714
 
        work_inv = self.work_tree.inventory
715
 
        entries = work_inv.iter_entries_by_dir(
716
 
            specific_file_ids=self.specific_file_ids, yield_parents=True)
717
 
        for path, existing_ie in entries:
718
 
            file_id = existing_ie.file_id
719
 
            name = existing_ie.name
720
 
            parent_id = existing_ie.parent_id
721
 
            kind = existing_ie.kind
722
 
            if kind == 'directory':
723
 
                self._next_progress_entry()
724
 
            # Skip files that have been deleted from the working tree.
725
 
            # The deleted path ids are also recorded so they can be explicitly
726
 
            # unversioned later.
727
 
            if deleted_paths:
728
 
                path_segments = splitpath(path)
729
 
                deleted_dict = deleted_paths
730
 
                for segment in path_segments:
731
 
                    deleted_dict = deleted_dict.get(segment, None)
732
 
                    if not deleted_dict:
733
 
                        # We either took a path not present in the dict
734
 
                        # (deleted_dict was None), or we've reached an empty
735
 
                        # child dir in the dict, so are now a sub-path.
736
 
                        break
737
 
                else:
738
 
                    deleted_dict = None
739
 
                if deleted_dict is not None:
740
 
                    # the path has a deleted parent, do not add it.
741
 
                    continue
742
 
            content_summary = self.work_tree.path_content_summary(path)
743
 
            # Note that when a filter of specific files is given, we must only
744
 
            # skip/record deleted files matching that filter.
745
 
            if not specific_files or is_inside_any(specific_files, path):
746
 
                if content_summary[0] == 'missing':
747
 
                    if not deleted_paths:
748
 
                        # path won't have been split yet.
749
 
                        path_segments = splitpath(path)
750
 
                    deleted_dict = deleted_paths
751
 
                    for segment in path_segments:
752
 
                        deleted_dict = deleted_dict.setdefault(segment, {})
753
 
                    self.reporter.missing(path)
754
 
                    deleted_ids.append(file_id)
755
 
                    continue
756
 
            # TODO: have the builder do the nested commit just-in-time IF and
757
 
            # only if needed.
758
 
            if content_summary[0] == 'tree-reference':
759
 
                # enforce repository nested tree policy.
760
 
                if (not self.work_tree.supports_tree_reference() or
761
 
                    # repository does not support it either.
762
 
                    not self.branch.repository._format.supports_tree_reference):
763
 
                    content_summary = ('directory',) + content_summary[1:]
764
 
            kind = content_summary[0]
765
 
            # TODO: specific_files filtering before nested tree processing
766
 
            if kind == 'tree-reference':
767
 
                if self.recursive == 'down':
768
 
                    nested_revision_id = self._commit_nested_tree(
769
 
                        file_id, path)
770
 
                    content_summary = content_summary[:3] + (
771
 
                        nested_revision_id,)
772
 
                else:
773
 
                    content_summary = content_summary[:3] + (
774
 
                        self.work_tree.get_reference_revision(file_id),)
775
 
 
776
 
            # Record an entry for this item
777
 
            # Note: I don't particularly want to have the existing_ie
778
 
            # parameter but the test suite currently (28-Jun-07) breaks
779
 
            # without it thanks to a unicode normalisation issue. :-(
780
 
            definitely_changed = kind != existing_ie.kind
781
 
            self._record_entry(path, file_id, specific_files, kind, name,
782
 
                parent_id, definitely_changed, existing_ie, report_changes,
783
 
                content_summary)
784
 
 
785
 
        # Unversion IDs that were found to be deleted
786
 
        self.work_tree.unversion(deleted_ids)
787
 
 
788
 
    def _commit_nested_tree(self, file_id, path):
789
 
        "Commit a nested tree."
790
 
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
791
 
        # FIXME: be more comprehensive here:
792
 
        # this works when both trees are in --trees repository,
793
 
        # but when both are bound to a different repository,
794
 
        # it fails; a better way of approaching this is to 
795
 
        # finally implement the explicit-caches approach design
796
 
        # a while back - RBC 20070306.
797
 
        if sub_tree.branch.repository.has_same_location(
798
 
            self.work_tree.branch.repository):
799
 
            sub_tree.branch.repository = \
800
 
                self.work_tree.branch.repository
801
 
        try:
802
 
            return sub_tree.commit(message=None, revprops=self.revprops,
803
 
                recursive=self.recursive,
804
 
                message_callback=self.message_callback,
805
 
                timestamp=self.timestamp, timezone=self.timezone,
806
 
                committer=self.committer,
807
 
                allow_pointless=self.allow_pointless,
808
 
                strict=self.strict, verbose=self.verbose,
809
 
                local=self.local, reporter=self.reporter)
810
 
        except errors.PointlessCommit:
811
 
            return self.work_tree.get_reference_revision(file_id)
812
 
 
813
 
    def _record_entry(self, path, file_id, specific_files, kind, name,
814
 
        parent_id, definitely_changed, existing_ie, report_changes,
815
 
        content_summary):
816
 
        "Record the new inventory entry for a path if any."
817
 
        # mutter('check %s {%s}', path, file_id)
818
 
        # mutter('%s selected for commit', path)
819
 
        if definitely_changed or existing_ie is None:
820
 
            ie = make_entry(kind, name, parent_id, file_id)
821
 
        else:
822
 
            ie = existing_ie.copy()
823
 
            ie.revision = None
824
 
        delta, version_recorded = self.builder.record_entry_contents(ie,
825
 
            self.parent_invs, path, self.work_tree, content_summary)
826
 
        if delta:
827
 
            self._basis_delta.append(delta)
828
 
        if version_recorded:
829
 
            self.any_entries_changed = True
830
 
        if report_changes:
831
 
            self._report_change(ie, path)
832
 
        return ie
833
 
 
834
 
    def _report_change(self, ie, path):
835
 
        """Report a change to the user.
836
 
 
837
 
        The change that has occurred is described relative to the basis
838
 
        inventory.
839
 
        """
840
 
        if (self.basis_inv.has_id(ie.file_id)):
841
 
            basis_ie = self.basis_inv[ie.file_id]
842
 
        else:
843
 
            basis_ie = None
844
 
        change = ie.describe_change(basis_ie, ie)
845
 
        if change in (InventoryEntry.RENAMED, 
846
 
            InventoryEntry.MODIFIED_AND_RENAMED):
847
 
            old_path = self.basis_inv.id2path(ie.file_id)
848
 
            self.reporter.renamed(change, old_path, path)
849
 
        else:
850
 
            self.reporter.snapshot_change(change, path)
851
 
 
852
 
    def _set_progress_stage(self, name, entries_title=None):
853
 
        """Set the progress stage and emit an update to the progress bar."""
854
 
        self.pb_stage_name = name
855
 
        self.pb_stage_count += 1
856
 
        self.pb_entries_title = entries_title
857
 
        if entries_title is not None:
858
 
            self.pb_entries_count = 0
859
 
            self.pb_entries_total = '?'
860
 
        self._emit_progress()
861
 
 
862
 
    def _next_progress_entry(self):
863
 
        """Emit an update to the progress bar and increment the entry count."""
864
 
        self.pb_entries_count += 1
865
 
        self._emit_progress()
866
 
 
867
 
    def _emit_progress(self):
868
 
        if self.pb_entries_title:
869
 
            if self.pb_entries_total == '?':
870
 
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
871
 
                    self.pb_entries_title, self.pb_entries_count)
872
 
            else:
873
 
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
874
 
                    self.pb_entries_title, self.pb_entries_count,
875
 
                    str(self.pb_entries_total))
876
 
        else:
877
 
            text = "%s - Stage" % (self.pb_stage_name)
878
 
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
879
695