~bzr-pqm/bzr/bzr.dev

2374.2.2 by John Arbash Meinel
Fix the small bug that ie.snapshot() didn't think about kind changes.
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
2
#
485 by Martin Pool
- move commit code into its own module
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1248 by Martin Pool
- new weave based cleanup [broken]
7
#
485 by Martin Pool
- move commit code into its own module
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1248 by Martin Pool
- new weave based cleanup [broken]
12
#
485 by Martin Pool
- move commit code into its own module
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
1248 by Martin Pool
- new weave based cleanup [broken]
18
# The newly committed revision is going to have a shape corresponding
19
# to that of the working inventory.  Files that are not in the
20
# working tree and that were in the predecessor are reported as
21
# removed --- this can include files that were either removed from the
22
# inventory or deleted in the working tree.  If they were only
23
# deleted from disk, they are removed from the working inventory.
24
25
# We then consider the remaining entries, which will be in the new
26
# version.  Directory entries are simply copied across.  File entries
27
# must be checked to see if a new version of the file should be
28
# recorded.  For each parent revision inventory, we check to see what
29
# version of the file was present.  If the file was present in at
30
# least one tree, and if it was the same version in all the trees,
31
# then we can just refer to that version.  Otherwise, a new version
32
# representing the merger of the file versions must be added.
33
34
# TODO: Update hashcache before and after - or does the WorkingTree
35
# look after that?
1245 by Martin Pool
doc
36
1339 by Martin Pool
- doc
37
# TODO: Rather than mashing together the ancestry and storing it back,
38
# perhaps the weave should have single method which does it all in one
39
# go, avoiding a lot of redundant work.
1335 by Martin Pool
doc
40
1341 by Martin Pool
- doc
41
# TODO: Perhaps give a warning if one of the revisions marked as
42
# merged is already in the ancestry, and then don't record it as a
43
# distinct parent.
44
1343 by Martin Pool
- fix up test for merge of trees
45
# TODO: If the file is newly merged but unchanged from the version it
46
# merges from, then it should still be reported as newly added
47
# relative to the basis revision.
48
1910.7.17 by Andrew Bennetts
Various cosmetic changes.
49
# TODO: Change the parameter 'rev_id' to 'revision_id' to be consistent with
50
# the rest of the code; add a deprecation of the old name.
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
51
1189 by Martin Pool
- BROKEN: partial support for commit into weave
52
import os
1390 by Robert Collins
pair programming worx... merge integration and weave
53
import re
1189 by Martin Pool
- BROKEN: partial support for commit into weave
54
import sys
1188 by Martin Pool
- clean up imports in commit code
55
import time
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
56
57
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
58
1551.8.30 by Aaron Bentley
Tweak from review comments
59
from bzrlib import (
2560.1.4 by Robert Collins
Allow -Dhooks to get the hooks invoked during commit logged.
60
    debug,
1551.8.30 by Aaron Bentley
Tweak from review comments
61
    errors,
1959.4.2 by Aaron Bentley
Merge bzr.dev
62
    inventory,
1551.8.30 by Aaron Bentley
Tweak from review comments
63
    tree,
64
    )
2246.1.3 by Robert Collins
New branch hooks: post_push, post_pull, post_commit, post_uncommit. These
65
from bzrlib.branch import Branch
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
66
import bzrlib.config
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
67
from bzrlib.errors import (BzrError, PointlessCommit,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
68
                           ConflictsInTree,
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
69
                           StrictCommitFailed
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
70
                           )
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
71
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any,
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
72
                            is_inside_or_parent_of_any,
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
73
                            minimum_path_selection,
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
74
                            quotefn, sha_file, split_lines)
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
75
from bzrlib.testament import Testament
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
76
from bzrlib.trace import mutter, note, warning, is_quiet
1189 by Martin Pool
- BROKEN: partial support for commit into weave
77
from bzrlib.xml5 import serializer_v5
1731.1.33 by Aaron Bentley
Revert no-special-root changes
78
from bzrlib.inventory import Inventory, InventoryEntry
1910.2.9 by Aaron Bentley
Inroduce assertDeprecated, and use it to test old commitbuilder API
79
from bzrlib import symbol_versioning
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
80
from bzrlib.symbol_versioning import (deprecated_passed,
1773.4.3 by Martin Pool
[merge] bzr.dev
81
        deprecated_function,
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
82
        DEPRECATED_PARAMETER)
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
83
from bzrlib.workingtree import WorkingTree
2747.6.11 by Daniel Watkins
Modified ReportCommitToLog.started to use urlutils.unescape_for_display for 'location'.
84
from bzrlib.urlutils import unescape_for_display
2094.3.5 by John Arbash Meinel
Fix imports to ensure modules are loaded before they are used
85
import bzrlib.ui
1189 by Martin Pool
- BROKEN: partial support for commit into weave
86
87
88
class NullCommitReporter(object):
89
    """I report on progress of a commit."""
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
90
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
91
    def started(self, revno, revid, location=None):
92
        pass
93
94
    def snapshot_change(self, change, path):
95
        pass
96
97
    def completed(self, revno, rev_id):
98
        pass
99
100
    def deleted(self, file_id):
101
        pass
102
103
    def escaped(self, escape_count, message):
104
        pass
105
106
    def missing(self, path):
107
        pass
108
109
    def renamed(self, change, old_path, new_path):
110
        pass
111
2789.2.11 by Ian Clatworthy
remove more reporting stuff
112
    def is_verbose(self):
113
        return False
114
115
116
class ReportCommitToLog(NullCommitReporter):
117
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
118
    def _note(self, format, *args):
119
        """Output a message.
120
2522.2.3 by Ian Clatworthy
Revert logging just to stderr in commit as broke unicode filenames (#120930)
121
        Subclasses may choose to override this method.
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
122
        """
