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

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

mucking around with unicode issues for parsing DIF's ...

  • 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 *
22
23import Cookie
24
25class BrowseSession:
26       
27        ''' Holds the browse and select history '''
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.selected=RingBuffer(5)
38             
39                self.__load()
40                       
41        def __toXML(self):
42                ''' Used to serialise the session into a cookie string '''
43                xml='<ndgCookie><bh>'
44                for uri,name in self.getHistory():
45                        xml+='<i><u>%s</u><n>%s</n></i>'%(uri,name)
46                xml+='</bh><sh>'
47                for uri,name in self.getSelected():
48                    xml+='<i><u>%s</u><n>%s</n></i>'%(uri,name)
49                xml+='</sh></ndgCookie>'
50                return xml
51               
52        def __load(self):
53            ''' get lists of URI values out of a cookie '''
54            try:
55                e=ET.fromstring(self.cookie['history'])
56                for se in e:
57                    for item in se:
58                        uri,name=item.find('u'),item.find('n')
59                        self.__addTo(uri,name,se.tag)
60            except:
61                pass
62                       
63        def __addTo(self,uri,name,tag,ignore=False):
64            d={'bh':self.history,'sh':self.selected}
65            current=d[tag].tolist()
66            if (uri,name) not in current or ignore:
67                d[tag].append((uri,name))
68                       
69        def addToHistory(self,uri,name,ignore=False):
70           ''' Add a URI to the session history'''
71           self.__addTo(uri,name,'bh',ignore)
72                       
73        def getHistory(self):
74           ''' Return a list of the items in the history '''
75           return self.history.tolist()
76       
77        def addToSelected(self,uri,name,ignore=False):
78            ''' Add a URI to the selected items '''
79            self.__addTo(uri,name,'sh',ignore)
80            self.__addTo(uri,name,'bh',ignore)
81                   
82        def getSelected(self):
83            ''' Return a list of selected items '''     
84            return self.selected.tolist()       
85       
86        def makeCookie(self,ndgSec=None):
87                ''' Create a local cookie '''
88                import md5,time,base64
89                # start by creating a unique session id
90                m=md5.new()
91                m.update('this is a seed string')
92                m.update(str(time.time()))
93                cookie=Cookie.SimpleCookie()
94                cookie['session']=base64.encodestring(m.digest())[:-3].replace("/", "$")
95                cookie['history']=self.__toXML()
96
97                return cookie
98       
99class CGIcontroller:
100        ''' Currently holds the cgi environment and controls '''
101       
102        def __init__(self,config):
103                ''' Instantiate the CGI environment'''
104                self.env=os.environ
105                self.path=self.env.get('PATH_INFO','/')
106                self.FieldStorage=getURLdict(cgi.FieldStorage())
107                self.config=config
108                self.response=Response()
109                self.requestURL=self.env.get('SCRIPT_NAME')+'?'+self.env.get('QUERY_STRING')
110                self.selector=selector(self.requestURL,config.get('layout','selectI'))
111               
112
113        def makeGateway(self,cookie=None):
114                ''' Make connection to NDG security '''
115                aa=self.config.get('security','localAA',None)
116                if 'NDG-ID1' in self.FieldStorage and 'NDG-ID2' in self.FieldStorage:
117                    #this is a redirect following login ...
118                    cmdLine=(self.FieldStorage['NDG-ID1'],self.FieldStorage['NDG-ID2'])
119                else: cmdLine=None
120                self.ndgGate=gateway2NDGsession(self.requestURL,aa,cookie=cookie,cmdLine=cmdLine)
121
122        def goforit(self):
123                ''' This method actually responds to the user'''
124               
125                self.ViewTextOnly,self.ViewXML=0,0
126               
127                #Instantiate the Session Environment
128                self.cookie=self.env.get('HTTP_COOKIE',None)
129                self.session=BrowseSession(self.cookie,self.config)
130                if self.config.logfile is not None: self.config.log(self.cookie)
131               
132                #this will do for the moment, although I'd rather the whole
133                #URI was self consistent ...
134               
135                if 'select' in self.FieldStorage:
136                    #need to sort out the name issue ...
137                    self.session.addToSelected(self.FieldStorage['select'],'dif')
138                    #we also need to trim the selector off the current requestURL
139                    self.requestURL=self.requestURL[0:self.requestURL.find('&select')]
140                    self.selector.baseURL=self.requestURL
141               
142                #use name as an error return as well in the following calls ...
143                if 'uri' in self.FieldStorage:
144                    self.uri=self.FieldStorage['uri']
145                    content,name=self.__browse()
146                elif 'search' in self.FieldStorage:
147                    self.searchType=self.FieldStorage['search']
148                    content,name=self.__search()
149                else: 
150                    content,name=self.error('No valid URI'),'Error'
151
152                if not self.ViewTextOnly:
153                    historyHTML='<p>'
154                    for item in self.session.getHistory():
155                        historyHTML+=hyperlink(item[1],item[0])
156                    historyHTML+='</p>'
157                    selectHTML='<p>'
158                    for item in self.session.getSelected():
159                        selectHTML+=hyperlink(item[1],item[0])
160                    selectHTML+='</p>'
161                    self.response.content=renderPage(
162                        content,historyHTML,selectHTML,name,self.config)
163                else:
164                    self.response.content=content
165                self.response.cookie=self.session.makeCookie()
166                return self.response
167               
168        def __browse(self):
169                ''' Handle orthodox browsing '''
170               
171                if self.FieldStorage.has_key('text'):
172                    self.ViewTextOnly=1
173                elif self.FieldStorage.has_key('xml'):
174                    self.ViewXML=1
175               
176                if self.FieldStorage.has_key('ndgSec'):
177                    pass
178               
179                #this is where we invoke NDG security setup
180                self.makeGateway()
181               
182                #get the xml document
183                db=self.config.get('db','exist',None)
184                xml=insecureGetDoc(self.uri,db)
185               
186                #create stub-b instance
187                self.b=stubB(xml,makeHTML=renderEntity)
188               
189                if self.b.xml is None:
190                    content=self.error('Unable to obtain stub-B from database')
191                    return content,0
192                else:
193                    self.session.addToHistory(self.b.Burl,self.b.abbreviation)
194                    self.response.cookie=self.session.makeCookie()
195                    if  self.b.constraints.exist:
196                        # we need to evaluate them
197                        result=self.ndgGate.check(self.b.constraints.SimpleCondition)
198                        if result=='AccessGranted': 
199                            access=1
200                        else:
201                            access=0
202                    else:
203                        access=1
204                    if access:
205                        name=self.b.name
206                        if self.ViewTextOnly:
207                            self.response.contentType='text/plain'
208                            content=et2text(self.b.tree)
209                        elif self.ViewXML==1:
210                            content=et2html(self.b.tree)
211                        else:
212                            content=self.b.toHTML()
213                    else:
214                        name='NDG Browse'
215                        content=result
216
217                    return content,name
218               
219        def __search(self):
220            ''' Handle simple searching within the context of the browse '''
221            if 'SEARCHSTRING' in self.FieldStorage:
222                searchString=self.FieldStorage['SEARCHSTRING']
223                try:
224                    ws=DiscoveryWS()
225                except Exception, e:
226                    return self.error('<p>%s<br/>%s'%(e,'Unable to connect to Search BackEnd')),'Error'
227                hits=ws.SearchFullText(searchString)
228                state=DiscoveryState(ws.sessID,self.requestURL,hits,stride=10)
229                results=ws.GetResults(offset=state.offset,number=state.stride)
230                difs=[]
231                for result in results:
232                    difs.append(xmlCleanup(result))
233                html=renderDiscoverySet(difs,state,selector=self.selector,
234                               summary=1,spatial=1,temporal=1,services=1)
235                title='Search for '+searchString
236                return html,title
237            else:
238                return self.error('No valid search option'),'Error'
239             
240        def error(self,message):
241                ''' Construct a nice formal response, but don't throw a 404 ... '''
242                return '<p>Error: %s</p>'%message
243               
Note: See TracBrowser for help on using the repository browser.