/lib/galaxy/util/json.py
https://bitbucket.org/cistrome/cistrome-harvard/ · Python · 110 lines · 99 code · 10 blank · 1 comment · 37 complexity · bae755ce203fb3d4a07394bfc63571fe MD5 · raw file
- from __future__ import absolute_import
- __all__ = [ "to_json_string", "from_json_string", "json_fix", "validate_jsonrpc_request", "validate_jsonrpc_response", "jsonrpc_request", "jsonrpc_response" ]
- import json
- import logging
- import random
- import socket
- import string
- to_json_string = json.dumps
- from_json_string = json.loads
- log = logging.getLogger( __name__ )
- def json_fix( val ):
- if isinstance( val, list ):
- return [ json_fix( v ) for v in val ]
- elif isinstance( val, dict ):
- return dict( [ ( json_fix( k ), json_fix( v ) ) for ( k, v ) in val.iteritems() ] )
- elif isinstance( val, unicode ):
- return val.encode( "utf8" )
- else:
- return val
- # Methods for handling JSON-RPC
- def validate_jsonrpc_request( request, regular_methods, notification_methods ):
- try:
- request = from_json_string( request )
- except Exception, e:
- return False, request, jsonrpc_response( id = None, error = dict( code = -32700, message = 'Parse error', data = str( e ) ) )
- try:
- assert 'jsonrpc' in request, \
- 'This server requires JSON-RPC 2.0 and no "jsonrpc" member was sent with the Request object as per the JSON-RPC 2.0 Specification.'
- assert request['jsonrpc'] == '2.0', \
- 'Requested JSON-RPC version "%s" != required version "2.0".' % request['jsonrpc']
- assert 'method' in request, 'No "method" member was sent with the Request object'
- except AssertionError, e:
- return False, request, jsonrpc_response( request = request, error = dict( code = -32600, message = 'Invalid Request', data = str( e ) ) )
- try:
- assert request['method'] in ( regular_methods + notification_methods )
- except AssertionError, e:
- return False, request, jsonrpc_response( request = request,
- error = dict( code = -32601,
- message = 'Method not found',
- data = 'Valid methods are: %s' % ', '.join( regular_methods + notification_methods ) ) )
- try:
- if request['method'] in regular_methods:
- assert 'id' in request, 'No "id" member was sent with the Request object and the requested method "%s" is not a notification method' % request['method']
- except AssertionError, e:
- return False, request, jsonrpc_response( request = request, error = dict( code = -32600, message = 'Invalid Request', data = str( e ) ) )
- return True, request, None
- def validate_jsonrpc_response( response, id=None ):
- try:
- response = from_json_string( response )
- except Exception, e:
- log.error( 'Response was not valid JSON: %s' % str( e ) )
- log.debug( 'Response was: %s' % response )
- return False, response
- try:
- assert 'jsonrpc' in response, \
- 'This server requires JSON-RPC 2.0 and no "jsonrpc" member was sent with the Response object as per the JSON-RPC 2.0 Specification.'
- assert ( 'result' in response or 'error' in response ), \
- 'Neither of "result" or "error" members were sent with the Response object.'
- if 'error' in response:
- assert int( response['error']['code'] ), \
- 'The "code" member of the "error" object in the Response is missing or not an integer.'
- assert 'message' in response, \
- 'The "message" member of the "error" object in the Response is missing.'
- except Exception, e:
- log.error( 'Response was not valid JSON-RPC: %s' % str( e ) )
- log.debug( 'Response was: %s' % response )
- return False, response
- if id is not None:
- try:
- assert 'id' in response and response['id'] == id
- except Exception, e:
- log.error( 'The response id "%s" does not match the request id "%s"' % ( response['id'], id ) )
- return False, response
- return True, response
- def jsonrpc_request( method, params=None, id=None, jsonrpc='2.0' ):
- if method is None:
- log.error( 'jsonrpc_request(): "method" parameter cannot be None' )
- return None
- request = dict( jsonrpc = jsonrpc, method = method )
- if params:
- request['params'] = params
- if id is not None and id is True:
- request['id'] = ''.join( [ random.choice( string.hexdigits ) for i in range( 16 ) ] )
- elif id is not None:
- request['id'] = id
- return request
- def jsonrpc_response( request=None, id=None, result=None, error=None, jsonrpc='2.0' ):
- if result:
- rval = dict( jsonrpc = jsonrpc, result = result )
- elif error:
- rval = dict( jsonrpc = jsonrpc, error = error )
- else:
- msg = 'jsonrpc_response() called with out a "result" or "error" parameter'
- log.error( msg )
- rval = dict( jsonrpc = jsonrpc, error = msg )
- if id is not None:
- rval['id'] = id
- elif request is not None and 'id' in request:
- rval['id'] = request['id']
- return rval