source: mauRepo/HPFos/trunk/hpfos/HPFos/osImpl/myimpl.py @ 8523

'''
BSD Licence
Copyright (c) 2012, Science & Technology Facilities Council (STFC)
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 the Science & Technology Facilities Council (STFC) 
        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 OWNER 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.

Created on 5 May 2012

@author: Maurizio Nagni
'''
from datetime import datetime
from hpfos.libs.postgisutil import create_st_setSRID
from ceda_markup.opensearch.osquery import OSQuery
from ceda_markup.atom.atom import createID, createUpdated,\
    createPublished, createEntry
from ceda_markup.atom.info import createTitle, HTML_TYPE, createContent
from ceda_markup.dc.dc import createDate
from ceda_markup.gml.gml import createPosList, createLinearRing, createExterior,\
    createPolygon
from ceda_markup.georss.georss import createWhere
from ceda_markup.atom.link import REL_SEARCH, REL_ALTERNATE
from ceda_markup.opensearch import filter_results, COUNT_DEFAULT,\
    START_INDEX_DEFAULT, START_PAGE_DEFAULT, create_autodiscovery_link
from ceda_markup.opensearch.template.osresponse import Result, Subresult
from ceda_markup.opensearch.template.atom import OSAtomResponse
from ceda_markup.opensearch.template.html import OSHTMLResponse
from ea_model.ceda_metadatamodel.ceda_observationcollection.ceda_observationcollection import CEDA_ObservationCollection
from ea_model.ceda_metadatamodel.ceda_observation.ceda_observation import CEDA_Observation
from ea_model.ceda_metadatamodel.ceda_result.ceda_result import CEDA_Result
from ceda_markup.opensearch.os_param import OSParam
from hpfos import __version__, __revision__
from ceda_markup.atom.atom import ATOM_NAMESPACE
from hpfos.HPFos.osImpl.commons import get_document, get_xml_document,\
    return_not_none_text
from xml.etree.ElementTree import _ElementInterface, ElementTree
from ceda_markup.opensearch.os_request import OpenSearchDescription, OS_NAMESPACE

GUID = 'guid'
COLLECTION = 'collection'
OBSERVATION = 'observation'
RESULT = 'result'
BBOX = 'bbox'
DUMMY_GUID = 'dummy_guid'

FATCAT_HOST = 'citest1.jc.rl.ac.uk'
FATCAT_ROOT_PATH = 'fatcatOS'

CEDA_TITLE = 'ceda_title'
HPFOS_VERSION = __version__
HPFOS_REVISION = __revision__

HPFOS_ID = ''
if HPFOS_REVISION != 'REVISION': 
    HPFOS_ID = '(v. %s rev. %s)' % (HPFOS_VERSION, HPFOS_REVISION)
else:
    HPFOS_ID = '(v. %s rev. %s)' % (HPFOS_VERSION, 'unknown')
    
HPFOS_TITLE = 'Discovery feed for Search Services %s' % (HPFOS_ID)



