source: hdldemo/trunk/hdldemo.py @ 563

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

added filename to dummy record

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    if 'URL' in self.__dict__:
98      fn = string.split( self.__dict__['URL'], '/' )[-1]
99      self.__dict__['filename'] = fn
100
101  def getSiblings(self):
102     if self.aggregation_level != 'file':
103       print 'No known siblings .....'
104       return
105
106     if 'parent' not in self.__dict__:
107       print 'No parent'
108       return
109
110     self.parent.get()
111     self.siblings = []
112     for c in self.parent.children:
113       if c.REC_id != self.REC_id:
114         self.siblings.append( c )
115
116class main(object):
117  knownargs0 = ['-h','-v','-t']
118  knownargs1 = ['-f','-id']
119  def __init__(self, args):
120    self.htmpl = 'http://hdl.handle.net/api/handles/%s'
121    self.version = '0.01.01'
122    self.args = args
123    self.parseArgs()
124    if self.d.get( '-v', False ):
125      print ( self.version )
126      return
127
128    if self.d.get( '-h', False ):
129      print (self.version)
130      print ( __doc__ )
131      return
132
133    if self.d.get( '-t', False ):
134      self.runTest()
135      return
136
137    if '-f' in self.d:
138      fn = self.d['-f']
139      self.dumpF(fn)
140
141    if '-id' in self.d:
142      id = self.d['-id']
143      self.dumpF('',id=id)
144
145  def dumpF(self,fn, id=None):
146    if id == None:
147      assert os.path.isfile( fn ), 'File %s not found' % fn
148      f = ncHead( fn )
149      thisid = string.replace(f.ga['tracking_id'], 'hdl:999999', '10876.test' )
150    else:
151      thisid = string.replace(id,'hdl:999999', '10876.test' )
152
153    url = self.htmpl % thisid
154    g = ghandle( thisid )
155    self.p = phandle(  g.msg )
156    gp = ghandle(  self.p.d['parent']['value'] )
157    self.pp = phandle(  gp.msg )
158    isReplaced = 'replaced_by' in self.p.d
159    if isReplaced:
160      print '******* OBSOLETE FILE ******'
161      pr = self.p
162      while isReplaced:
163        pr = phandle(  ghandle( pr.d['replaced_by']['value'] ).msg )
164        isReplaced = 'replaced_by' in pr.d
165        print 'REPLACED BY: ',pr.d['URL']['value']
166    else:
167      print 'File is current'
168
169    cl = eval( self.pp.d['children']['value'] )
170    thisfound=False
171    print '------- SIBLINGS -------'
172    for c in cl:
173      if c == thisid:
174        thisfound = True
175      else:
176        gc = ghandle(  c )
177        pc = phandle( gc.msg )
178        isReplaced = 'replaced_by' in pc.d
179        rsq = [pc,]
180        if isReplaced:
181          while isReplaced:
182            pc = phandle(  ghandle( pc.d['replaced_by']['value'] ).msg )
183            isReplaced = 'replaced_by' in pc.d
184            print '>>>', pc.d['URL']['value']
185        elif 'URL' in pc.d:
186          print pc.d['URL']['value']
187        else:
188          print 'Sibling url not found',pc.d.keys()
189
190  def runTest(self):
191    f = ncHead( fn1 )
192    url = self.htmpl % f.ga['tracking_id']
193    hdl = string.replace( f.ga['tracking_id'], 'hdl:999999', '10876.test' )
194    g = ghandle( hdl )
195    self.p = phandle(  g.msg )
196    expected= ['creation_date', 'aggregation_level', 'HS_ADMIN', '10320/loc', 'checksum', 'URL', 'parent']
197    ## 'replaced_by' if obsolete
198    for k in expected:
199      assert k in self.p.d, 'Expected handle content key %s not found:: %s' % (k,str(self.p.d.keys()))
200    assert 'tracking_id' in self.p.d or 'trackingID' in self.p.d, 'No tracking id found: %s' % str(self.p.d.keys())
201    for k in expected:
202      print ('%s: %s' % (k,self.p.d[k]))
203
204    print ('PARSING PARENT ..... ' )
205    print ( self.htmpl % self.p.d['parent']['value'] )
206    g = ghandle( self.p.d['parent']['value'] )
207    self.pp = phandle(  g.msg )
208    for k in self.pp.d.keys():
209      print ('%s: %s' % (k,self.pp.d[k]))
210    #'isReplacedBy' if obsolete
211    expected= ['creation_date', 'aggregation_level', 'HS_ADMIN', '10320/loc', 'checksum', 'URL', 'children', 'tracking_id']
212
213  def parseArgs(self):
214    self.d = {}
215    kn = self.knownargs0 + self.knownargs1
216    xx = []
217    al = self.args[1:]
218    while len(al) > 0:
219      a = al.pop(0)
220      if a not in kn:
221        xx.append(a)
222      elif a in self.knownargs1:
223         self.d[a] = al.pop(0)
224      else:
225         self.d[a] = True
226    if len(xx) > 0:
227      print ('ARGUMENTS NOT RECOGNISED: %s' % str(xx) )
228       
229class ncHead(object):
230  def __init__(self, fn):
231    nc0 = ncq3.open( fn )
232    nc0.getDigest()
233    self.ga = {}
234    for a in nc0.alla:
235      self.ga[a.name] = a.value
236     
237     
238if __name__ == "__main__":
239  import sys
240  m = main( sys.argv )
241
242
Note: See TracBrowser for help on using the repository browser.