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

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

Handling selection and browse history better ...

  • 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 htmlUtilities import selector,hyperlink
19from Utilities import *
20from ETxmlView import *
21from DiscoveryWS import *
22from DIF import DIF
23
24import Cookie
25
26class BrowseSession:
27       
28        ''' Holds the browse and select history '''
29       
30        def __init__(self,cookie,config):
31               
32                '''Instantiate with an unsecured browse session (security only
33                required if a secure resource is the target) '''
34                self.config=config
35                self.rawCookie=cookie
36                self.cookie=Cookie.SimpleCookie(cookie)
37                self.history=RingBuffer(10)
38                self.selected=RingBuffer(5)
39             
40                self.__load()
41                       
42        def __toXML(self):
43                ''' Used to serialise the session into a cookie string '''
44                xml='<ndgCookie><bh>'
45                for uri,name in self.getHistory():
46                        xml+='<i><u>%s</u><n>%s</n></i>'%(uri,name)
47                xml+='</bh><sh>'
48                for uri,name in self.getSelected():
49                    xml+='<i><u>%s</u><n>%s</n></i>'%(uri,name)
50                xml+='</sh></ndgCookie>'
51                return xml
52               
53        def __load(self):
54            ''' get lists of URI values out of a cookie '''
55            try:
56                e=ET.fromstring(self.cookie['history'].value)
57                for se in e:
58                    for item in se:
59                        uri,name=item.find('u'),item.find('n')
60                        self.__addTo(uri.text,name.text,se.tag)
61            except KeyError:
62                pass
63                       
64        def __addTo(self,uri,name,tag,ignore=False):
65            d={'bh':self.history,'sh':self.selected}
66            current=d[tag].tolist()
67            if (uri,name) not in current or ignore:
68                d[tag].append((uri,name))
69                       
70        def addToHistory(self,uri,name,ignore=False):
71           ''' Add a URI to the session history'''
72           self.__addTo(uri,name,'bh',ignore)
73                       
74        def getHistory(self):
75           ''' Return a list of the items in the history '''
76           return self.history.tolist()
77       
78        def addToSelected(self,uri,name,ignore=False):
79            ''' Add a URI to the selected items '''
80            self.__addTo(uri,name,'sh',ignore)
81            self.__addTo(uri,name,'bh',ignore)
82                   
83        def getSelected(self):
84            ''' Return a list of selected items '''     
85            return self.selected.tolist()       
86       
87        def makeCookie(self,ndgSec=None):
88                ''' Create a local cookie '''
89                import md5,time,base64
90                # start by creating a unique session id
91                m=md5.new()
92                m.update('this is a seed string')
93                m.update(str(time.time()))
94                cookie=Cookie.SimpleCookie()
95                cookie['session']=base64.encodestring(m.digest())[:-3].replace("/", "$")
96                cookie['history']=self.__toXML()
97                if ndgSec is not None:
98                    cookie['NDG-ID1']=ndgSec[0]
99                    cookie['NDG-ID2']=ndgSec[1]
100                return cookie
101       
102class Request:
103    ''' Holds the request URL etc '''
104    def __init__(self,env):
105        self.env=env
106        self.URL='http://%s:%s%s'%(env.get('SERVER_NAME'),env.get('SERVER_PORT'),
107        env.get('SCRIPT_NAME'))
108        qs=env.get('QUERY_STRING')
109        if qs!='': self.URL+='?'+qs
110
111class CGIcontroller:
112        ''' Currently holds the cgi environment and controls '''
113       
114        def __init__(self,config):
115                ''' Instantiate the CGI environment'''
116                #
117                # Need to refactor all of this to use the request class and then move
118                # the request class out into the utilities ...
119                #
120                self.env=os.environ
121                self.path=self.env.get('PATH_INFO','/')
122                self.FieldStorage=getURLdict(cgi.FieldStorage())
123                self.config=config
124                self.response=Response()
125                self.request=Request(self.env)
126                self.requestURL=self.request.URL
127                self.selector=selector(self.requestURL,'select',config.get('layout','selectI'))
128                self.serviceFile=self.config.get('services','serviceFile')
129               
130
131        def makeGateway(self,cookie=None):
132                ''' Make connection to NDG security and load what is necessary for
133                an NDG cookie to be written '''
134                aa=self.config.get('security','localAA',None)
135                if 'NDG-ID1' in self.FieldStorage and 'NDG-ID2' in self.FieldStorage:
136                    #this is a redirect following login ...
137                    cmdLine=(self.FieldStorage['NDG-ID1'],self.FieldStorage['NDG-ID2'])
138                else: cmdLine=None
139                self.ndgGate=gateway2NDGsession(self.requestURL,self.config,aa,cookie=self.cookie,cmdLine=cmdLine)
140                self.ndgSec=cmdLine
141
142        def goforit(self):
143                ''' This method actually responds to the user'''
144               
145                self.ViewTextOnly,self.ViewXML=0,0
146               
147                #Instantiate the Session Environment
148                cookie=self.env.get('HTTP_COOKIE',None)
149                self.session=BrowseSession(cookie,self.config)
150                self.cookie=self.session.cookie # now a cookie class object ...
151                if self.config.logfile is not None: self.config.log(self.cookie)
152               
153                #this is where we invoke NDG security setup, even if we don't
154                #need it ...
155                self.makeGateway()
156               
157                #this will do for the moment, although I'd rather the whole
158                #URI was self consistent using the request object.
159               
160                if 'select' in self.FieldStorage:
161                    n=self.FieldStorage['name']
162                    s=ServiceBinding(n=n,
163                                     entryID=self.FieldStorage['select'],
164                                     serviceFile=self.serviceFile)
165                    self.session.addToSelected(s.url,n)
166
167                    #we also need to trim the selector off the current requestURL
168                    self.requestURL=self.requestURL[0:self.requestURL.find('&select')]
169                    self.selector.baseURL=self.requestURL
170               
171                #use name as an error return as well in the following calls ...
172                if 'uri' in self.FieldStorage:
173                    self.uri=self.FieldStorage['uri']
174                    content,name=self.__browse()
175                elif 'search' in self.FieldStorage:
176                    self.searchType=self.FieldStorage['search']
177                    content,name=self.__search()
178                else: 
179                    content,name=self.error('No URI or search string. Begin browsing via search box or pass a specific URI argument.'),'No URI'
180
181                if not self.ViewTextOnly:
182                    historyHTML='<p>'
183                    for item in self.session.getHistory():
184                        historyHTML+=hyperlink(item[1],item[0])+'<br/>'
185                    historyHTML+='</p>'
186                    selectHTML='<p>'
187                    for item in self.session.getSelected():
188                        selectHTML+=hyperlink(item[1],item[0])+'<br/>'
189                    selectHTML+='</p>'
190                    self.response.content=renderPage(
191                        content,historyHTML,selectHTML,name,self.config)
192                else:
193                    self.response.content=content
194                self.response.cookie=self.session.makeCookie(ndgSec=self.ndgSec)
195                return self.response
196               
197        def __browse(self):
198                ''' Handle orthodox browsing '''
199               
200                if self.FieldStorage.has_key('text'):
201                    self.ViewTextOnly=1
202                elif self.FieldStorage.has_key('xml'):
203                    self.ViewXML=1
204               
205                format='NDG-B0'
206                if self.FieldStorage.has_key('D'):format='DIF'
207               
208                #get the xml document
209                db=self.config.get('db','exist',None)
210                jar=self.config.get('services','jarLoc')
211                javabin=self.config.get('services','javaBinary')
212                xml=insecureGetDoc(self.uri,db=db,format=format,jar=jar,javaBin=javabin)
213               
214                #create document instance
215                if format=='NDG-B0':
216                    self.b=stubB(xml,serviceFile=self.serviceFile)
217                elif format=='DIF':
218                    self.b=DIF(xml,serviceFile=self.serviceFile)
219               
220                if self.b.xml is None:
221                    content=self.error('Unable to obtain record from database')
222                    return content,0
223                else:
224                    self.session.addToHistory(self.b.binding.url,self.b.abbreviation)
225                    if  self.b.constraints.exist:
226                        # we need to evaluate them
227                        try:
228                             result=self.ndgGate.check(self.b.constraints.SimpleCondition)
229                             if result=='AccessGranted': 
230                                access=1
231                             else:
232                                access=0
233                        except:
234                             #unable to make ndggate check ... deny
235                             access=0
236                             result=self.error('Unable to connect to security gateway, access to secure resource denied')
237                    else:
238                        access=1
239                    if access:
240                        name=self.b.name
241                        if self.ViewTextOnly:
242                            self.response.contentType='text/plain'
243                            content=et2text(self.b.tree)
244                        elif self.ViewXML==1:
245                            content=et2html(self.b.tree)
246                        else:
247                            content=self.b.toHTML(self.config)
248                    else:
249                        name='NDG Browse'
250                        content=result
251
252                    return content,name
253               
254        def __search(self):
255            ''' Handle simple searching within the context of the browse '''
256            if 'SEARCHSTRING' in self.FieldStorage:
257                searchString=self.FieldStorage['SEARCHSTRING']
258                title='Search for '+searchString
259                try:
260                    ws=DiscoveryWS()
261                except Exception, e:
262                    return self.error('<p>%s<br/>%s'%(e,'Unable to connect to Search BackEnd')),'Error'
263                try:
264                    hits=ws.SearchFullText(searchString)
265                    state=DiscoveryState(ws.sessID,self.requestURL,hits,stride=10)
266                    results=ws.GetResults(offset=state.offset,number=state.stride)
267                except TypeError:
268                    # this is not what these web services should do, they should
269                    # return an empty set or something which matches the argument
270                    # list, but at least I think this traps the empty set.
271                    return self.error('No records found'),title
272                difs=[]
273               
274                for result in results: difs.append(DIF(result,serviceFile=self.serviceFile))
275                html=renderDiscoverySet(difs,state,selector=self.selector,
276                               summary=1,spatial=1,temporal=1,services=1)
277               
278                return html,title
279            else:
280                return self.error('No valid search option'),'Error'
281             
282        def error(self,message):
283                ''' Construct a nice formal response, but don't throw a 404 ... '''
284                return '<p>Error: %s</p>'%message
285               
Note: See TracBrowser for help on using the repository browser.