9 from apiclient import discovery as apiclient_discovery
10 from apiclient import errors as apiclient_errors
15 _logger = logging.getLogger('arvados.api')
17 class CredentialsFromToken(object):
18 def __init__(self, api_token):
19 self.api_token = api_token
22 def http_request(self, uri, **kwargs):
23 from httplib import BadStatusLine
24 if 'headers' not in kwargs:
25 kwargs['headers'] = {}
27 if config.get("ARVADOS_EXTERNAL_CLIENT", "") == "true":
28 kwargs['headers']['X-External-Client'] = '1'
30 kwargs['headers']['Authorization'] = 'OAuth2 %s' % self.arvados_api_token
32 return self.orig_http_request(uri, **kwargs)
34 # This is how httplib tells us that it tried to reuse an
35 # existing connection but it was already closed by the
36 # server. In that case, yes, we would like to retry.
37 # Unfortunately, we are not absolutely certain that the
38 # previous call did not succeed, so this is slightly
40 return self.orig_http_request(uri, **kwargs)
41 def authorize(self, http):
42 http.arvados_api_token = self.api_token
43 http.orig_http_request = http.request
44 http.request = types.MethodType(self.http_request, http)
47 # Monkey patch discovery._cast() so objects and arrays get serialized
48 # with json.dumps() instead of str().
49 _cast_orig = apiclient_discovery._cast
50 def _cast_objects_too(value, schema_type):
52 if (type(value) != type('') and
53 (schema_type == 'object' or schema_type == 'array')):
54 return json.dumps(value)
56 return _cast_orig(value, schema_type)
57 apiclient_discovery._cast = _cast_objects_too
59 # Convert apiclient's HttpErrors into our own API error subclass for better
61 # Reassigning apiclient_errors.HttpError is not sufficient because most of the
62 # apiclient submodules import the class into their own namespace.
63 def _new_http_error(cls, *args, **kwargs):
64 return super(apiclient_errors.HttpError, cls).__new__(
65 errors.ApiError, *args, **kwargs)
66 apiclient_errors.HttpError.__new__ = staticmethod(_new_http_error)
68 def http_cache(data_type):
69 path = os.environ['HOME'] + '/.cache/arvados/' + data_type
71 util.mkdir_dash_p(path)
76 def api(version=None, cache=True, host=None, token=None, insecure=False, apiconfig=None, **kwargs):
77 """Return an apiclient Resources object for an Arvados instance.
80 * version: A string naming the version of the Arvados API to use (for
82 * cache: Use a cache (~/.cache/arvados/discovery) for the discovery
84 * host: The Arvados API server host (and optional :port) to connect to.
85 * token: The authentication token to send with each API call.
86 * insecure: If True, ignore SSL certificate validation errors.
87 * apiconfig: If provided, this should be a dict containing with entries for ARVADOS_API_HOST, ARVADOS_API_TOKEN, and optionally ARVADOS_API_HOST_INSECURE
89 Additional keyword arguments will be passed directly to
90 `apiclient_discovery.build` if a new Resource object is created.
91 If the `discoveryServiceUrl` or `http` keyword arguments are
92 missing, this function will set default values for them, based on
93 the current Arvados configuration settings.
99 _logger.info("Using default API version. " +
100 "Call arvados.api('%s') instead." %
102 if 'discoveryServiceUrl' in kwargs:
104 raise ValueError("both discoveryServiceUrl and host provided")
105 # Here we can't use a token from environment, config file,
106 # etc. Those probably have nothing to do with the host
107 # provided by the caller.
109 raise ValueError("discoveryServiceUrl provided, but token missing")
112 elif not host and not token:
113 # Load from user configuration or environment
114 if apiconfig is None:
115 apiconfig = config.settings()
116 for x in ['ARVADOS_API_HOST', 'ARVADOS_API_TOKEN']:
117 if x not in apiconfig:
118 raise ValueError("%s is not set. Aborting." % x)
119 host = apiconfig.get('ARVADOS_API_HOST')
120 token = apiconfig.get('ARVADOS_API_TOKEN')
121 insecure = config.flag_is_true('ARVADOS_API_HOST_INSECURE', apiconfig)
123 # Caller provided one but not the other
125 raise ValueError("token argument provided, but host missing.")
127 raise ValueError("host argument provided, but token missing.")
130 # Caller wants us to build the discoveryServiceUrl
131 kwargs['discoveryServiceUrl'] = (
132 'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,))
134 if 'http' not in kwargs:
136 # Prefer system's CA certificates (if available) over httplib2's.
137 certs_path = '/etc/ssl/certs/ca-certificates.crt'
138 if os.path.exists(certs_path):
139 http_kwargs['ca_certs'] = certs_path
141 http_kwargs['cache'] = http_cache('discovery')
143 http_kwargs['disable_ssl_certificate_validation'] = True
144 kwargs['http'] = httplib2.Http(**http_kwargs)
146 credentials = CredentialsFromToken(api_token=token)
147 kwargs['http'] = credentials.authorize(kwargs['http'])
149 svc = apiclient_discovery.build('arvados', version, **kwargs)
150 svc.api_token = token
151 kwargs['http'].cache = None