blob: d51942c0891a18d6d5262757162176f5ca1ff5a7 [file] [log] [blame]
Khen Nursimulua7b842a2016-12-03 23:28:42 -05001#!/usr/bin/env python
2#
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -05003# Copyright 2017 the original author or authors.
Khen Nursimulua7b842a2016-12-03 23:28:42 -05004#
5# Code adapted from https://github.com/choppsv1/netconf
6#
7# Licensed under the Apache License, Version 2.0 (the "License");
8# you may not use this file except in compliance with the License.
9# You may obtain a copy of the License at
10#
11# http://www.apache.org/licenses/LICENSE-2.0
12#
13# Unless required by applicable law or agreed to in writing, software
14# distributed under the License is distributed on an "AS IS" BASIS,
15# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16# See the License for the specific language governing permissions and
17# limitations under the License.
18#
19import structlog
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050020from netconf.constants import Constants as C
Khen Nursimulua7b842a2016-12-03 23:28:42 -050021from base.commit import Commit
22from base.copy_config import CopyConfig
23from base.delete_config import DeleteConfig
Khen Nursimulua7b842a2016-12-03 23:28:42 -050024from base.edit_config import EditConfig
25from base.get import Get
26from base.get_config import GetConfig
27from base.lock import Lock
28from base.unlock import UnLock
29from base.close_session import CloseSession
30from base.kill_session import KillSession
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050031from ext.get_schemas import GetSchemas
32from ext.get_schema import GetSchema
Khen Nursimuluaaac7ee2016-12-11 22:03:52 -050033from ext.get_voltha import GetVoltha
Khen Nursimulua7b842a2016-12-03 23:28:42 -050034import netconf.nc_common.error as ncerror
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050035from netconf.nc_common.utils import qmap, ns
Khen Nursimulu3b212942016-12-12 23:09:53 -050036from lxml import etree
37
Khen Nursimulua4972742016-12-23 17:15:20 -050038
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050039log = structlog.get_logger()
Khen Nursimulua7b842a2016-12-03 23:28:42 -050040
41class RpcFactory:
Khen Nursimulue0d53f82016-12-14 11:05:44 -080042 instance = None
Khen Nursimulua7b842a2016-12-03 23:28:42 -050043
Khen Nursimulue0d53f82016-12-14 11:05:44 -080044 def __init__(self):
Khen Nursimuluc7991dd2017-01-05 17:05:48 -050045 pass
Khen Nursimulua7b842a2016-12-03 23:28:42 -050046
Khen Nursimulue0d53f82016-12-14 11:05:44 -080047 def _get_key(self, namespace, service, name):
48 return ''.join([namespace, service, name])
Khen Nursimulu3b212942016-12-12 23:09:53 -050049
Khen Nursimulua4972742016-12-23 17:15:20 -050050 def get_attribute_value(self, name, attributes):
51 for tup in attributes.items():
52 if tup[0] == name:
53 return tup[1]
54
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050055
Khen Nursimulua4972742016-12-23 17:15:20 -050056 # Parse a request (node is an ElementTree) and return a dictionary
Khen Nursimuluc7991dd2017-01-05 17:05:48 -050057 # TODO: This parser is specific for a GET/GET SCHEMAS request. Need to be
58 # it more generic
Khen Nursimulua4972742016-12-23 17:15:20 -050059 def parse_xml_request(self, node):
60 request = {}
61 if not len(node):
62 return request
63 for elem in node.iter():
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050064 if elem.tag.find(qmap(C.NC)) != -1: # found
65 elem_name = elem.tag.replace(qmap(C.NC), "")
Khen Nursimulua4972742016-12-23 17:15:20 -050066 if elem_name == 'rpc':
67 request['type'] = 'rpc'
68 request['message_id'] = self.get_attribute_value(
69 'message-id', elem.attrib)
70 elif elem_name == 'filter':
71 request['filter'] = self.get_attribute_value('type',
72 elem.attrib)
73 else:
Khen Nursimulu5b7b3fb2017-01-13 16:00:00 -050074 request['command'] = elem_name # attribute is empty for now
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050075 elif elem.tag.find(qmap(C.VOLTHA)) != -1: # found
76 request['namespace'] = ns(C.VOLTHA)
Khen Nursimulua4972742016-12-23 17:15:20 -050077 if request.has_key('class'):
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050078 request['subclass'] = elem.tag.replace(qmap(C.VOLTHA),"")
Khen Nursimulua4972742016-12-23 17:15:20 -050079 else:
Khen Nursimulu5b7b3fb2017-01-13 16:00:00 -050080 elem_name = elem.tag.replace(qmap(C.VOLTHA), "")
81 request['class'] = elem_name
82 if not request.has_key('command'):
83 request['command'] = elem_name
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050084 elif elem.tag.find(qmap(C.NCM)) != -1: # found
85 request['namespace'] = ns(C.NCM)
86 elem_name = elem.tag.replace(qmap(C.NCM), "")
87 if elem_name == 'get-schema':
88 request['command'] = elem_name
89 request['class'] = elem_name
90 elif request.has_key('class'):
91 request['subclass'] = elem_name
92 elif elem_name == 'netconf-state':
93 request['command'] = 'get-schemas'
94 request['class'] = elem_name
95
Khen Nursimulua4972742016-12-23 17:15:20 -050096 return request
97
Khen Nursimulu3b212942016-12-12 23:09:53 -050098
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -050099 def get_rpc_handler(self, rpc_node, msg, grpc_channel, session,
100 capabilities):
Khen Nursimulue0d53f82016-12-14 11:05:44 -0800101 try:
Khen Nursimulua4972742016-12-23 17:15:20 -0500102 # Parse the request into a dictionary
103 log.info("rpc-node",
104 node=etree.tostring(rpc_node, pretty_print=True))
Khen Nursimulu3b212942016-12-12 23:09:53 -0500105
Khen Nursimulua4972742016-12-23 17:15:20 -0500106 request = self.parse_xml_request(rpc_node)
107 if not request:
108 log.error("request-bad-format")
109 raise ncerror.BadMsg(rpc_node)
Khen Nursimulu3b212942016-12-12 23:09:53 -0500110
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -0500111 log.info("parsed-request", request=request)
112
113 if not request.has_key('message_id'):
Khen Nursimulua4972742016-12-23 17:15:20 -0500114 log.error("request-no-message-id")
115 raise ncerror.BadMsg(rpc_node)
Khen Nursimulua7b842a2016-12-03 23:28:42 -0500116
Khen Nursimulua4972742016-12-23 17:15:20 -0500117 class_handler = self.rpc_class_handlers.get(request['command'],
118 None)
119 if class_handler is not None:
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -0500120 return class_handler(request, rpc_node, grpc_channel, session,
121 capabilities)
Khen Nursimulua4972742016-12-23 17:15:20 -0500122
123 log.error("rpc-not-implemented", rpc=request['command'])
124
Khen Nursimulu5b7b3fb2017-01-13 16:00:00 -0500125
Khen Nursimuluc7991dd2017-01-05 17:05:48 -0500126 except ncerror.BadMsg as err:
127 log.info('ncerror.BadMsg')
Khen Nursimulue0d53f82016-12-14 11:05:44 -0800128 raise ncerror.BadMsg(rpc_node)
Khen Nursimulua7b842a2016-12-03 23:28:42 -0500129
Khen Nursimuluc7991dd2017-01-05 17:05:48 -0500130 except Exception as e:
131 raise ncerror.ServerException(rpc_node, exception=e)
132
Khen Nursimulue0d53f82016-12-14 11:05:44 -0800133 rpc_class_handlers = {
134 'getvoltha': GetVoltha,
135 'get-config': GetConfig,
136 'get': Get,
Khen Nursimuluc9ef7c12017-01-04 20:40:53 -0500137 'get-schemas': GetSchemas,
138 'get-schema': GetSchema,
Khen Nursimulue0d53f82016-12-14 11:05:44 -0800139 'edit-config': EditConfig,
140 'copy-config': CopyConfig,
141 'delete-config': DeleteConfig,
142 'commit': Commit,
143 'lock': Lock,
144 'unlock': UnLock,
145 'close-session': CloseSession,
146 'kill-session': KillSession
147 }
Khen Nursimulua7b842a2016-12-03 23:28:42 -0500148
Khen Nursimulu3b212942016-12-12 23:09:53 -0500149
Khen Nursimulua7b842a2016-12-03 23:28:42 -0500150def get_rpc_factory_instance():
Khen Nursimulue0d53f82016-12-14 11:05:44 -0800151 if RpcFactory.instance == None:
152 RpcFactory.instance = RpcFactory()
153 return RpcFactory.instance