← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/testament.py

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

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
61
61
 
62
62
# XXX: At the moment, clients trust that the graph described in a weave
63
63
# is accurate, but that's not covered by the testament.  Perhaps the best
64
 
# 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 
65
65
# in the revision has compatible ancestry links.
66
66
 
67
67
# TODO: perhaps write timestamp in a more readable form
70
70
# revisions can be serialized.
71
71
 
72
72
from copy import copy
 
73
from sha import sha
73
74
 
74
 
from bzrlib.osutils import (
75
 
    contains_whitespace,
76
 
    contains_linebreaks,
77
 
    sha_strings,
78
 
    )
79
 
from bzrlib.tree import Tree
 
75
from bzrlib.osutils import contains_whitespace, contains_linebreaks
80
76
 
81
77
 
82
78
class Testament(object):
83
79
    """Reduced summary of a revision.
84
80
 
85
 
    Testaments can be
 
81
    Testaments can be 
86
82
 
87
83
      - produced from a revision
88
84
      - written to a stream
92
88
 
93
89
    long_header = 'bazaar-ng testament version 1\n'
94
90
    short_header = 'bazaar-ng testament short form 1\n'
95
 
    include_root = False
96
91
 
97
92
    @classmethod
98
93
    def from_revision(cls, repository, revision_id):
99
 
        """Produce a new testament from a historical revision."""
 
94
        """Produce a new testament from a historical revision"""
100
95
        rev = repository.get_revision(revision_id)
101
 
        tree = repository.revision_tree(revision_id)
102
 
        return cls(rev, tree)
103
 
 
104
 
    @classmethod
105
 
    def from_revision_tree(cls, tree):
106
 
        """Produce a new testament from a revision tree."""
107
 
        rev = tree._repository.get_revision(tree.get_revision_id())
108
 
        return cls(rev, tree)
109
 
 
110
 
    def __init__(self, rev, tree):
111
 
        """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."""
112
101
        self.revision_id = rev.revision_id
113
102
        self.committer = rev.committer
114
103
        self.timezone = rev.timezone or 0
115
104
        self.timestamp = rev.timestamp
116
105
        self.message = rev.message
117
106
        self.parent_ids = rev.parent_ids[:]
118
 
        if not isinstance(tree, Tree):
119
 
            raise TypeError("As of bzr 2.4 Testament.__init__() takes a "
120
 
                "Revision and a Tree.")
121
 
        self.tree = tree
 
107
        self.inventory = inventory
122
108
        self.revprops = copy(rev.properties)
123
109
        if contains_whitespace(self.revision_id):
124
110
            raise ValueError(self.revision_id)
154
140
        return [line.encode('utf-8') for line in r]
155
141
 
156
142
    def _get_entries(self):
157
 
        return ((path, ie) for (path, versioned, kind, file_id, ie) in
158
 
                self.tree.list_files(include_root=self.include_root))
 
143
        entries = self.inventory.iter_entries()
 
144
        entries.next()
 
145
        return entries
159
146
 
160
147
    def _escape_path(self, path):
161
148
        if contains_linebreaks(path):
190
177
 
191
178
    def as_short_text(self):
192
179
        """Return short digest-based testament."""
193
 
        return (self.short_header +
 
180
        return (self.short_header + 
194
181
                'revision-id: %s\n'
195
182
                'sha1: %s\n'
196
183
                % (self.revision_id, self.as_sha1()))
209
196
        return r
210
197
 
211
198
    def as_sha1(self):
212
 
        return sha_strings(self.as_text_lines())
 
199
        s = sha()
 
200
        map(s.update, self.as_text_lines())
 
201
        return s.hexdigest()
213
202
 
214
203
 
215
204
class StrictTestament(Testament):
217
206
 
218
207
    long_header = 'bazaar-ng testament version 2.1\n'
219
208
    short_header = 'bazaar-ng testament short form 2.1\n'
220
 
    include_root = False
221
209
    def _entry_to_line(self, path, ie):
222
210
        l = Testament._entry_to_line(self, path, ie)[:-1]
223
211
        l += ' ' + ie.revision
227
215
 
228
216
class StrictTestament3(StrictTestament):
229
217
    """This testament format is for use as a checksum in bundle format 0.9+
230
 
 
 
218
    
231
219
    It differs from StrictTestament by including data about the tree root.
232
220
    """
233
221
 
234
222
    long_header = 'bazaar testament version 3 strict\n'
235
223
    short_header = 'bazaar testament short form 3 strict\n'
236
 
    include_root = True
 
224
    def _get_entries(self):
 
225
        return self.inventory.iter_entries()
237
226
 
238
227
    def _escape_path(self, path):
239
228
        if contains_linebreaks(path):