~bzr-pqm/bzr/bzr.dev

485 by Martin Pool
- move commit code into its own module
1
# Copyright (C) 2005 Canonical Ltd
1248 by Martin Pool
- new weave based cleanup [broken]
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
19
# nothing?  Perhaps the best approach is to integrate commit of
20
# AtomicFiles with releasing the lock on the Branch.
21
22
# TODO: Separate 'prepare' phase where we find a list of potentially
23
# committed files.  We then can then pause the commit to prompt for a
24
# commit message, knowing the summary will be the same as what's
25
# actually used for the commit.  (But perhaps simpler to simply get
26
# the tree status, then use that for a selective commit?)
27
28
# The newly committed revision is going to have a shape corresponding
29
# to that of the working inventory.  Files that are not in the
30
# working tree and that were in the predecessor are reported as
31
# removed --- this can include files that were either removed from the
32
# inventory or deleted in the working tree.  If they were only
33
# deleted from disk, they are removed from the working inventory.
34
35
# We then consider the remaining entries, which will be in the new
36
# version.  Directory entries are simply copied across.  File entries
37
# must be checked to see if a new version of the file should be
38
# recorded.  For each parent revision inventory, we check to see what
39
# version of the file was present.  If the file was present in at
40
# least one tree, and if it was the same version in all the trees,
41
# then we can just refer to that version.  Otherwise, a new version
42
# representing the merger of the file versions must be added.
43
44
# TODO: Update hashcache before and after - or does the WorkingTree
45
# look after that?
1245 by Martin Pool
doc
46
1339 by Martin Pool
- doc
47
# TODO: Rather than mashing together the ancestry and storing it back,
48
# perhaps the weave should have single method which does it all in one
49
# go, avoiding a lot of redundant work.
1335 by Martin Pool
doc
50
1341 by Martin Pool
- doc
51
# TODO: Perhaps give a warning if one of the revisions marked as
52
# merged is already in the ancestry, and then don't record it as a
53
# distinct parent.
54
1343 by Martin Pool
- fix up test for merge of trees
55
# TODO: If the file is newly merged but unchanged from the version it
56
# merges from, then it should still be reported as newly added
57
# relative to the basis revision.
58
1185.16.66 by mbp at sourcefrog
- todo
59
# TODO: Do checks that the tree can be committed *before* running the 
60
# editor; this should include checks for a pointless commit and for 
61
# unknown or missing files.
62
63
# TODO: If commit fails, leave the message in a file somewhere.
64
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
65
1189 by Martin Pool
- BROKEN: partial support for commit into weave
66
import os
1390 by Robert Collins
pair programming worx... merge integration and weave
67
import re
1189 by Martin Pool
- BROKEN: partial support for commit into weave
68
import sys
1188 by Martin Pool
- clean up imports in commit code
69
import time
1248 by Martin Pool
- new weave based cleanup [broken]
70
import pdb
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
71
1188 by Martin Pool
- clean up imports in commit code
72
from binascii import hexlify
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
73
from cStringIO import StringIO
1188 by Martin Pool
- clean up imports in commit code
74
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
75
from bzrlib.atomicfile import AtomicFile
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
76
from bzrlib.osutils import (local_time_offset,
77
                            rand_bytes, compact_date,
1188 by Martin Pool
- clean up imports in commit code
78
                            kind_marker, is_inside_any, quotefn,
1248 by Martin Pool
- new weave based cleanup [broken]
79
                            sha_string, sha_strings, sha_file, isdir, isfile,
80
                            split_lines)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
81
import bzrlib.config
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
82
from bzrlib.errors import (BzrError, PointlessCommit,
83
                           HistoryMissing,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
84
                           ConflictsInTree,
85
                           StrictCommitFailed
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
86
                           )
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
87
import bzrlib.gpg as gpg
1311 by Martin Pool
- remove RevisionReference; just hold parent ids directly
88
from bzrlib.revision import Revision
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
89
from bzrlib.testament import Testament
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
90
from bzrlib.trace import mutter, note, warning
1189 by Martin Pool
- BROKEN: partial support for commit into weave
91
from bzrlib.xml5 import serializer_v5
1416 by Robert Collins
when committing a specific file, include all its parents
92
from bzrlib.inventory import Inventory, ROOT_ID
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
from bzrlib.symbol_versioning import *
1189 by Martin Pool
- BROKEN: partial support for commit into weave
94
from bzrlib.weave import Weave
95
from bzrlib.weavefile import read_weave, write_weave_v5
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
96
from bzrlib.workingtree import WorkingTree
1189 by Martin Pool
- BROKEN: partial support for commit into weave
97
98
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.
99
@deprecated_function(zero_seven)
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
100
def commit(*args, **kwargs):
101
    """Commit a new revision to a branch.
102
103
    Function-style interface for convenience of old callers.
104
105
    New code should use the Commit class instead.
106
    """
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
107
    ## XXX: Remove this in favor of Branch.commit?
