source: mauRepo/CedaMarkup/trunk/ceda_markup/opensearch/os_engine.py @ 8463

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

Major changes

  • Improved Opensearch engine
  • Refactored other markups to the "createMarkup" style
  • Included an opensoftware library for managing Date
  • 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
34
35from os_engine_helper import OSEngineHelper
36from ceda_markup.opensearch.query import createQuery
37from ceda_markup.opensearch.os_request import createOSDescription
38from xml.etree.ElementTree import tostring
39from xml.dom import minidom
40
41 
42
43class OSEngine(object):
44    '''
45    classdocs
46    '''
47
48    def __init__(self, query, osEnResponses, osDescription, osEngineHelper = OSEngineHelper()):
49        '''
50        Constructor
51            @param osQuery: an OSQuery instance
52            @param osResponses: a list of OSEngineResponse instances
53            @param osDescription: an OpenSearchDescription instance                       
54            @param ospath: the URL where the OpenSearch service is hosted
55            @param osEngineHelper:
56        '''
57        self.osQuery = query
58        self.osEnResponses = osEnResponses
59        self.osDescription = osDescription       
60        self.osEngineHelper = osEngineHelper
61        self.osHostURL = 'http://localhost'             
62       
63    def doSearch(self, hostURL, mimetype, context):
64        """
65            Executes the Opensearch call.
66            @param hostURL: the opensearch engine URL
67            @param mimetype: the desired mimetype output
68            @param context: a dictionary containing all the necessary information to exploit the request
69            @return: a response in the required mimetype or None if the mimetype is not supported   
70        """
71        self.osHostURL = hostURL
72        response = None
73        for item in self.osEnResponses:
74            if item.extension == mimetype:
75                response = item
76        if response is not None:
77            queries = createQuery(mimetype, self.osQuery.params_model, context)
78            result = self.osQuery.doSearch(context)
79            packagedResults = response.digestSearchResults(result, context)
80            return response.generateResponse(packagedResults, [queries], self.osHostURL, context)
81        return None             
82   
83    def getDescription(self, ospath):
84        reqDoc = createOSDescription(self.osEnResponses, self.osDescription, self.osQuery, ospath)
85        self.osEngineHelper.additionalDescription(reqDoc)
86        reparsed = minidom.parseString(tostring(reqDoc))
87        return reparsed.toprettyxml(indent="  ")
88
89    def createQueryDictionary(self):
90        '''
91            Returns a dictionary having as keys the query parameters. This method is
92            supposed to be used as utility to migrate the request parameters from the
93            http request to an internal neutral (not any django QueryDict) dictionary.
94            @return: a dictionary
95        '''       
96        ret = {}
97        for param in self.osQuery.params_model:
98            ret[param.par_name] = None
99        return ret
Note: See TracBrowser for help on using the repository browser.