def __init__(self, app, api, config, mount):
RESTEntity.__init__(self, app, api, config, mount)
self.config = config
self.mgr = WMArchiveManager(config)
class WMAData(RESTEntity):
"REST interface for WMArchvie"
def __init__(self, app, api, config, mount):
RESTEntity.__init__(self, app, api, config, mount)
self.config = config
self.mgr = WMArchiveManager(config)
def validate(self, apiobj, method, api, param, safe):
"""
Validate request input data.
Has to be implemented, otherwise the service fails to start.
If it's not implemented correctly (e.g. just pass), the arguments
are not passed in the method at all.
"""
if method == 'GET':
if 'query' in param.kwargs.keys():
validate_str('query', param, safe, PAT_QUERY, optional=True)
for key in ['status', 'jobs', 'adocs', '_']:
if key in param.kwargs.keys():
validate_str(key, param, safe, PAT_INFO, optional=True)
# underscore may come from ajax call via jQuery
validate_str('_', param, safe, PAT_INFO, optional=True)
# test if user provided uid
if len(param.args) == 1 and PAT_UID.match(param.args[0]):
safe.args.append(param.args[0])
param.args.remove(param.args[0])
return True
elif method == 'POST':
if not param.args or not param.kwargs:
return False # this class does not need any parameters
return True
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def get(self, *args, **kwds):
"""
Implement GET request with given uid or set of parameters
All work is done by WMArchiveManager
"""
if kwds.get('status', ''):
return results(dict(status=self.mgr.status()))
if kwds.get('jobs', ''):
return results(dict(jobs=self.mgr.jobs()))
if kwds.get('adocs', ''):
return results(dict(adocs=self.mgr.adocs()))
if args and len(args) == 1: # requested uid
return results(self.mgr.read(args[0], []))
return results({'request': kwds, 'results': 'Not available'})
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def post(self):
"""
Implement POST request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be either
{"data":some_data} for posting the data into WMArchive or
{"spec":some_query, "fields":return_fields} for querying the data in WMArchive.
The some_data should be proper JSON document(s).
The some_query should be use MongoDB QL.
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status':'Not supported, %s' % msg, 'data':[]}
try:
request = json.load(cherrypy.request.body)
if 'spec' in request.keys() and 'fields' in request.keys():
result = self.mgr.read(request['spec'], request['fields'])
elif 'data' in request.keys():
result = self.mgr.write(request['data'])
elif 'job' in request.keys():
result = self.mgr.write(request['job'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError(str(exp))
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def put(self):
"""
Implement PUT request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be in a form
{"ids":[list_of_ids], "spec": update_spec}
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status':'Not supported, %s' % msg, 'data':[]}
try:
request = json.load(cherrypy.request.body)
result = self.mgr.update(request['ids'], request['spec'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError(str(exp))
class WMAData(RESTEntity):
"REST interface for WMArchive"
def __init__(self, app, api, config, mount):
RESTEntity.__init__(self, app, api, config, mount)
self.config = config
self.mgr = WMArchiveManager(config)
def validate(self, apiobj, method, api, param, safe):
"""
Validate request input data.
Has to be implemented, otherwise the service fails to start.
If it's not implemented correctly (e.g. just pass), the arguments
are not passed in the method at all.
"""
if method == 'GET':
# Check for `performance` endpoint, documented in
# https://github.com/knly/WMArchiveAggregation
if len(param.args) == 1 and param.args[0] == 'performance':
safe.args.append(param.args[0])
param.args.remove(param.args[0])
# Validate arguments
validate_strlist('metrics[]', param, safe,
re.compile(r'^[a-zA-Z.]+'))
validate_strlist('axes[]', param, safe,
re.compile(r'^[a-zA-Z_]+'))
validate_strlist('suggestions[]', param, safe,
re.compile(r'^[a-zA-Z]+'))
date_pattern = PAT_YYYYMMDD
validate_str('start_date',
param,
safe,
date_pattern,
optional=True)
validate_str('end_date',
param,
safe,
date_pattern,
optional=True)
validate_rx('workflow', param, safe, optional=True)
validate_rx('task', param, safe, optional=True)
validate_rx('host', param, safe, optional=True)
validate_rx('site', param, safe, optional=True)
validate_rx('jobtype', param, safe, optional=True)
validate_rx('jobstate', param, safe, optional=True)
validate_rx('acquisitionEra', param, safe, optional=True)
validate_rx('exitCode', param, safe, optional=True)
validate_rx('exitStep', param, safe, optional=True)
validate_str('_', param, safe, PAT_INFO, optional=True)
return True
if 'query' in param.kwargs.keys():
validate_str('query', param, safe, PAT_QUERY, optional=True)
for key in ['status', 'jobs', '_']:
if key in param.kwargs.keys():
validate_str(key, param, safe, PAT_INFO, optional=True)
# test if user provided uid
if len(param.args) == 1 and PAT_UID.match(param.args[0]):
safe.args.append(param.args[0])
param.args.remove(param.args[0])
return True
elif method == 'POST':
if not param.args or not param.kwargs:
return False # this class does not need any parameters
return True
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def get(self, *args, **kwds):
"""
Implement GET request with given uid or set of parameters
All work is done by WMArchiveManager
"""
if 'performance' in args:
# documented in https://github.com/knly/WMArchiveAggregation
kwds['metrics'] = kwds.pop('metrics[]', None)
kwds['axes'] = kwds.pop('axes[]', None)
kwds['suggestions'] = kwds.pop('suggestions[]', None)
return results(dict(performance=self.mgr.performance(**kwds)))
if kwds.get('status', ''):
return results(dict(status=self.mgr.status()))
if kwds.get('jobs', ''):
return results(dict(jobs=self.mgr.jobs()))
if args and len(args) == 1: # requested uid
return results(self.mgr.read(args[0], []))
return results({'request': kwds, 'results': 'Not available'})
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def post(self):
"""
Implement POST request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be either
{"data":some_data} for posting the data into WMArchive or
{"spec":some_query, "fields":return_fields} for querying the data in WMArchive.
The some_data should be proper JSON document(s).
The some_query should be use MongoDB QL.
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status': 'Not supported, %s' % msg, 'data': []}
try:
request = json.load(cherrypy.request.body)
if 'spec' in request.keys() and 'fields' in request.keys():
result = self.mgr.read(request['spec'], request['fields'])
elif 'data' in request.keys():
result = self.mgr.write(request['data'])
elif 'job' in request.keys():
result = self.mgr.write(request['job'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except cherrypy.HTTPError:
raise
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError()
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def put(self):
"""
Implement PUT request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be in a form
{"ids":[list_of_ids], "spec": update_spec}
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status': 'Not supported, %s' % msg, 'data': []}
try:
request = json.load(cherrypy.request.body)
result = self.mgr.update(request['ids'], request['spec'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except cherrypy.HTTPError:
raise
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError()
def __init__(self, app, api, config, mount):
RESTEntity.__init__(self, app, api, config, mount)
self.config = config
self.mgr = WMArchiveManager(config)
class WMAData(RESTEntity):
"REST interface for WMArchive"
def __init__(self, app, api, config, mount):
RESTEntity.__init__(self, app, api, config, mount)
self.config = config
self.mgr = WMArchiveManager(config)
def validate(self, apiobj, method, api, param, safe):
"""
Validate request input data.
Has to be implemented, otherwise the service fails to start.
If it's not implemented correctly (e.g. just pass), the arguments
are not passed in the method at all.
"""
if method == 'GET':
# Check for `performance` endpoint, documented in
# https://github.com/knly/WMArchiveAggregation
if len(param.args) == 1 and param.args[0] == 'performance':
safe.args.append(param.args[0])
param.args.remove(param.args[0])
# Validate arguments
validate_strlist('metrics[]', param, safe, re.compile(r'^[a-zA-Z.]+'))
validate_strlist('axes[]', param, safe, re.compile(r'^[a-zA-Z_]+'))
validate_strlist('suggestions[]', param, safe, re.compile(r'^[a-zA-Z]+'))
date_pattern = PAT_YYYYMMDD
validate_str('start_date', param, safe, date_pattern, optional=True)
validate_str('end_date', param, safe, date_pattern, optional=True)
validate_rx('workflow', param, safe, optional=True)
validate_rx('task', param, safe, optional=True)
validate_rx('host', param, safe, optional=True)
validate_rx('site', param, safe, optional=True)
validate_rx('jobtype', param, safe, optional=True)
validate_rx('jobstate', param, safe, optional=True)
validate_rx('acquisitionEra', param, safe, optional=True)
validate_rx('exitCode', param, safe, optional=True)
validate_rx('exitStep', param, safe, optional=True)
validate_str('_', param, safe, PAT_INFO, optional=True)
return True
if 'query' in param.kwargs.keys():
validate_str('query', param, safe, PAT_QUERY, optional=True)
for key in ['status', 'jobs', '_']:
if key in param.kwargs.keys():
validate_str(key, param, safe, PAT_INFO, optional=True)
# test if user provided uid
if len(param.args) == 1 and PAT_UID.match(param.args[0]):
safe.args.append(param.args[0])
param.args.remove(param.args[0])
return True
elif method == 'POST':
if not param.args or not param.kwargs:
return False # this class does not need any parameters
return True
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def get(self, *args, **kwds):
"""
Implement GET request with given uid or set of parameters
All work is done by WMArchiveManager
"""
if 'performance' in args:
# documented in https://github.com/knly/WMArchiveAggregation
kwds['metrics'] = kwds.pop('metrics[]', None)
kwds['axes'] = kwds.pop('axes[]', None)
kwds['suggestions'] = kwds.pop('suggestions[]', None)
return results(dict(performance=self.mgr.performance(**kwds)))
if kwds.get('status', ''):
return results(dict(status=self.mgr.status()))
if kwds.get('jobs', ''):
return results(dict(jobs=self.mgr.jobs()))
if args and len(args) == 1: # requested uid
return results(self.mgr.read(args[0], []))
return results({'request': kwds, 'results': 'Not available'})
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def post(self):
"""
Implement POST request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be either
{"data":some_data} for posting the data into WMArchive or
{"spec":some_query, "fields":return_fields} for querying the data in WMArchive.
The some_data should be proper JSON document(s).
The some_query should be use MongoDB QL.
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status':'Not supported, %s' % msg, 'data':[]}
try:
request = json.load(cherrypy.request.body)
if 'spec' in request.keys() and 'fields' in request.keys():
result = self.mgr.read(request['spec'], request['fields'])
elif 'data' in request.keys():
result = self.mgr.write(request['data'])
elif 'job' in request.keys():
result = self.mgr.write(request['job'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except cherrypy.HTTPError:
raise
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError()
@restcall(formats=[('application/json', JSONFormat())])
@tools.expires(secs=-1)
def put(self):
"""
Implement PUT request API, all work is done by WMArchiveManager.
The request should either provide query to fetch results from back-end
or data to store to the back-end.
The input HTTP request should be in a form
{"ids":[list_of_ids], "spec": update_spec}
"""
msg = 'expect "data", "query" attributes in your request'
result = {'status':'Not supported, %s' % msg, 'data':[]}
try:
request = json.load(cherrypy.request.body)
result = self.mgr.update(request['ids'], request['spec'])
if isinstance(result, GeneratorType):
result = [r for r in result]
return results(result)
except cherrypy.HTTPError:
raise
except Exception as exp:
traceback.print_exc()
raise cherrypy.HTTPError()
