geonode-pycsw 3.0.0b2__py3-none-any.whl

pycsw/plugins/profiles/profile.py

@@ -0,0 +1,141 @@
+# -*- coding: utf-8 -*-
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#          Angelos Tzotsos <tzotsos@gmail.com>
+#
+# Copyright (c) 2024 Tom Kralidis
+# Copyright (c) 2015 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 os
+import warnings
+
+class Profile(object):
+    ''' base Profile class '''
+    def __init__(self, name, version, title, url,
+    namespace, typename, outputschema, prefixes, model, core_namespaces,
+    added_namespaces,repository):
+
+        ''' Initialize profile '''
+        self.name = name
+        self.version = version
+        self.title = title
+        self.url = url
+        self.namespace = namespace
+        self.typename = typename
+        self.outputschema = outputschema
+        self.prefixes = prefixes
+        self.repository = repository
+
+        if 'DescribeRecord' in model['operations']:
+            model['operations']['DescribeRecord']['parameters']\
+            ['typeName']['values'].append(self.typename)
+
+        model['operations']['GetRecords']['parameters']['outputSchema']\
+        ['values'].append(self.outputschema)
+
+        model['operations']['GetRecords']['parameters']['typeNames']\
+        ['values'].append(self.typename)
+
+        model['operations']['GetRecordById']['parameters']['outputSchema']\
+        ['values'].append(self.outputschema)
+
+        if 'Harvest' in model['operations']:
+            model['operations']['Harvest']['parameters']['ResourceType']\
+            ['values'].append(self.outputschema)
+
+        # namespaces
+        core_namespaces.update(added_namespaces)
+
+        # repository
+        model['typenames'][self.typename] = self.repository
+
+    def extend_core(self, model, namespaces, config):
+        ''' Extend config.model and config.namespaces '''
+        raise NotImplementedError
+
+    def check_parameters(self):
+        ''' Perform extra parameters checking.
+            Return dict with keys "locator", "code", "text" or None '''
+        raise NotImplementedError
+
+    def get_extendedcapabilities(self):
+        ''' Return ExtendedCapabilities child as lxml.etree.Element '''
+        raise NotImplementedError
+
+    def get_schemacomponents(self):
+        ''' Return schema components as lxml.etree.Element list '''
+        raise NotImplementedError
+
+    def check_getdomain(self, kvp):
+        '''Perform extra profile specific checks in the GetDomain request'''
+        raise NotImplementedError
+
+    def write_record(self, result, esn, outputschema, queryables):
+        ''' Return csw:SearchResults child as lxml.etree.Element '''
+        raise NotImplementedError
+
+    def transform2dcmappings(self, queryables):
+        ''' Transform information model mappings into csw:Record mappings '''
+        raise NotImplementedError
+
+def load_profiles(path, cls, profiles):
+    ''' load CSW profiles, return dict by class name '''
+
+    def look_for_subclass(modulename):
+        module = __import__(modulename)
+
+        dmod = module.__dict__
+        for modname in modulename.split('.')[1:]:
+            dmod = dmod[modname].__dict__
+
+        for key, entry in dmod.items():
+            if key == cls.__name__:
+                continue
+
+            try:
+                if issubclass(entry, cls):
+                    aps['plugins'][key] = entry
+            except TypeError:
+                continue
+
+    aps = {}
+    aps['plugins'] = {}
+    aps['loaded'] = {}
+
+    for prof in profiles:
+        # fgdc, atom, dif, gm03 are supported in core
+        # no need to specify them explicitly anymore
+        # provide deprecation warning
+        # https://github.com/geopython/pycsw/issues/118
+        if prof in ['fgdc', 'atom', 'dif', 'gm03']:
+            warnings.warn('%s is now a core module, and does not need to be'
+                          ' specified explicitly.  So you can remove %s from '
+                          'server.profiles' % (prof, prof))
+        else:
+            modulename='%s.%s.%s' % (path.replace(os.sep, '.'), prof, prof)
+            look_for_subclass(modulename)
+    return aps

pycsw/plugins/repository/__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/plugins/repository/odc/__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/plugins/repository/odc/odc.py