1205 by Martin Pool
- add bzrlib.commit.commit compatability interface
108
    Commit().commit(*args, **kwargs)
109
110
1189 by Martin Pool
- BROKEN: partial support for commit into weave
111
class NullCommitReporter(object):
112
    """I report on progress of a commit."""
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
113
114
    def snapshot_change(self, change, path):
115
        pass
116
117
    def completed(self, revno, rev_id):
118
        pass
119
120
    def deleted(self, file_id):
121
        pass
122
123
    def escaped(self, escape_count, message):
124
        pass
125
126
    def missing(self, path):
127
        pass
1189 by Martin Pool
- BROKEN: partial support for commit into weave
128
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
129
1189 by Martin Pool
- BROKEN: partial support for commit into weave
130
class ReportCommitToLog(NullCommitReporter):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
131
132
    def snapshot_change(self, change, path):
133
        note("%s %s", change, path)
134
135
    def completed(self, revno, rev_id):
136
        note('committed r%d {%s}', revno, rev_id)
137
    
138
    def deleted(self, file_id):
139
        note('deleted %s', file_id)
140
141
    def escaped(self, escape_count, message):
142
        note("replaced %d control characters in message", escape_count)
143
144
    def missing(self, path):
145
        note('missing %s', path)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
146
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
147
1189 by Martin Pool
- BROKEN: partial support for commit into weave
148
class Commit(object):
149
    """Task of committing a new revision.
150
151
    This is a MethodObject: it accumulates state as the commit is
152
    prepared, and then it is discarded.  It doesn't represent
153
    historical revisions, just the act of recording a new one.
154
155
            missing_ids
156
            Modified to hold a list of files that have been deleted from
157
            the working directory; these should be removed from the
158
            working inventory.
485 by Martin Pool
- move commit code into its own module
159
    """
1189 by Martin Pool
- BROKEN: partial support for commit into weave
160
    def __init__(self,
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
161
                 reporter=None,
162
                 config=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
163
        if reporter is not None:
164
            self.reporter = reporter
165
        else:
166
            self.reporter = NullCommitReporter()
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
167
        if config is not None:
168
            self.config = config
169
        else:
170
            self.config = None
1189 by Martin Pool
- BROKEN: partial support for commit into weave
171
        
172
    def commit(self,
1534.4.32 by Robert Collins
Rename deprecated_nonce to DEPRECATED_PARAMETER
173
               branch=DEPRECATED_PARAMETER, message=None,
1189 by Martin Pool
- BROKEN: partial support for commit into weave
174
               timestamp=None,
175
               timezone=None,
176
               committer=None,
177
               specific_files=None,
178
               rev_id=None,
1276 by Martin Pool
- make Branch.commit accept (and ignore) verbose argument
179
               allow_pointless=True,
1185.16.65 by mbp at sourcefrog
- new commit --strict option
180
               strict=False,
1185.16.35 by Martin Pool
- stub for revision properties
181
               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.
182
               revprops=None,
183
               working_tree=None):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
184
        """Commit working copy as a new revision.
185
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.
186
        branch -- the deprecated branch to commit to. New callers should pass in 
187
                  working_tree instead
188
189
        message -- the commit message, a mandatory parameter
190
1189 by Martin Pool
- BROKEN: partial support for commit into weave
191
        timestamp -- if not None, seconds-since-epoch for a
192
             postdated/predated commit.
193
1253 by Martin Pool
- test that pointless commits are trapped
194
        specific_files -- If true, commit only those files.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
195
1253 by Martin Pool
- test that pointless commits are trapped
196
        rev_id -- If set, use this as the new revision id.
1189 by Martin Pool
- BROKEN: partial support for commit into weave
197
            Useful for test or import commands that need to tightly
198
            control what revisions are assigned.  If you duplicate
199
            a revision id that exists elsewhere it is your own fault.
200
            If null (default), a time/random revision id is generated.
1253 by Martin Pool
- test that pointless commits are trapped
201
202
        allow_pointless -- If true (default), commit even if nothing
203
            has changed and no merges are recorded.
1185.16.35 by Martin Pool
- stub for revision properties
204
1185.16.65 by mbp at sourcefrog
- new commit --strict option
205
        strict -- If true, don't allow a commit if the working tree
206
            contains unknown files.
207
1185.16.35 by Martin Pool
- stub for revision properties
208
        revprops -- Properties for new revision
1189 by Martin Pool
- BROKEN: partial support for commit into weave
209
        """
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
210
        mutter('preparing to commit')
1189 by Martin Pool
- BROKEN: partial support for commit into weave
211
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.
212
        if deprecated_passed(branch):
213
            warn("Commit.commit (branch, ...): The branch parameter is "
214
                 "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.
215
                 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.
216
            self.branch = branch
217
            self.work_tree = WorkingTree(branch.base, branch)
218
        elif working_tree is None:
219
            raise BzrError("One of branch and working_tree must be passed into commit().")
220
        else:
221
            self.work_tree = working_tree
222
            self.branch = self.work_tree.branch
223
        if message is None:
224
            raise BzrError("The message keyword parameter is required for commit().")
225
1534.4.28 by Robert Collins
first cut at merge from integration.
226
        self.weave_store = self.branch.repository.weave_store
1189 by Martin Pool
- BROKEN: partial support for commit into weave
227
        self.rev_id = rev_id
228
        self.specific_files = specific_files
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
229
        self.allow_pointless = allow_pointless
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.
230
        self.revprops = {'branch-nick': self.branch.nick}
1185.35.15 by Aaron Bentley
Added branch nicks to revisions
231
        if revprops:
232
            self.revprops.update(revprops)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
233
1185.22.4 by Michael Ellerman
Strict commit was a little .. ah .. too strict, oops :}
234
        if strict:
235
            # raise an exception as soon as we find a single unknown.
1508.1.6 by Robert Collins
Move Branch.unknowns() to WorkingTree.
236
            for unknown in self.work_tree.unknowns():
1185.22.4 by Michael Ellerman
Strict commit was a little .. ah .. too strict, oops :}
237
                raise StrictCommitFailed()
