geonode-pycsw 3.0.0b2__py3-none-any.whl

pycsw/ogc/api/util.py

@@ -0,0 +1,252 @@
+# -*- coding: utf-8 -*-
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#          Angelos Tzotsos <tzotsos@gmail.com>
+#
+# Copyright (c) 2024 Tom Kralidis
+# Copyright (c) 2021 Angelos Tzotsos
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================
+
+import base64
+from datetime import date, datetime, time
+from decimal import Decimal
+import json
+import logging
+import mimetypes
+import os
+import pathlib
+import re
+from typing import Union
+
+from dateutil.parser import parse as dparse
+from jinja2 import Environment, FileSystemLoader
+from jinja2.exceptions import TemplateNotFound
+import yaml
+
+from pycsw import __version__
+
+LOGGER = logging.getLogger(__name__)
+
+DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S.%fZ'
+
+TEMPLATES = f'{os.path.dirname(os.path.realpath(__file__))}{os.sep}templates'
+
+STATIC = f'{TEMPLATES}/static'
+
+mimetypes.add_type('text/plain', '.yaml')
+mimetypes.add_type('text/plain', '.yml')
+
+
+def get_typed_value(value):
+    """
+    Derive true type from data value
+    :param value: value
+    :returns: value as a native Python data type
+    """
+
+    try:
+        if '.' in value:  # float?
+            value2 = float(value)
+        elif len(value) > 1 and value.startswith('0'):
+            value2 = value
+        else:  # int?
+            value2 = int(value)
+    except ValueError:  # string (default)?
+        value2 = value
+
+    return value2
+
+
+def json_serial(obj):
+    """
+    helper function to convert to JSON non-default
+    types (source: https://stackoverflow.com/a/22238613)
+
+    :param obj: `object` to be evaluated
+
+    :returns: JSON non-default type to `str`
+    """
+
+    if isinstance(obj, (datetime, date, time)):
+        if isinstance(obj, date):
+            return obj.strftime('%Y-%m-%d')
+        else:
+            return obj.isoformat() + 'Z'
+    elif isinstance(obj, bytes):
+        try:
+            LOGGER.debug('Returning as UTF-8 decoded bytes')
+            return obj.decode('utf-8')
+        except UnicodeDecodeError:
+            LOGGER.debug('Returning as base64 encoded JSON object')
+            return base64.b64encode(obj)
+    elif isinstance(obj, Decimal):
+        return float(obj)
+
+    msg = f'{obj} type {type(obj)} not serializable'
+    LOGGER.error(msg)
+    raise TypeError(msg)
+
+
+def match_env_var(value):
+    path_matcher = re.compile(r'.*\$\{([^}^{]+)\}.*')
+    env_var = path_matcher.match(value).group(1)
+    if env_var not in os.environ:
+        raise EnvironmentError('Undefined environment variable in config')
+
+    return env_var
+
+
+def yaml_load(fh):
+    """
+    serializes a YAML files into a pyyaml object
+
+    :param fh: file handle
+
+    :returns: `dict` representation of YAML
+    """
+
+    # support environment variables in config
+    # https://stackoverflow.com/a/55301129
+    path_matcher = re.compile(r'.*\$\{([^}^{]+)\}.*')
+
+    def path_constructor(loader, node):
+        env_var = path_matcher.match(node.value).group(1)
+        if env_var not in os.environ:
+            raise EnvironmentError('Undefined environment variable in config')
+        return get_typed_value(os.path.expandvars(node.value))
+
+    class EnvVarLoader(yaml.SafeLoader):
+        pass
+
+    EnvVarLoader.add_implicit_resolver('!path', path_matcher, None)
+    EnvVarLoader.add_constructor('!path', path_constructor)
+
+    return yaml.load(fh, Loader=EnvVarLoader)
+
+
+def yaml_dump(dict_: dict, destfile: str) -> bool:
+    """
+    Dump dict to YAML file
+
+    :param dict_: `dict` to dump
+    :param destfile: destination filepath
+
+    :returns: `bool`
+    """
+
+    def path_representer(dumper, data):
+        return dumper.represent_scalar(u'tag:yaml.org,2002:str', str(data))
+
+    yaml.add_multi_representer(pathlib.PurePath, path_representer)
+
+    LOGGER.debug('Dumping YAML document')
+    with open(destfile, 'wb') as fh:
+        yaml.dump(dict_, fh, sort_keys=False, encoding='utf8', indent=4,
+                  default_flow_style=False)
+
+    return True
+
+
+def to_json(dict_, pretty=False):
+    """
+    Serialize dict to json
+
+    :param dict_: `dict` of JSON representation
+    :param pretty: `bool` of whether to prettify JSON (default is `False`)
+
+    :returns: JSON string representation
+    """
+
+    if pretty:
+        indent = 4
+    else:
+        indent = None
+
+    return json.dumps(dict_, default=json_serial,
+                      indent=indent)
+
+
+def render_j2_template(config, template, data):
+    """
+    render Jinja2 template
+
+    :param config: dict of configuration
+    :param template: template (relative path)
+    :param data: dict of data
+
+    :returns: string of rendered template
+    """
+
+    custom_templates = False
+    try:
+        templates_path = config['server']['templates']['path']
+        env = Environment(loader=FileSystemLoader(templates_path))
+        custom_templates = True
+        LOGGER.debug(f'using custom templates: {templates_path}')
+    except (KeyError, TypeError):
+        env = Environment(loader=FileSystemLoader(TEMPLATES))
+        LOGGER.debug(f'using default templates: {TEMPLATES}')
+
+    env.filters['to_json'] = to_json
+    env.globals.update(to_json=to_json)
+
+    try:
+        template = env.get_template(template)
+    except TemplateNotFound as err:
+        if custom_templates:
+            LOGGER.debug(err)
+            LOGGER.debug('Custom template not found; using default')
+            env = Environment(loader=FileSystemLoader(TEMPLATES))
+            template = env.get_template(template)
+        else:
+            raise
+
+    return template.render(config=config, data=data, version=__version__)
+
+
+def to_rfc3339(value: str) -> Union[tuple, None]:
+    """
+    Helper function to convert a date/datetime into
+    RFC3339
+
+    :param value: `str` of date/datetime value
+
+    :returns: `tuple` of `datetime` of RFC3339 value and date type
+    """
+
+    try:
+        dt = dparse(value)  # TODO TIMEZONE)
+    except Exception as err:
+        msg = f'Parse error: {err}'
+        LOGGER.error(msg)
+        return 'date', None
+
+    if len(value) < 11:
+        dt_type = 'date'
+    else:
+        dt_type = 'date-time'
+
+    return dt, dt_type

