/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2220.3.1 by Martin Pool
add bencode utility
1
# bencode structured encoding
2
#
3
# Written by Petru Paler
4
#
5
# Permission is hereby granted, free of charge, to any person
6
# obtaining a copy of this software and associated documentation files
7
# (the "Software"), to deal in the Software without restriction,
8
# including without limitation the rights to use, copy, modify, merge,
9
# publish, distribute, sublicense, and/or sell copies of the Software,
10
# and to permit persons to whom the Software is furnished to do so,
11
# subject to the following conditions:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
12
#
2220.3.1 by Martin Pool
add bencode utility
13
# The above copyright notice and this permission notice shall be
14
# included in all copies or substantial portions of the Software.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
15
#
3923.4.2 by Andrew Bennetts
Tweaks prompted by John's review.
16
# Modifications copyright (C) 2008 Canonical Ltd
2220.3.1 by Martin Pool
add bencode utility
17
6379.6.3 by Jelmer Vernooij
Use absolute_import.
18
from __future__ import absolute_import
19
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
20
import sys
21
22
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
23
class BDecoder(object):
24
25
    def __init__(self, yield_tuples=False):
26
        """Constructor.
27
28
        :param yield_tuples: if true, decode "l" elements as tuples rather than
29
            lists.
30
        """
31
        self.yield_tuples = yield_tuples
32
        decode_func = {}
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
33
        decode_func[b'l'] = self.decode_list
34
        decode_func[b'd'] = self.decode_dict
35
        decode_func[b'i'] = self.decode_int
36
        decode_func[b'0'] = self.decode_string
37
        decode_func[b'1'] = self.decode_string
38
        decode_func[b'2'] = self.decode_string
39
        decode_func[b'3'] = self.decode_string
40
        decode_func[b'4'] = self.decode_string
41
        decode_func[b'5'] = self.decode_string
42
        decode_func[b'6'] = self.decode_string
43
        decode_func[b'7'] = self.decode_string
44
        decode_func[b'8'] = self.decode_string
45
        decode_func[b'9'] = self.decode_string
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
46
        self.decode_func = decode_func
47
48
    def decode_int(self, x, f):
49
        f += 1
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
50
        newf = x.index(b'e', f)
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
51
        n = int(x[f:newf])
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
52
        if x[f:f+2] == b'-0':
53
            raise ValueError
54
        elif x[f:f+1] == b'0' and newf != f+1:
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
55
            raise ValueError
56
        return (n, newf+1)
57
58
    def decode_string(self, x, f):
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
59
        colon = x.index(b':', f)
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
60
        n = int(x[f:colon])
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
61
        if x[f:f+1] == b'0' and colon != f+1:
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
62
            raise ValueError
63
        colon += 1
64
        return (x[colon:colon+n], colon+n)
65
66
    def decode_list(self, x, f):
67
        r, f = [], f+1
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
68
        while x[f:f+1] != b'e':
69
            v, f = self.decode_func[x[f:f+1]](x, f)
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
70
            r.append(v)
71
        if self.yield_tuples:
72
            r = tuple(r)
73
        return (r, f + 1)
74
75
    def decode_dict(self, x, f):
76
        r, f = {}, f+1
77
        lastkey = None
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
78
        while x[f:f+1] != b'e':
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
79
            k, f = self.decode_string(x, f)
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
80
            if lastkey is not None and lastkey >= k:
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
81
                raise ValueError
82
            lastkey = k
6701.1.1 by Martin
Really fix all bencode behaviour on Python 3
83
            r[k], f = self.decode_func[x[f:f+1]](x, f)
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
84
        return (r, f + 1)
85
86
    def bdecode(self, x):
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
87
        if not isinstance(x, bytes):
2694.5.9 by Jelmer Vernooij
Fix tests.
88
            raise TypeError
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
89
        try:
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
90
            r, l = self.decode_func[x[:1]](x, 0)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
91
        except (IndexError, KeyError, OverflowError) as e:
6621.14.1 by Martin
Remove remaining uses of multi-argument raise
92
            raise ValueError(str(e))
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
93
        if l != len(x):
94
            raise ValueError
95
        return r
96
97
98
_decoder = BDecoder()
99
bdecode = _decoder.bdecode
100
101
_tuple_decoder = BDecoder(True)
3923.4.2 by Andrew Bennetts
Tweaks prompted by John's review.
102
bdecode_as_tuple = _tuple_decoder.bdecode
2220.3.1 by Martin Pool
add bencode utility
103
104
105
class Bencached(object):
106
    __slots__ = ['bencoded']
107
108
    def __init__(self, s):
109
        self.bencoded = s
110
6701.1.2 by Martin
Tidy up some transitional changes in bencode
111
2220.3.1 by Martin Pool
add bencode utility
112
def encode_bencached(x,r):
113
    r.append(x.bencoded)
114
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
115
def encode_bool(x,r):
116
    encode_int(int(x), r)
117
2220.3.1 by Martin Pool
add bencode utility
118
def encode_int(x, r):
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
119
    r.extend((b'i', int_to_bytes(x), b'e'))
2220.3.1 by Martin Pool
add bencode utility
120
121
def encode_string(x, r):
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
122
    r.extend((int_to_bytes(len(x)), b':', x))
123
2220.3.1 by Martin Pool
add bencode utility
124
def encode_list(x, r):
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
125
    r.append(b'l')
2220.3.1 by Martin Pool
add bencode utility
126
    for i in x:
127
        encode_func[type(i)](i, r)
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
128
    r.append(b'e')
2220.3.1 by Martin Pool
add bencode utility
129
130
def encode_dict(x,r):
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
131
    r.append(b'd')
6619.3.18 by Jelmer Vernooij
Run 2to3 idioms fixer.
132
    ilist = sorted(x.items())
2220.3.1 by Martin Pool
add bencode utility
133
    for k, v in ilist:
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
134
        r.extend((int_to_bytes(len(k)), b':', k))
2220.3.1 by Martin Pool
add bencode utility
135
        encode_func[type(v)](v, r)
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
136
    r.append(b'e')
2220.3.1 by Martin Pool
add bencode utility
137
138
encode_func = {}
139
encode_func[type(Bencached(0))] = encode_bencached
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
140
encode_func[int] = encode_int
141
if sys.version_info < (3,):
142
    encode_func[long] = encode_int
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
143
    int_to_bytes = str
144
else:
6701.1.2 by Martin
Tidy up some transitional changes in bencode
145
    def int_to_bytes(n):
146
        return b'%d' % n
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
147
encode_func[bytes] = encode_string
148
encode_func[list] = encode_list
149
encode_func[tuple] = encode_list
150
encode_func[dict] = encode_dict
151
encode_func[bool] = encode_bool
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
152
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
153
from breezy._static_tuple_py import StaticTuple
4848.1.2 by John Arbash Meinel
we need to support the non-extension StaticTuple type.
154
encode_func[StaticTuple] = encode_list
4679.8.10 by John Arbash Meinel
quick patch to allow bencode to handle StaticTuple objects.
155
try:
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
156
    from breezy._static_tuple_c import StaticTuple
4679.8.10 by John Arbash Meinel
quick patch to allow bencode to handle StaticTuple objects.
157
except ImportError:
158
    pass
159
else:
160
    encode_func[StaticTuple] = encode_list
161
2220.3.1 by Martin Pool
add bencode utility
162
163
def bencode(x):
164
    r = []
165
    encode_func[type(x)](x, r)
6681.1.1 by Martin
Switch bencode to bytes types for Python 3
166
    return b''.join(r)
2220.3.1 by Martin Pool
add bencode utility
167