~bzr-pqm/bzr/bzr.dev

1704.2.14 by Martin Pool
[merge] work from 0.8 fixes
1
# Copyright (C) 2005, 2006 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
# XXX: Can we do any better about making interrupted commits change
1755.3.1 by Robert Collins
Tune the time to build our kernel_like tree : make LocalTransport.put faster, AtomicFile faster, LocalTransport.append faster.
19
# nothing?  
1248 by Martin Pool
- new weave based cleanup [broken]
20
21
# TODO: Separate 'prepare' phase where we find a list of potentially
22
# committed files.  We then can then pause the commit to prompt for a
23
# commit message, knowing the summary will be the same as what's
24
# actually used for the commit.  (But perhaps simpler to simply get
25
# the tree status, then use that for a selective commit?)
26
27
# The newly committed revision is going to have a shape corresponding
28
# to that of the working inventory.  Files that are not in the
29
# working tree and that were in the predecessor are reported as
30
# removed --- this can include files that were either removed from the
31
# inventory or deleted in the working tree.  If they were only
32
# deleted from disk, they are removed from the working inventory.
33
34
# We then consider the remaining entries, which will be in the new
35
# version.  Directory entries are simply copied across.  File entries
36
# must be checked to see if a new version of the file should be
37
# recorded.  For each parent revision inventory, we check to see what
38
# version of the file was present.  If the file was present in at
39
# least one tree, and if it was the same version in all the trees,
40
# then we can just refer to that version.  Otherwise, a new version
41
# representing the merger of the file versions must be added.
42
43
# TODO: Update hashcache before and after - or does the WorkingTree
44
# look after that?
1245 by Martin Pool
doc
45
1339 by Martin Pool
- doc
46
# TODO: Rather than mashing together the ancestry and storing it back,
47
# perhaps the weave should have single method which does it all in one
48
# go, avoiding a lot of redundant work.
1335 by Martin Pool
doc
49
1341 by Martin Pool
- doc
50
# TODO: Perhaps give a warning if one of the revisions marked as
51
# merged is already in the ancestry, and then don't record it as a
52
# distinct parent.
53
1343 by Martin Pool
- fix up test for merge of trees
54
# TODO: If the file is newly merged but unchanged from the version it
55
# merges from, then it should still be reported as newly added
56
# relative to the basis revision.
57
1185.16.66 by mbp at sourcefrog
- todo
58
# TODO: Do checks that the tree can be committed *before* running the 
59
# editor; this should include checks for a pointless commit and for 
60
# unknown or missing files.
61
62
# TODO: If commit fails, leave the message in a file somewhere.
63
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
64
1189 by Martin Pool
- BROKEN: partial support for commit into weave
65
import os
1390 by Robert Collins
pair programming worx... merge integration and weave
66
import re
1189 by Martin Pool
- BROKEN: partial support for commit into weave
67
import sys
1188 by Martin Pool
- clean up imports in commit code
68
import time
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
69
import warnings
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
70
71
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
72
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
73
import bzrlib.config
1508.1.22 by Robert Collins
implement out of date working tree checks in commit.
74
import bzrlib.errors as errors
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
75
from bzrlib.errors import (BzrError, PointlessCommit,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
76
                           ConflictsInTree,
77
                           StrictCommitFailed
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
78
                           )
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
79
from bzrlib.osutils import (kind_marker, isdir,isfile, is_inside_any, 
80
                            is_inside_or_parent_of_any,
81
                            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.
82
from bzrlib.testament import Testament
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
83
from bzrlib.trace import mutter, note, warning
1189 by Martin Pool
- BROKEN: partial support for commit into weave
84
from bzrlib.xml5 import serializer_v5
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
85
from bzrlib.inventory import Inventory, ROOT_ID, InventoryEntry
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
86
from bzrlib.symbol_versioning import (deprecated_passed,
1773.4.3 by Martin Pool
[merge] bzr.dev
87
        deprecated_function,
88
        zero_seven,
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
89
        DEPRECATED_PARAMETER)
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
90
from bzrlib.workingtree import WorkingTree
1189 by Martin Pool
- BROKEN: partial support for commit into weave
91
92
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.
93
@deprecated_function(zero_seven)
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
94
def commit(*args, **kwargs):
95
    """Commit a new revision to a branch.
96
97
    Function-style interface for convenience of old callers.
98
99
    New code should use the Commit class instead.
100
    """
1773.1.1 by Robert Collins
Teach WorkingTree.commit to return the committed revision id.
101
    ## XXX: Remove this in favor of WorkingTree.commit?
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
102
    Commit().commit(*args, **kwargs)
103
104
1189 by Martin Pool
- BROKEN: partial support for commit into weave
105
class NullCommitReporter(object):
106
    """I report on progress of a commit."""
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
107
108
    def snapshot_change(self, change, path):
109
        pass
110
111
    def completed(self, revno, rev_id):
112
        pass
113
114
    def deleted(self, file_id):
115
        pass
116
117
    def escaped(self, escape_count, message):
118
        pass
119
120
    def missing(self, path):
121
        pass
1189 by Martin Pool
- BROKEN: partial support for commit into weave
122
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
123
    def renamed(self, change, old_path, new_path):
124
        pass
125
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
126
1189 by Martin Pool
- BROKEN: partial support for commit into weave
127
class ReportCommitToLog(NullCommitReporter):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
128
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
129
    # this may be more useful if 'note' was replaced by an overridable
130
    # method on self, which would allow more trivial subclassing.
131
    # alternative, a callable could be passed in, allowing really trivial
132
    # reuse for some uis. RBC 20060511
133
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
134
    def snapshot_change(self, change, path):
1616.1.4 by Martin Pool
Verbose commit shouldn't talk about every unchanged file.
135
        if change == 'unchanged':
136
            return
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
137
        note("%s %s", change, path)
138
139
    def completed(self, revno, rev_id):
1607.1.5 by Robert Collins
Make commit verbose mode work!.
140
        note('Committed revision %d.', revno)
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
141
    
142
    def deleted(self, file_id):
143
        note('deleted %s', file_id)
144
145
    def escaped(self, escape_count, message):
146
        note("replaced %d control characters in message", escape_count)
147
148
    def missing(self, path):
149
        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):
