← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/testament.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Testament - a summary of a revision for signing.
18
18
 
19
 
A testament can be defined as "something that serves as tangible
 
19
A testament can be defined as "something that serves as tangible 
20
20
proof or evidence."  In bzr we use them to allow people to certify
21
 
particular revisions as authentic.
 
21
particular revisions as authentic.  
22
22
 
23
23
The goal is that if two revisions are semantically equal, then they will
24
24
have a byte-for-byte equal testament.  We can define different versions of
59
59
* the testament uses unix line-endings (\n)
60
60
"""
61
61
 
62
 
from __future__ import absolute_import
63
 
 
64
62
# XXX: At the moment, clients trust that the graph described in a weave
65
63
# is accurate, but that's not covered by the testament.  Perhaps the best
66
 
# fix is when verifying a revision to make sure that every file mentioned
 
64
# fix is when verifying a revision to make sure that every file mentioned 
67
65
# in the revision has compatible ancestry links.
68
66
 
69
67
# TODO: perhaps write timestamp in a more readable form
72
70
# revisions can be serialized.
73
71
 
74
72
from copy import copy
 
73
from sha import sha
75
74
 
76
 
from bzrlib.osutils import (
77
 
    contains_whitespace,
78
 
    contains_linebreaks,
79
 
    sha_strings,
80
 
    )
81
 
from bzrlib.tree import Tree
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
82
76
 
83
77
 
84
78
class Testament(object):
85
79
    """Reduced summary of a revision.
86
80
 
87
 
    Testaments can be
 
81
    Testaments can be 
88
82
 
89
83
      - produced from a revision
90
84
      - written to a stream
94
88
 
95
89
    long_header = 'bazaar-ng testament version 1\n'
96
90
    short_header = 'bazaar-ng testament short form 1\n'
97
 
    include_root = False
98
91
 
99
92
    @classmethod
100
93
    def from_revision(cls, repository, revision_id):
101
 
        """Produce a new testament from a historical revision."""
 
94
        """Produce a new testament from a historical revision"""
102
95
        rev = repository.get_revision(revision_id)
103
 
        tree = repository.revision_tree(revision_id)
104
 
        return cls(rev, tree)
105
 
 
106
 
    @classmethod
107
 
    def from_revision_tree(cls, tree):
108
 
        """Produce a new testament from a revision tree."""
109
 
        rev = tree._repository.get_revision(tree.get_revision_id())
110
 
        return cls(rev, tree)
111
 
 
112
 
    def __init__(self, rev, tree):
113
 
        """Create a new testament for rev using tree."""
 
96
        inventory = repository.get_inventory(revision_id)
 
97
        return cls(rev, inventory)
 
98
 
 
99
    def __init__(self, rev, inventory):
 
100
        """Create a new testament for rev using inventory."""
114
101
        self.revision_id = rev.revision_id
115
102
        self.committer = rev.committer
116
103
        self.timezone = rev.timezone or 0
117
104
        self.timestamp = rev.timestamp
118
105
        self.message = rev.message
119
106
        self.parent_ids = rev.parent_ids[:]
120
 
        if not isinstance(tree, Tree):
121
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
122
 
                "Revision and a Tree.")
123
 
        self.tree = tree
 
107
        self.inventory = inventory
124
108
        self.revprops = copy(rev.properties)
125
109
        if contains_whitespace(self.revision_id):
126
110
            raise ValueError(self.revision_id)
156
140
        return [line.encode('utf-8') for line in r]
157
141
 
158
142
    def _get_entries(self):
159
 
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
160
 
                self.tree.list_files(include_root=self.include_root))
 
143
        entries = self.inventory.iter_entries()
 
144
        entries.next()
 
145
        return entries
161
146
 
162
147
    def _escape_path(self, path):
163
148
        if contains_linebreaks(path):
192
177
 
193
178
    def as_short_text(self):
194
179
        """Return short digest-based testament."""
195
 
        return (self.short_header +
 
180
        return (self.short_header + 
196
181
                'revision-id: %s\n'
197
182
                'sha1: %s\n'
198
183
                % (self.revision_id, self.as_sha1()))
211
196
        return r
212
197
 
213
198
    def as_sha1(self):
214
 
        return sha_strings(self.as_text_lines())
 
199
        s = sha()
 
200
        map(s.update, self.as_text_lines())
 
201
        return s.hexdigest()
215
202
 
216
203
 
217
204
class StrictTestament(Testament):
219
206
 
220
207
    long_header = 'bazaar-ng testament version 2.1\n'
221
208
    short_header = 'bazaar-ng testament short form 2.1\n'
222
 
    include_root = False
223
209
    def _entry_to_line(self, path, ie):
224
210
        l = Testament._entry_to_line(self, path, ie)[:-1]
225
211
        l += ' ' + ie.revision
229
215
 
230
216
class StrictTestament3(StrictTestament):
231
217
    """This testament format is for use as a checksum in bundle format 0.9+
232
 
 
 
218
    
233
219
    It differs from StrictTestament by including data about the tree root.
234
220
    """
235
221
 
236
222
    long_header = 'bazaar testament version 3 strict\n'
237
223
    short_header = 'bazaar testament short form 3 strict\n'
238
 
    include_root = True
 
224
    def _get_entries(self):
 
225
        return self.inventory.iter_entries()
239
226
 
240
227
    def _escape_path(self, path):
241
228
        if contains_linebreaks(path):