@@ -0,0 +1,153 @@
+#-*- coding: utf-8 -*-
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2024 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.
+#
+# =================================================================
+
+from django.db import connection
+from django.db.models import Max, Min, Count
+from django.conf import settings
+
+from pycsw.core import repository, util
+from OpenDataCatalog.opendata.models import Resource
+
+class OpenDataCatalogRepository(object):
+    ''' Class to interact with underlying repository '''
+    def __init__(self, context, repo_filter=None):
+        ''' Initialize repository '''
+
+        self.context = context
+        self.filter = repo_filter
+        self.fts = False
+
+        self.dbtype = settings.DATABASES['default']['ENGINE'].split('.')[-1]
+
+        # ODC PostgreSQL installs are not PostGIS enabled
+        if self.dbtype == 'postgresql_psycopg2':
+            self.dbtype = 'postgresql'
+
+        if self.dbtype in ['sqlite', 'sqlite3']:  # load SQLite query bindings
+            cursor = connection.cursor()
+            connection.connection.create_function(
+            'query_spatial', 4, util.query_spatial)
+            connection.connection.create_function(
+            'get_anytext', 1, repository.get_anytext)
+            connection.connection.create_function(
+            'get_geometry_area', 1, util.get_geometry_area)
+
+        # generate core queryables db and obj bindings
+        self.queryables = {}
+
+        for tname in self.context.model['typenames']:
+            for qname in self.context.model['typenames'][tname]['queryables']:
+                self.queryables[qname] = {}
+
+                for qkey, qvalue in \
+                self.context.model['typenames'][tname]['queryables'][qname].items():
+                    self.queryables[qname][qkey] = qvalue
+
+        # flatten all queryables
+        # TODO smarter way of doing this
+        self.queryables['_all'] = {}
+        for qbl in self.queryables:
+            self.queryables['_all'].update(self.queryables[qbl])
+        self.queryables['_all'].update(self.context.md_core_model['mappings'])
+
+    def query_ids(self, ids):
+        ''' Query by list of identifiers '''
+
+        # identifiers are URN masked, where the last token of the identifier
+        # is opendata.models.Resource.id (integer)
+        # if ids are passed which are not int, silently return (does not exist)
+        try:
+            return self._get_repo_filter(Resource.objects).filter(id__in=[s.split(':')[-1] for s in ids]).all()
+        except Exception as err:
+            return []
+
+    def query_domain(self, domain, typenames, domainquerytype='list',
+        count=False):
+        ''' Query by property domain values '''
+
+        objects = self._get_repo_filter(Resource.objects)
+
+        if domainquerytype == 'range':
+            return [tuple(objects.aggregate(
+            Min(domain), Max(domain)).values())]
+        else:
+            if count:
+                return [(d[domain], d['%s__count' % domain]) \
+                for d in objects.values(domain).annotate(Count(domain))]
+            else:
+                return objects.values_list(domain).distinct()
+
+    def query_insert(self, direction='max'):
+        ''' Query to get latest (default) or earliest update to repository '''
+        if direction == 'min':
+            return Resource.objects.aggregate(
+                Min('last_updated'))['last_updated__min'].strftime('%Y-%m-%dT%H:%M:%SZ')
+        return self._get_repo_filter(Resource.objects).aggregate(
+            Max('last_updated'))['last_updated__max'].strftime('%Y-%m-%dT%H:%M:%SZ')
+
+    def query_source(self, source):
+        ''' Query by source '''
+        return self._get_repo_filter(Resource.objects).filter(source=source)
+
+    def query(self, constraint, sortby=None, typenames=None,
+        maxrecords=10, startposition=0):
+        ''' Query records from underlying repository '''
+
+        # run the raw query and get total
+        if 'where' in constraint:  # GetRecords with constraint
+            query = self._get_repo_filter(Resource.objects).extra(where=[constraint['where']], params=constraint['values'])
+
+        else:  # GetRecords sans constraint
+            query = self._get_repo_filter(Resource.objects)
+
+        total = query.count()
+
+        # apply sorting, limit and offset
+        if sortby is not None:
+            if 'spatial' in sortby and sortby['spatial']:  # spatial sort
+                desc = False
+                if sortby['order'] == 'DESC':
+                    desc = True
+                query = query.all()
+                return [str(total), sorted(query, key=lambda x: float(util.get_geometry_area(getattr(x, sortby['propertyname']))), reverse=desc)[startposition:startposition+int(maxrecords)]]
+            if sortby['order'] == 'DESC':
+                pname = '-%s' % sortby['propertyname']
+            else:
+                pname = sortby['propertyname']
+            return [str(total), \
+            query.order_by(pname)[startposition:startposition+int(maxrecords)]]
+        else:  # no sort
+            return [str(total), query.all()[startposition:startposition+int(maxrecords)]]
+
+    def _get_repo_filter(self, query):
+        ''' Apply repository wide side filter / mask query '''
+        if self.filter is not None:
+            return query.extra(where=[self.filter])
+        return query