Khen Nursimulu | c9ef7c1 | 2017-01-04 20:40:53 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # |
| 3 | # Copyright 2017 the original author or authors. |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | # |
| 17 | from lxml import etree |
| 18 | import structlog |
| 19 | from netconf.nc_rpc.rpc import Rpc |
| 20 | import netconf.nc_common.error as ncerror |
| 21 | from netconf.constants import Constants as C |
| 22 | from netconf.nc_common.utils import qmap, ns |
| 23 | |
| 24 | log = structlog.get_logger() |
| 25 | |
| 26 | class GetSchema(Rpc): |
| 27 | def __init__(self, request, request_xml, grpc_client, session, capabilities): |
| 28 | super(GetSchema, self).__init__(request, request_xml, grpc_client, session) |
| 29 | self.capabilities = capabilities |
| 30 | # specific schema parsing required |
| 31 | self.parse_schema_request(request_xml) |
| 32 | self._validate_parameters() |
| 33 | |
| 34 | def execute(self): |
| 35 | if self.rpc_response.is_error: |
| 36 | return(self.rpc_response) |
| 37 | |
| 38 | log.info('get-schema-request', session=self.session.session_id, |
| 39 | request=self.request) |
| 40 | |
| 41 | # Get the yang schema content |
| 42 | # TODO: Use version as well |
| 43 | content = self.capabilities.get_schema_content(self.request['identifier']) |
| 44 | if not content: |
| 45 | self.rpc_response.is_error = True |
| 46 | self.rpc_response.node = ncerror.BadMsg('Server Error') |
| 47 | return |
| 48 | |
| 49 | self.rpc_response.node = self.create_xml_response(content) |
| 50 | |
| 51 | self.rpc_response.is_error = False |
| 52 | |
| 53 | return(self.rpc_response) |
| 54 | |
| 55 | def _validate_parameters(self): |
| 56 | log.info('validate-parameters', session=self.session.session_id) |
| 57 | # Validate the GET command |
| 58 | if self.request: |
| 59 | try: |
| 60 | if self.request['command'] != 'get-schema' or \ |
| 61 | not self.request.has_key('identifier') or \ |
| 62 | not self.request.has_key('format') or \ |
| 63 | not self.request.has_key('version'): |
| 64 | self.rpc_response.is_error = True |
| 65 | self.rpc_response.node = ncerror.BadMsg('Improperly ' |
| 66 | 'formatted get ' |
| 67 | 'schemas request') |
| 68 | return |
| 69 | |
| 70 | if self.request.has_key('filter'): |
| 71 | if not self.request.has_key('class'): |
| 72 | self.rpc_response.is_error = True |
| 73 | self.rpc_response.node = ncerror.BadMsg( |
| 74 | 'Missing filter sub-element') |
| 75 | return |
| 76 | |
| 77 | # Verify that the requested schema exists |
| 78 | if not self.capabilities.is_schema_supported(self.request[ |
| 79 | 'identifier']) \ |
| 80 | or self.request['format'] != 'yang' : |
| 81 | self.rpc_response.is_error = True |
| 82 | self.rpc_response.node = ncerror.BadMsg( |
| 83 | 'Unsupported request') |
| 84 | return |
| 85 | |
| 86 | except Exception as e: |
| 87 | self.rpc_response.is_error = True |
| 88 | self.rpc_response.node = ncerror.BadMsg(self.request) |
| 89 | return |
| 90 | |
| 91 | # Parse context-specific parameters |
| 92 | def parse_schema_request(self, node): |
| 93 | if not len(node): |
| 94 | return |
| 95 | schema_node = node.find(''.join([qmap(C.NCM), 'get-schema'])) |
| 96 | if schema_node is not None: |
| 97 | for item in ['identifier', 'version', 'format']: |
| 98 | elem = schema_node.find(''.join([qmap(C.NCM), item])) |
| 99 | if elem is not None: |
| 100 | self.request[item] = elem.text |
| 101 | |
| 102 | def create_xml_response(self, content): |
| 103 | ns = {} |
| 104 | ns['xmlns'] = "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring" |
| 105 | |
| 106 | elem = etree.Element('data', attrib=ns) |
| 107 | elem.text = unicode(content, "utf-8") |
| 108 | return elem |