/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 = {}
33
        decode_func['l'] = self.decode_list
34
        decode_func['d'] = self.decode_dict
35
        decode_func['i'] = self.decode_int
36
        decode_func['0'] = self.decode_string
37
        decode_func['1'] = self.decode_string
38
        decode_func['2'] = self.decode_string
39
        decode_func['3'] = self.decode_string
40
        decode_func['4'] = self.decode_string
41
        decode_func['5'] = self.decode_string
42
        decode_func['6'] = self.decode_string
43
        decode_func['7'] = self.decode_string
44
        decode_func['8'] = self.decode_string
45
        decode_func['9'] = self.decode_string
46
        self.decode_func = decode_func
47
48
    def decode_int(self, x, f):
49
        f += 1
50
        newf = x.index('e', f)
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
51
        n = int(x[f:newf])
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
52
        if x[f] == '-':
53
            if x[f + 1] == '0':
54
                raise ValueError
55
        elif x[f] == '0' and newf != f+1:
56
            raise ValueError
57
        return (n, newf+1)
58
59
    def decode_string(self, x, f):
60
        colon = x.index(':', f)
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
61
        n = int(x[f:colon])
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
62
        if x[f] == '0' and colon != f+1:
63
            raise ValueError
64
        colon += 1
65
        return (x[colon:colon+n], colon+n)
66
67
    def decode_list(self, x, f):
68
        r, f = [], f+1
69
        while x[f] != 'e':
70
            v, f = self.decode_func[x[f]](x, f)
71
            r.append(v)
72
        if self.yield_tuples:
73
            r = tuple(r)
74
        return (r, f + 1)
75
76
    def decode_dict(self, x, f):
77
        r, f = {}, f+1
78
        lastkey = None
79
        while x[f] != 'e':
80
            k, f = self.decode_string(x, f)
81
            if lastkey >= k:
82
                raise ValueError
83
            lastkey = k
84
            r[k], f = self.decode_func[x[f]](x, f)
85
        return (r, f + 1)
86
87
    def bdecode(self, x):
6621.18.1 by Martin
Remove or fix use of long type and nearby type issues
88
        if not isinstance(x, bytes):
2694.5.9 by Jelmer Vernooij
Fix tests.
89
            raise TypeError
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
90
        try:
91
            r, l = self.decode_func[x[0]](x, 0)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
92
        except (IndexError, KeyError, OverflowError) as e:
6621.14.1 by Martin
Remove remaining uses of multi-argument raise
93
            raise ValueError(str(e))
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
94
        if l != len(x):
95
            raise ValueError
96
        return r
97
98
99
_decoder = BDecoder()
100
bdecode = _decoder.bdecode
101
102
_tuple_decoder = BDecoder(True)
3923.4.2 by Andrew Bennetts
Tweaks prompted by John's review.
103
bdecode_as_tuple = _tuple_decoder.bdecode
2220.3.1 by Martin Pool
add bencode utility
104
105
106
class Bencached(object):
107
    __slots__ = ['bencoded']
108
109
    def __init__(self, s):
110
        self.bencoded = s
111
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):
119
    r.extend(('i', str(x), 'e'))
120
121
def encode_string(x, r):
122
    r.extend((str(len(x)), ':', x))
123
124
def encode_list(x, r):
125
    r.append('l')
126
    for i in x:
127
        encode_func[type(i)](i, r)
128
    r.append('e')
129
130
def encode_dict(x,r):
131
    r.append('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:
134
        r.extend((str(len(k)), ':', k))
135
        encode_func[type(v)](v, r)
136
    r.append('e')
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
143
encode_func[bytes] = encode_string
144
encode_func[list] = encode_list
145
encode_func[tuple] = encode_list
146
encode_func[dict] = encode_dict
147
encode_func[bool] = encode_bool
3923.4.1 by Andrew Bennetts
Fix encoding of bools, provide a bdecode_tuple function.
148
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
149
from breezy._static_tuple_py import StaticTuple
4848.1.2 by John Arbash Meinel
we need to support the non-extension StaticTuple type.
150
encode_func[StaticTuple] = encode_list
4679.8.10 by John Arbash Meinel
quick patch to allow bencode to handle StaticTuple objects.
151
try:
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
152
    from breezy._static_tuple_c import StaticTuple
4679.8.10 by John Arbash Meinel
quick patch to allow bencode to handle StaticTuple objects.
153
except ImportError:
154
    pass
155
else:
156
    encode_func[StaticTuple] = encode_list
157
2220.3.1 by Martin Pool
add bencode utility
158
159
def bencode(x):
160
    r = []
161
    encode_func[type(x)](x, r)
162
    return ''.join(r)
163