152
        note('%s %s => %s', change, old_path, new_path)
153
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
154
1189 by Martin Pool
- BROKEN: partial support for commit into weave
155
class Commit(object):
156
    """Task of committing a new revision.
157
158
    This is a MethodObject: it accumulates state as the commit is
159
    prepared, and then it is discarded.  It doesn't represent
160
    historical revisions, just the act of recording a new one.
161
162
            missing_ids
163
            Modified to hold a list of files that have been deleted from
164
            the working directory; these should be removed from the
165
            working inventory.
485 by Martin Pool
- move commit code into its own module
166
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
167
    def __init__(self,
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
168
                 reporter=None,
169
                 config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
170
        if reporter is not None:
171
            self.reporter = reporter
172
        else:
173
            self.reporter = NullCommitReporter()
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
174
        if config is not None:
175
            self.config = config
176
        else:
177
            self.config = None
1189 by Martin Pool
- BROKEN: partial support for commit into weave
178
        
179
    def commit(self,
1534.4.32 by Robert Collins
Rename deprecated_nonce to DEPRECATED_PARAMETER
180
               branch=DEPRECATED_PARAMETER, message=None,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
181
               timestamp=None,
182
               timezone=None,
183
               committer=None,
184
               specific_files=None,
185
               rev_id=None,
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
186
               allow_pointless=True,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
187
               strict=False,
1185.16.35 by Martin Pool
- stub for revision properties
188
               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.
189
               revprops=None,
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
190
               working_tree=None,
1607.1.5 by Robert Collins
Make commit verbose mode work!.
191
               local=False,
192
               reporter=None,
193
               config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
194
        """Commit working copy as a new revision.