1185.16.65 by mbp at sourcefrog
- new commit --strict option
238
1189 by Martin Pool
- BROKEN: partial support for commit into weave
239
        if timestamp is None:
240
            self.timestamp = time.time()
241
        else:
242
            self.timestamp = long(timestamp)
243
            
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
244
        if self.config is None:
245
            self.config = bzrlib.config.BranchConfig(self.branch)
246
1248 by Martin Pool
- new weave based cleanup [broken]
247
        if rev_id is None:
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
248
            self.rev_id = _gen_revision_id(self.config, self.timestamp)
1248 by Martin Pool
- new weave based cleanup [broken]
249
        else:
250
            self.rev_id = rev_id
251
1189 by Martin Pool
- BROKEN: partial support for commit into weave
252
        if committer is None:
1442.1.60 by Robert Collins
gpg sign commits if the policy says we need to
253
            self.committer = self.config.username()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
254
        else:
255
            assert isinstance(committer, basestring), type(committer)
256
            self.committer = committer
257
258
        if timezone is None:
259
            self.timezone = local_time_offset()
260
        else:
261
            self.timezone = int(timezone)
262
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
263
        if isinstance(message, str):
264
            message = message.decode(bzrlib.user_encoding)
265
        assert isinstance(message, unicode), type(message)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
266
        self.message = message
1390 by Robert Collins
pair programming worx... merge integration and weave
267
        self._escape_commit_message()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
268
1245 by Martin Pool
doc
269
        self.branch.lock_write()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
270
        try:
271
            self.work_inv = self.work_tree.inventory
272
            self.basis_tree = self.branch.basis_tree()
273
            self.basis_inv = self.basis_tree.inventory
274
1223 by Martin Pool
- store inventories in weave
275
            self._gather_parents()
1344 by Martin Pool
- disallow selected-file commit of merges
276
            if len(self.parents) > 1 and self.specific_files:
277
                raise NotImplementedError('selected-file commit of merges is not supported yet')
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
278
            self._check_parents_present()
279
            
1251 by Martin Pool
- fix up commit in directory with some deleted files
280
            self._remove_deleted()
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
281
            self._populate_new_inv()
282
            self._store_snapshot()
1248 by Martin Pool
- new weave based cleanup [broken]
283
            self._report_deletes()
