source: TI07-MOLES/trunk/PythonCode/wsgi/eXistInterface.py @ 2098

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI07-MOLES/trunk/PythonCode/wsgi/eXistInterface.py@2098
Revision 2098, 6.5 KB checked in by lawrence, 12 years ago (diff)

Further modifications to support xml versions of displayed records in
discovery.

Line 
1# Code inspired by example on eXist website.
2import urllib2, base64, urllib, urlparse, httplib, xmlrpclib, types
3
4class   InstanceObject(object):
5    def __init__(self, **kw):
6        self.dict={}
7        self.dict.update(kw)
8    def __getattr__(self,arg):
9        return self.dict[arg]
10
11class  eXist_Connector(object):
12    """Access class for eXist"""
13    def __init__(self,constants=None):
14        ''' Instantiates the eXist connector using supplied constants '''
15        if constants is None: raise 'NoExistConstants'
16        authinfo = urllib2.HTTPPasswordMgrWithDefaultRealm()
17        authinfo.add_password(None,
18                                  constants.host,
19                                  constants.userid,
20                                  constants.password)
21        authHandler = urllib2.HTTPBasicAuthHandler(authinfo)
22        opener = urllib2.build_opener(authHandler)
23        s = constants.userid+':'+constants.password
24        z = base64.encodestring(s)[:-1] # strip trailing 12
25        opener.addheaders.append(('Authorization', 'Basic %s' % z))
26        self.http_headers = {'Authorization':'Basic %s' % z}
27        self.opener = opener
28        # also create an xmlrpc Server object
29       
30        xmlrpc_uri = '%s%s:%s@%s:%d%s' % ( 
31                                            'http://',
32                                            constants.userid,
33                                            constants.password,
34                                            constants.host,
35                                            constants.port,
36                                            constants.xmlrpc_base_path
37                                        )
38        self.xmlrpc = xmlrpclib.Server(xmlrpc_uri)
39
40    def executeQuery(self, xquery, params={}):
41        '''Execute an xquery string, return session and summary information'''
42        xquery=xmlrpclib.Binary(xquery)
43        id = self.xmlrpc.executeQuery(xquery, params)
44        summary = self.xmlrpc.querySummary(id)
45        return id,summary
46
47    def release(self,id):
48        ''' Release an executeQuery session '''
49        self.xmlrpc.releaseQueryResult(id)
50       
51    def retrieve(self,id,pos,params={}):
52        ''' Retrieve a specific document from an executeQuery result set '''
53        return self.xmlrpc.retrieve(id,pos,params).data
54 
55    def executeChunkedQuery(self,xquery,start,number,params={}):
56        ''' Execute a query, return a specific part of the result set, and
57        dump the session automagically '''
58        xquery=xmlrpclib.Binary(xquery)
59        r=self.xmlrpc.query(xquery,number,start,params)
60        return r
61   
62    def querySummary(self,id):
63        ''' Returns a summary of query results for the result-set referenced by id (which was returned by a previous query '''
64        return self.xmlrpc.querySummary(id)
65   
66    def getHits(self,id):
67        ''' Return the number of hits associated with the query that created session id '''
68        return self.xmlrpc.getHits(id)
69       
70class ndg_eXist(eXist_Connector):
71    ''' Adds ndg methods to a "standard" exist Connector '''
72    def __init__(self,db='glue.badc.rl.ac.uk',passwordFile='passwords.txt'):
73        f=file(passwordFile,'r')
74        pw={}
75        for line in f.readlines():
76            host,userid,password=line.strip().split(' ')
77            pw[host]=(userid,password)
78        eXistConstants = InstanceObject(host=db,
79                                userid=pw[db][0],
80                                password=pw[db][1],
81                                base_path="/exist/servlet",
82                                xmlrpc_base_path="/exist/xmlrpc",
83                                port=8080)
84       
85        eXist_Connector.__init__(self,eXistConstants)
86        self.ids={}
87       
88    def __buildquery(self,query,target=None):
89        '''Create an NDG full text query '''
90        if target is not None:
91            s="//%s[. &='%s']"%(target,query)
92        else: s="/*[. &='%s']"%query
93        return s#xmlrpclib.Binary(s)
94
95    def __buildParamSearch(self,param,value,target):
96        s="for $x in document()//%s where $x[.%s &= '%s'] return $x"%(target,param,value)
97        return s
98
99    def full_text(self,query,target=None):
100        ''' Carry out a full text search within the "target" collection '''
101        id,summary=self.executeQuery(self.__buildquery(query,target))
102        self.ids[id]=0
103        return id,summary
104
105    def retrieveNext(self,id,pos=None):
106        ''' Takes a sessionID from an existing query and gets the next document '''
107        if pos is not None: self.ids[id]=pos
108        try:
109            r=self.retrieve(id, self.ids[id])
110            self.ids[id]+=1
111            return r
112        except xmlrpclib.Fault:
113            return None
114        except KeyError:
115            return None
116   
117    def sessionRelease(self,id):
118        ''' Releases a session and removes the position counter '''
119        try:
120            self.release(id)
121            del self.ids[id]
122            return 1
123        except:
124            return 0
125   
126    def chunkedFullText(self,query,start=1,number=10,target='DIF'):
127        ''' Execute a chunked full text query and return the result
128        set '''
129        return self.executeChunkedQuery(self.__buildquery(query,target),start,number,params={})
130   
131   
132    def getDIF(self,entryID):
133        ''' Get a specific DIF document from a repository by using the entryID '''
134        xq='''for $DE in collection()/DIF[Entry_ID='%s'] return $DE'''%entryID
135        xquery='''for $DE in collection('/db/testdif1')/DIF[Entry_ID='%s'] return $DE'''%entryID
136        id,summary=self.executeQuery(xq)#xquery)
137        if summary['hits']==1:
138            r=self.retrieve(id,0,{})
139            self.sessionRelease(id)
140        else:
141            r=summary['hits']
142        return r
143       
144if __name__=="__main__":
145   
146   
147    existDB=ndg_eXist()
148    gepidaeDB=ndg_eXist(db='gepidae.esc.rl.ac.uk')
149   
150    #these both work fine
151    #id,summary=existDB.full_text('coapec')
152    #print 'GLUE:',summary
153   
154    #print 'GLUE AGAIN:',existDB.querySummary(id)
155   
156    id,summary=gepidaeDB.full_text('coapec')
157    print 'GEPIDAE:\n ',summary
158   
159    #we can retrieve them all and look at them ...
160    r=1
161    # just get one for now
162    #while r is not None:
163    r=gepidaeDB.retrieveNext(id)
164    if r is not None: print r
165
166   
167    #existDB.release(id)
168   
169    gepidaeDB.release(id)
170    #print 'done simple'
171   
172    #now try and get the DIF documents alone:
173    #works fine: print gepidaeDB.getDIF('badc.nerc.ac.uk:DIF:dataent10')
174    #crashes:
175    #print existDB.getDIF('badc.nerc.ac.uk:DIF:dataent10')
176   
177    print 'done getDIF'
178   
179    #start,howmany=4,4
180    #existDB.chunkedFullText('badc',start,howmany)
181   
182   
183
184   
185   
Note: See TracBrowser for help on using the repository browser.