-
Notifications
You must be signed in to change notification settings - Fork 592
/
models.py
444 lines (313 loc) · 13.4 KB
/
models.py
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
"""
Copyright 2020 The Magma Authors.
This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
from spyne.model import ComplexModel
from spyne.model.complex import XmlAttribute, XmlData
from spyne.model.primitive import (
Boolean,
DateTime,
Integer,
String,
UnsignedInteger,
)
from spyne.util.odict import odict
# Namespaces
XSI_NS = 'http://www.w3.org/2001/XMLSchema-instance'
SOAP_ENV = 'http://schemas.xmlsoap.org/soap/envelope/'
SOAP_ENC = 'http://schemas.xmlsoap.org/soap/encoding/'
CWMP_NS = 'urn:dslforum-org:cwmp-1-0'
class Tr069ComplexModel(ComplexModel):
""" Base class for TR-069 models, to set common attributes. Does not appear
in CWMP XSD file. """
__namespace__ = CWMP_NS
def as_dict(self):
"""
Overriding default implementation to fix memory leak. Can remove if
or after https://github.com/arskom/spyne/pull/579 lands.
"""
flat_type_info = self.get_flat_type_info(self.__class__)
return dict((
(k, getattr(self, k)) for k in flat_type_info
if getattr(self, k) is not None
))
class anySimpleType(Tr069ComplexModel):
""" Type used to transfer simple data of various types. Data type is
defined in 'type' XML attribute. Data is handled as a string. """
_type_info = odict()
_type_info["type"] = XmlAttribute(String, ns=XSI_NS)
_type_info["Data"] = XmlData(String)
def __repr__(self):
"""For types we can't resolve only print the datum"""
return self.Data
# SOAP Header Elements
class ID(Tr069ComplexModel):
# Note: for some reason, XmlAttribute/XmlData pairs MUST be ordered, with
# XmlAttribute coming first. This appears to be a spyne bug (something to do
# with spyne.interface._base.add_class())
_type_info = odict()
_type_info["mustUnderstand"] = XmlAttribute(String, ns=SOAP_ENV)
_type_info["Data"] = XmlData(String)
class HoldRequests(Tr069ComplexModel):
_type_info = odict()
_type_info["mustUnderstand"] = XmlAttribute(String, ns=SOAP_ENV)
_type_info["Data"] = XmlData(Boolean)
# SOAP Fault Extensions
class SetParameterValuesFault(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterName"] = String
_type_info["FaultCode"] = UnsignedInteger
_type_info["FaultString"] = String
class Fault(Tr069ComplexModel):
_type_info = odict()
_type_info["FaultCode"] = UnsignedInteger
_type_info["FaultString"] = String
_type_info["SetParameterValuesFault"] = SetParameterValuesFault.customize(
max_occurs='unbounded',
)
# Type definitions used in messages
class MethodList(Tr069ComplexModel):
_type_info = odict()
_type_info["string"] = String(max_length=64, max_occurs='unbounded')
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class FaultStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["FaultCode"] = Integer
_type_info["FaultString"] = String(max_length=256)
class DeviceIdStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["Manufacturer"] = String(max_length=64)
_type_info["OUI"] = String(length=6)
_type_info["ProductClass"] = String(max_length=64)
_type_info["SerialNumber"] = String(max_length=64)
class EventStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["EventCode"] = String(max_length=64)
_type_info["CommandKey"] = String(max_length=32)
class EventList(Tr069ComplexModel):
_type_info = odict()
_type_info["EventStruct"] = EventStruct.customize(max_occurs='unbounded')
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class ParameterValueStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["Name"] = String
_type_info["Value"] = anySimpleType
class ParameterValueList(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterValueStruct"] = ParameterValueStruct.customize(
max_occurs='unbounded',
)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class ParameterInfoStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["Name"] = String(max_length=256)
_type_info["Writable"] = Boolean
class ParameterInfoList(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterInfoStruct"] = ParameterInfoStruct.customize(max_occurs='unbounded')
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class ParameterNames(Tr069ComplexModel):
_type_info = odict()
_type_info["string"] = String.customize(max_occurs='unbounded', max_length=256)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class ParameterKeyType(String.customize(max_length=32)):
pass
class AccessList(Tr069ComplexModel):
_type_info = odict()
_type_info["string"] = String.customize(max_occurs='unbounded', max_length=64)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class SetParameterAttributesStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["Name"] = String(max_length=256)
_type_info["NotificationChange"] = Boolean
_type_info["Notification"] = Integer
_type_info["AccessListChange"] = Boolean
_type_info["AccessList"] = AccessList
class SetParameterAttributesList(Tr069ComplexModel):
_type_info = odict()
_type_info["SetParameterAttributesStruct"] = SetParameterAttributesStruct.customize(
max_occurs='unbounded',
)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class ParameterAttributeStruct(Tr069ComplexModel):
_type_info = odict()
_type_info["Name"] = String(max_length=256)
_type_info["Notification"] = Integer
_type_info["AccessList"] = AccessList
class ParameterAttributeList(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterValueStruct"] = ParameterAttributeStruct.customize(
max_occurs='unbounded',
)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
class CommandKeyType(String.customize(max_length=32)):
pass
class ObjectNameType(String.customize(max_length=256)):
pass
# CPE messages
class SetParameterValues(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterList"] = ParameterValueList
_type_info["ParameterKey"] = ParameterKeyType
class SetParameterValuesResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["Status"] = Integer
class GetParameterValues(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterNames"] = ParameterNames
class GetParameterValuesResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterList"] = ParameterValueList
class GetParameterNames(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterPath"] = String.customize(max_length=256)
_type_info["NextLevel"] = Boolean
class GetParameterNamesResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterList"] = ParameterInfoList
class SetParameterAttributes(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterList"] = SetParameterAttributesList
class SetParameterAttributesResponse(Tr069ComplexModel):
# Dummy field required because spyne does not allow 'bare' RPC function with
# no input parameters. This field is never sent by CPE.
_type_info = odict()
_type_info["DummyField"] = UnsignedInteger
class GetParameterAttributes(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterNames"] = ParameterNames
class GetParameterAttributesResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["ParameterList"] = ParameterAttributeList
class AddObject(Tr069ComplexModel):
_type_info = odict()
_type_info["ObjectName"] = ObjectNameType
_type_info["ParameterKey"] = ParameterKeyType
class AddObjectResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["InstanceNumber"] = UnsignedInteger
_type_info["Status"] = Integer
class DeleteObject(Tr069ComplexModel):
_type_info = odict()
_type_info["ObjectName"] = ObjectNameType
_type_info["ParameterKey"] = ParameterKeyType
class DeleteObjectResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["Status"] = Integer
class Download(Tr069ComplexModel):
_type_info = odict()
_type_info["CommandKey"] = CommandKeyType
_type_info["FileType"] = String(max_length=64)
_type_info["URL"] = String(max_length=256)
_type_info["Username"] = String(max_length=256)
_type_info["Password"] = String(max_length=256)
_type_info["FileSize"] = UnsignedInteger
_type_info["TargetFileName"] = String(max_length=256)
_type_info["DelaySeconds"] = UnsignedInteger
_type_info["SuccessURL"] = String(max_length=256)
_type_info["FailureURL"] = String(max_length=256)
class DownloadResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["Status"] = Integer
_type_info["StartTime"] = DateTime
_type_info["CompleteTime"] = DateTime
class Reboot(Tr069ComplexModel):
_type_info = odict()
_type_info["CommandKey"] = CommandKeyType
class RebootResponse(Tr069ComplexModel):
# Dummy field required because spyne does not allow 'bare' RPC function with
# no input parameters. This field is never sent by CPE.
_type_info = odict()
_type_info["DummyField"] = UnsignedInteger
# ACS messages
class Inform(Tr069ComplexModel):
_type_info = odict()
_type_info["DeviceId"] = DeviceIdStruct
_type_info["Event"] = EventList
_type_info["MaxEnvelopes"] = UnsignedInteger
_type_info["CurrentTime"] = DateTime
_type_info["RetryCount"] = UnsignedInteger
_type_info["ParameterList"] = ParameterValueList
class InformResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["MaxEnvelopes"] = UnsignedInteger
class TransferComplete(Tr069ComplexModel):
_type_info = odict()
_type_info["CommandKey"] = CommandKeyType
_type_info["FaultStruct"] = FaultStruct
_type_info["StartTime"] = DateTime
_type_info["CompleteTime"] = DateTime
class TransferCompleteResponse(Tr069ComplexModel):
# Dummy field required because spyne does not allow 'bare' RPC function with
# no input parameters. This field is never sent by ACS.
_type_info = odict()
_type_info["DummyField"] = UnsignedInteger
class GetRPCMethods(Tr069ComplexModel):
_type_info = odict()
_type_info["DummyField"] = UnsignedInteger
class GetRPCMethodsResponse(Tr069ComplexModel):
_type_info = odict()
_type_info["MethodList"] = MethodList
#
# Miscellaneous
#
class ParameterListUnion(Tr069ComplexModel):
""" Union of structures that get instantiated as 'ParameterList' in ACS->CPE
messages. This is required because AcsToCpeRequests can only have one
parameter named 'ParameterList', so that must also be a union """
_type_info = odict()
# Fields from ParameterValueList
_type_info["ParameterValueStruct"] = ParameterValueStruct.customize(
max_occurs='unbounded',
)
_type_info["arrayType"] = XmlAttribute(String, ns=SOAP_ENC)
# Fields from SetParameterAttributesList
_type_info["SetParameterAttributesStruct"] = \
SetParameterAttributesStruct.customize(max_occurs='unbounded')
# arrayType = XmlAttribute(String, ns=SOAP_ENC) - Already covered above
class AcsToCpeRequests(Tr069ComplexModel):
""" Union of all ACS->CPE requests. Only fields for one request is populated
per message instance """
_type_info = odict()
# Fields for SetParameterValues
_type_info["ParameterList"] = ParameterListUnion # See ParameterListUnion for explanation
_type_info["ParameterKey"] = ParameterKeyType
# Fields for GetParameterValues
# _type_info["ParameterList"] = ParameterValueList - Already covered above
# Fields for GetParameterNames
_type_info["ParameterPath"] = String.customize(max_length=256)
_type_info["NextLevel"] = Boolean
# Fields for SetParameterAttributes
# _type_info["ParameterList"] = SetParameterAttributesList - Already covered above
# Fields for GetParameterAttributes
_type_info["ParameterNames"] = ParameterNames
# Fields for AddObject
_type_info["ObjectName"] = ObjectNameType
_type_info["ParameterKey"] = ParameterKeyType
# Fields for DeleteObject
# _type_info["ObjectName"] = ObjectNameType - Already covered above
# _type_info["ParameterKey"] = ParameterKeyType - Already covered above
# Fields for Download
_type_info["CommandKey"] = CommandKeyType
_type_info["FileType"] = String(max_length=64)
_type_info["URL"] = String(max_length=256)
_type_info["Username"] = String(max_length=256)
_type_info["Password"] = String(max_length=256)
_type_info["FileSize"] = UnsignedInteger
_type_info["TargetFileName"] = String(max_length=256)
_type_info["DelaySeconds"] = UnsignedInteger
_type_info["SuccessURL"] = String(max_length=256)
_type_info["FailureURL"] = String(max_length=256)
# Fields for Reboot
# _type_info["CommandKey"] = CommandKeyType - Already covered above
class DummyInput(Tr069ComplexModel):
""" Dummy complex model. Used for 'EmptyHttp' function, because spyne Does
not handle 'bare' function with no inputs """
_type_info = odict()
_type_info["DummyField"] = UnsignedInteger