195
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.
196
        branch -- the deprecated branch to commit to. New callers should pass in 
197
                  working_tree instead
198
199
        message -- the commit message, a mandatory parameter
200
1189 by Martin Pool
- BROKEN: partial support for commit into weave
201
        timestamp -- if not None, seconds-since-epoch for a
202
             postdated/predated commit.
203
1253 by Martin Pool
- test that pointless commits are trapped
204
        specific_files -- If true, commit only those files.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
205
1253 by Martin Pool
- test that pointless commits are trapped
206
        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
212
        allow_pointless -- If true (default), commit even if nothing
213
            has changed and no merges are recorded.
1185.16.35 by Martin Pool
- stub for revision properties
214
1185.16.65 by mbp at sourcefrog
- new commit --strict option
215
        strict -- If true, don't allow a commit if the working tree
216
            contains unknown files.
217
1185.16.35 by Martin Pool
- stub for revision properties
218
        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.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
220
        """
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
221
        mutter('preparing to commit')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
222
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.
223
        if deprecated_passed(branch):
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
224
            warnings.warn("Commit.commit (branch, ...): The branch parameter is "
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.
225
                 "deprecated as of bzr 0.8. Please use working_tree= instead.",
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
226
                 DeprecationWarning, stacklevel=2)
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.
227
            self.branch = branch
1508.1.19 by Robert Collins
Give format3 working trees their own last-revision marker.
228
            self.work_tree = self.branch.bzrdir.open_workingtree()
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
        elif working_tree is None:
230
            raise BzrError("One of branch and working_tree must be passed into commit().")
231
        else:
232
            self.work_tree = working_tree
233
            self.branch = self.work_tree.branch
234
        if message is None:
235
            raise BzrError("The message keyword parameter is required for commit().")
236
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
237
        self.bound_branch = None
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
238
        self.local = local
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
239
        self.master_branch = None
1614.1.1 by Aaron Bentley
Fixed master locking in commit
240
        self.master_locked = False
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
241
        self.rev_id = None
1189 by Martin Pool
- BROKEN: partial support for commit into weave
242
        self.specific_files = specific_files
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
243
        self.allow_pointless = allow_pointless
1189 by Martin Pool
- BROKEN: partial support for commit into weave
244
1607.1.5 by Robert Collins
Make commit verbose mode work!.
245
        if reporter is None and self.reporter is None:
246
            self.reporter = NullCommitReporter()
1607.1.8 by Robert Collins
Integrate latest bzr.dev.
247
        elif reporter is not None:
1607.1.5 by Robert Collins
Make commit verbose mode work!.
248
            self.reporter = reporter
249
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
250
        self.work_tree.lock_write()
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
251
        self.pb = bzrlib.ui.ui_factory.nested_progress_bar()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
252
        try:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
253
            # Cannot commit with conflicts present.
254
            if len(self.work_tree.conflicts())>0:
255
                raise ConflictsInTree
256
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
257
            # 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
258
            self._check_bound_branch()
259
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
260
            # check for out of date working trees
261
            # if we are bound, then self.branch is the master branch and this
262
            # test is thus all we need.
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
263
            if self.work_tree.last_revision() != self.master_branch.last_revision():
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
264
                raise errors.OutOfDateTree(self.work_tree)
265
    
266
            if strict:
267
                # raise an exception as soon as we find a single unknown.
268
                for unknown in self.work_tree.unknowns():
269
                    raise StrictCommitFailed()
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
270
                   
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
271
            if self.config is None:
1770.2.9 by Aaron Bentley
Add Branch.get_config, update BranchConfig() callers
272
                self.config = self.branch.get_config()
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
273
      
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
274
            if isinstance(message, str):
275
                message = message.decode(bzrlib.user_encoding)
276
            assert isinstance(message, unicode), type(message)
277
            self.message = message
278
            self._escape_commit_message()
279
1189 by Martin Pool
- BROKEN: partial support for commit into weave
280
            self.work_inv = self.work_tree.inventory
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
281
            self.basis_tree = self.work_tree.basis_tree()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
282
            self.basis_inv = self.basis_tree.inventory
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
283
            # one to finish, one for rev and inventory, and one for each
284
            # inventory entry, and the same for the new inventory.
285
            # note that this estimate is too long when we do a partial tree
286
            # commit which excludes some new files from being considered.
287
            # The estimate is corrected when we populate the new inv.
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
288
            self.pb_total = len(self.work_inv) + 5
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
289
            self.pb_count = 0
1189 by Martin Pool
- BROKEN: partial support for commit into weave
290
1223 by Martin Pool
- store inventories in weave
291
            self._gather_parents()
1344 by Martin Pool
- disallow selected-file commit of merges
292
            if len(self.parents) > 1 and self.specific_files:
1704.2.11 by Martin Pool
Handle 'bzr commit DIR' when dir contains pending merges.
293
                raise NotImplementedError('selected-file commit of merges is not supported yet: files %r',
294
                        self.specific_files)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
295
            self._check_parents_present()
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
296
            self.builder = self.branch.get_commit_builder(self.parents, 
297
                self.config, timestamp, timezone, committer, revprops, rev_id)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
298
            
1251 by Martin Pool
- fix up commit in directory with some deleted files
299
            self._remove_deleted()
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
300
            self._populate_new_inv()
1248 by Martin Pool
- new weave based cleanup [broken]
301
            self._report_deletes()
1245 by Martin Pool
doc
302
1248 by Martin Pool
- new weave based cleanup [broken]
303
            if not (self.allow_pointless
1279 by Martin Pool
- pointless commit of r1 no longer allowed
304
                    or len(self.parents) > 1
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
305
                    or self.builder.new_inventory != self.basis_inv):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
306
                raise PointlessCommit()
307
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
308
            self._emit_progress_update()
1740.3.9 by Jelmer Vernooij
Make the commit message the first argument of CommitBuilder.commit().
309
            # TODO: Now the new inventory is known, check for conflicts and prompt the 
310
            # user for a commit message.
1740.3.8 by Jelmer Vernooij
Move make_revision() to commit builder.
311
            self.builder.finish_inventory()
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
312
            self._emit_progress_update()
1740.3.9 by Jelmer Vernooij
Make the commit message the first argument of CommitBuilder.commit().
313
            self.rev_id = self.builder.commit(self.message)
1740.3.10 by Jelmer Vernooij
Fix some minor issues pointed out by j-a-m.
314
            self._emit_progress_update()
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
315
            # revision data is in the local branch now.
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
316
            
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
317
            # upload revision data to the master.
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
318
            # this will propagate merged revisions too if needed.
1587.1.7 by Robert Collins
Commit revision data locally first for bound branch commits.
319
            if self.bound_branch:
320
                self.master_branch.repository.fetch(self.branch.repository,
321
                                                    revision_id=self.rev_id)
322
                # now the master has the revision data
323
                # 'commit' to the master first so a timeout here causes the local
324
                # branch to be out of date
325
                self.master_branch.append_revision(self.rev_id)
326
327
            # and now do the commit locally.
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
328
            self.branch.append_revision(self.rev_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
329
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
330
            self.work_tree.set_pending_merges([])
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
331
            self.work_tree.set_last_revision(self.rev_id)
1587.1.6 by Robert Collins
Update bound branch implementation to 0.8.
332
            # now the work tree is up to date with the branch
333
            
1607.1.5 by Robert Collins
Make commit verbose mode work!.
334
            self.reporter.completed(self.branch.revno(), self.rev_id)
1472 by Robert Collins
post commit hook, first pass implementation
335
            if self.config.post_commit() is not None:
336
                hooks = self.config.post_commit().split(' ')
337
                # this would be nicer with twisted.python.reflect.namedAny
338
                for hook in hooks:
339
                    result = eval(hook + '(branch, rev_id)',
340
                                  {'branch':self.branch,
341
                                   'bzrlib':bzrlib,
342
                                   'rev_id':self.rev_id})
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
343
            self._emit_progress_update()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
344
        finally:
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
345
            self._cleanup()
1773.1.1 by Robert Collins
Teach WorkingTree.commit to return the committed revision id.
346
        return self.rev_id
1189 by Martin Pool
- BROKEN: partial support for commit into weave
347
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
348
    def _check_bound_branch(self):
349
        """Check to see if the local branch is bound.
