source: TI07-MOLES/trunk/PythonCode/existInterface/eXistInterface.py @ 1275

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

First cut at creating a specific NDG interface to eXist
which is aware of our structures etc ...

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,query,start,number,params={}):
56        ''' Execute a query, return a specific part of the result set, and
57        dump the session automagically '''
58        r=self.xmlrpc.query(query,number,start,params)
59        return r
60       
61class ndg_eXist(eXist_Connector):
62    ''' Adds ndg methods to a "standard" exist Connector '''
63    def __init__(self,myhost='glue.badc.rl.ac.uk'):
64        f=file('passwords.txt','r')
65        pw={}
66        for line in f.readlines():
67            host,userid,password=line.strip().split(' ')
68            pw[host]=(userid,password)
69        eXistConstants = InstanceObject(host=myhost,
70                                userid=pw[myhost][0],
71                                password=pw[myhost][1],
72                                base_path="/exist/servlet",
73                                xmlrpc_base_path="/exist/xmlrpc",
74                                port=8080)
75       
76        eXist_Connector.__init__(self,eXistConstants)
77        self.ids={}
78       
79    def __buildquery(self,query,target):
80        '''Create an NDG full text query '''
81        s="//%s[. &='%s']"%(target,query)
82        return s#xmlrpclib.Binary(s)
83
84    def __buildParamSearch(self,param,value,target):
85        s="for $x in document()//%s where $x[.%s &= '%s'] return $x"%(target,param,value)
86        return s
87
88    def full_text(self,query,target='DIF'):
89        ''' Carry out a full text search within the "target" collection '''
90        id,summary=self.executeQuery(self.__buildquery(query,target))
91        self.ids[id]=0
92        return id,summary
93
94    def retrieveNext(self,id):
95        ''' Takes a sessionID from an existing query and gets the next document '''
96        try:
97            r=self.retrieve(id, self.ids[id])
98            self.ids[id]+=1
99            return r
100        except xmlrpclib.Fault:
101            return None
102   
103    def sessionRelease(self,id):
104        ''' Releases a session and removes the position counter '''
105        try:
106            self.release(id)
107            del self.ids[id]
108            return 1
109        except:
110            return 0
111   
112    def chunkedFullText(self,query,target='DIF',start=0,number=10):
113        ''' Execute a chunked full text query and return the result
114        set '''
115        return self.executeChunkedQuery(self.__buildquery(query,target),start,number,params={})
116   
117   
118       
119   
120
121if __name__=="__main__":
122   
123    existDB=ndg_eXist()
124    id,summary=existDB.full_text('coapec')
125    print summary
126    r=1
127    while r is not None:
128        r=existDB.retrieveNext(id)
129        if r is not None: print r
130    existDB.release(id)
131    print 'done simple'
132    print dir(existDB.xmlrpc)
133   
134    print existDB.chunkedFullText('wdcc')
135   
136   
Note: See TracBrowser for help on using the repository browser.