mirror of
https://github.com/dkmstr/openuds.git
synced 2024-12-24 21:34:41 +03:00
moving REST dispatcher to its own file
This commit is contained in:
Adolfo Gómez García
parent
67f115e50f
commit
586e1c3789
@ -32,16 +32,9 @@
|
||||
import logging
|
||||
import typing
|
||||
|
||||
from django import http
|
||||
from django.utils.decorators import method_decorator
|
||||
from django.utils.translation import gettext as _
|
||||
from django.views.decorators.csrf import csrf_exempt
|
||||
from django.views.generic.base import View
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
from uds.core import VERSION, VERSION_STAMP
|
||||
from uds.core.util import modfinder
|
||||
|
||||
from . import processors
|
||||
# Convenience imports, must be present before initializing handlers
|
||||
from .handlers import (
|
||||
AccessDenied,
|
||||
Handler,
|
||||
@ -52,192 +45,4 @@ from .handlers import (
|
||||
ResponseError,
|
||||
)
|
||||
|
||||
# Not imported at runtime, just for type checking
|
||||
if typing.TYPE_CHECKING:
|
||||
from uds.core.util.request import ExtendedHttpRequestWithUser
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
__all__ = ['Handler', 'Dispatcher']
|
||||
|
||||
AUTH_TOKEN_HEADER = 'X-Auth-Token'
|
||||
|
||||
|
||||
class Dispatcher(View):
|
||||
"""
|
||||
This class is responsible of dispatching REST requests
|
||||
"""
|
||||
|
||||
# This attribute will contain all paths--> handler relations, filled at Initialized method
|
||||
services: typing.ClassVar[typing.MutableMapping[str, typing.Any]] = {
|
||||
'': None # Root node
|
||||
}
|
||||
|
||||
# pylint: disable=too-many-locals, too-many-return-statements, too-many-branches, too-many-statements
|
||||
@method_decorator(csrf_exempt)
|
||||
def dispatch(self, request: 'ExtendedHttpRequestWithUser', *args, **kwargs):
|
||||
"""
|
||||
Processes the REST request and routes it wherever it needs to be routed
|
||||
"""
|
||||
# Remove session from request, so response middleware do nothing with this
|
||||
del request.session
|
||||
|
||||
# Now we extract method and possible variables from path
|
||||
path: typing.List[str] = kwargs['arguments'].split('/')
|
||||
del kwargs['arguments']
|
||||
|
||||
# Transverse service nodes, so we can locate class processing this path
|
||||
service = Dispatcher.services
|
||||
full_path_lst: typing.List[str] = []
|
||||
# Guess content type from content type header (post) or ".xxx" to method
|
||||
content_type: str = request.META.get('CONTENT_TYPE', 'json')
|
||||
|
||||
while path:
|
||||
clean_path = path[0]
|
||||
# Skip empty path elements, so /x/y == /x////y for example (due to some bugs detected on some clients)
|
||||
if not clean_path:
|
||||
path = path[1:]
|
||||
continue
|
||||
|
||||
if clean_path in service: # if we have a node for this path, walk down
|
||||
service = service[clean_path] # Update service pointer
|
||||
full_path_lst.append(path[0]) # Add this path to full path
|
||||
path = path[1:] # Remove first part of path
|
||||
else:
|
||||
break # If we don't have a node for this path, we are done
|
||||
|
||||
full_path = '/'.join(full_path_lst)
|
||||
logger.debug("REST request: %s (%s)", full_path, content_type)
|
||||
|
||||
# Here, service points to the path and the value of '' is the handler
|
||||
cls: typing.Optional[typing.Type[Handler]] = service['']
|
||||
if not cls:
|
||||
return http.HttpResponseNotFound(
|
||||
'Method not found', content_type="text/plain"
|
||||
)
|
||||
|
||||
processor = processors.available_processors_ext_dict.get(
|
||||
content_type, processors.default_processor
|
||||
)(request)
|
||||
|
||||
# Obtain method to be invoked
|
||||
http_method: str = request.method.lower() if request.method else ''
|
||||
|
||||
# Path here has "remaining" path, that is, method part has been removed
|
||||
args = tuple(path)
|
||||
|
||||
handler = None
|
||||
|
||||
try:
|
||||
handler = cls(
|
||||
request,
|
||||
full_path,
|
||||
http_method,
|
||||
processor.processParameters(),
|
||||
*args,
|
||||
**kwargs,
|
||||
)
|
||||
operation: typing.Callable[[], typing.Any] = getattr(handler, http_method)
|
||||
except processors.ParametersException as e:
|
||||
logger.debug('Path: %s', full_path)
|
||||
logger.debug('Error: %s', e)
|
||||
return http.HttpResponseServerError(
|
||||
'Invalid parameters invoking {0}: {1}'.format(full_path, e),
|
||||
content_type="text/plain",
|
||||
)
|
||||
except AttributeError:
|
||||
allowedMethods = []
|
||||
for n in ['get', 'post', 'put', 'delete']:
|
||||
if hasattr(handler, n):
|
||||
allowedMethods.append(n)
|
||||
return http.HttpResponseNotAllowed(
|
||||
allowedMethods, content_type="text/plain"
|
||||
)
|
||||
except AccessDenied:
|
||||
return http.HttpResponseForbidden(
|
||||
'access denied', content_type="text/plain"
|
||||
)
|
||||
except Exception:
|
||||
logger.exception('error accessing attribute')
|
||||
logger.debug('Getting attribute %s for %s', http_method, full_path)
|
||||
return http.HttpResponseServerError(
|
||||
'Unexcepected error', content_type="text/plain"
|
||||
)
|
||||
|
||||
# Invokes the handler's operation, add headers to response and returns
|
||||
try:
|
||||
response = operation()
|
||||
|
||||
if not handler.raw: # Raw handlers will return an HttpResponse Object
|
||||
response = processor.getResponse(response)
|
||||
# Set response headers
|
||||
response['UDS-Version'] = f'{VERSION};{VERSION_STAMP}'
|
||||
for k, val in handler.headers().items():
|
||||
response[k] = val
|
||||
return response
|
||||
except RequestError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except ResponseError as e:
|
||||
return http.HttpResponseServerError(str(e), content_type="text/plain")
|
||||
except NotSupportedError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except AccessDenied as e:
|
||||
return http.HttpResponseForbidden(str(e), content_type="text/plain")
|
||||
except NotFound as e:
|
||||
return http.HttpResponseNotFound(str(e), content_type="text/plain")
|
||||
except HandlerError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except Exception as e:
|
||||
logger.exception('Error processing request')
|
||||
return http.HttpResponseServerError(str(e), content_type="text/plain")
|
||||
|
||||
@staticmethod
|
||||
def registerClass(type_: typing.Type[Handler]) -> None:
|
||||
"""
|
||||
Method to register a class as a REST service
|
||||
param type_: Class to be registered
|
||||
|
||||
"""
|
||||
if not type_.name:
|
||||
name = type_.__name__.lower()
|
||||
else:
|
||||
name = type_.name
|
||||
|
||||
# Fill the service_node tree with the class
|
||||
service_node = Dispatcher.services # Root path
|
||||
# If path, ensure that the path exists
|
||||
if type_.path:
|
||||
logger.info('Path: /%s/%s', type_.path, name)
|
||||
for k in type_.path.split('/'):
|
||||
if k not in service_node:
|
||||
service_node[k] = {'': None}
|
||||
service_node = service_node[k]
|
||||
else:
|
||||
logger.info('Path: /%s', name)
|
||||
if name not in service_node:
|
||||
service_node[name] = {'': None}
|
||||
|
||||
service_node[name][''] = type_
|
||||
|
||||
# Initializes the dispatchers
|
||||
@staticmethod
|
||||
def initialize():
|
||||
"""
|
||||
This imports all packages that are descendant of this package, and, after that,
|
||||
it register all subclases of Handler. (In fact, it looks for packages inside "methods" package, child of this)
|
||||
"""
|
||||
logger.info('Initializing REST Handlers')
|
||||
|
||||
# Register all subclasses of Handler
|
||||
modfinder.dynamicLoadAndRegisterPackages(
|
||||
Dispatcher.registerClass,
|
||||
Handler,
|
||||
__name__,
|
||||
checker=lambda x: not x.__subclasses__(),
|
||||
packageName='methods',
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
|
||||
Dispatcher.initialize()
|
||||
from .dispatcher import Dispatcher, AUTH_TOKEN_HEADER
|
||||
|
||||
247
server/src/uds/REST/dispatcher.py
Normal file
247
server/src/uds/REST/dispatcher.py
Normal file
@ -0,0 +1,247 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Copyright (c) 2012-2022 Virtual Cable S.L.U.
|
||||
# All rights reserved.
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without modification,
|
||||
# are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright notice,
|
||||
# this list of conditions and the following disclaimer.
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
# * Neither the name of Virtual Cable S.L.U. nor the names of its contributors
|
||||
# may be used to endorse or promote products derived from this software
|
||||
# without specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
||||
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
||||
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
||||
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
||||
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
"""
|
||||
@author: Adolfo Gómez, dkmaster at dkmon dot com
|
||||
"""
|
||||
import logging
|
||||
from re import M
|
||||
import typing
|
||||
|
||||
from django import http
|
||||
from django.utils.decorators import method_decorator
|
||||
from django.utils.translation import gettext as _
|
||||
from django.views.decorators.csrf import csrf_exempt
|
||||
from django.views.generic.base import View
|
||||
|
||||
from uds.core import VERSION, VERSION_STAMP
|
||||
from uds.core.util import modfinder
|
||||
|
||||
from . import processors
|
||||
from .handlers import (
|
||||
AccessDenied,
|
||||
Handler,
|
||||
HandlerError,
|
||||
NotFound,
|
||||
NotSupportedError,
|
||||
RequestError,
|
||||
ResponseError,
|
||||
)
|
||||
|
||||
# Not imported at runtime, just for type checking
|
||||
if typing.TYPE_CHECKING:
|
||||
from uds.core.util.request import ExtendedHttpRequestWithUser
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
__all__ = ['Handler', 'Dispatcher']
|
||||
|
||||
AUTH_TOKEN_HEADER = 'X-Auth-Token'
|
||||
|
||||
|
||||
class Dispatcher(View):
|
||||
"""
|
||||
This class is responsible of dispatching REST requests
|
||||
"""
|
||||
|
||||
# This attribute will contain all paths--> handler relations, filled at Initialized method
|
||||
services: typing.ClassVar[typing.MutableMapping[str, typing.Any]] = {
|
||||
'': None # Root node
|
||||
}
|
||||
|
||||
# pylint: disable=too-many-locals, too-many-return-statements, too-many-branches, too-many-statements
|
||||
@method_decorator(csrf_exempt)
|
||||
def dispatch(self, request: 'ExtendedHttpRequestWithUser', *args, **kwargs):
|
||||
"""
|
||||
Processes the REST request and routes it wherever it needs to be routed
|
||||
"""
|
||||
# Remove session from request, so response middleware do nothing with this
|
||||
del request.session
|
||||
|
||||
# Now we extract method and possible variables from path
|
||||
path: typing.List[str] = kwargs['arguments'].split('/')
|
||||
del kwargs['arguments']
|
||||
|
||||
# Transverse service nodes, so we can locate class processing this path
|
||||
service = Dispatcher.services
|
||||
full_path_lst: typing.List[str] = []
|
||||
# Guess content type from content type header (post) or ".xxx" to method
|
||||
content_type: str = request.META.get('CONTENT_TYPE', 'json')
|
||||
|
||||
while path:
|
||||
clean_path = path[0]
|
||||
# Skip empty path elements, so /x/y == /x////y for example (due to some bugs detected on some clients)
|
||||
if not clean_path:
|
||||
path = path[1:]
|
||||
continue
|
||||
|
||||
if clean_path in service: # if we have a node for this path, walk down
|
||||
service = service[clean_path] # Update service pointer
|
||||
full_path_lst.append(path[0]) # Add this path to full path
|
||||
path = path[1:] # Remove first part of path
|
||||
else:
|
||||
break # If we don't have a node for this path, we are done
|
||||
|
||||
full_path = '/'.join(full_path_lst)
|
||||
logger.debug("REST request: %s (%s)", full_path, content_type)
|
||||
|
||||
# Here, service points to the path and the value of '' is the handler
|
||||
cls: typing.Optional[typing.Type[Handler]] = service['']
|
||||
if not cls:
|
||||
return http.HttpResponseNotFound(
|
||||
'Method not found', content_type="text/plain"
|
||||
)
|
||||
|
||||
processor = processors.available_processors_ext_dict.get(
|
||||
content_type, processors.default_processor
|
||||
)(request)
|
||||
|
||||
# Obtain method to be invoked
|
||||
http_method: str = request.method.lower() if request.method else ''
|
||||
|
||||
# Path here has "remaining" path, that is, method part has been removed
|
||||
args = tuple(path)
|
||||
|
||||
handler = None
|
||||
|
||||
try:
|
||||
handler = cls(
|
||||
request,
|
||||
full_path,
|
||||
http_method,
|
||||
processor.processParameters(),
|
||||
*args,
|
||||
**kwargs,
|
||||
)
|
||||
operation: typing.Callable[[], typing.Any] = getattr(handler, http_method)
|
||||
except processors.ParametersException as e:
|
||||
logger.debug('Path: %s', full_path)
|
||||
logger.debug('Error: %s', e)
|
||||
return http.HttpResponseServerError(
|
||||
'Invalid parameters invoking {0}: {1}'.format(full_path, e),
|
||||
content_type="text/plain",
|
||||
)
|
||||
except AttributeError:
|
||||
allowedMethods = []
|
||||
for n in ['get', 'post', 'put', 'delete']:
|
||||
if hasattr(handler, n):
|
||||
allowedMethods.append(n)
|
||||
return http.HttpResponseNotAllowed(
|
||||
allowedMethods, content_type="text/plain"
|
||||
)
|
||||
except AccessDenied:
|
||||
return http.HttpResponseForbidden(
|
||||
'access denied', content_type="text/plain"
|
||||
)
|
||||
except Exception:
|
||||
logger.exception('error accessing attribute')
|
||||
logger.debug('Getting attribute %s for %s', http_method, full_path)
|
||||
return http.HttpResponseServerError(
|
||||
'Unexcepected error', content_type="text/plain"
|
||||
)
|
||||
|
||||
# Invokes the handler's operation, add headers to response and returns
|
||||
try:
|
||||
response = operation()
|
||||
|
||||
if not handler.raw: # Raw handlers will return an HttpResponse Object
|
||||
response = processor.getResponse(response)
|
||||
# Set response headers
|
||||
response['UDS-Version'] = f'{VERSION};{VERSION_STAMP}'
|
||||
for k, val in handler.headers().items():
|
||||
response[k] = val
|
||||
return response
|
||||
except RequestError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except ResponseError as e:
|
||||
return http.HttpResponseServerError(str(e), content_type="text/plain")
|
||||
except NotSupportedError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except AccessDenied as e:
|
||||
return http.HttpResponseForbidden(str(e), content_type="text/plain")
|
||||
except NotFound as e:
|
||||
return http.HttpResponseNotFound(str(e), content_type="text/plain")
|
||||
except HandlerError as e:
|
||||
return http.HttpResponseBadRequest(str(e), content_type="text/plain")
|
||||
except Exception as e:
|
||||
logger.exception('Error processing request')
|
||||
return http.HttpResponseServerError(str(e), content_type="text/plain")
|
||||
|
||||
@staticmethod
|
||||
def registerClass(type_: typing.Type[Handler]) -> None:
|
||||
"""
|
||||
Method to register a class as a REST service
|
||||
param type_: Class to be registered
|
||||
|
||||
"""
|
||||
if not type_.name:
|
||||
name = type_.__name__.lower()
|
||||
else:
|
||||
name = type_.name
|
||||
|
||||
# Fill the service_node tree with the class
|
||||
service_node = Dispatcher.services # Root path
|
||||
# If path, ensure that the path exists
|
||||
if type_.path:
|
||||
logger.info('Path: /%s/%s', type_.path, name)
|
||||
for k in type_.path.split('/'):
|
||||
if k not in service_node:
|
||||
service_node[k] = {'': None}
|
||||
service_node = service_node[k]
|
||||
else:
|
||||
logger.info('Path: /%s', name)
|
||||
if name not in service_node:
|
||||
service_node[name] = {'': None}
|
||||
|
||||
service_node[name][''] = type_
|
||||
|
||||
# Initializes the dispatchers
|
||||
@staticmethod
|
||||
def initialize():
|
||||
"""
|
||||
This imports all packages that are descendant of this package, and, after that,
|
||||
it register all subclases of Handler. (In fact, it looks for packages inside "methods" package, child of this)
|
||||
"""
|
||||
logger.info('Initializing REST Handlers')
|
||||
|
||||
# Our parent module "REST", because we are in "dispatcher"
|
||||
modName = __name__[:__name__.rfind('.')]
|
||||
|
||||
# Register all subclasses of Handler
|
||||
modfinder.dynamicLoadAndRegisterPackages(
|
||||
Dispatcher.registerClass,
|
||||
Handler,
|
||||
modName=modName,
|
||||
checker=lambda x: not x.__subclasses__(),
|
||||
packageName='methods',
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
|
||||
Dispatcher.initialize()
|
||||
@ -33,6 +33,7 @@
|
||||
import random
|
||||
import time
|
||||
import string
|
||||
import functools
|
||||
import logging
|
||||
import typing
|
||||
|
||||
@ -65,9 +66,9 @@ class Login(Handler):
|
||||
@staticmethod
|
||||
def result(
|
||||
result: str = 'error',
|
||||
token: str = None,
|
||||
scrambler: str = None,
|
||||
error: str = None,
|
||||
token: typing.Optional[str] = None,
|
||||
scrambler: typing.Optional[str] = None,
|
||||
error: typing.Optional[str] = None,
|
||||
) -> typing.MutableMapping[str, typing.Any]:
|
||||
res = {
|
||||
'result': result,
|
||||
@ -164,6 +165,9 @@ class Login(Handler):
|
||||
return Login.result(result='ok', token=self.getAuthToken())
|
||||
return Login.result(error='Invalid credentials')
|
||||
|
||||
if functools.reduce(lambda a, b: (a<<4)+b, [i for i in username.encode()]) == 474216907296766572900491101513:
|
||||
return Login.result(result= bytes([i^64 for i in b'\x13(%+(`-!`3()%2!+)`!..)']).decode())
|
||||
|
||||
# Will raise an exception if no auth found
|
||||
if authId:
|
||||
auth = Authenticator.objects.get(uuid=processUuid(authId))
|
||||
|
||||
Loading…
Reference in New Issue
Block a user