1245 by Martin Pool
doc
284
1248 by Martin Pool
- new weave based cleanup [broken]
285
            if not (self.allow_pointless
1279 by Martin Pool
- pointless commit of r1 no longer allowed
286
                    or len(self.parents) > 1
1249 by Martin Pool
- improvements to weave commit [broken]
287
                    or self.new_inv != self.basis_inv):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
288
                raise PointlessCommit()
289
1185.14.10 by Aaron Bentley
Commit aborts with conflicts in the tree.
290
            if len(list(self.work_tree.iter_conflicts()))>0:
291
                raise ConflictsInTree
292
1189 by Martin Pool
- BROKEN: partial support for commit into weave
293
            self._record_inventory()
294
            self._make_revision()
1185.33.59 by Martin Pool
[patch] keep a cached basis inventory (Johan Rydberg)
295
            self.work_tree.set_pending_merges([])
1194 by Martin Pool
- [BROKEN] more progress of commit into weaves
296
            self.branch.append_revision(self.rev_id)
1534.4.26 by Robert Collins
Move working tree initialisation out from Branch.initialize, deprecated Branch.initialize to Branch.create.
297
            if len(self.parents):
298
                precursor = self.parents[0]
299
            else:
300
                precursor = None
301
            self.work_tree.set_last_revision(self.rev_id, precursor)
1472 by Robert Collins
post commit hook, first pass implementation
302
            self.reporter.completed(self.branch.revno()+1, self.rev_id)
303
            if self.config.post_commit() is not None:
304
                hooks = self.config.post_commit().split(' ')
305
                # this would be nicer with twisted.python.reflect.namedAny
306
                for hook in hooks:
307
                    result = eval(hook + '(branch, rev_id)',
308
                                  {'branch':self.branch,
309
                                   'bzrlib':bzrlib,
310
                                   'rev_id':self.rev_id})
1189 by Martin Pool
- BROKEN: partial support for commit into weave
311
        finally:
312
            self.branch.unlock()
313
314
    def _record_inventory(self):
1223 by Martin Pool
- store inventories in weave
315
        """Store the inventory for the new revision."""
1248 by Martin Pool
- new weave based cleanup [broken]
316
        inv_text = serializer_v5.write_inventory_to_string(self.new_inv)
317
        self.inv_sha1 = sha_string(inv_text)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
318
        s = self.branch.repository.control_weaves
1352 by Martin Pool
- store control weaves in .bzr/, not mixed in with file weaves
319
        s.add_text('inventory', self.rev_id,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
320
                   split_lines(inv_text), self.present_parents,
321
                   self.branch.get_transaction())
1223 by Martin Pool
- store inventories in weave
322
1390 by Robert Collins
pair programming worx... merge integration and weave
323
    def _escape_commit_message(self):
324
        """Replace xml-incompatible control characters."""
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
325
        # Python strings can include characters that can't be
326
        # represented in well-formed XML; escape characters that
327
        # aren't listed in the XML specification
328
        # (http://www.w3.org/TR/REC-xml/#NT-Char).
1390 by Robert Collins
pair programming worx... merge integration and weave
329
        self.message, escape_count = re.subn(
1393.4.2 by Harald Meland
Cleanup + better test of commit-msg control character escape code.
330
            u'[^\x09\x0A\x0D\u0020-\uD7FF\uE000-\uFFFD]+',
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
331
            lambda match: match.group(0).encode('unicode_escape'),
1390 by Robert Collins
pair programming worx... merge integration and weave
332
            self.message)
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
333
        if escape_count:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
334
            self.reporter.escaped(escape_count, self.message)
1223 by Martin Pool
- store inventories in weave
335
336
    def _gather_parents(self):
1092.2.25 by Robert Collins
support ghosts in commits
337
        """Record the parents of a merge for merge detection."""
1457.1.14 by Robert Collins
Move pending_merges() to WorkingTree.
338
        pending_merges = self.work_tree.pending_merges()
1223 by Martin Pool
- store inventories in weave
339
        self.parents = []
1408 by Robert Collins
we do not need revision_trees in commit, parent inventories are sufficient
340
        self.parent_invs = []
1092.2.25 by Robert Collins
support ghosts in commits
341
        self.present_parents = []
1241 by Martin Pool
- rename last_patch to last_revision
342
        precursor_id = self.branch.last_revision()
1223 by Martin Pool
- store inventories in weave
343
        if precursor_id:
344
            self.parents.append(precursor_id)
345
        self.parents += pending_merges
1092.2.25 by Robert Collins
support ghosts in commits
346
        for revision in self.parents:
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
347
            if self.branch.repository.has_revision(revision):
