From 16d6e515c6bb096ce3e502302752ca2847fbe890 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adolfo=20G=C3=B3mez=20Garc=C3=ADa?= Date: Mon, 7 Jun 2021 20:57:19 +0200 Subject: [PATCH 1/2] Added "version" method to REST api so we can check UDS Server version easily --- server/src/uds/REST/methods/version.py | 48 ++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 server/src/uds/REST/methods/version.py diff --git a/server/src/uds/REST/methods/version.py b/server/src/uds/REST/methods/version.py new file mode 100644 index 00000000..091df3b8 --- /dev/null +++ b/server/src/uds/REST/methods/version.py @@ -0,0 +1,48 @@ +# -*- coding: utf-8 -*- +# +# Copyright (c) 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 +import typing + +from uds.core import VERSION, VERSION_STAMP + +from ..handlers import Handler + +logger = logging.getLogger(__name__) + +class UDSVersion(Handler): + authenticated = False # Version requests are public + name = 'version' + + def get(self) -> typing.MutableMapping[str, typing.Any]: + return { + 'version': VERSION, + 'build': VERSION_STAMP + } From 610085e353b58ce9e63d32a63b66338a7469651f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adolfo=20G=C3=B3mez=20Garc=C3=ADa?= Date: Mon, 7 Jun 2021 21:01:39 +0200 Subject: [PATCH 2/2] Added UDS-Version as header on response to REST api --- server/src/uds/REST/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/server/src/uds/REST/__init__.py b/server/src/uds/REST/__init__.py index 06d3739c..56d3200e 100644 --- a/server/src/uds/REST/__init__.py +++ b/server/src/uds/REST/__init__.py @@ -32,7 +32,6 @@ import os.path import pkgutil import sys -import time import importlib import logging import typing @@ -41,8 +40,8 @@ from django import http from django.views.generic.base import View from django.views.decorators.csrf import csrf_exempt from django.utils.decorators import method_decorator -from django.utils.translation import ugettext as _, activate -from django.conf import settings +from django.utils.translation import ugettext as _ +from uds.core import VERSION, VERSION_STAMP from .handlers import ( Handler, @@ -151,6 +150,7 @@ class Dispatcher(View): 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