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, **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.
88 Additional keyword arguments will be passed directly to
89 `apiclient_discovery.build` if a new Resource object is created.
90 If the `discoveryServiceUrl` or `http` keyword arguments are
91 missing, this function will set default values for them, based on
92 the current Arvados configuration settings.
98 _logger.info("Using default API version. " +
99 "Call arvados.api('%s') instead." %
101 if 'discoveryServiceUrl' in kwargs:
103 raise ValueError("both discoveryServiceUrl and host provided")
104 # Here we can't use a token from environment, config file,
105 # etc. Those probably have nothing to do with the host
106 # provided by the caller.
108 raise ValueError("discoveryServiceUrl provided, but token missing")
111 elif not host and not token:
112 return api_from_config(version=version, cache=cache, **kwargs)
114 # Caller provided one but not the other
116 raise ValueError("token argument provided, but host missing.")
118 raise ValueError("host argument provided, but token missing.")
121 # Caller wants us to build the discoveryServiceUrl
122 kwargs['discoveryServiceUrl'] = (
123 'https://%s/discovery/v1/apis/{api}/{apiVersion}/rest' % (host,))
125 if 'http' not in kwargs:
127 # Prefer system's CA certificates (if available) over httplib2's.
128 certs_path = '/etc/ssl/certs/ca-certificates.crt'
129 if os.path.exists(certs_path):
130 http_kwargs['ca_certs'] = certs_path
132 http_kwargs['cache'] = http_cache('discovery')
134 http_kwargs['disable_ssl_certificate_validation'] = True
135 kwargs['http'] = httplib2.Http(**http_kwargs)
137 credentials = CredentialsFromToken(api_token=token)
138 kwargs['http'] = credentials.authorize(kwargs['http'])
140 svc = apiclient_discovery.build('arvados', version, **kwargs)
141 svc.api_token = token
142 kwargs['http'].cache = None
145 def api_from_config(version=None, apiconfig=None, **kwargs):
146 """Return an apiclient Resources object enabling access to an Arvados server
150 A string naming the version of the Arvados REST API to use (for
154 Use a cache (~/.cache/arvados/discovery) for the discovery
158 If provided, this should be a dict-like object (must support the get()
159 method) with entries for ARVADOS_API_HOST, ARVADOS_API_TOKEN, and
160 optionally ARVADOS_API_HOST_INSECURE. If not provided, use
161 arvados.config (which gets these parameters from the environment by
165 # Load from user configuration or environment
166 if apiconfig is None:
167 apiconfig = config.settings()
169 for x in ['ARVADOS_API_HOST', 'ARVADOS_API_TOKEN']:
170 if x not in apiconfig:
171 raise ValueError("%s is not set. Aborting." % x)
172 host = apiconfig.get('ARVADOS_API_HOST')
173 token = apiconfig.get('ARVADOS_API_TOKEN')
174 insecure = config.flag_is_true('ARVADOS_API_HOST_INSECURE', apiconfig)
176 return api(version=version, host=host, token=token, insecure=insecure, **kwargs)