350
351
        If it is bound, then most of the commit will actually be
352
        done using the remote branch as the target branch.
353
        Only at the end will the local branch be updated.
354
        """
1587.1.9 by Robert Collins
Local commits do no alter or access the master branch.
355
        if self.local and not self.branch.get_bound_location():
356
            raise errors.LocalRequiresBoundBranch()
357
358
        if not self.local:
359
            self.master_branch = self.branch.get_master_branch()
360
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
361
        if not self.master_branch:
1587.1.8 by Robert Collins
Local commits on unbound branches fail.
362
            # make this branch the reference branch for out of date checks.
363
            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
364
            return
365
366
        # If the master branch is bound, we must fail
367
        master_bound_location = self.master_branch.get_bound_location()
368
        if master_bound_location:
1505.1.27 by John Arbash Meinel
Adding tests against an sftp branch.
369
            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
370
                    self.master_branch, master_bound_location)
371
372
        # TODO: jam 20051230 We could automatically push local
373
        #       commits to the remote branch if they would fit.
374
        #       But for now, just require remote to be identical
375
        #       to local.
376
        
377
        # Make sure the local branch is identical to the master
378
        master_rh = self.master_branch.revision_history()
379
        local_rh = self.branch.revision_history()
380
        if local_rh != master_rh:
381
            raise errors.BoundBranchOutOfDate(self.branch,
382
                    self.master_branch)
383
384
        # Now things are ready to change the master branch
385
        # so grab the lock
386
        self.bound_branch = self.branch
387
        self.master_branch.lock_write()
1614.1.1 by Aaron Bentley
Fixed master locking in commit
388
        self.master_locked = True
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
389
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
390
    def _cleanup(self):
391
        """Cleanup any open locks, progress bars etc."""
392
        cleanups = [self._cleanup_bound_branch,
393
                    self.work_tree.unlock,
394
                    self.pb.finished]
395
        found_exception = None
396
        for cleanup in cleanups:
397
            try:
398
                cleanup()
399
            # we want every cleanup to run no matter what.
400
            # so we have a catchall here, but we will raise the
401
            # last encountered exception up the stack: and
402
            # typically this will be useful enough.
403
            except Exception, e:
404
                found_exception = e
405
        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.
406
            # 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.
407
            # trashed, e is our sure-to-work exception even though it loses the
408
            # full traceback. XXX: RBC 20060421 perhaps we could check the
409
            # exc_info and if its the same one do a plain raise otherwise 
410
            # 'raise e' as we do now.
411
            raise e
412
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
413
    def _cleanup_bound_branch(self):
414
        """Executed at the end of a try/finally to cleanup a bound branch.
