source: hdldemo/trunk/hdldemo.py @ 562

Subversion URL: http://proj.badc.rl.ac.uk/svn/exarch/hdldemo/trunk/hdldemo.py@562
Revision 562, 6.3 KB checked in by mjuckes, 3 years ago (diff)

improved class structures

Line 
1"""
2Demonstration handle dump for CMIP/ESGF files ..
3
4 -h: print this message;
5 -v: print version;
6 -t: run a test;
7 -f <file name>: examine file, print path to replacement if this file is obsolete, print path to sibling files.
8 -id <tracking id>: examine handle record of tracking id.
9"""
10## see https://www.handle.net/proxy_servlet.html for info on restfull API
11
12import string, collections, os
13import ncq3
14import xml
15from xml.dom import minidom
16
17try:
18 import urllib
19 from urllib import request
20except:
21 import requests
22
23from testdata import *
24
25class phandle(object):
26 
27  def __init__(self, hdlDict, k='values'):
28    self.h = hdlDict
29    self.d = {}
30    try:
31      for r in hdlDict[k]:
32        self.d[r['type']] = r['data']
33    except:
34      print ( hdlDict[k] )
35      raise
36
37class ghandle(object):
38  htmpl = 'http://hdl.handle.net/api/handles/%s'
39  dh = dummyHandles()
40  def __init__(self,hdl,url=None):
41
42     if hdl[:5] == 'xxxxx':
43       self.msg = self.dh.hh[hdl]
44     else:
45       if url == None:
46         thisid = string.replace(hdl,'hdl:999999', '10876.test' )
47         url = self.htmpl % thisid
48       self.fetch(url)
49
50  def fetch(self,url):
51     print url
52
53     try:
54       fh = request.urlopen( url )
55       msg = eval( fh.read() )
56     except:
57       r = requests.get( url )
58       msg = r.json()
59     assert type( msg ) == type( {} ), 'Response of wrong type'
60     for k in ['responseCode', 'handle']:
61       assert k in msg, 'Required key %s not found: %s' % (k, str( msg.keys() ) )
62
63     ###print ( 'url read ok' )
64     self.msg = msg
65
66class GHandles(object):
67  def __init__(self):
68    self.hh = {}
69  def __call__(self,hdl):
70    if hdl not in self.hh:
71      self.hh[hdl] = ghandle(hdl)
72    return self.hh[hdl]
73
74ghandles = GHandles()
75
76class pyhandle(object):
77  def __init__(self,id):
78    self.REC_id = id
79    self.REC_got = False
80
81  def get(self):
82    if self.REC_got:
83      return
84
85    g = ghandles( self.REC_id )
86    for r in g.msg['values']:
87        if str(r['type']) in ['replaces', 'replacedBy', 'isReplacedBy','parent']:
88          self.__dict__[r['type']] = pyhandle( r['data']['value'] )
89
90        elif r['type']  == 'children':
91          cl = eval( r['data']['value'] )
92          self.__dict__['children'] = [pyhandle(c) for c in cl]
93
94        else:
95          self.__dict__[r['type']] = r['data']['value']
96
97  def getSiblings(self):
98     if self.aggregation_level != 'file':
99       print 'No known siblings .....'
100       return
101
102     if 'parent' not in self.__dict__:
103       print 'No parent'
104       return
105
106     self.parent.get()
107     self.siblings = []
108     for c in self.parent.children:
109       if c.REC_id != self.REC_id:
110         self.siblings.append( c )
111
112class main(object):
113  knownargs0 = ['-h','-v','-t']
114  knownargs1 = ['-f','-id']
115  def __init__(self, args):
116    self.htmpl = 'http://hdl.handle.net/api/handles/%s'
117    self.version = '0.01.01'
118    self.args = args
119    self.parseArgs()
120    if self.d.get( '-v', False ):
121      print ( self.version )
122      return
123
124    if self.d.get( '-h', False ):
125      print (self.version)
126      print ( __doc__ )
127      return
128
129    if self.d.get( '-t', False ):
130      self.runTest()
131      return
132
133    if '-f' in self.d:
134      fn = self.d['-f']
135      self.dumpF(fn)
136
137    if '-id' in self.d:
138      id = self.d['-id']
139      self.dumpF('',id=id)
140
141  def dumpF(self,fn, id=None):
142    if id == None:
143      assert os.path.isfile( fn ), 'File %s not found' % fn
144      f = ncHead( fn )
145      thisid = string.replace(f.ga['tracking_id'], 'hdl:999999', '10876.test' )
146    else:
147      thisid = string.replace(id,'hdl:999999', '10876.test' )
148
149    url = self.htmpl % thisid
150    g = ghandle( thisid )
151    self.p = phandle(  g.msg )
152    gp = ghandle(  self.p.d['parent']['value'] )
153    self.pp = phandle(  gp.msg )
154    isReplaced = 'replaced_by' in self.p.d
155    if isReplaced:
156      print '******* OBSOLETE FILE ******'
157      pr = self.p
158      while isReplaced:
159        pr = phandle(  ghandle( pr.d['replaced_by']['value'] ).msg )
160        isReplaced = 'replaced_by' in pr.d
161        print 'REPLACED BY: ',pr.d['URL']['value']
162    else:
163      print 'File is current'
164
165    cl = eval( self.pp.d['children']['value'] )
166    thisfound=False
167    print '------- SIBLINGS -------'
168    for c in cl:
169      if c == thisid:
170        thisfound = True
171      else:
172        gc = ghandle(  c )
173        pc = phandle( gc.msg )
174        isReplaced = 'replaced_by' in pc.d
175        rsq = [pc,]
176        if isReplaced:
177          while isReplaced:
178            pc = phandle(  ghandle( pc.d['replaced_by']['value'] ).msg )
179            isReplaced = 'replaced_by' in pc.d
180            print '>>>', pc.d['URL']['value']
181        elif 'URL' in pc.d:
182          print pc.d['URL']['value']
183        else:
184          print 'Sibling url not found',pc.d.keys()
185
186  def runTest(self):
187    f = ncHead( fn1 )
188    url = self.htmpl % f.ga['tracking_id']
189    hdl = string.replace( f.ga['tracking_id'], 'hdl:999999', '10876.test' )
190    g = ghandle( hdl )
191    self.p = phandle(  g.msg )
192    expected= ['creation_date', 'aggregation_level', 'HS_ADMIN', '10320/loc', 'checksum', 'URL', 'parent']
193    ## 'replaced_by' if obsolete
194    for k in expected:
195      assert k in self.p.d, 'Expected handle content key %s not found:: %s' % (k,str(self.p.d.keys()))
196    assert 'tracking_id' in self.p.d or 'trackingID' in self.p.d, 'No tracking id found: %s' % str(self.p.d.keys())
197    for k in expected:
198      print ('%s: %s' % (k,self.p.d[k]))
199
200    print ('PARSING PARENT ..... ' )
201    print ( self.htmpl % self.p.d['parent']['value'] )
202    g = ghandle( self.p.d['parent']['value'] )
203    self.pp = phandle(  g.msg )
204    for k in self.pp.d.keys():
205      print ('%s: %s' % (k,self.pp.d[k]))
206    #'isReplacedBy' if obsolete
207    expected= ['creation_date', 'aggregation_level', 'HS_ADMIN', '10320/loc', 'checksum', 'URL', 'children', 'tracking_id']
208
209  def parseArgs(self):
210    self.d = {}
211    kn = self.knownargs0 + self.knownargs1
212    xx = []
213    al = self.args[1:]
214    while len(al) > 0:
215      a = al.pop(0)
216      if a not in kn:
217        xx.append(a)
218      elif a in self.knownargs1:
219         self.d[a] = al.pop(0)
220      else:
221         self.d[a] = True
222    if len(xx) > 0:
223      print ('ARGUMENTS NOT RECOGNISED: %s' % str(xx) )
224       
225class ncHead(object):
226  def __init__(self, fn):
227    nc0 = ncq3.open( fn )
228    nc0.getDigest()
229    self.ga = {}
230    for a in nc0.alla:
231      self.ga[a.name] = a.value
232     
233     
234if __name__ == "__main__":
235  import sys
236  m = main( sys.argv )
237
238
Note: See TracBrowser for help on using the repository browser.