class MyOSAtomResponse(OSAtomResponse):
    '''
    classdocs
    '''

    def __init__(self):
        #query_params = {"q": "searchTerms", "pw":"startPage"}
        super(MyOSAtomResponse, self).__init__()
        
        '''
        Constructor
        '''

    def _get_tot_results(self, results):
        if results is None:
            return 0
        
        if isinstance(results, list):
            return len(results)
        
        return 1
    
    def _digest_fatcat_atom(self, context, results):
        count, start_index, start_page = self._importCountAndPage(context)
        subresults = results.findall('{%s}entry' % (ATOM_NAMESPACE))
        tot_results = int(results.find('{%s}totalResults' % (OS_NAMESPACE)).text.replace('\n','').strip())
        return Result(count, start_index, start_page, tot_results, subresult = subresults, title=HPFOS_TITLE)        
        

    def digest_search_results(self, results, context): 
        count, start_index, start_page = self._importCountAndPage(context)
        
        filtered = None
        tot_results = 0
        
        if type(results) == CEDA_ObservationCollection:
            filtered = filter_results(results.member, count, start_index, start_page)
            tot_results = self._get_tot_results(results.member)
        elif type(results) == CEDA_Observation:
            #to be done
            filtered = filter_results(results.result, count, start_index, start_page)
            tot_results = self._get_tot_results(results.result)
        elif type(results) == CEDA_Result:
            filtered = filter_results(results.result, count, start_index, start_page)
            tot_results = 1  
        elif isinstance(results, _ElementInterface):
            return self._digest_fatcat_atom(context, results)                                 
        else:
            filtered = filter_results(results, count, start_index, start_page)
            tot_results = self._get_tot_results(results)
              
        if filtered is None:
            return Result(count, start_index, start_page, tot_results, subresult = []) 
              
        subresults = []
        for result in filtered:
            item = None          
            result_guid = context['moles3EPB'].retrieveGUIDFromInstance(result)
            if result_guid is None:
                continue
            ititle = self._extractTitle(result)
            item = Subresult(result_guid.id, ititle, datetime.now().isoformat(), description = result.description)               
            subresults.append(item)
        
        
        return Result(count, start_index, start_page, tot_results, subresult = subresults, title=HPFOS_TITLE)
        
    def generateEntryLinks(self, entry, atomroot, path, linkid = None):
        entry.append(create_autodiscovery_link(atomroot, path, self.extension, linkid, None, rel = REL_ALTERNATE))
        entry.append(create_autodiscovery_link(atomroot, path, self.extension, linkid, None, rel = REL_SEARCH))                

    def generate_entries(self, atomroot, subresults, path):
        if isinstance(subresults, list) \
                and len(subresults) > 0 \
                and isinstance(subresults[0], _ElementInterface):
            for entry in subresults:
                atomroot.append(entry)
            return
        
        entries = []
        
        for subresult in subresults: 
            #Here could loop over results
            atomID = createID(path + subresult.id + '/' + self.extension, root = atomroot)
            ititle = createTitle(root = atomroot, body = subresult.title, itype = HTML_TYPE)
            atomContent = createContent(root = atomroot, body = subresult.description, itype = HTML_TYPE)
            atomUpdated = createUpdated(subresult.updated, root = atomroot)
            atomPublished = createPublished('TO_BE_DONE_2011-01-21T11:05:29.511Z', root = atomroot)            
            entry = createEntry(atomID, ititle, atomUpdated,
                                published=atomPublished,
                                content=atomContent, root = atomroot)
            #xmlentry = entry.buildElement()
            
            idate = createDate(root = atomroot, 
                               body = 'TO_BE_DONE_2002-10-18T08:07:37.387Z/2012-03-29T07:12:20.735Z')        
            entry.append(idate)
            
            posList = createPosList(root = atomroot, body = '-90 -180 90 -180 90 180 -90 180 -90 -180', srsDimension = '2')
            linearRing = createLinearRing(root = atomroot, body = posList)
            exterior = createExterior(root = atomroot, body = linearRing)
            polygon = createPolygon(root = atomroot, body = exterior)
            where = createWhere(root = atomroot, body = polygon)
            entry.append(where)
            self.generateEntryLinks(entry, atomroot, path, subresult.id)            
            entries.append(entry)

        for entry in entries:
            atomroot.append(entry) 

    def _importCountAndPage(self, context):        
        count = COUNT_DEFAULT
        start_index = START_INDEX_DEFAULT
        start_page = START_PAGE_DEFAULT
        
        try: 
            count = int(context['count'])
        except:
            pass        
        
        try: 
            start_index = int(context['startIndex'])
        except:
            pass
        
        try: 
            start_page = int(context['startPage'])
        except:
            pass
        
        return count, start_index, start_page

    def _extractTitle(self, cedaObj):
        if hasattr(cedaObj, 'identifier'):
            for ident in cedaObj.identifier:
                if ident.authority.title == CEDA_TITLE:
                    return ident.code  

class MyOSHTMLResponse(OSHTMLResponse):
    '''
    classdocs
    '''

    def __init__(self):
        '''
        Constructor
        '''
        super(MyOSHTMLResponse, self).__init__()
        
    def generateResponse(self, result, queries, ospath, **kwargs):
        return result + " HTML!"
        
class MyOSQuery(OSQuery):
    '''
    classdocs
    '''

    def __init__(self):
        '''
            Constructor
        '''
        #param_1 = OSParam("q", "searchTerms", namespace = "http://example.com/opensearchextensions/1.0/")       
        param_1 = OSParam("count", "count")
        param_2 = OSParam("startPage", "startPage")
        param_3 = OSParam("startIndex", "startIndex")                
        param_4 = OSParam("q", "searchTerms")           
        param_5 = OSParam("uid", "uid", namespace = "http://a9.com/-/opensearch/extensions/geo/1.0/")        
        param_6 = OSParam(BBOX, BBOX, namespace = "http://a9.com/-/opensearch/extensions/geo/1.0/")        
        param_7 = OSParam("start", "start", namespace = "http://a9.com/-/opensearch/extensions/geo/1.0/")        
        param_8 = OSParam("stop", "stop", namespace = "http://a9.com/-/opensearch/extensions/time/1.0/")        
        params = [param_1, param_2, param_3, param_4, param_5, param_6, param_7, param_8] 
        super(MyOSQuery, self).__init__(params)
        
    def do_search(self, context):
        ibbox = None
        if context is not None and context.has_key(BBOX) and context[BBOX] is not None:
            coords = context[BBOX].split(',')
            try:
                if len(coords) == 4:
                    ibbox = create_st_setSRID(int(coords[0]),int(coords[1]),int(coords[2]),int(coords[3]))
            except:
                pass
        
        if not context.has_key(GUID) or context[GUID] is None:
            return context['moles3EPB'].getObservationCollections(bbox = ibbox)        
              
        obj = context['moles3EPB'].getInstanceFromGUID(context[GUID])    
        if obj is None:
            return None
        if type(obj) == CEDA_ObservationCollection:
            return context['moles3EPB'].searchSelectiveLoadByInstance(obj, 'member') #need to add bbox & phenomTime
        elif type(obj) == CEDA_Observation:
            #return context['moles3EPB'].searchSelectiveLoadByInstance(obj, 'result') #need to add bbox & phenomTime
            for source in obj.result.source:
                if source.function == 'search':
                    return self._extractFatcatEntities(source.description)

        
    def _extractFatcatEntities(self, fc_resource_id):
        path = '/%s/search/%s/atom/' % (FATCAT_ROOT_PATH, str(fc_resource_id))
        return find_fatcat_atom_entity(host = FATCAT_HOST, path = path)
    
def find_fatcat_atom_entity(host = 'localhost', path = '', port = 80):    
    source = get_document(host, path, port)
    return get_xml_document(source)