2522.2.3 by Ian Clatworthy
Revert logging just to stderr in commit as broke unicode filenames (#120930)
123
        note(format, *args)
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
124
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
125
    def snapshot_change(self, change, path):
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
126
        if change == 'unchanged':
127
            return
128
        if change == 'added' and path == '':
129
            return
2789.2.11 by Ian Clatworthy
remove more reporting stuff
130
        self._note("%s %s", change, path)
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
131
2747.6.5 by Daniel Watkins
Added 'started' hook to CommitReporters and moved location functionality from completed hook into it.
132
    def started(self, revno, rev_id, location=None):
2747.6.1 by Daniel Watkins
Added message at the end of commit for bound branches.
133
        if location is not None:
2747.6.11 by Daniel Watkins
Modified ReportCommitToLog.started to use urlutils.unescape_for_display for 'location'.
134
            location = ' to "' + unescape_for_display(location, 'utf-8') + '"'
2747.6.1 by Daniel Watkins
Added message at the end of commit for bound branches.
135
        else:
136
            location = ''
2747.6.5 by Daniel Watkins
Added 'started' hook to CommitReporters and moved location functionality from completed hook into it.
137
        self._note('Committing revision %d%s.', revno, location)
138
139
    def completed(self, revno, rev_id):
2789.2.11 by Ian Clatworthy
remove more reporting stuff
140
        self._note('Committed revision %d.', revno)
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
141
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
142
    def deleted(self, file_id):
2789.2.11 by Ian Clatworthy
remove more reporting stuff
143
        self._note('deleted %s', file_id)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
144
145
    def escaped(self, escape_count, message):
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
146
        self._note("replaced %d control characters in message", escape_count)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
147
148
    def missing(self, path):
2789.2.11 by Ian Clatworthy
remove more reporting stuff
149
        self._note('missing %s', path)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
150
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
151
    def renamed(self, change, old_path, new_path):
2789.2.11 by Ian Clatworthy
remove more reporting stuff
152
        self._note('%s %s => %s', change, old_path, new_path)
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
153
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
154
    def is_verbose(self):
155
        return True
156
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
157
1189 by Martin Pool
- BROKEN: partial support for commit into weave
158
class Commit(object):
159
    """Task of committing a new revision.
160
161
    This is a MethodObject: it accumulates state as the commit is
162
    prepared, and then it is discarded.  It doesn't represent
163
    historical revisions, just the act of recording a new one.
164
165
            missing_ids
166
            Modified to hold a list of files that have been deleted from
167
            the working directory; these should be removed from the
168
            working inventory.
485 by Martin Pool
- move commit code into its own module
169
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
170
    def __init__(self,
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
171
                 reporter=None,
172
                 config=None):
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
173
        """Create a Commit object.
174
175
        :param reporter: the default reporter to use or None to decide later
176
        """
177
        self.reporter = reporter
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
178
        self.config = config
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
179
1189 by Martin Pool
- BROKEN: partial support for commit into weave
180
    def commit(self,
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
181
               message=None,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
182
               timestamp=None,
183
               timezone=None,
184
               committer=None,
185
               specific_files=None,
186
               rev_id=None,
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
187
               allow_pointless=True,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
188
               strict=False,
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
189
               verbose=False,
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
190
               revprops=None,
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
191
               working_tree=None,
1607.1.5 by Robert Collins
Make commit verbose mode work!.
192
               local=False,
193
               reporter=None,
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
194
               config=None,
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
195
               message_callback=None,
196
               recursive='down'):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
197
        """Commit working copy as a new revision.
198
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
199
        :param message: the commit message (it or message_callback is required)
200
201
        :param timestamp: if not None, seconds-since-epoch for a
202
            postdated/predated commit.
203
204
        :param specific_files: If true, commit only those files.
205
206
        :param rev_id: If set, use this as the new revision id.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
207
            Useful for test or import commands that need to tightly
208
            control what revisions are assigned.  If you duplicate
209
            a revision id that exists elsewhere it is your own fault.
210
            If null (default), a time/random revision id is generated.
1253 by Martin Pool
- test that pointless commits are trapped
211
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
212
        :param allow_pointless: If true (default), commit even if nothing
1253 by Martin Pool
- test that pointless commits are trapped
213
            has changed and no merges are recorded.
1185.16.35 by Martin Pool
- stub for revision properties
214
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
215
        :param strict: If true, don't allow a commit if the working tree
1185.16.65 by mbp at sourcefrog
- new commit --strict option
216
            contains unknown files.
217
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
218
        :param revprops: Properties for new revision
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
219
        :param local: Perform a local only commit.
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
220
        :param reporter: the reporter to use or None for the default
221
        :param verbose: if True and the reporter is not None, report everything
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
222
        :param recursive: If set to 'down', commit in any subtrees that have
223
            pending changes of any sort during this commit.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
224
        """
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
225
        mutter('preparing to commit')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
226
2367.2.1 by Robert Collins
Remove bzrlib 0.8 compatability where it was making the code unclear or messy. (Robert Collins)
227
        if working_tree is None:
228
            raise BzrError("working_tree must be passed into commit().")
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
229
        else:
230
            self.work_tree = working_tree
231
            self.branch = self.work_tree.branch
2100.3.14 by Aaron Bentley
Test workingtree4 format, prevent use with old repos
232
            if getattr(self.work_tree, 'requires_rich_root', lambda: False)():
233
                if not self.branch.repository.supports_rich_root():
234
                    raise errors.RootNotRich()
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
235
        if message_callback is None:
2149.1.3 by Aaron Bentley
Updates from review comments
236
            if message is not None:
237
                if isinstance(message, str):
238
                    message = message.decode(bzrlib.user_encoding)
239
                message_callback = lambda x: message
2149.1.1 by Aaron Bentley
Provide a message_callback parameter to tree.commit
240
            else:
2149.1.3 by Aaron Bentley
Updates from review comments
241
                raise BzrError("The message or message_callback keyword"
242
                               " parameter is required for commit().")
1534.4.25 by Robert Collins
Add a --transport parameter to the test suite to set the default transport to be used in the test suite.
243
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
244
        self.bound_branch = None
2840.1.1 by Ian Clatworthy
faster pointless commit detection (Robert Collins)
245
        self.any_entries_changed = False
246
        self.any_entries_deleted = False
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
247
        self.local = local
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
248
        self.master_branch = None
1614.1.1 by Aaron Bentley
Fixed master locking in commit
249
        self.master_locked = False
2776.4.15 by Robert Collins
Put checking for recursive commits back to the commit driver, not commit builder.
250
        self.recursive = recursive
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
251
        self.rev_id = None
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
252
        if specific_files is not None:
253
            self.specific_files = sorted(
254
                minimum_path_selection(specific_files))
255
        else:
256
            self.specific_files = None
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
257
        self.specific_file_ids = None
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
258
        self.allow_pointless = allow_pointless
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
259
        self.revprops = revprops
260
        self.message_callback = message_callback
261
        self.timestamp = timestamp
262
        self.timezone = timezone
263
        self.committer = committer
264
        self.strict = strict
265
        self.verbose = verbose
1189 by Martin Pool
- BROKEN: partial support for commit into weave
266
2789.2.5 by Ian Clatworthy
Upgrade commit tests to reflect new reporting formats
267
        self.work_tree.lock_write()
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
268
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
269
        self.basis_tree = self.work_tree.basis_tree()
2255.2.25 by John Arbash Meinel
DirstateRevisionTrees need to be read_locked before they will work as BasisTree
270
        self.basis_tree.lock_read()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
271
        try:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
272
            # Cannot commit with conflicts present.
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
273
            if len(self.work_tree.conflicts()) > 0:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
274
                raise ConflictsInTree
275
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
276
            # Setup the bound branch variables as needed.
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
277
            self._check_bound_branch()
278
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
279
            # Check that the working tree is up to date
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
280
            old_revno, new_revno = self._check_out_of_date_tree()
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
281
2789.2.5 by Ian Clatworthy
Upgrade commit tests to reflect new reporting formats
282
            # Complete configuration setup
283
            if reporter is not None:
284
                self.reporter = reporter
285
            elif self.reporter is None:
286
                self.reporter = self._select_reporter()
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
287
            if self.config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
288
                self.config = self.branch.get_config()
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
289
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
290
            # If provided, ensure the specified files are versioned
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
291
            if self.specific_files is not None:
2776.4.13 by Robert Collins
Merge bzr.dev.
292
                # Note: This routine is being called because it raises
2776.4.14 by Robert Collins
Merge bzr.dev.
293
                # PathNotVersionedError as a side effect of finding the IDs. We
2776.4.13 by Robert Collins
Merge bzr.dev.
294
                # later use the ids we found as input to the working tree
295
                # inventory iterator, so we only consider those ids rather than
296
                # examining the whole tree again.
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
297
                # XXX: Dont we have filter_unversioned to do this more
298
                # cheaply?
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
299
                self.specific_file_ids = tree.find_ids_across_trees(
300
                    specific_files, [self.basis_tree, self.work_tree])
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
301
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
302
            # Setup the progress bar. As the number of files that need to be
303
            # committed in unknown, progress is reported as stages.
304
            # We keep track of entries separately though and include that
305
            # information in the progress bar during the relevant stages.
306
            self.pb_stage_name = ""
307
            self.pb_stage_count = 0
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
308
            self.pb_stage_total = 5
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
309
            if self.bound_branch:
310
                self.pb_stage_total += 1
311
            self.pb.show_pct = False
312
            self.pb.show_spinner = False
313
            self.pb.show_eta = False
314
            self.pb.show_count = True
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
315
            self.pb.show_bar = True
1189 by Martin Pool
- BROKEN: partial support for commit into weave
316
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
317
            # After a merge, a selected file commit is not supported.
318
            # See 'bzr help merge' for an explanation as to why.
319
            self.basis_inv = self.basis_tree.inventory
1223 by Martin Pool
- store inventories in weave
320
            self._gather_parents()
1344 by Martin Pool
- disallow selected-file commit of merges
321
            if len(self.parents) > 1 and self.specific_files:
1551.15.9 by Aaron Bentley
Better error for selected-file commit of merges
322
                raise errors.CannotCommitSelectedFileMerge(self.specific_files)
2747.6.6 by Daniel Watkins
Added call to CommitReport.started hook.
323
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
324
            # Collect the changes
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
325
            self._set_progress_stage("Collecting changes",
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
326
                    entries_title="Directory")
2255.2.218 by Robert Collins
Make the nested tree commit smoke test be more rigourous.
327
            self.builder = self.branch.get_commit_builder(self.parents,
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
328
                self.config, timestamp, timezone, committer, revprops, rev_id)
2659.3.5 by NamNguyen
merge with bzr.dev
329
            
2617.6.2 by Robert Collins
Add abort_write_group and wire write_groups into fetch and commit.
330
            try:
2747.6.6 by Daniel Watkins
Added call to CommitReport.started hook.
331
                # find the location being committed to
332
                if self.bound_branch:
333
                    master_location = self.master_branch.base
334
                else:
335
                    master_location = self.branch.base
336
337
                # report the start of the commit
338
                self.reporter.started(new_revno, self.rev_id, master_location)
339
2617.6.2 by Robert Collins
Add abort_write_group and wire write_groups into fetch and commit.
340
                self._update_builder_with_changes()
341
                self._check_pointless()
342
343
                # TODO: Now the new inventory is known, check for conflicts.
344
                # ADHB 2006-08-08: If this is done, populate_new_inv should not add
345
                # weave lines, because nothing should be recorded until it is known
346
                # that commit will succeed.
2617.6.9 by Robert Collins
Merge bzr.dev.
347
                self._set_progress_stage("Saving data locally")
2617.6.2 by Robert Collins
Add abort_write_group and wire write_groups into fetch and commit.
348
                self.builder.finish_inventory()
349
350
                # Prompt the user for a commit message if none provided
351
                message = message_callback(self)
352
                assert isinstance(message, unicode), type(message)
353
                self.message = message
354
                self._escape_commit_message()
355
356
                # Add revision data to the local branch
357
                self.rev_id = self.builder.commit(self.message)
2659.3.5 by NamNguyen
merge with bzr.dev
358
2617.6.2 by Robert Collins
Add abort_write_group and wire write_groups into fetch and commit.
359
            except:
2749.3.1 by Jelmer Vernooij
Add CommitBuilder.abort().
360
                self.builder.abort()
2617.6.2 by Robert Collins
Add abort_write_group and wire write_groups into fetch and commit.
361
                raise
362
2659.3.6 by NamNguyen
branch_implementations/test_commit.py:
363
            self._process_pre_hooks(old_revno, new_revno)
364
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
365
            # Upload revision data to the master.
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
366
            # this will propagate merged revisions too if needed.
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
367
            if self.bound_branch:
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
368
                self._set_progress_stage("Uploading data to master branch")
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
369
                self.master_branch.repository.fetch(self.branch.repository,
370
                                                    revision_id=self.rev_id)
371
                # now the master has the revision data
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
372
                # 'commit' to the master first so a timeout here causes the
373
                # local branch to be out of date
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
374
                self.master_branch.set_last_revision_info(new_revno,
375
                                                          self.rev_id)
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
376
377
            # and now do the commit locally.
2230.3.51 by Aaron Bentley
Store revno for Branch6, set_last_revision -> set_last_revision_info
378
            self.branch.set_last_revision_info(new_revno, self.rev_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
379
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
380
            # Make the working tree up to date with the branch
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
381
            self._set_progress_stage("Updating the working tree")
2041.1.5 by John Arbash Meinel
CommitBuilder.get_tree => CommitBuilder.revision_tree
382
            rev_tree = self.builder.revision_tree()
2041.1.2 by John Arbash Meinel
Update WorkingTree.set_parent_trees() to directly cache inv.
383
            self.work_tree.set_parent_trees([(self.rev_id, rev_tree)])
2747.6.5 by Daniel Watkins
Added 'started' hook to CommitReporters and moved location functionality from completed hook into it.
384
            self.reporter.completed(new_revno, self.rev_id)
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
385
            self._process_post_hooks(old_revno, new_revno)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
386
        finally:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
387
            self._cleanup()
1773.1.1 by Robert Collins
Teach WorkingTree.commit to return the committed revision id.
388
        return self.rev_id
1189 by Martin Pool
- BROKEN: partial support for commit into weave
389
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
390
    def _select_reporter(self):
391
        """Select the CommitReporter to use."""
392
        if is_quiet():
393
            return NullCommitReporter()
2789.2.10 by Ian Clatworthy
focus on performance gains, not better reporting
394
        return ReportCommitToLog()
2789.2.4 by Ian Clatworthy
make change reporting smarter for initial commit
395
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
396
    def _check_pointless(self):
397
        if self.allow_pointless:
398
            return
399
        # A merge with no effect on files
400
        if len(self.parents) > 1:
401
            return
402
        # work around the fact that a newly-initted tree does differ from its
403
        # basis
1731.1.49 by Aaron Bentley
Merge bzr.dev
404
        if len(self.basis_inv) == 0 and len(self.builder.new_inventory) == 1:
405
            raise PointlessCommit()
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
406
        # Shortcut, if the number of entries changes, then we obviously have
407
        # a change
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
408
        if len(self.builder.new_inventory) != len(self.basis_inv):
409
            return
2044.1.1 by Robert Collins
(Robert Collins) Forward merge from 0.11rc2 NEWS and performance-regression fix.
410
        # If length == 1, then we only have the root entry. Which means
411
        # that there is no real difference (only the root could be different)
2840.1.1 by Ian Clatworthy
faster pointless commit detection (Robert Collins)
412
        if len(self.builder.new_inventory) != 1 and (self.any_entries_changed
413
            or self.any_entries_deleted):
1910.2.37 by Aaron Bentley
Handle empty commits, fix test
414
            return
415
        raise PointlessCommit()
416
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
417
    def _check_bound_branch(self):
418
        """Check to see if the local branch is bound.
419
420
        If it is bound, then most of the commit will actually be
421
        done using the remote branch as the target branch.
422
        Only at the end will the local branch be updated.
423
        """
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
424
        if self.local and not self.branch.get_bound_location():
425
            raise errors.LocalRequiresBoundBranch()
426
427
        if not self.local:
428
            self.master_branch = self.branch.get_master_branch()
429
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
430
        if not self.master_branch:
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
431
            # make this branch the reference branch for out of date checks.
432
            self.master_branch = self.branch
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
433
            return
434
435
        # If the master branch is bound, we must fail
436
        master_bound_location = self.master_branch.get_bound_location()
437
        if master_bound_location:
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
438
            raise errors.CommitToDoubleBoundBranch(self.branch,
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
439
                    self.master_branch, master_bound_location)
440
441
        # TODO: jam 20051230 We could automatically push local
442
        #       commits to the remote branch if they would fit.
443
        #       But for now, just require remote to be identical
444
        #       to local.
445
        
446
        # Make sure the local branch is identical to the master
2249.4.2 by Wouter van Heyst
Convert callers of Branch.revision_history() to Branch.last_revision_info() where sensible.
447
        master_info = self.master_branch.last_revision_info()
448
        local_info = self.branch.last_revision_info()
449
        if local_info != master_info:
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
450
            raise errors.BoundBranchOutOfDate(self.branch,
451
                    self.master_branch)
452
453
        # Now things are ready to change the master branch
454
        # so grab the lock
455
        self.bound_branch = self.branch
456
        self.master_branch.lock_write()
1614.1.1 by Aaron Bentley
Fixed master locking in commit
457
        self.master_locked = True
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
458
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
459
    def _check_out_of_date_tree(self):
460
        """Check that the working tree is up to date.
461
462
        :return: old_revision_number,new_revision_number tuple
463
        """
464
        try:
465
            first_tree_parent = self.work_tree.get_parent_ids()[0]
466
        except IndexError:
467
            # if there are no parents, treat our parent as 'None'
468
            # this is so that we still consider the master branch
469
            # - in a checkout scenario the tree may have no
470
            # parents but the branch may do.
471
            first_tree_parent = bzrlib.revision.NULL_REVISION
472
        old_revno, master_last = self.master_branch.last_revision_info()
473
        if master_last != first_tree_parent:
474
            if master_last != bzrlib.revision.NULL_REVISION:
475
                raise errors.OutOfDateTree(self.work_tree)
476
        if self.branch.repository.has_revision(first_tree_parent):
477
            new_revno = old_revno + 1
478
        else:
479
            # ghost parents never appear in revision history.
480
            new_revno = 1
481
        return old_revno,new_revno
482
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
483
    def _process_pre_hooks(self, old_revno, new_revno):
484
        """Process any registered pre commit hooks."""
2659.3.9 by NamNguyen
branch.py:
485
        self._set_progress_stage("Running pre_commit hooks")
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
486
        self._process_hooks("pre_commit", old_revno, new_revno)
487
488
    def _process_post_hooks(self, old_revno, new_revno):
489
        """Process any registered post commit hooks."""
2553.1.2 by Robert Collins
Show hook names during commit.
490
        # Process the post commit hooks, if any
2659.3.9 by NamNguyen
branch.py:
491
        self._set_progress_stage("Running post_commit hooks")
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
492
        # old style commit hooks - should be deprecated ? (obsoleted in
493
        # 0.15)
494
        if self.config.post_commit() is not None:
495
            hooks = self.config.post_commit().split(' ')
496
            # this would be nicer with twisted.python.reflect.namedAny
497
            for hook in hooks:
498
                result = eval(hook + '(branch, rev_id)',
499
                              {'branch':self.branch,
500
                               'bzrlib':bzrlib,
501
                               'rev_id':self.rev_id})
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
502
        # process new style post commit hooks
503
        self._process_hooks("post_commit", old_revno, new_revno)
504
505
    def _process_hooks(self, hook_name, old_revno, new_revno):
2659.3.3 by NamNguyen
Changed ``pre_commit`` hook signature.
506
        if not Branch.hooks[hook_name]:
507
            return
508
        
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
509
        # new style commit hooks:
510
        if not self.bound_branch:
511
            hook_master = self.branch
512
            hook_local = None
513
        else:
514
            hook_master = self.master_branch
515
            hook_local = self.branch
516
        # With bound branches, when the master is behind the local branch,
517
        # the 'old_revno' and old_revid values here are incorrect.
518
        # XXX: FIXME ^. RBC 20060206
519
        if self.parents:
520
            old_revid = self.parents[0]
521
        else:
522
            old_revid = bzrlib.revision.NULL_REVISION
2659.3.9 by NamNguyen
branch.py:
523
        
524
        if hook_name == "pre_commit":
525
            future_tree = self.builder.revision_tree()
526
            tree_delta = future_tree.changes_from(self.basis_tree,
527
                                             include_root=True)
528
        
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
529
        for hook in Branch.hooks[hook_name]:
2553.1.3 by Robert Collins
Increase docs in response to review feedback.
530
            # show the running hook in the progress bar. As hooks may
531
            # end up doing nothing (e.g. because they are not configured by
532
            # the user) this is still showing progress, not showing overall
533
            # actions - its up to each plugin to show a UI if it want's to
534
            # (such as 'Emailing diff to foo@example.com').
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
535
            self.pb_stage_name = "Running %s hooks [%s]" % \
2659.3.9 by NamNguyen
branch.py:
536
                (hook_name, Branch.hooks.get_hook_name(hook))
2553.1.2 by Robert Collins
Show hook names during commit.
537
            self._emit_progress()
2560.1.4 by Robert Collins
Allow -Dhooks to get the hooks invoked during commit logged.
538
            if 'hooks' in debug.debug_flags:
539
                mutter("Invoking commit hook: %r", hook)
2659.3.1 by NamNguyen
``Branch.hooks`` now supports ``pre_commit`` hook.
540
            if hook_name == "post_commit":
541
                hook(hook_local, hook_master, old_revno, old_revid, new_revno,
542
                     self.rev_id)
543
            elif hook_name == "pre_commit":
544
                hook(hook_local, hook_master,
545
                     old_revno, old_revid, new_revno, self.rev_id,
2659.3.9 by NamNguyen
branch.py:
546
                     tree_delta, future_tree)
2511.1.1 by Ian Clatworthy
commit.py clean-up including logging just to stderr, not bzr.log
547
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
548
    def _cleanup(self):
549
        """Cleanup any open locks, progress bars etc."""
550
        cleanups = [self._cleanup_bound_branch,
2255.2.25 by John Arbash Meinel
DirstateRevisionTrees need to be read_locked before they will work as BasisTree
551
                    self.basis_tree.unlock,
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
552
                    self.work_tree.unlock,
553
                    self.pb.finished]
554
        found_exception = None
555
        for cleanup in cleanups:
556
            try:
557
                cleanup()
558
            # we want every cleanup to run no matter what.
559
            # so we have a catchall here, but we will raise the
560
            # last encountered exception up the stack: and
561
            # typically this will be useful enough.
562
            except Exception, e:
563
                found_exception = e
564
        if found_exception is not None: 
1759.2.2 by Jelmer Vernooij
Revert some of my spelling fixes and fix some typos after review by Aaron.
565
            # don't do a plan raise, because the last exception may have been
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
566
            # trashed, e is our sure-to-work exception even though it loses the
567
            # full traceback. XXX: RBC 20060421 perhaps we could check the
568
            # exc_info and if its the same one do a plain raise otherwise 
569
            # 'raise e' as we do now.
570
            raise e
571
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
572
    def _cleanup_bound_branch(self):
573
        """Executed at the end of a try/finally to cleanup a bound branch.
574
575
        If the branch wasn't bound, this is a no-op.
576
        If it was, it resents self.branch to the local branch, instead
577
        of being the master.
578
        """
579
        if not self.bound_branch:
580
            return
1614.1.1 by Aaron Bentley
Fixed master locking in commit
581
        if self.master_locked:
582
            self.master_branch.unlock()
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
583
1390 by Robert Collins
pair programming worx... merge integration and weave
584
    def _escape_commit_message(self):
585
        """Replace xml-incompatible control characters."""
1666.1.6 by Robert Collins
Make knit the default format.
586
        # FIXME: RBC 20060419 this should be done by the revision
587
        # serialiser not by commit. Then we can also add an unescaper
588
        # in the deserializer and start roundtripping revision messages
589
        # precisely. See repository_implementations/test_repository.py
590
        
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
591
        # Python strings can include characters that can't be
592
        # represented in well-formed XML; escape characters that
593
        # aren't listed in the XML specification
594
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
1390 by Robert Collins
pair programming worx... merge integration and weave
595
        self.message, escape_count = re.subn(
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
596
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
597
            lambda match: match.group(0).encode('unicode_escape'),
1390 by Robert Collins
pair programming worx... merge integration and weave
598
            self.message)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
599
        if escape_count:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
600
            self.reporter.escaped(escape_count, self.message)
1223 by Martin Pool
- store inventories in weave
601
602
    def _gather_parents(self):
1092.2.25 by Robert Collins
support ghosts in commits
603
        """Record the parents of a merge for merge detection."""
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
604
        # TODO: Make sure that this list doesn't contain duplicate 
605
        # entries and the order is preserved when doing this.
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
606
        self.parents = self.work_tree.get_parent_ids()
2283.2.1 by John Arbash Meinel
Avoid deserializing an inventory we have already parsed.
607
        self.parent_invs = [self.basis_inv]
608
        for revision in self.parents[1:]:
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
609
            if self.branch.repository.has_revision(revision):
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
610
                mutter('commit parent revision {%s}', revision)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
611
                inventory = self.branch.repository.get_inventory(revision)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
612
                self.parent_invs.append(inventory)
1927.2.1 by Robert Collins
Alter set_pending_merges to shove the left most merge into the trees last-revision if that is not set. Related bugfixes include basis_tree handling ghosts, de-duping the merges with the last-revision and update changing where and how it adds its pending merge.
613
            else:
614
                mutter('commit parent ghost revision {%s}', revision)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
615
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
616
    def _update_builder_with_changes(self):
617
        """Update the commit builder with the data about what has changed.
618
        """
619
        # Build the revision inventory.
620
        #
621
        # This starts by creating a new empty inventory. Depending on
622
        # which files are selected for commit, and what is present in the
623
        # current tree, the new inventory is populated. inventory entries 
624
        # which are candidates for modification have their revision set to
625
        # None; inventory entries that are carried over untouched have their
626
        # revision set to their prior value.
627
        #
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
628
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
629
        # results to create a new inventory at the same time, which results
1852.10.3 by Robert Collins
Remove all uses of compare_trees and replace with Tree.changes_from throughout bzrlib.
630
        # in bugs like #46635.  Any reason not to use/enhance Tree.changes_from?
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
631
        # ADHB 11-07-2006
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
632
633
        specific_files = self.specific_files
634
        mutter("Selecting files for commit with filter %s", specific_files)
635
636
        # Check and warn about old CommitBuilders
2564.2.7 by Ian Clatworthy
Clean-up comments and make use of self.builder.record_root_entry more explicit
637
        if not self.builder.record_root_entry:
1910.2.9 by Aaron Bentley
Inroduce assertDeprecated, and use it to test old commitbuilder API
638
            symbol_versioning.warn('CommitBuilders should support recording'
639
                ' the root entry as of bzr 0.10.', DeprecationWarning, 
640
                stacklevel=1)
1910.2.4 by Aaron Bentley
Support old CommitBuilders
641
            self.builder.new_inventory.add(self.basis_inv.root.copy())
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
642
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
643
        # Build the new inventory
2564.2.7 by Ian Clatworthy
Clean-up comments and make use of self.builder.record_root_entry more explicit
644
        self._populate_from_inventory(specific_files)
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
645
2564.2.7 by Ian Clatworthy
Clean-up comments and make use of self.builder.record_root_entry more explicit
646
        # If specific files are selected, then all un-selected files must be
647
        # recorded in their previous state. For more details, see
648
        # https://lists.ubuntu.com/archives/bazaar/2007q3/028476.html.
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
649
        if specific_files:
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
650
            for path, old_ie in self.basis_inv.iter_entries():
651
                if old_ie.file_id in self.builder.new_inventory:
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
652
                    # already added - skip.
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
653
                    continue
654
                if is_inside_any(specific_files, path):
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
655
                    # was inside the selected path, if not present it has been
656
                    # deleted so skip.
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
657
                    continue
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
658
                if old_ie.kind == 'directory':
659
                    self._next_progress_entry()
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
660
                # not in final inv yet, was not in the selected files, so is an
661
                # entry to be preserved unaltered.
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
662
                ie = old_ie.copy()
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
663
                # Note: specific file commits after a merge are currently
664
                # prohibited. This test is for sanity/safety in case it's
665
                # required after that changes.
666
                if len(self.parents) > 1:
667
                    ie.revision = None
2871.1.3 by Robert Collins
* The CommitBuilder method ``record_entry_contents`` now returns summary
668
                delta, version_recorded = self.builder.record_entry_contents(
2871.1.4 by Robert Collins
Merge bzr.dev.
669
                    ie, self.parent_invs, path, self.basis_tree, None)
2871.1.3 by Robert Collins
* The CommitBuilder method ``record_entry_contents`` now returns summary
670
                if version_recorded:
2840.1.1 by Ian Clatworthy
faster pointless commit detection (Robert Collins)
671
                    self.any_entries_changed = True
2541.1.1 by Ian Clatworthy
Refactor commit.commit() to walk the working inventory once/less
672
2825.5.2 by Robert Collins
Review feedback, and fix pointless commits with nested trees to raise PointlessCommit appropriately.
673
        # note that deletes have occurred
2825.5.1 by Robert Collins
* Committing a change which is not a merge and does not change the number of
674
        if set(self.basis_inv._byid.keys()) - set(self.builder.new_inventory._byid.keys()):
2840.1.1 by Ian Clatworthy
faster pointless commit detection (Robert Collins)
675
            self.any_entries_deleted = True
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
676
        # Report what was deleted.
2840.1.1 by Ian Clatworthy
faster pointless commit detection (Robert Collins)
677
        if self.any_entries_deleted and self.reporter.is_verbose():
2789.2.1 by Ian Clatworthy
Make commit less verbose by default
678
            for path, ie in self.basis_inv.iter_entries():
679
                if ie.file_id not in self.builder.new_inventory:
680
                    self.reporter.deleted(path)
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
681
2564.2.7 by Ian Clatworthy
Clean-up comments and make use of self.builder.record_root_entry more explicit
682
    def _populate_from_inventory(self, specific_files):
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
683
        """Populate the CommitBuilder by walking the working tree inventory."""
684
        if self.strict:
685
            # raise an exception as soon as we find a single unknown.
686
            for unknown in self.work_tree.unknowns():
687
                raise StrictCommitFailed()
688
               
2789.2.11 by Ian Clatworthy
remove more reporting stuff
689
        report_changes = self.reporter.is_verbose()
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
690
        deleted_ids = []
691
        deleted_paths = set()
692
        work_inv = self.work_tree.inventory
693
        assert work_inv.root is not None
2776.4.2 by Robert Collins
nuke _read_tree_state and snapshot from inventory, moving responsibility into the commit builder.
694
        # XXX: Note that entries may have the wrong kind.
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
695
        entries = work_inv.iter_entries_by_dir(
696
            specific_file_ids=self.specific_file_ids, yield_parents=True)
2564.2.7 by Ian Clatworthy
Clean-up comments and make use of self.builder.record_root_entry more explicit
697
        if not self.builder.record_root_entry:
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
698
            entries.next()
2564.2.6 by Ian Clatworthy
Incorporate feedback from abentley
699
        for path, existing_ie in entries:
700
            file_id = existing_ie.file_id
701
            name = existing_ie.name
702
            parent_id = existing_ie.parent_id
703
            kind = existing_ie.kind
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
704
            if kind == 'directory':
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
705
                self._next_progress_entry()
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
706
            # Skip files that have been deleted from the working tree.
707
            # The deleted files/directories are also recorded so they
708
            # can be explicitly unversioned later. Note that when a
709
            # filter of specific files is given, we must only skip/record
710
            # deleted files matching that filter.
711
            if is_inside_any(deleted_paths, path):
712
                continue
2776.4.7 by Robert Collins
Remove another stat by using path_content_summary to avoid a has_filename call.
713
            content_summary = self.work_tree.path_content_summary(path)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
714
            if not specific_files or is_inside_any(specific_files, path):
2776.4.7 by Robert Collins
Remove another stat by using path_content_summary to avoid a has_filename call.
715
                if content_summary[0] == 'missing':
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
716
                    deleted_paths.add(path)
717
                    self.reporter.missing(path)
718
                    deleted_ids.append(file_id)
719
                    continue
2776.4.2 by Robert Collins
nuke _read_tree_state and snapshot from inventory, moving responsibility into the commit builder.
720
            # TODO: have the builder do the nested commit just-in-time IF and
721
            # only if needed.
2776.4.4 by Robert Collins
Move content summary generation outside of record_entry_contents.
722
            if content_summary[0] == 'tree-reference':
723
                # enforce repository nested tree policy.
724
                if (not self.work_tree.supports_tree_reference() or
725
                    # repository does not support it either.
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
726
                    not self.branch.repository._format.supports_tree_reference):
2776.4.4 by Robert Collins
Move content summary generation outside of record_entry_contents.
727
                    content_summary = ('directory',) + content_summary[1:]
728
            kind = content_summary[0]
729
            # TODO: specific_files filtering before nested tree processing
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
730
            if kind == 'tree-reference':
2776.4.15 by Robert Collins
Put checking for recursive commits back to the commit driver, not commit builder.
731
                if self.recursive == 'down':
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
732
                    nested_revision_id = self._commit_nested_tree(
733
                        file_id, path)
734
                    content_summary = content_summary[:3] + (
735
                        nested_revision_id,)
736
                else:
737
                    content_summary = content_summary[:3] + (
738
                        self.work_tree.get_reference_revision(file_id),)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
739
740
            # Record an entry for this item
741
            # Note: I don't particularly want to have the existing_ie
742
            # parameter but the test suite currently (28-Jun-07) breaks
743
            # without it thanks to a unicode normalisation issue. :-(
2776.4.2 by Robert Collins
nuke _read_tree_state and snapshot from inventory, moving responsibility into the commit builder.
744
            definitely_changed = kind != existing_ie.kind
2789.2.12 by Ian Clatworthy
reduce conditionals
745
            self._record_entry(path, file_id, specific_files, kind, name,
2776.4.10 by Robert Collins
Merge bzr.dev.
746
                parent_id, definitely_changed, existing_ie, report_changes,
747
                content_summary)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
748
749
        # Unversion IDs that were found to be deleted
750
        self.work_tree.unversion(deleted_ids)
751
2564.2.3 by Ian Clatworthy
more abentley feedback: use get_nested_tree and include file_id
752
    def _commit_nested_tree(self, file_id, path):
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
753
        "Commit a nested tree."
2564.2.3 by Ian Clatworthy
more abentley feedback: use get_nested_tree and include file_id
754
        sub_tree = self.work_tree.get_nested_tree(file_id, path)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
755
        # FIXME: be more comprehensive here:
756
        # this works when both trees are in --trees repository,
757
        # but when both are bound to a different repository,
758
        # it fails; a better way of approaching this is to 
759
        # finally implement the explicit-caches approach design
760
        # a while back - RBC 20070306.
2665.5.2 by Aaron Bentley
Switch commit and merge to Repository.has_same_location
761
        if sub_tree.branch.repository.has_same_location(
762
            self.work_tree.branch.repository):
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
763
            sub_tree.branch.repository = \
764
                self.work_tree.branch.repository
765
        try:
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
766
            return sub_tree.commit(message=None, revprops=self.revprops,
2776.4.15 by Robert Collins
Put checking for recursive commits back to the commit driver, not commit builder.
767
                recursive=self.recursive,
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
768
                message_callback=self.message_callback,
769
                timestamp=self.timestamp, timezone=self.timezone,
770
                committer=self.committer,
771
                allow_pointless=self.allow_pointless,
772
                strict=self.strict, verbose=self.verbose,
773
                local=self.local, reporter=self.reporter)
774
        except errors.PointlessCommit:
2776.4.6 by Robert Collins
Fixup various commit test failures falling out from the other commit changes.
775
            return self.work_tree.get_reference_revision(file_id)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
776
777
    def _record_entry(self, path, file_id, specific_files, kind, name,
2776.4.10 by Robert Collins
Merge bzr.dev.
778
        parent_id, definitely_changed, existing_ie, report_changes,
779
        content_summary):
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
780
        "Record the new inventory entry for a path if any."
781
        # mutter('check %s {%s}', path, file_id)
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
782
        # mutter('%s selected for commit', path)
783
        if definitely_changed or existing_ie is None:
784
            ie = inventory.make_entry(kind, name, parent_id, file_id)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
785
        else:
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
786
            ie = existing_ie.copy()
787
            ie.revision = None
2871.1.3 by Robert Collins
* The CommitBuilder method ``record_entry_contents`` now returns summary
788
        delta, version_recorded = self.builder.record_entry_contents(ie,
2871.1.4 by Robert Collins
Merge bzr.dev.
789
            self.parent_invs, path, self.work_tree, content_summary)
2871.1.3 by Robert Collins
* The CommitBuilder method ``record_entry_contents`` now returns summary
790
        if version_recorded:
2843.1.1 by Ian Clatworthy
Faster partial commits by walking less data (Robert Collins)
791
            self.any_entries_changed = True
2825.7.1 by Robert Collins
* Partial commits are now approximately 40% faster by walking over the
792
        if report_changes:
793
            self._report_change(ie, path)
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
794
        return ie
795
796
    def _report_change(self, ie, path):
797
        """Report a change to the user.
798
799
        The change that has occurred is described relative to the basis
800
        inventory.
801
        """
802
        if (self.basis_inv.has_id(ie.file_id)):
803
            basis_ie = self.basis_inv[ie.file_id]
804
        else:
805
            basis_ie = None
806
        change = ie.describe_change(basis_ie, ie)
807
        if change in (InventoryEntry.RENAMED, 
808
            InventoryEntry.MODIFIED_AND_RENAMED):
809
            old_path = self.basis_inv.id2path(ie.file_id)
810
            self.reporter.renamed(change, old_path, path)
811
        else:
812
            self.reporter.snapshot_change(change, path)
813
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
814
    def _set_progress_stage(self, name, entries_title=None):
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
815
        """Set the progress stage and emit an update to the progress bar."""
816
        self.pb_stage_name = name
817
        self.pb_stage_count += 1
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
818
        self.pb_entries_title = entries_title
819
        if entries_title is not None:
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
820
            self.pb_entries_count = 0
821
            self.pb_entries_total = '?'
822
        self._emit_progress()
823
2564.2.2 by Ian Clatworthy
incorporate feedback from abentley
824
    def _next_progress_entry(self):
825
        """Emit an update to the progress bar and increment the entry count."""
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
826
        self.pb_entries_count += 1
827
        self._emit_progress()
828
829
    def _emit_progress(self):
2564.2.1 by Ian Clatworthy
refactor commit to support alternative population meothds
830
        if self.pb_entries_title:
831
            if self.pb_entries_total == '?':
832
                text = "%s [%s %d] - Stage" % (self.pb_stage_name,
833
                    self.pb_entries_title, self.pb_entries_count)
834
            else:
835
                text = "%s [%s %d/%s] - Stage" % (self.pb_stage_name,
836
                    self.pb_entries_title, self.pb_entries_count,
837
                    str(self.pb_entries_total))
2531.1.2 by Ian Clatworthy
Improved progress reporting for commit
838
        else:
839
            text = "%s - Stage" % (self.pb_stage_name)
840
        self.pb.update(text, self.pb_stage_count, self.pb_stage_total)
841