geonode-pycsw 3.0.0b2__py3-none-any.whl

pycsw/oaipmh.py

@@ -0,0 +1,311 @@
+# -*- 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.
+#
+# =================================================================
+
+import logging
+from pycsw.core import util
+from pycsw.core.etree import etree
+
+
+LOGGER = logging.getLogger(__name__)
+
+class OAIPMH(object):
+    """OAI-PMH wrapper class"""
+    def __init__(self, context, config):
+        LOGGER.debug('Initializing OAI-PMH constants')
+        self.oaipmh_version = '2.0'
+
+        self.namespaces = {
+            'oai': 'http://www.openarchives.org/OAI/2.0/',
+            'oai_dc': 'http://www.openarchives.org/OAI/2.0/oai_dc/',
+            'xsi': 'http://www.w3.org/2001/XMLSchema-instance'
+        }
+        self.request_model = {
+            'Identify': [],
+            'ListSets': ['resumptiontoken'],
+            'ListMetadataFormats': ['identifier'],
+            'GetRecord': ['identifier', 'metadataprefix'],
+            'ListRecords': ['from', 'until', 'set', 'resumptiontoken', 'metadataprefix'],
+            'ListIdentifiers': ['from', 'until', 'set', 'resumptiontoken', 'metadataprefix'],
+        }
+        self.metadata_formats = {
+            'iso19139': {
+                'namespace': 'http://www.isotc211.org/2005/gmd',
+                'schema': 'http://www.isotc211.org/2005/gmd/gmd.xsd',
+                'identifier': './/gmd:fileIdentifier/gco:CharacterString',
+                'datestamp': './/gmd:dateStamp/gco:DateTime|.//gmd:dateStamp/gco:Date',
+                'setSpec': './/gmd:hierarchyLevel/gmd:MD_ScopeCode'
+            },
+            'csw-record': {
+                'namespace': 'http://www.opengis.net/cat/csw/2.0.2',
+                'schema': 'http://schemas.opengis.net/csw/2.0.2/record.xsd',
+                'identifier': './/dc:identifier',
+                'datestamp': './/dct:modified',
+                'setSpec': './/dc:type'
+            },
+            'fgdc-std': {
+                'namespace': 'http://www.opengis.net/cat/csw/csdgm',
+                'schema': 'http://www.fgdc.gov/metadata/fgdc-std-001-1998.xsd',
+                'identifier': './/idinfo/datasetid',
+                'datestamp': './/metainfo/metd',
+                'setSpec': './/dataset'
+            },
+            'oai_dc': {
+                'namespace': '%soai_dc/' % self.namespaces['oai'],
+                'schema': 'http://www.openarchives.org/OAI/2.0/oai_dc.xsd',
+                'identifier': './/dc:identifier',
+                'datestamp': './/dct:modified',
+                'setSpec': './/dc:type'
+            },
+            'dif': {
+                'namespace': 'http://gcmd.gsfc.nasa.gov/Aboutus/xml/dif/',
+                'schema': 'http://gcmd.gsfc.nasa.gov/Aboutus/xml/dif/dif.xsd',
+                'identifier': './/dif:Entry_ID',
+                'datestamp': './/dif:Last_DIF_Revision_Date',
+                'setSpec': '//dataset'
+            },
+            'gm03': {
+                'namespace': 'http://www.interlis.ch/INTERLIS2.3',
+                'schema': 'http://www.geocat.ch/internet/geocat/en/home/documentation/gm03.parsys.50316.downloadList.86742.DownloadFile.tmp/gm0321.zip',
+                'identifier': './/gm03:DATASECTION//gm03:fileIdentifer',
+                'datestamp': './/gm03:DATASECTION//gm03:dateStamp',
+                'setSpec': './/dataset'
+            },
+            'datacite': {
+                'namespace': 'http://datacite.org/schema/kernel-4',
+                'schema': 'http://schema.datacite.org/meta/kernel-4.3/metadata.xsd',
+                'identifier': '//identifier',
+                'datestamp': '//dates/date',
+                'setSpec': ''
+            }
+        }
+        self.metadata_sets = {
+            'datasets': ('Datasets', 'dataset'),
+            'interactiveResources': ('Interactive Resources', 'service')
+        }
+        self.error_codes = {
+            'badArgument': 'InvalidParameterValue',
+            'badVerb': 'OperationNotSupported',
+            'idDoesNotExist': None,
+            'noRecordsMatch': None,
+        }
+
+        self.context = context
+        self.context.namespaces.update(self.namespaces)
+        self.context.namespaces.update({'gco': 'http://www.isotc211.org/2005/gco'})
+        self.config = config
+
+    def request(self, kvp):
+        """process OAI-PMH request"""
+        kvpout = {'service': 'CSW', 'version': '2.0.2', 'mode': 'oaipmh'}
+        LOGGER.debug('Incoming kvp: %s', kvp)
+        if 'verb' in kvp:
+            if 'metadataprefix' in kvp:
+                self.metadata_prefix = kvp['metadataprefix']
+                try:
+                    kvpout['outputschema'] = self._get_metadata_prefix(kvp['metadataprefix'])
+                except KeyError:
+                    kvpout['outputschema'] = kvp['metadataprefix']
+            else:
+                self.metadata_prefix = 'csw-record'
+            LOGGER.debug('metadataPrefix: %s', self.metadata_prefix)
+            if kvp['verb'] in ['ListRecords', 'ListIdentifiers', 'GetRecord']:
+                kvpout['request'] = 'GetRecords'
+                kvpout['resulttype'] = 'results'
+                kvpout['typenames'] = 'csw:Record'
+                kvpout['elementsetname'] = 'full'
+            if kvp['verb'] in ['Identify', 'ListMetadataFormats', 'ListSets']:
+                kvpout['request'] = 'GetCapabilities'
+            elif kvp['verb'] == 'GetRecord':
+                kvpout['request'] = 'GetRecordById'
+                if 'identifier' in kvp:
+                    kvpout['id'] = kvp['identifier']
+                if ('outputschema' in kvpout and
+                    kvp['metadataprefix'] == 'oai_dc'):  # just use default DC
+                    del kvpout['outputschema']
+            elif kvp['verb'] in ['ListRecords', 'ListIdentifiers']:
+                if 'resumptiontoken' in kvp:
+                    kvpout['startposition'] = kvp['resumptiontoken']
+                if ('outputschema' in kvpout and
+                   kvp['verb'] == 'ListIdentifiers'):  # simple output only
+                    pass #del kvpout['outputschema']
+                if ('outputschema' in kvpout and
+                    kvp['metadataprefix'] in ['dc', 'oai_dc']):  # just use default DC
+                    del kvpout['outputschema']
+
+
+                start = end = None
+                LOGGER.debug('Scanning temporal parameters')
+                if 'from' in kvp:
+                    start = 'dc:date >= %s' % kvp['from']
+                if 'until' in kvp:
+                    end = 'dc:date <= %s' % kvp['until']
+                if any([start is not None, end is not None]):
+                    if all([start is not None, end is not None]):
+                        time_query = '%s and %s' % (start, end)
+                    elif end is None:
+                        time_query = start
+                    elif start is None:
+                        time_query = end
+                    kvpout['constraintlanguage'] = 'CQL_TEXT'
+                    kvpout['constraint'] = time_query
+        LOGGER.debug('Resulting parameters: %s', kvpout)
+        return kvpout
+
+    def response(self, response, kvp, repository, server_url):
+        """process OAI-PMH request"""
+
+        mode = kvp.pop('mode', None)
+        if 'config' in kvp:
+            config_val = kvp.pop('config')
+        url = '%smode=oaipmh' % util.bind_url(server_url)
+
+        node = etree.Element(util.nspath_eval('oai:OAI-PMH', self.namespaces), nsmap=self.namespaces)
+        node.set(util.nspath_eval('xsi:schemaLocation', self.namespaces), '%s http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd' % self.namespaces['oai'])
+        LOGGER.debug(etree.tostring(node))
+
+        etree.SubElement(node, util.nspath_eval('oai:responseDate', self.namespaces)).text = util.get_today_and_now()
+        kvp2 = dict(kvp)
+        if 'metadataprefix' in kvp2:
+            kvp2['metadataPrefix'] = kvp2.pop('metadataprefix')
+        etree.SubElement(node, util.nspath_eval('oai:request', self.namespaces), attrib=kvp2).text = url
+
+        if 'verb' not in kvp:
+            etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = 'Missing \'verb\' parameter'
+            return node
+
+        if kvp['verb'] not in self.request_model.keys():
+            etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = 'Unknown verb \'%s\'' % kvp['verb']
+            return node
+
+        if etree.QName(response).localname == 'ExceptionReport':
+            etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = response.xpath('//ows:ExceptionText|//ows20:ExceptionText', namespaces=self.context.namespaces)[0].text
+            return node
+
+        verb = kvp.pop('verb')
+
+        if verb in ['GetRecord', 'ListIdentifiers', 'ListRecords']:
+            if 'metadataprefix' not in kvp:
+                etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = 'Missing metadataPrefix parameter'
+                return node
+            elif kvp['metadataprefix'] not in self.metadata_formats.keys():
+                etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = 'Invalid metadataPrefix parameter'
+                return node
+
+        for key, value in kvp.items():
+            if key != 'mode' and key not in self.request_model[verb]:
+                etree.SubElement(node, util.nspath_eval('oai:error', self.namespaces), code='badArgument').text = 'Illegal parameter \'%s\'' % key
+                return node
+
+        verbnode = etree.SubElement(node, util.nspath_eval('oai:%s' % verb, self.namespaces))
+
+        if verb == 'Identify':
+                etree.SubElement(verbnode, util.nspath_eval('oai:repositoryName', self.namespaces)).text = self.config['metadata']['identification']['title']
+                etree.SubElement(verbnode, util.nspath_eval('oai:baseURL', self.namespaces)).text = url
+                etree.SubElement(verbnode, util.nspath_eval('oai:protocolVersion', self.namespaces)).text = '2.0'
+                etree.SubElement(verbnode, util.nspath_eval('oai:adminEmail', self.namespaces)).text = self.config['metadata']['contact']['email']
+                etree.SubElement(verbnode, util.nspath_eval('oai:earliestDatestamp', self.namespaces)).text = repository.query_insert('min')
+                etree.SubElement(verbnode, util.nspath_eval('oai:deletedRecord', self.namespaces)).text = 'no'
+                etree.SubElement(verbnode, util.nspath_eval('oai:granularity', self.namespaces)).text = 'YYYY-MM-DDThh:mm:ssZ'
+
+        elif verb == 'ListSets':
+            for key, value in sorted(self.metadata_sets.items()):
+                setnode = etree.SubElement(verbnode, util.nspath_eval('oai:set', self.namespaces))
+                etree.SubElement(setnode, util.nspath_eval('oai:setSpec', self.namespaces)).text = key
+                etree.SubElement(setnode, util.nspath_eval('oai:setName', self.namespaces)).text = value[0]
+
+        elif verb == 'ListMetadataFormats':
+            for key, value in sorted(self.metadata_formats.items()):
+                mdfnode = etree.SubElement(verbnode, util.nspath_eval('oai:metadataFormat', self.namespaces))
+                etree.SubElement(mdfnode, util.nspath_eval('oai:metadataPrefix', self.namespaces)).text = key
+                etree.SubElement(mdfnode, util.nspath_eval('oai:schema', self.namespaces)).text = value['schema']
+                etree.SubElement(mdfnode, util.nspath_eval('oai:metadataNamespace', self.namespaces)).text = value['namespace']
+
+        elif verb in ['GetRecord', 'ListIdentifiers', 'ListRecords']:
+                if verb == 'GetRecord':  # GetRecordById
+                    records = response.getchildren()
+                else:  # GetRecords & ListIdentifiers
+                    records = response.getchildren()[1].getchildren()
+                for child in records:
+                    if verb == 'ListIdentifiers':
+                        header = etree.SubElement(verbnode, util.nspath_eval('oai:header', self.namespaces))
+                        recnode = header
+                    else:
+                        recnode = etree.SubElement(verbnode, util.nspath_eval('oai:record', self.namespaces))
+                        header = etree.SubElement(recnode, util.nspath_eval('oai:header', self.namespaces))
+                    
+                    self._transform_element(header, child, 'oai:identifier')
+                    self._transform_element(header, child, 'oai:datestamp')
+                    self._transform_element(header, child, 'oai:setSpec')
+                    if verb in ['GetRecord', 'ListRecords']:
+                        metadata = etree.SubElement(recnode, util.nspath_eval('oai:metadata', self.namespaces))
+                        if 'metadataprefix' in kvp and kvp['metadataprefix'] == 'oai_dc':
+                            child.tag = util.nspath_eval('oai_dc:dc', self.namespaces)
+                        metadata.append(child)
+                if verb != 'GetRecord':
+                    complete_list_size = response.xpath('//@numberOfRecordsMatched')[0]
+                    next_record = response.xpath('//@nextRecord')[0]
+                    cursor = str(int(complete_list_size) - int(next_record) - 1)
+
+                    resumption_token = etree.SubElement(verbnode, util.nspath_eval('oai:resumptionToken', self.namespaces),
+                                                        completeListSize=complete_list_size, cursor=cursor)
+
+                    if int(next_record) > 0:
+                        resumption_token.text = next_record
+
+        return node
+
+    def _get_metadata_prefix(self, prefix):
+        """Convenience function to return metadataPrefix as CSW outputschema"""
+        try:
+            outputschema = self.metadata_formats[prefix]['namespace']
+        except KeyError:
+            outputschema = prefix
+        return outputschema
+
+    def _transform_element(self, parent, element, elname):
+        """tests for existence of a given xpath, writes out text if exists"""
+
+        xpath = self.metadata_formats[self.metadata_prefix][elname.split(':')[1]]
+
+        if xpath.startswith(('.//', '//')):
+            value = element.xpath(xpath, namespaces=self.context.namespaces)
+            if value:
+                value = value[0].text
+        else:  # bare string literal
+            value = xpath
+        el = etree.SubElement(parent, util.nspath_eval(elname, self.context.namespaces))
+        if value:
+            if elname == 'oai:setSpec':
+                value = None
+                for k, v in self.metadata_sets.items():
+                    if v[1] == elname:
+                        value = k
+                        break
+            el.text = value

pycsw/ogc/__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/api/__init__.py

@@ -0,0 +1,28 @@
+# =================================================================
+#
+# Authors: Tom Kralidis <tomkralidis@gmail.com>
+#
+# Copyright (c) 2021 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.
+#
+# =================================================================