source: mauRepo/HPFos/trunk/src/markup/opensearch/os_engine.py @ 8352

'''
Created on 24 May 2012

@author: kusanagi
'''

import mimetypes
from markup.opensearch.query import QueryTag
from markup.opensearch.os_engine_helper import OSEngineHelper
if not mimetypes.inited:
    mimetypes.init()
    if not mimetypes.types_map.has_key('.atom'):
        mimetypes.add_type('application/atom+xml', '.atom')
    if not mimetypes.types_map.has_key('.opensearchdescription'):        
        mimetypes.add_type('application/opensearchdescription+xml', '.opensearchdescription')

def get_mimetype(extension):
    return mimetypes.types_map[('.%s') % (extension)]  

class OSEngine(object):
    '''
    classdocs
    '''

    def __init__(self, osRequest, ospath, osEngineHelper = OSEngineHelper()):
        '''
        Constructor
            @param osRequest: an OSREquest instance 
            @param ospath: the URL where the OpenSearch service is hosted
            @param osEngineHelper: 
        '''
        self.osRequest = osRequest
        self.ospath = ospath
        self.osEngineHelper = osEngineHelper                
        
    def doSearch(self, mimetype, params_values, **kwargs):
        response = None
        for item in self.osRequest.responses:
            if item.extension == mimetype:
                response = item
        if response:
            kwargs['params_values'] = params_values
            queries = QueryTag.queryWithRoleRequest(mimetype, self.osRequest.query.params_model, params_values)
            return response.generateResponse(self.osRequest.query.doSearch(**kwargs), [queries], self.ospath, **kwargs)
        return None                
    
    '''
    def generateURLPath(self, ospath):
        """
            Generate the proper URL path, before the parameters, for the Opensearch:URL tag.
            This method is supposed to be overridden by classes extending OSREsponse            
            @param ospath: same value of OSEngine.path
            @return the default implementation return ospath. 
        """
        return ospath
    '''    
    
    def getDescription(self, ospath):
        reqDoc = self.osRequest.getDescription(ospath)
        self.osEngineHelper.additionalDescription(reqDoc)
        return reqDoc