415
416
        If the branch wasn't bound, this is a no-op.
417
        If it was, it resents self.branch to the local branch, instead
418
        of being the master.
419
        """
420
        if not self.bound_branch:
421
            return
1614.1.1 by Aaron Bentley
Fixed master locking in commit
422
        if self.master_locked:
423
            self.master_branch.unlock()
1505.1.24 by John Arbash Meinel
Updated commit to handle bound branches. Included test to handle commit after merge
424
1390 by Robert Collins
pair programming worx... merge integration and weave
425
    def _escape_commit_message(self):
426
        """Replace xml-incompatible control characters."""
1666.1.6 by Robert Collins
Make knit the default format.
427
        # FIXME: RBC 20060419 this should be done by the revision
428
        # serialiser not by commit. Then we can also add an unescaper
429
        # in the deserializer and start roundtripping revision messages
430
        # precisely. See repository_implementations/test_repository.py
431
        
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
432
        # Python strings can include characters that can't be
433
        # represented in well-formed XML; escape characters that
434
        # aren't listed in the XML specification
435
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
1390 by Robert Collins
pair programming worx... merge integration and weave
436
        self.message, escape_count = re.subn(
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
437
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
438
            lambda match: match.group(0).encode('unicode_escape'),
1390 by Robert Collins
pair programming worx... merge integration and weave
439
            self.message)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
440
        if escape_count:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
441
            self.reporter.escaped(escape_count, self.message)
1223 by Martin Pool
- store inventories in weave
442
443
    def _gather_parents(self):
1092.2.25 by Robert Collins
support ghosts in commits
444
        """Record the parents of a merge for merge detection."""
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
445
        # TODO: Make sure that this list doesn't contain duplicate 
446
        # 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.
447
        self.parents = self.work_tree.get_parent_ids()
1408 by Robert Collins
we do not need revision_trees in commit, parent inventories are sufficient
448
        self.parent_invs = []
1092.2.25 by Robert Collins
support ghosts in commits
449
        for revision in self.parents:
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
450
            if self.branch.repository.has_revision(revision):
451
                inventory = self.branch.repository.get_inventory(revision)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
452
                self.parent_invs.append(inventory)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
453
454
    def _check_parents_present(self):
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
455
        for parent_id in self.parents:
1270 by Martin Pool
- fix recording of merged ancestry lines
456
            mutter('commit parent revision {%s}', parent_id)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
457
            if not self.branch.repository.has_revision(parent_id):
1092.2.25 by Robert Collins
support ghosts in commits
458
                if parent_id == self.branch.last_revision():
1185.12.9 by Aaron Bentley
Removed crude language
459
                    warning("parent is missing %r", parent_id)
1740.5.6 by Martin Pool
Clean up many exception classes.
460
                    raise BzrCheckError("branch %s is missing revision {%s}"
461
                            % (self.branch, parent_id))
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
462
            
1189 by Martin Pool
- BROKEN: partial support for commit into weave
463
    def _remove_deleted(self):
1248 by Martin Pool
- new weave based cleanup [broken]
464
        """Remove deleted files from the working inventories.