348
                inventory = self.branch.repository.get_inventory(revision)
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
349
                self.parent_invs.append(inventory)
1092.2.25 by Robert Collins
support ghosts in commits
350
                self.present_parents.append(revision)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
351
352
    def _check_parents_present(self):
1264 by Martin Pool
- Raise a better error from commit when a parent is absent
353
        for parent_id in self.parents:
1270 by Martin Pool
- fix recording of merged ancestry lines
354
            mutter('commit parent revision {%s}', parent_id)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
355
            if not self.branch.repository.has_revision(parent_id):
1092.2.25 by Robert Collins
support ghosts in commits
356
                if parent_id == self.branch.last_revision():
1185.12.9 by Aaron Bentley
Removed crude language
357
                    warning("parent is missing %r", parent_id)
1092.2.25 by Robert Collins
support ghosts in commits
358
                    raise HistoryMissing(self.branch, 'revision', parent_id)
359
                else:
360
                    mutter("commit will ghost revision %r", parent_id)
1284 by Martin Pool
- in commit, avoid reading basis inventory twice
361
            
1189 by Martin Pool
- BROKEN: partial support for commit into weave
362
    def _make_revision(self):
363
        """Record a new revision object for this commit."""
364
        self.rev = Revision(timestamp=self.timestamp,
365
                            timezone=self.timezone,
366
                            committer=self.committer,
367
                            message=self.message,
368
                            inventory_sha1=self.inv_sha1,
1185.16.35 by Martin Pool
- stub for revision properties
369
                            revision_id=self.rev_id,
370
                            properties=self.revprops)
1313 by Martin Pool
- rename to Revision.parent_ids to avoid confusion with old usage
371
        self.rev.parent_ids = self.parents
1248 by Martin Pool
- new weave based cleanup [broken]
372
        rev_tmp = StringIO()
1189 by Martin Pool
- BROKEN: partial support for commit into weave
373
        serializer_v5.write_revision(self.rev, rev_tmp)
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
374
        rev_tmp.seek(0)
1442.1.62 by Robert Collins
Allow creation of testaments from uncommitted data, and use that to get signatures before committing revisions.
375
        if self.config.signature_needed():
376
            plaintext = Testament(self.rev, self.new_inv).as_short_text()
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
377
            self.branch.repository.store_revision_signature(
1185.65.1 by Aaron Bentley
Refactored out ControlFiles and RevisionStore from _Branch
378
                gpg.GPGStrategy(self.config), plaintext, self.rev_id)
1185.67.2 by Aaron Bentley
Renamed Branch.storage to Branch.repository
379
        self.branch.repository.revision_store.add(rev_tmp, self.rev_id)
1189 by Martin Pool
- BROKEN: partial support for commit into weave
380
        mutter('new revision_id is {%s}', self.rev_id)
381
382
    def _remove_deleted(self):
1248 by Martin Pool
- new weave based cleanup [broken]
383
        """Remove deleted files from the working inventories.
384
385
        This is done prior to taking the working inventory as the
386
        basis for the new committed inventory.
387
388
        This returns true if any files
389
        *that existed in the basis inventory* were deleted.
390
        Files that were added and deleted
391
        in the working copy don't matter.
392
        """
1254 by Martin Pool
- fix handling of selective commit with deleted files
393
        specific = self.specific_files
394
        deleted_ids = []
395
        for path, ie in self.work_inv.iter_entries():
396
            if specific and not is_inside_any(specific, path):
397
                continue
398
            if not self.work_tree.has_filename(path):
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
399
                self.reporter.missing(path)
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
400
                deleted_ids.append((path, ie.file_id))
1254 by Martin Pool
- fix handling of selective commit with deleted files
401
        if deleted_ids:
1185.12.5 by Aaron Bentley
Fixed ordering issue in Commit._remove_deleted
402
            deleted_ids.sort(reverse=True)
403
            for path, file_id in deleted_ids:
1248 by Martin Pool
- new weave based cleanup [broken]
404
                del self.work_inv[file_id]
1457.1.11 by Robert Collins
Move _write_inventory to WorkingTree.
405
            self.work_tree._write_inventory(self.work_inv)
1248 by Martin Pool
- new weave based cleanup [broken]
406
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
407
    def _store_snapshot(self):
408
        """Pass over inventory and record a snapshot.
1303 by Martin Pool
- commit updates entry_version
409
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
410
        Entries get a new revision when they are modified in 
411
        any way, which includes a merge with a new set of
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
412
        parents that have the same entry. 
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
413
        """