pycsw/ogc/csw/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*-
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2015 Tom Kralidis
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================

pycsw/ogc/csw/cql.py

@@ -0,0 +1,133 @@
+# -*- coding: utf-8 -*-
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2016 Tom Kralidis
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+# =================================================================
+
+import logging
+
+from pycsw.core.etree import etree
+from pycsw.core import util
+from pycsw.ogc.fes.fes1 import MODEL as fes1_model
+from pycsw.ogc.fes.fes2 import MODEL as fes2_model
+
+LOGGER = logging.getLogger(__name__)
+
+
+def cql2fes(cql, namespaces, fes_version='1.0'):
+    """transforms Common Query Language (CQL) query into OGC fes1 syntax"""
+
+    filters = []
+    tmp_list = []
+    logical_op = None
+
+    LOGGER.debug('CQL: %s', cql)
+
+    if fes_version.startswith('1.0'):
+        element_or = 'ogc:Or'
+        element_and = 'ogc:And'
+        element_filter = 'ogc:Filter'
+        element_propertyname = 'ogc:PropertyName'
+        element_literal = 'ogc:Literal'
+    elif fes_version.startswith('2.0'):
+        element_or = 'fes20:Or'
+        element_and = 'fes20:And'
+        element_filter = 'fes20:Filter'
+        element_propertyname = 'fes20:Literal'
+
+    if ' or ' in cql:
+        logical_op = etree.Element(util.nspath_eval(element_or, namespaces))
+        tmp_list = cql.split(' or ')
+    elif ' OR ' in cql:
+        logical_op = etree.Element(util.nspath_eval(element_or, namespaces))
+        tmp_list = cql.split(' OR ')
+    elif ' and ' in cql:
+        logical_op = etree.Element(util.nspath_eval(element_and, namespaces))
+        tmp_list = cql.split(' and ')
+    elif ' AND ' in cql:
+        logical_op = etree.Element(util.nspath_eval(element_and, namespaces))
+        tmp_list = cql.split(' AND ')
+
+    if tmp_list:
+        LOGGER.debug('Logical operator found (AND/OR)')
+    else:
+        tmp_list.append(cql)
+
+    for t in tmp_list:
+        filters.append(_parse_condition(t, fes_version))
+
+    root = etree.Element(util.nspath_eval(element_filter, namespaces))
+
+    if logical_op is not None:
+        root.append(logical_op)
+
+    for flt in filters:
+        condition = etree.Element(util.nspath_eval(flt[0], namespaces))
+
+        etree.SubElement(
+            condition,
+            util.nspath_eval(element_propertyname, namespaces)).text = flt[1]
+
+        etree.SubElement(
+            condition,
+            util.nspath_eval(element_literal, namespaces)).text = flt[2]
+
+        if logical_op is not None:
+            logical_op.append(condition)
+        else:
+            root.append(condition)
+
+    LOGGER.debug('Resulting OGC Filter: %s',
+                 etree.tostring(root, pretty_print=1))
+
+    return root
+
+
+def _parse_condition(condition, fes_version='1.0'):
+    """parses a single condition"""
+
+    LOGGER.debug('condition: %s', condition)
+
+    # split at the most 2 times to take into account literals with
+    # spaces in them
+    property_name, operator, literal = condition.split(None, 2)
+
+    literal = literal.replace('"', '').replace('\'', '')
+
+    if fes_version.startswith('1.0'):
+        fes_model = fes1_model
+    elif fes_version.startswith('2.0'):
+        fes_model = fes2_model
+
+    for k, v in fes_model['ComparisonOperators'].items():
+        if v['opvalue'] == operator:
+            fes_predicate = k
+
+    LOGGER.debug('parsed condition: %s %s %s', property_name, fes_predicate,
+                 literal)
+
+    return (fes_predicate, property_name, literal)