465
466
        This is done prior to taking the working inventory as the
467
        basis for the new committed inventory.
468
469
        This returns true if any files
470
        *that existed in the basis inventory* were deleted.
471
        Files that were added and deleted
472
        in the working copy don't matter.
473
        """
1254 by Martin Pool
- fix handling of selective commit with deleted files
474
        specific = self.specific_files
475
        deleted_ids = []
476
        for path, ie in self.work_inv.iter_entries():
477
            if specific and not is_inside_any(specific, path):
478
                continue
479
            if not self.work_tree.has_filename(path):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
480
                self.reporter.missing(path)
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
481
                deleted_ids.append((path, ie.file_id))
1254 by Martin Pool
- fix handling of selective commit with deleted files
482
        if deleted_ids:
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
483
            deleted_ids.sort(reverse=True)
484
            for path, file_id in deleted_ids:
1248 by Martin Pool
- new weave based cleanup [broken]
485
                del self.work_inv[file_id]
1457.1.11 by Robert Collins
Move _write_inventory to WorkingTree.
486
            self.work_tree._write_inventory(self.work_inv)
1248 by Martin Pool
- new weave based cleanup [broken]
487
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
488
    def _populate_new_inv(self):
489
        """Build revision inventory.
490
491
        This creates a new empty inventory. Depending on
492
        which files are selected for commit, and what is present in the
493
        current tree, the new inventory is populated. inventory entries 
494
        which are candidates for modification have their revision set to
495
        None; inventory entries that are carried over untouched have their
496
        revision set to their prior value.
