source: mauRepo/HPFos/trunk/src/HPFos/osImpl/myimpl.py @ 8355

'''
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 xml.etree.ElementTree import tostring, ElementTree
from xml.dom import minidom
from markup.atom.atom import Atom
from markup.opensearch.os_response import OpenSearchResponse
from markup.opensearch.osParam import OSParam
from markup.atom.link import Link
from markup.opensearch.os_engine import get_mimetype
from markup.atom.info import Title, Info, Content
from markup.atom.entry import Entry
from markup.dc.dc import Date
from markup.gml.gml import PosList, LinearRing, Exterior, Polygon
from markup.georss.georss import Where
from markup.template.html import OSHTMLResponse
from markup.template.atom import OSAtomResponse
from datetime import datetime
from markup.opensearch.osquery import OSQuery
from libs.postgisutil import create_st_setSRID
 
COLLECTION = 'collection'
OBSERVATION = 'observation'
RESULT = 'result'
BBOX = 'box'

def calculateStep(**kwargs):
    step = 20
    if kwargs['params_values'].has_key('count'):
        step = int(kwargs['params_values']['count'])
    return step

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

    def __init__(self):
        #query_params = {"q": "searchTerms", "pw":"startPage"}
        super(MyOSAtomResponse, self).__init__()
        
        '''
        Constructor
        '''
        
                        
    def generateResponse(self, result, queries, osHostURL, **kwargs):
        """
            @param result: a Result instance
            @param queries:
            @param osHostURL:  
            @param kwargs: 
        """
        id = ""
        ospath = self.generateLinkHref(osHostURL, result.id, self.extension, rel = None)
        
        #Generates the ATOM document
        atomdoc = Atom.createDocument(ospath + "atom", \
                                      result.title, \
                                      result.updated)
        
        #configuration level
        step = calculateStep(**kwargs)
        root = ElementTree(atomdoc).getroot()

        #Generate feed's links
        self.generateFeedLinks(root, ospath, None, result.totalResult, step)
    
        
        #Inserts the OpenSearchResponse elements
        osdoc = OpenSearchResponse(root)
        os_totalResults = str(result.totalResult)
        os_startIndex = str(0)
        os_itemsPerPage = str(step)
        osdoc.createDocument(totalResults = os_totalResults, startIndex = os_startIndex, itemsPerPage = os_itemsPerPage)
        for query in queries:                       
            root.append(query)

        self.generateEntries(root, result.subresult, ospath)
        
        reparsed = minidom.parseString(tostring(atomdoc))
        return reparsed.toprettyxml(indent="  ")

    def generateFeedLinks(self, atomroot, path, linkid = None, total_results = None, step = 0):
        self.appendAtomLink(atomroot, path, linkid, startIndex = None, rel = Link.REL_SEARCH)
        self.appendAtomLink(atomroot, path, linkid, 0, Link.REL_SELF)
        self.appendAtomLink(atomroot, path, linkid, 0, Link.REL_FIRST)
        
        if total_results > 2*step:
            self.appendAtomLink(atomroot, path, linkid, step, Link.REL_NEXT)
            self.appendAtomLink(atomroot, path, linkid, total_results - (total_results % step), Link.REL_LAST)
        else:
            if total_results > step:
                self.appendAtomLink(atomroot, path, linkid, step, Link.REL_NEXT)                    
                self.appendAtomLink(atomroot, path, linkid, step, Link.REL_LAST)
            else:
                self.appendAtomLink(atomroot, path, linkid, 0, Link.REL_NEXT)                    
                self.appendAtomLink(atomroot, path, linkid, 0, Link.REL_LAST)                               
        
    def generateEntryLinks(self, atomroot, path, linkid = None):
        self.appendAtomLink(atomroot, path, linkid, startIndex = None, rel = Link.REL_ALTERNATE)
        self.appendAtomLink(atomroot, path, linkid, startIndex = None, rel = Link.REL_SEARCH)                
                
    def appendAtomLink(self, atomroot, path, linkid = None, startIndex = 0, rel = Link.REL_SELF):
        href = self.generateLinkHref(path, linkid, startIndex, rel)
        type = get_mimetype(self.extension)
        if rel == Link.REL_SEARCH:
            type = get_mimetype('opensearchdescription')            
        link = Link(href, rel, type)                    
        atomroot.append(link.buildElement())

    def generateLinkHref(self, path, linkid, startIndex = None, rel = Link.REL_SELF):
        """
            @param path: the host URL
            @param linkid: the search id
            @param startIndex: the starting index
            @param rel: a Link type identificator. If None returns a generic ID   
        """
        if rel == None:
            if linkid:
                return "%s/search/%s/" % (path, linkid)
            else:
                return "%s/search/" % (path)
    
        if rel == Link.REL_SEARCH:
            if linkid:
                return "%s%s/description" % (path, linkid)    
            else:
                return "%sdescription" % (path)
        
        if rel == Link.REL_ALTERNATE:
            if linkid:
                return "%s%s/%s" % (path, linkid, self.extension)
            else:
                return "%s%s" % (path, self.extension)
    
        if linkid:
            return "%s%s/%s/?startIndex=%d" % (path, linkid, self.extension, startIndex)
        else:
            return "%s%s/?startIndex=%d" % (path, self.extension, startIndex)        

    def generateEntries(self, atomroot, subresults, path):
        entries = []
        
        for subresult in subresults: 
            #Here could loop over results
            ititle = Title(Info.TEXT_TYPE, subresult.title)
            icontent = Content(Info.HTML_TYPE, '<b> Search Feed  </b>  \
                <ul> <li> Title: ASAR Image Mode source packets Level 0 (ASA_IM__0P) </li> \
             The ASAR Image Mode source packets Level 0 data product offers Level 0 data for possible images processing on an other processing site. It includes some mandatory information for SAR processing. The Image Mode Level 0 product consists of time-ordered Annotated Instrument Source Packets (AISPs) collected while the instrument is in Image Mode. The echo samples contained in the AISPs are compressed to 4 bits/sample using Flexible Block Adaptive Quantisation (FBAQ). This is a high-rate, narrow swath mode so data is only acquired for partial orbit segments and may be from one of seven possible image swaths. The Level 0 product is produced systematically for all data acquired within this mode. This product provides a continuation of the ERS-SAR_RAW product.<li> Abstract: The ASAR Image Mode source packets Level 0 data product offers Level 0 data for possible images processing on an other processing site. It includes some mandatory information for SAR processing. The Image Mode Level 0 product consists of time-ordered Annotated Instrument Source Packets (AISPs) collected while the instrument is in Image Mode. The echo samples contained in the AISPs are compressed to 4 bits/sample using Flexible Block Adaptive Quantisation (FBAQ). This is a high-rate, narrow swath mode so data is only acquired for partial orbit segments and may be from one of seven possible image swaths. The Level 0 product is produced systematically for all data acquired within this mode. This product provides a continuation of the ERS-SAR_RAW product. </li><li> Subject: Radar Imagery, Solid Earth (Tectonics/Seismic Activity), Water (Water Management), Natural Disasters (Oil Slick), Land (Topography/Mapping,Soil,Vegetation) Ocean and Coast (Ocean Currents and Topography,Ocean Waves,Coastal Geomorphology) </li>  \
               <li> Date: 2002-10-18 to 2012-03-29  \
                </li> <li> Number of Records: 15945 </ul>')
            entry = Entry(path + subresult.id + '/' + self.extension, \
                          ititle.buildElement(), \
                          subresult.updated, \
                          published = '2011-01-21T11:05:29.511Z', \
                           link = [], \
                           content = icontent.buildElement())
            xmlentry = entry.buildElement()
            
            idate = Date(atomroot, '2002-10-18T08:07:37.387Z/2012-03-29T07:12:20.735Z')        
            xmlentry.append(idate.buildElement())
            
            posList = PosList(atomroot, body = '-90 -180 90 -180 90 180 -90 180 -90 -180', srsDimension = '2')
            linearRing = LinearRing(atomroot, posList)
            exterior = Exterior(atomroot, linearRing)
            polygon = Polygon(atomroot, exterior)
            where = Where(atomroot, polygon)
            xmlentry.append(where.buildElement())
            self.generateEntryLinks(xmlentry, path, subresult.id)
            
            entries.append(xmlentry)

        for entry in entries:
            atomroot.append(entry) 

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 _packResult(self, results, id = None, **kwargs):
        subresults = []

        step = calculateStep(**kwargs)

        startIndex = self.indexOffset
        if kwargs['params_values'].has_key('startIndex'):
            if int(kwargs['params_values']['startIndex']) < len(results):
                startIndex = int(kwargs['params_values']['startIndex'])
        
        startPage = self.pageOffset
        if kwargs['params_values'].has_key('startPage'):
            if int(kwargs['params_values']['startPage']) * step < len(results):
                startPage = int(kwargs['params_values']['startPage'])
                
        firstResult = startIndex
        lastResult = firstResult + step

        if startPage > 1 and (firstResult + (startPage - 1)*step) <= len(results):
            firstResult = firstResult + (startPage - 1)*step
            if firstResult + step <= len(results):            
                lastResult = firstResult + step
            else:
                lastResult = len(results)

        for result in results[firstResult:lastResult]:
            result_guid = kwargs['moles3EPB'].retrieveGUIDFromInstance(result)
            item = Subresult(result_guid.id, "title", datetime.now().isoformat())
            subresults.append(item)
        
        return Result(len(results), subresult = subresults)
        
        
    def doSearch(self, **kwargs):
        ibbox = None
        if kwargs['params_values'] and kwargs['params_values'].has_key(BBOX):
            coords = kwargs['params_values'][BBOX].split(',')
            try:
                if len(coords) == 4:
                    ibbox = create_st_setSRID(int(coords[0]),int(coords[1]),int(coords[2]),int(coords[3]))
            except Exception as e:
                pass
        
        if kwargs['params_values'] and kwargs['params_values'].has_key(COLLECTION) and kwargs['params_values'].has_key(OBSERVATION):
            return self.searchObservation(**kwargs)        
        
        if kwargs['params_values'] and kwargs['params_values'].has_key(COLLECTION):
            return self.searchCollection(**kwargs)        
            
        results = kwargs['moles3EPB'].getObservationCollections(bbox = ibbox)

                                  
                
        
        return self._packResult(results, **kwargs)

    def searchCollection(self, **kwargs):        
        obs_coll = kwargs['moles3EPB'].getInstanceFromGUID(kwargs['params_values'][COLLECTION])
        if obs_coll:
            obs_coll = kwargs['moles3EPB'].searchSelectiveLoadByInstance(obs_coll, 'member')
                        
        return self._packResult(obs_coll.member, id = kwargs['params_values'][COLLECTION], **kwargs)

    def searchObservation(self, **kwargs):        
        observation = kwargs['moles3EPB'].getInstanceFromGUID(kwargs['params_values'][OBSERVATION])
        if observation:
            observation = kwargs['moles3EPB'].searchSelectiveLoadByInstance(observation, 'result')
            
        print observation
        '''                        
        subresults = []
        for result in obs_coll.member:
            result_guid = kwargs['moles3EPB'].retrieveGUIDFromInstance(result)
            item = Subresult(result_guid.id, "title", datetime.now().isoformat())
            subresults.append(item)
            
        result = Result(id = kwargs['params_values'][COLLECTION], subresult = subresults)
        return result
        '''
        return None

class Result(object):
    def __init__(self, totalResults, id = None, title = "Discovery feed for Search Services", updated = datetime.now().isoformat(), subresult = []):
        '''
            Constructor
            @param id: a unique identifier, eventually an URI
            @param title: an atom.Entry instance 
            @param updated: the last time the record was updated
            @param subresult: a Subresults array                       
        '''
        self.totalResult = totalResults
        self.id = id
        self.title = title
        self.updated = updated
        self.subresult = subresult        
        

class Subresult(object):
    def __init__(self, id, title, updated):
        '''
            Constructor
            @param id: a unique identifier, eventually an URI
            @param title: an atom.Entry instance 
            @param updated: the last time the record was updated                        
        '''
        self.id = id
        self.title = title
        self.updated = updated