source: mauRepo/CedaManager/trunk/ceda_markup/opensearch/os_engine.py @ 8369

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/mauRepo/CedaManager/trunk/ceda_markup/opensearch/os_engine.py@8369
Revision 8369, 3.8 KB checked in by mnagni, 7 years ago (diff)

CedaManager? contains python class definition for many markup languages used in ceda projects

  • Property svn:mime-type set to text/plain
Line 
1'''
2BSD Licence
3Copyright (c) 2012, Science & Technology Facilities Council (STFC)
4All rights reserved.
5
6Redistribution and use in source and binary forms, with or without modification,
7are permitted provided that the following conditions are met:
8
9    * Redistributions of source code must retain the above copyright notice,
10        this list of conditions and the following disclaimer.
11    * Redistributions in binary form must reproduce the above copyright notice,
12        this list of conditions and the following disclaimer in the documentation
13        and/or other materials provided with the distribution.
14    * Neither the name of the Science & Technology Facilities Council (STFC)
15        nor the names of its contributors may be used to endorse or promote
16        products derived from this software without specific prior written permission.
17
18THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
20THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
22BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
23OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29Created on 24 May 2012
30
31@author: Maurizio Nagni
32'''
33
34import mimetypes
35from ceda_markup.opensearch.query import QueryTag
36from ceda_markup.opensearch.os_engine_helper import OSEngineHelper
37if not mimetypes.inited:
38    mimetypes.init()
39    if not mimetypes.types_map.has_key('.atom'):
40        mimetypes.add_type('application/atom+xml', '.atom')
41    if not mimetypes.types_map.has_key('.opensearchdescription'):       
42        mimetypes.add_type('application/opensearchdescription+xml', '.opensearchdescription')
43
44def get_mimetype(extension):
45    return mimetypes.types_map[('.%s') % (extension)] 
46
47class OSEngine(object):
48    '''
49    classdocs
50    '''
51
52    def __init__(self, osRequest, osEngineHelper = OSEngineHelper()):
53        '''
54        Constructor
55            @param osRequest: an OSREquest instance
56            @param ospath: the URL where the OpenSearch service is hosted
57            @param osEngineHelper:
58        '''
59        self.osRequest = osRequest
60        self.osEngineHelper = osEngineHelper
61        self.osHostURL = 'http://localhost'             
62       
63    def doSearch(self, hostURL, mimetype, params_values, **kwargs):
64        self.osHostURL = hostURL
65        response = None
66        for item in self.osRequest.responses:
67            if item.extension == mimetype:
68                response = item
69        if response:
70            kwargs['params_values'] = params_values
71            queries = QueryTag.queryWithRoleRequest(mimetype, self.osRequest.query.params_model, params_values)
72            return response.generateResponse(self.osRequest.query.doSearch(**kwargs), [queries], self.osHostURL, **kwargs)
73        return None               
74   
75    '''
76    def generateURLPath(self, ospath):
77        """
78            Generate the proper URL path, before the parameters, for the Opensearch:URL tag.
79            This method is supposed to be overridden by classes extending OSREsponse           
80            @param ospath: same value of OSEngine.path
81            @return the default implementation return ospath.
82        """
83        return ospath
84    '''   
85   
86    def getDescription(self, ospath):
87        reqDoc = self.osRequest.getDescription(ospath)
88        self.osEngineHelper.additionalDescription(reqDoc)
89        return reqDoc
Note: See TracBrowser for help on using the repository browser.