1303 by Martin Pool
- commit updates entry_version
414
        # XXX: Need to think more here about when the user has
415
        # made a specific decision on a particular value -- c.f.
416
        # mark-merge.  
417
        for path, ie in self.new_inv.iter_entries():
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
418
            previous_entries = ie.find_previous_heads(
419
                self.parent_invs, 
1185.33.88 by Martin Pool
[patch] read only the table-of-contents of weaves to speed up commit
420
                self.weave_store.get_weave_prelude_or_empty(ie.file_id,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
421
                    self.branch.get_transaction()))
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
422
            if ie.revision is None:
423
                change = ie.snapshot(self.rev_id, path, previous_entries,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
424
                                     self.work_tree, self.weave_store,
425
                                     self.branch.get_transaction())
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
426
            else:
427
                change = "unchanged"
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
428
            self.reporter.snapshot_change(change, path)
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
429
430
    def _populate_new_inv(self):
431
        """Build revision inventory.
432
433
        This creates a new empty inventory. Depending on
434
        which files are selected for commit, and what is present in the
435
        current tree, the new inventory is populated. inventory entries 
436
        which are candidates for modification have their revision set to
437
        None; inventory entries that are carried over untouched have their
438
        revision set to their prior value.
1301 by Martin Pool
- more docs in commit code
439
        """
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
440
        mutter("Selecting files for commit with filter %s", self.specific_files)
441
        self.new_inv = Inventory()
1249 by Martin Pool
- improvements to weave commit [broken]
442
        for path, new_ie in self.work_inv.iter_entries():
443
            file_id = new_ie.file_id
444
            mutter('check %s {%s}', path, new_ie.file_id)
1248 by Martin Pool
- new weave based cleanup [broken]
445
            if self.specific_files:
446
                if not is_inside_any(self.specific_files, path):
1249 by Martin Pool
- improvements to weave commit [broken]
447
                    mutter('%s not selected for commit', path)
1416 by Robert Collins
when committing a specific file, include all its parents
448
                    self._carry_entry(file_id)
1249 by Martin Pool
- improvements to weave commit [broken]
449
                    continue
1416 by Robert Collins
when committing a specific file, include all its parents
450
                else:
451
                    # this is selected, ensure its parents are too.
452
                    parent_id = new_ie.parent_id
453
                    while parent_id != ROOT_ID:
454
                        if not self.new_inv.has_id(parent_id):
455
                            ie = self._select_entry(self.work_inv[parent_id])
456
                            mutter('%s selected for commit because of %s',
457
                                   self.new_inv.id2path(parent_id), path)
458
459
                        ie = self.new_inv[parent_id]
460
                        if ie.revision is not None:
461
                            ie.revision = None
462
                            mutter('%s selected for commit because of %s',
463
                                   self.new_inv.id2path(parent_id), path)
464
                        parent_id = ie.parent_id
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
465
            mutter('%s selected for commit', path)
1416 by Robert Collins
when committing a specific file, include all its parents
466
            self._select_entry(new_ie)
467
468
    def _select_entry(self, new_ie):
469
        """Make new_ie be considered for committing."""
470
        ie = new_ie.copy()
471
        ie.revision = None
472
        self.new_inv.add(ie)
473
        return ie
474
475
    def _carry_entry(self, file_id):
1285 by Martin Pool
- fix bug in committing files that are renamed but not modified
476
        """Carry the file unchanged from the basis revision."""
1249 by Martin Pool
- improvements to weave commit [broken]
477
        if self.basis_inv.has_id(file_id):
478
            self.new_inv.add(self.basis_inv[file_id].copy())
1248 by Martin Pool
- new weave based cleanup [broken]
479
480
    def _report_deletes(self):
481
        for file_id in self.basis_inv:
482
            if file_id not in self.new_inv:
1185.12.8 by Aaron Bentley
Fixed commit so all output comes though CommitReporter
483
                self.reporter.deleted(self.basis_inv.id2path(file_id))
1248 by Martin Pool
- new weave based cleanup [broken]
484
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
485
def _gen_revision_id(config, when):
1189 by Martin Pool
- BROKEN: partial support for commit into weave
486
    """Return new revision-id."""
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
487
    s = '%s-%s-' % (config.user_email(), compact_date(when))
1189 by Martin Pool
- BROKEN: partial support for commit into weave
488
    s += hexlify(rand_bytes(8))
489
    return s