1301 by Martin Pool
- more docs in commit code
497
        """
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
498
        # ESEPARATIONOFCONCERNS: this function is diffing and using the diff
499
        # 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.
500
        # 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
501
        # ADHB 11-07-2006
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
502
        mutter("Selecting files for commit with filter %s", self.specific_files)
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
503
        # at this point we dont copy the root entry:
1852.6.3 by Robert Collins
Make iter(Tree) consistent for all tree types.
504
        entries = self.work_inv.iter_entries()
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
505
        entries.next()
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
506
        self._emit_progress_update()
1852.6.3 by Robert Collins
Make iter(Tree) consistent for all tree types.
507
        for path, new_ie in entries:
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
508
            self._emit_progress_update()
1249 by Martin Pool
- improvements to weave commit [broken]
509
            file_id = new_ie.file_id
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
510
            # mutter('check %s {%s}', path, file_id)
1740.3.5 by Jelmer Vernooij
Simplify inventory population code by using is_inside_or_parent_of_any()
511
            if (not self.specific_files or 
512
                is_inside_or_parent_of_any(self.specific_files, path)):
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
513
                    # mutter('%s selected for commit', path)
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
514
                    ie = new_ie.copy()
515
                    ie.revision = None
1740.3.5 by Jelmer Vernooij
Simplify inventory population code by using is_inside_or_parent_of_any()
516
            else:
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
517
                # mutter('%s not selected for commit', path)
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
518
                if self.basis_inv.has_id(file_id):
519
                    ie = self.basis_inv[file_id].copy()
520
                else:
521
                    # this entry is new and not being committed
522
                    continue
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
523
524
            self.builder.record_entry_contents(ie, self.parent_invs, 
525
                path, self.work_tree)
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
526
            # describe the nature of the change that has occurred relative to
1740.3.6 by Jelmer Vernooij
Move inventory writing to the commit builder.
527
            # the basis inventory.
528
            if (self.basis_inv.has_id(ie.file_id)):
529
                basis_ie = self.basis_inv[ie.file_id]
530
            else:
531
                basis_ie = None
532
            change = ie.describe_change(basis_ie, ie)
533
            if change in (InventoryEntry.RENAMED, 
534
                InventoryEntry.MODIFIED_AND_RENAMED):
535
                old_path = self.basis_inv.id2path(ie.file_id)
536
                self.reporter.renamed(change, old_path, path)
537
            else:
538
                self.reporter.snapshot_change(change, path)
1416 by Robert Collins
when committing a specific file, include all its parents
539
1551.7.24 by Aaron Bentley
Ensure commit respects file spec when committing removals
540
        if not self.specific_files:
541
            return
542
543
        # ignore removals that don't match filespec
544
        for path, new_ie in self.basis_inv.iter_entries():
545
            if new_ie.file_id in self.work_inv:
546
                continue
547
            if is_inside_any(self.specific_files, path):
548
                continue
549
            ie = new_ie.copy()
550
            ie.revision = None
551
            self.builder.record_entry_contents(ie, self.parent_invs, path,
552
                                               self.basis_tree)
553
1666.1.22 by Robert Collins
Rename Commit._update to _emit_progress_update.
554
    def _emit_progress_update(self):
1666.1.18 by Robert Collins
Add a progress bar during commit operations.
555
        """Emit an update to the progress bar."""
556
        self.pb.update("Committing", self.pb_count, self.pb_total)
557
        self.pb_count += 1
558
1248 by Martin Pool
- new weave based cleanup [broken]
559
    def _report_deletes(self):
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
560
        for path, ie in self.basis_inv.iter_entries():
1740.3.4 by Jelmer Vernooij
Move inventory to commit builder.
561
            if ie.file_id not in self.builder.new_inventory:
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
562
                self.reporter.deleted(path)
1248 by Martin Pool
- new weave based cleanup [broken]
563
1740.3.7 by Jelmer Vernooij
Move committer, log, revprops, timestamp and timezone to CommitBuilder.
564