/brz/remove-bazaar

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