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

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

Modifications to show original records

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   
70    def getDoc(self,collectionName,documentName):
71        ''' Lightweight interface to the getDocument method '''
72        name='%s/%s'%(collectionName,documentName)
73        r=self.xmlrpc.getDocumentAsString(name,{})
74        return r
75   
76# unfortunately it looks like the exist server doesn't support introspection
77#    def showMethods(self):
78#        print self.xmlrpc.system.listMethods()
79       
80class ndg_eXist(eXist_Connector):
81    ''' Adds ndg methods to a "standard" exist Connector '''
82    def __init__(self,db='glue.badc.rl.ac.uk',passwordFile='passwords.txt'):
83        f=file(passwordFile,'r')
84        pw={}
85        for line in f.readlines():
86            host,userid,password=line.strip().split(' ')
87            pw[host]=(userid,password)
88        eXistConstants = InstanceObject(host=db,
89                                userid=pw[db][0],
90                                password=pw[db][1],
91                                base_path="/exist/servlet",
92                                xmlrpc_base_path="/exist/xmlrpc",
93                                port=8080)
94       
95        eXist_Connector.__init__(self,eXistConstants)
96        self.ids={}
97       
98    def __buildquery(self,query,target=None):
99        '''Create an NDG full text query '''
100        if target is not None:
101            s="//%s[. &='%s']"%(target,query)
102        else: s="/*[. &='%s']"%query
103        return s#xmlrpclib.Binary(s)
104
105    def __buildParamSearch(self,param,value,target):
106        s="for $x in document()//%s where $x[.%s &= '%s'] return $x"%(target,param,value)
107        return s
108
109    def full_text(self,query,target=None):
110        ''' Carry out a full text search within the "target" collection '''
111        id,summary=self.executeQuery(self.__buildquery(query,target))
112        self.ids[id]=0
113        return id,summary
114
115    def retrieveNext(self,id,pos=None):
116        ''' Takes a sessionID from an existing query and gets the next document '''
117        if pos is not None: self.ids[id]=pos
118        try:
119            r=self.retrieve(id, self.ids[id])
120            self.ids[id]+=1
121            return r
122        except xmlrpclib.Fault:
123            return None
124        except KeyError:
125            return None
126   
127    def sessionRelease(self,id):
128        ''' Releases a session and removes the position counter '''
129        try:
130            self.release(id)
131            del self.ids[id]
132            return 1
133        except:
134            return 0
135   
136    def chunkedFullText(self,query,start=1,number=10,target='DIF'):
137        ''' Execute a chunked full text query and return the result
138        set '''
139        return self.executeChunkedQuery(self.__buildquery(query,target),start,number,params={})
140   
141   
142    def getDIF(self,entryID):
143        ''' Get a specific DIF document from a repository by using the entryID '''
144        xq='''for $DE in collection()/DIF[Entry_ID='%s'] return $DE'''%entryID
145        xquery='''for $DE in collection('/db/testdif1')/DIF[Entry_ID='%s'] return $DE'''%entryID
146        id,summary=self.executeQuery(xq)#xquery)
147        if summary['hits']==1:
148            r=self.retrieve(id,0,{})
149            self.sessionRelease(id)
150        else:
151            r=summary['hits']
152        return r
153       
154   
155import unittest
156
157class TestCase(unittest.TestCase):
158   
159    def testFullText(self):
160           
161        ''' Exercises some of the methods based on something we hope might exist in the database '''
162       
163        existDB=ndg_eXist(db='glue.badc.rl.ac.uk')
164        id,summary=existDB.full_text('neodc')
165       
166        r=existDB.retrieveNext(id)
167        d=summary['documents'][0][0]
168        print d
169        doc=existDB.getDoc('/db/discovery/moles',d)
170       
171        ok=existDB.sessionRelease(id)
172        self.assertEqual(1,ok)
173
174if __name__=="__main__":
175    unittest.main()
176 
Note: See TracBrowser for help on using the repository browser.