1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
# Copyright 2017 Canonical Ltd.
# Licensed under the LGPLv3, see LICENCE file for details.
import collections
from macaroonbakery.checkers.utils import condition_with_prefix
from macaroonbakery.checkers.caveat import error_caveat
class Namespace:
'''Holds maps from schema URIs to prefixes.
prefixes that are used to encode them in first party
caveats. Several different URIs may map to the same
prefix - this is usual when several different backwardly
compatible schema versions are registered.
'''
def __init__(self, uri_to_prefix=None):
self._uri_to_prefix = {}
if uri_to_prefix is not None:
for k in uri_to_prefix:
self.register(k, uri_to_prefix[k])
def __str__(self):
'''Returns the namespace representation as returned by serialize
:return: str
'''
return self.serialize_text().decode('utf-8')
def __eq__(self, other):
return self._uri_to_prefix == other._uri_to_prefix
def serialize_text(self):
'''Returns a serialized form of the Namepace.
All the elements in the namespace are sorted by
URI, joined to the associated prefix with a colon and
separated with spaces.
:return: bytes
'''
if self._uri_to_prefix is None or len(self._uri_to_prefix) == 0:
return b''
od = collections.OrderedDict(sorted(self._uri_to_prefix.items()))
data = []
for uri in od:
data.append(uri + ':' + od[uri])
return ' '.join(data).encode('utf-8')
def register(self, uri, prefix):
'''Registers the given URI and associates it with the given prefix.
If the URI has already been registered, this is a no-op.
:param uri: string
:param prefix: string
'''
if not is_valid_schema_uri(uri):
raise KeyError(
'cannot register invalid URI {} (prefix {})'.format(
uri, prefix))
if not is_valid_prefix(prefix):
raise ValueError(
'cannot register invalid prefix %q for URI %q'.format(
prefix, uri))
if self._uri_to_prefix.get(uri) is None:
self._uri_to_prefix[uri] = prefix
def resolve(self, uri):
''' Returns the prefix associated to the uri.
returns None if not found.
:param uri: string
:return: string
'''
return self._uri_to_prefix.get(uri)
def resolve_caveat(self, cav):
''' Resolves the given caveat(string) by using resolve to map from its
schema namespace to the appropriate prefix.
If there is no registered prefix for the namespace, it returns an error
caveat.
If cav.namespace is empty or cav.location is non-empty, it returns cav
unchanged.
It does not mutate ns and may be called concurrently with other
non-mutating Namespace methods.
:return: Caveat object
'''
# TODO: If a namespace isn't registered, try to resolve it by
# resolving it to the latest compatible version that is
# registered.
if cav.namespace == '' or cav.location != '':
return cav
prefix = self.resolve(cav.namespace)
if prefix is None:
err_cav = error_caveat(
'caveat {} in unregistered namespace {}'.format(
cav.condition, cav.namespace))
if err_cav.namespace != cav.namespace:
prefix = self.resolve(err_cav.namespace)
if prefix is None:
prefix = ''
cav = err_cav
if prefix != '':
cav.condition = condition_with_prefix(prefix, cav.condition)
cav.namespace = ''
return cav
def is_valid_schema_uri(uri):
'''Reports if uri is suitable for use as a namespace schema URI.
It must be non-empty and it must not contain white space.
:param uri string
:return bool
'''
if len(uri) <= 0:
return False
return uri.find(' ') == -1
def is_valid_prefix(prefix):
'''Reports if prefix is valid.
It must not contain white space or semi-colon.
:param prefix string
:return bool
'''
return prefix.find(' ') == -1 and prefix.find(':') == -1
def deserialize_namespace(data):
''' Deserialize a Namespace object.
:param data: bytes or str
:return: namespace
'''
if isinstance(data, bytes):
data = data.decode('utf-8')
kvs = data.split()
uri_to_prefix = {}
for kv in kvs:
i = kv.rfind(':')
if i == -1:
raise ValueError('no colon in namespace '
'field {}'.format(repr(kv)))
uri, prefix = kv[0:i], kv[i + 1:]
if not is_valid_schema_uri(uri):
# Currently this can't happen because the only invalid URIs
# are those which contain a space
raise ValueError(
'invalid URI {} in namespace '
'field {}'.format(repr(uri), repr(kv)))
if not is_valid_prefix(prefix):
raise ValueError(
'invalid prefix {} in namespace field'
' {}'.format(repr(prefix), repr(kv)))
if uri in uri_to_prefix:
raise ValueError(
'duplicate URI {} in '
'namespace {}'.format(repr(uri), repr(data)))
uri_to_prefix[uri] = prefix
return Namespace(uri_to_prefix)
|
