source: TI07-MOLES/trunk/StubB/XSLT/browse/portal/cgi/browseCGI.py @ 996

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI07-MOLES/trunk/StubB/XSLT/browse/portal/cgi/browseCGI.py@996
Revision 996, 6.9 KB checked in by lawrence, 16 years ago (diff)

Further changes associated with the browse/discovery
look and feel

  • Property svn:executable set to *
Line 
1#!/usr/bin/env python
2# CGI Script to support prototype NDG MOLES_Portal (Browse) functionality
3# Bryan Lawrence, April, 2006
4
5import cgi
6#import cgitb;ctitb.enable()
7
8import os
9import ElementTree as ET
10
11from insecure import *
12from secure import *
13from stubB import *
14
15from renderEntity import renderEntity
16from renderPage import renderPage
17from renderDiscoverySet import renderDiscoverySet
18from Utilities import *
19from ETxmlView import *
20from DiscoveryWS import *
21
22import Cookie
23
24class BrowseSession:
25       
26        ''' Holds the browse history and contact details for the NDG session manager, designed
27        to work with the discovery portal as well '''
28       
29        def __init__(self,cookie,config):
30               
31                '''Instantiate with an unsecured browse session (security only
32                required if a secure resource is the target) '''
33                self.config=config
34                self.rawCookie=cookie
35                self.cookie=Cookie.SimpleCookie(cookie)
36                self.history=RingBuffer(10)
37                self.__loadBrowseHistory()
38       
39        def __toXML(self):
40                ''' Used to serialise the history into a cookie string '''
41                xml='<BH>'
42                for uri,name in self.getHistory():
43                        xml+='<i><u>%s</u><n>%s</n></i>'%(uri,name)
44                xml+='</BH>'
45                return xml
46                               
47        def __loadBrowseHistory(self):
48                ''' get the string of URI values out of the cookie (if it's there)'''
49                try:
50                        self.tree=ET.fromstring(self.cookie['BrowseHistory'].value)
51                        for item in self.tree:
52                                self.addToHistory(item.find('u').text,item.find('n').text,ignore=True)
53                except:
54                        pass
55        def addToHistory(self,uri,name,ignore=False):
56                ''' Add a URI to the session history'''
57                if not ignore:
58                        current=self.getHistory()
59                        if (uri,name) not in current:
60                                self.history.append((uri,name))
61                else:
62                        self.history.append((uri,name))
63        def getHistory(self):
64                ''' Return a list of the items in the history '''
65                return self.history.tolist()
66        def makeCookie(self,ndgSec=None):
67                ''' Create a local cookie '''
68                import md5,time,base64
69                # start by creating a unique session id
70                m=md5.new()
71                m.update('this is a seed string')
72                m.update(str(time.time()))
73                cookie=Cookie.SimpleCookie()
74                cookie['session']=base64.encodestring(m.digest())[:-3].replace("/", "$")
75                cookie['BrowseHistory']=self.__toXML()
76                return cookie
77       
78class CGIcontroller:
79        ''' Currently holds the cgi environment and controls '''
80       
81        def __init__(self,config):
82                ''' Instantiate the CGI environment'''
83                self.env=os.environ
84                self.path=self.env.get('PATH_INFO','/')
85                self.FieldStorage=cgi.FieldStorage()
86                self.config=config
87                self.response=Response()
88                self.requestURL=self.env.get('SCRIPT_NAME')+'?'+self.env.get('QUERY_STRING')
89               
90       
91        def makeGateway(self,cookie=None,cmdLine=None):
92                ''' Make connection to NDG security '''
93                aa=self.config.get('security','localAA',None)
94                self.ndgGate=gateway2NDGsession(self.requestURL,aa,cookie=cookie,cmdLine=cmdLine)
95
96        def goforit(self):
97                ''' This method actually responds to the user'''
98               
99                self.ViewTextOnly,self.ViewXML=0,0
100               
101                #Instantiate the Session Environment
102                self.cookie=self.env.get('HTTP_COOKIE',None)
103                self.session=BrowseSession(self.cookie,self.config)
104                if self.config.logfile is not None: self.config.log(self.cookie)
105               
106                #this will do for the moment, although I'd rather the whole
107                #URI was self consistent ...
108               
109                #use name as an error return as well in the following calls ...
110                if self.FieldStorage.has_key('uri'):
111                        self.uri=self.FieldStorage['uri'].value
112                        content,name=self.__browse()
113                elif self.FieldStorage.has_key('search'):
114                        self.searchType=self.FieldStorage['search'].value
115                        content,name=self.__search()
116                else: 
117                        self.response.content=self.error('No valid URI')
118                        return self.response
119               
120                if not self.ViewTextOnly and name !=0:
121                    historyHTML='<p>'
122                    for item in self.session.getHistory():
123                        historyHTML+='<a href="%s">%s</a><br/>'%item
124                    historyHTML+='</p>'
125                    self.response.content=renderPage(
126                        content,historyHTML,historyHTML,name,self.config)
127                else:
128                    self.response.content=content
129                return self.response
130               
131        def __browse(self):
132                ''' Handle orthodox browsing '''
133               
134                if self.FieldStorage.has_key('text'):
135                    self.ViewTextOnly=1
136                elif self.FieldStorage.has_key('xml'):
137                    self.ViewXML=1
138               
139                if self.FieldStorage.has_key('ndgSec'):
140                    pass
141               
142                #this is where we invoke NDG security setup
143                self.makeGateway()
144               
145                #get the xml document
146                db=self.config.get('db','exist',None)
147                xml=insecureGetDoc(self.uri,db)
148               
149                #create stub-b instance
150                self.b=stubB(xml,makeHTML=renderEntity)
151               
152                if self.b.xml is None:
153                    content=self.error('Unable to obtain stub-B from database')
154                    return content,0
155                else:
156                    self.session.addToHistory(self.b.Burl,self.b.abbreviation)
157                    self.response.cookie=self.session.makeCookie()
158                    if  self.b.constraints.exist:
159                        # we need to evaluate them
160                        result=self.ndgGate.check(self.b.constraints.SimpleCondition)
161                        if result=='AccessGranted': 
162                            access=1
163                        else:
164                            access=0
165                    else:
166                        access=1
167                    if access:
168                        name=self.b.name
169                        if self.ViewTextOnly:
170                            self.response.contentType='text/plain'
171                            content=et2text(self.b.tree)
172                        elif self.ViewXML==1:
173                            content=et2html(self.b.tree)
174                        else:
175                            content=self.b.toHTML()
176                    else:
177                        name='NDG Browse'
178                        content=result
179
180                    return content,name
181               
182        def __search(self):
183            ''' Handle simple searching within the context of the browse '''
184            if self.FieldStorage.has_key('SEARCHSTRING'):
185                searchString=self.FieldStorage['SEARCHSTRING'].value
186                ws=DiscoveryWS()
187                ws.SearchFullText(searchString)
188                results=ws.GetResults(number=5)
189                difs=[]
190                for result in results:
191                    difs.append(xmlCleanup(result))
192                html=renderDiscoverySet(difs,summary=1,spatial=1,temporal=1)
193                title='Search for '+searchString
194                return html,title
195            else:
196                return self.error('No valid search optoin'),0
197             
198        def error(self,message):
199                ''' Construct a nice formal response, but don't throw a 404 ... '''
200                return '<p>Error: %s</p>'%message
201               
Note: See TracBrowser for help on using the repository browser.