__init__.py 20.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
# Copyright (C) 2012, 2013 GRNET S.A. All rights reserved.
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.
33 34 35

import logging
import urlparse
36
import urllib
37
import hashlib
38
from copy import copy
39 40

import simplejson
41 42
from astakosclient.utils import \
    retry, scheme_to_class, parse_request, check_input
43
from astakosclient.errors import \
44
    AstakosClientException, Unauthorized, BadRequest, NotFound, Forbidden, \
45
    NoUserName, NoUUID, BadValue, QuotaLimit, InvalidResponse
46 47


48 49 50 51 52 53 54 55 56 57 58
# --------------------------------------------------------------------
# Astakos API urls
API_AUTHENTICATE = "/astakos/api/authenticate"
API_USERCATALOGS = "/astakos/api/user_catalogs"
API_SERVICE_USERCATALOGS = "/astakos/api/service/user_catalogs"
API_GETSERVICES = "/astakos/api/get_services"
API_RESOURCES = "/astakos/api/resources"
API_QUOTAS = "/astakos/api/quotas"
API_SERVICE_QUOTAS = "/astakos/api/service_quotas"
API_COMMISSIONS = "/astakos/api/commissions"
API_COMMISSIONS_ACTION = API_COMMISSIONS + "/action"
59
API_FEEDBACK = "/astakos/api/feedback"
60 61


62
# --------------------------------------------------------------------
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
63
# Astakos Client Class
64

65
def get_token_from_cookie(request, cookie_name):
66 67 68 69 70 71 72 73 74 75 76 77 78 79
    """Extract token from the cookie name provided

    Cookie should be in the same form as astakos
    service sets its cookie contents:
        <user_uniq>|<user_token>

    """
    try:
        cookie_content = urllib.unquote(request.COOKIE.get(cookie_name, None))
        return cookie_content.split("|")[1]
    except:
        return None


Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
80 81 82 83
class AstakosClient():
    """AstakosClient Class Implementation"""

    # ----------------------------------
84 85
    def __init__(self, astakos_url, retry=0,
                 use_pool=False, pool_size=8, logger=None):
86
        """Initialize AstakosClient Class
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
87 88 89 90

        Keyword arguments:
        astakos_url -- i.e https://accounts.example.com (string)
        use_pool    -- use objpool for http requests (boolean)
91
        retry       -- how many time to retry (integer)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
92 93 94 95
        logger      -- pass a different logger

        """
        if logger is None:
96 97 98 99
            logging.basicConfig(
                format='%(asctime)s [%(levelname)s] %(name)s %(message)s',
                datefmt='%Y-%m-%d %H:%M:%S',
                level=logging.INFO)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
100
            logger = logging.getLogger("astakosclient")
101
        logger.debug("Intialize AstakosClient: astakos_url = %s, "
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
102 103
                     "use_pool = %s" % (astakos_url, use_pool))

104
        check_input("__init__", logger, astakos_url=astakos_url)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
105 106 107

        # Check for supported scheme
        p = urlparse.urlparse(astakos_url)
108
        conn_class = scheme_to_class(p.scheme, use_pool, pool_size)
109
        if conn_class is None:
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
110 111
            m = "Unsupported scheme: %s" % p.scheme
            logger.error(m)
112
            raise BadValue(m)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
113

Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
114
        # Save astakos_url etc. in our class
115
        self.retry = retry
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
116 117 118
        self.logger = logger
        self.netloc = p.netloc
        self.scheme = p.scheme
119
        self.path = p.path.rstrip('/')
120
        self.conn_class = conn_class
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
121

122 123
    # ----------------------------------
    @retry
124 125
    def _call_astakos(self, token, request_path,
                      headers=None, body=None, method="GET"):
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
126
        """Make the actual call to Astakos Service"""
127 128 129 130 131 132
        if token is not None:
            hashed_token = hashlib.sha1()
            hashed_token.update(token)
            using_token = "using token %s" % (hashed_token.hexdigest())
        else:
            using_token = "without using token"
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
133
        self.logger.debug(
134 135
            "Make a %s request to %s %s with headers %s and body %s"
            % (method, request_path, using_token, headers, body))
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
136

Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
137
        # Check Input
138 139 140 141
        if headers is None:
            headers = {}
        if body is None:
            body = {}
142
        path = self.path + "/" + request_path.strip('/')
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
143

Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
144 145
        # Build request's header and body
        kwargs = {}
146
        kwargs['headers'] = copy(headers)
147 148
        if token is not None:
            kwargs['headers']['X-Auth-Token'] = token
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
149
        if body:
150
            kwargs['body'] = copy(body)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
151 152 153 154 155 156
            kwargs['headers'].setdefault(
                'content-type', 'application/octet-stream')
        kwargs['headers'].setdefault('content-length',
                                     len(body) if body else 0)

        try:
157 158 159
            # Get the connection object
            with self.conn_class(self.netloc) as conn:
                # Send request
160
                (message, data, status) = \
161
                    _do_request(conn, method, path, **kwargs)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
162
        except Exception as err:
163
            self.logger.error("Failed to send request: %s" % repr(err))
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
164 165 166 167
            raise AstakosClientException(str(err))

        # Return
        self.logger.debug("Request returned with status %s" % status)
168
        if status == 400:
169
            raise BadRequest(message, data)
170
        elif status == 401:
171
            raise Unauthorized(message, data)
172
        elif status == 403:
173
            raise Forbidden(message, data)
174
        elif status == 404:
175
            raise NotFound(message, data)
176
        elif status < 200 or status >= 300:
177
            raise AstakosClientException(message, data, status)
178 179 180 181 182

        try:
            if data:
                return simplejson.loads(unicode(data))
            else:
183
                return None
184
        except Exception as err:
185 186
            self.logger.error("Cannot parse response \"%s\" with simplejson: %s"
                              % (data, str(err)))
187
            raise InvalidResponse(str(err), data)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
188 189

    # ------------------------
190
    # do a GET to ``API_AUTHENTICATE``
191
    def get_user_info(self, token, usage=False):
192
        """Authenticate user and get user's info as a dictionary
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
193 194

        Keyword arguments:
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
195
        token   -- user's token (string)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
196 197 198 199 200 201
        usage   -- return usage information for user (boolean)

        In case of success return user information (json parsed format).
        Otherwise raise an AstakosClientException.

        """
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
202
        # Send request
203
        auth_path = copy(API_AUTHENTICATE)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
204 205
        if usage:
            auth_path += "?usage=1"
206
        return self._call_astakos(token, auth_path)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
207 208

    # ----------------------------------
209
    # do a POST to ``API_USERCATALOGS`` (or ``API_SERVICE_USERCATALOGS``)
210
    #   with {'uuids': uuids}
211
    def _uuid_catalog(self, token, uuids, req_path):
212
        req_headers = {'content-type': 'application/json'}
213
        req_body = parse_request({'uuids': uuids}, self.logger)
214
        data = self._call_astakos(
215
            token, req_path, req_headers, req_body, "POST")
216 217 218
        if "uuid_catalog" in data:
            return data.get("uuid_catalog")
        else:
219
            m = "_uuid_catalog request returned %s. No uuid_catalog found" \
220 221 222
                % data
            self.logger.error(m)
            raise AstakosClientException(m)
223

224
    def get_usernames(self, token, uuids):
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
225 226 227
        """Return a uuid_catalog dictionary for the given uuids

        Keyword arguments:
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
228
        token   -- user's token (string)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
229 230 231 232 233 234
        uuids   -- list of user ids (list of strings)

        The returned uuid_catalog is a dictionary with uuids as
        keys and the corresponding user names as values

        """
235
        req_path = copy(API_USERCATALOGS)
236
        return self._uuid_catalog(token, uuids, req_path)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
237

238 239
    def get_username(self, token, uuid):
        """Return the user name of a uuid (see get_usernames)"""
240
        check_input("get_username", self.logger, uuid=uuid)
241
        uuid_dict = self.get_usernames(token, [uuid])
242 243 244
        if uuid in uuid_dict:
            return uuid_dict.get(uuid)
        else:
245
            raise NoUserName(uuid)
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
246

247
    def service_get_usernames(self, token, uuids):
248
        """Return a uuid_catalog dict using a service's token"""
249
        req_path = copy(API_SERVICE_USERCATALOGS)
250
        return self._uuid_catalog(token, uuids, req_path)
251

252
    def service_get_username(self, token, uuid):
253
        """Return the displayName of a uuid using a service's token"""
254
        check_input("service_get_username", self.logger, uuid=uuid)
255
        uuid_dict = self.service_get_usernames(token, [uuid])
256 257 258
        if uuid in uuid_dict:
            return uuid_dict.get(uuid)
        else:
259
            raise NoUserName(uuid)
260

261
    # ----------------------------------
262
    # do a POST to ``API_USERCATALOGS`` (or ``API_SERVICE_USERCATALOGS``)
263
    #   with {'displaynames': display_names}
264
    def _displayname_catalog(self, token, display_names, req_path):
265
        req_headers = {'content-type': 'application/json'}
266
        req_body = parse_request({'displaynames': display_names}, self.logger)
267
        data = self._call_astakos(
268
            token, req_path, req_headers, req_body, "POST")
269 270 271
        if "displayname_catalog" in data:
            return data.get("displayname_catalog")
        else:
272
            m = "_displayname_catalog request returned %s. " \
273 274 275
                "No displayname_catalog found" % data
            self.logger.error(m)
            raise AstakosClientException(m)
276

277
    def get_uuids(self, token, display_names):
278 279 280 281 282 283 284 285 286 287
        """Return a displayname_catalog for the given names

        Keyword arguments:
        token           -- user's token (string)
        display_names   -- list of user names (list of strings)

        The returned displayname_catalog is a dictionary with
        the names as keys and the corresponding uuids as values

        """
288
        req_path = copy(API_USERCATALOGS)
289
        return self._displayname_catalog(token, display_names, req_path)
290

291
    def get_uuid(self, token, display_name):
292
        """Return the uuid of a name (see getUUIDs)"""
293
        check_input("get_uuid", self.logger, display_name=display_name)
294
        name_dict = self.get_uuids(token, [display_name])
295 296 297 298
        if display_name in name_dict:
            return name_dict.get(display_name)
        else:
            raise NoUUID(display_name)
299

300
    def service_get_uuids(self, token, display_names):
301
        """Return a display_name catalog using a service's token"""
302
        req_path = copy(API_SERVICE_USERCATALOGS)
303
        return self._displayname_catalog(token, display_names, req_path)
304

305
    def service_get_uuid(self, token, display_name):
306
        """Return the uuid of a name using a service's token"""
307
        check_input("service_get_uuid", self.logger, display_name=display_name)
308
        name_dict = self.service_get_uuids(token, [display_name])
309 310 311 312
        if display_name in name_dict:
            return name_dict.get(display_name)
        else:
            raise NoUUID(display_name)
313

Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
314
    # ----------------------------------
315
    # do a GET to ``API_GETSERVICES``
316
    def get_services(self):
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
317
        """Return a list of dicts with the registered services"""
318
        return self._call_astakos(None, copy(API_GETSERVICES))
319 320

    # ----------------------------------
321
    # do a GET to ``API_RESOURCES``
322 323
    def get_resources(self):
        """Return a dict of dicts with the available resources"""
324
        return self._call_astakos(None, copy(API_RESOURCES))
Ilias Tsitsimpis's avatar
Ilias Tsitsimpis committed
325

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    # ----------------------------------
    # do a POST to ``API_FEEDBACK``
    def send_feedback(self, token, message, data):
        """Send feedback to astakos service

        keyword arguments:
        token       -- user's token (string)
        message     -- Feedback message
        data        -- Additional information about service client status

        In case of success return nothing.
        Otherwise raise an AstakosClientException

        """
        check_input("send_feedback", self.logger, message=message, data=data)
        path = copy(API_FEEDBACK)
        req_headers = {'content-type': 'application/json'}
        req_body = urllib.urlencode(
            {'feedback_msg': message, 'feedback_data': data})
        self._call_astakos(token, path, req_headers, req_body, "POST")

347
    # ----------------------------------
348
    # do a GET to ``API_QUOTAS``
349
    def get_quotas(self, token):
350 351 352 353 354 355 356 357 358
        """Get user's quotas

        Keyword arguments:
        token   -- user's token (string)

        In case of success return a dict of dicts with user's current quotas.
        Otherwise raise an AstakosClientException

        """
359
        return self._call_astakos(token, copy(API_QUOTAS))
360

361
    # ----------------------------------
362
    # do a GET to ``API_SERVICE_QUOTAS``
363
    def service_get_quotas(self, token, user=None):
364 365 366 367
        """Get all quotas for resources associated with the service

        Keyword arguments:
        token   -- service's token (string)
368
        user    -- optionally, the uuid of a specific user
369 370

        In case of success return a dict of dicts of dicts with current quotas
371
        for all users, or of a specified user, if user argument is set.
372 373 374
        Otherwise raise an AstakosClientException

        """
375
        query = copy(API_SERVICE_QUOTAS)
376 377 378
        if user is not None:
            query += "?user=" + user
        return self._call_astakos(token, query)
379

380
    # ----------------------------------
381
    # do a POST to ``API_COMMISSIONS``
382 383 384 385
    def issue_commission(self, token, request):
        """Issue a commission

        Keyword arguments:
386
        token   -- service's token (string)
387 388 389 390 391 392 393
        request -- commision request (dict)

        In case of success return commission's id (int).
        Otherwise raise an AstakosClientException.

        """
        req_headers = {'content-type': 'application/json'}
394
        req_body = parse_request(request, self.logger)
395
        try:
396
            response = self._call_astakos(token, copy(API_COMMISSIONS),
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
                                          req_headers, req_body, "POST")
        except AstakosClientException as err:
            if err.status == 413:
                raise QuotaLimit(err.message, err.details)
            else:
                raise

        if "serial" in response:
            return response['serial']
        else:
            m = "issue_commission_core request returned %s. No serial found" \
                % response
            self.logger.error(m)
            raise AstakosClientException(m)

412
    def issue_one_commission(self, token, holder, source, provisions,
413
                             name="", force=False, auto_accept=False):
414 415 416 417 418 419
        """Issue one commission (with specific holder and source)

        keyword arguments:
        token       -- service's token (string)
        holder      -- user's id (string)
        source      -- commission's source (ex system) (string)
420
        provisions  -- resources with their quantity (dict from string to int)
421
        name        -- description of the commission (string)
422 423 424 425 426 427 428 429
        force       -- force this commission (boolean)
        auto_accept -- auto accept this commission (boolean)

        In case of success return commission's id (int).
        Otherwise raise an AstakosClientException.
        (See also issue_commission)

        """
430 431 432
        check_input("issue_one_commission", self.logger,
                    holder=holder, source=source,
                    provisions=provisions)
433 434 435 436

        request = {}
        request["force"] = force
        request["auto_accept"] = auto_accept
437
        request["name"] = name
438 439
        try:
            request["provisions"] = []
440
            for resource, quantity in provisions.iteritems():
441 442 443 444 445 446 447 448 449
                t = {"holder": holder, "source": source,
                     "resource": resource, "quantity": quantity}
                request["provisions"].append(t)
        except Exception as err:
            self.logger.error(str(err))
            raise BadValue(str(err))

        return self.issue_commission(token, request)

450
    # ----------------------------------
451
    # do a GET to ``API_COMMISSIONS``
452 453 454 455
    def get_pending_commissions(self, token):
        """Get Pending Commissions

        Keyword arguments:
456
        token   -- service's token (string)
457 458 459 460 461

        In case of success return a list of pending commissions' ids
        (list of integers)

        """
462
        return self._call_astakos(token, copy(API_COMMISSIONS))
463

464
    # ----------------------------------
465
    # do a GET to ``API_COMMISSIONS``/<serial>
466 467 468 469
    def get_commission_info(self, token, serial):
        """Get Description of a Commission

        Keyword arguments:
470
        token   -- service's token (string)
471 472 473
        serial  -- commission's id (int)

        In case of success return a dict of dicts containing
474
        informations (details) about the requested commission
475 476

        """
477
        check_input("get_commission_info", self.logger, serial=serial)
478

479
        path = API_COMMISSIONS + "/" + str(serial)
480 481
        return self._call_astakos(token, path)

482
    # ----------------------------------
483
    # do a POST to ``API_COMMISSIONS``/<serial>/action"
484 485
    def commission_action(self, token, serial, action):
        """Perform a commission action
486 487

        Keyword arguments:
488
        token   -- service's token (string)
489 490 491 492 493 494
        serial  -- commission's id (int)
        action  -- action to perform, currently accept/reject (string)

        In case of success return nothing.

        """
495 496
        check_input("commission_action", self.logger,
                    serial=serial, action=action)
497

498
        path = API_COMMISSIONS + "/" + str(serial) + "/action"
499
        req_headers = {'content-type': 'application/json'}
500
        req_body = parse_request({str(action): ""}, self.logger)
501 502
        self._call_astakos(token, path, req_headers, req_body, "POST")

503 504 505
    def accept_commission(self, token, serial):
        """Accept a commission (see commission_action)"""
        self.commission_action(token, serial, "accept")
506

507 508 509
    def reject_commission(self, token, serial):
        """Reject a commission (see commission_action)"""
        self.commission_action(token, serial, "reject")
510

511
    # ----------------------------------
512
    # do a POST to ``API_COMMISSIONS_ACTION``
513 514 515 516 517 518 519 520 521 522 523 524 525
    def resolve_commissions(self, token, accept_serials, reject_serials):
        """Resolve multiple commissions at once

        Keyword arguments:
        token           -- service's token (string)
        accept_serials  -- commissions to accept (list of ints)
        reject_serials  -- commissions to reject (list of ints)

        In case of success return a dict of dicts describing which
        commissions accepted, which rejected and which failed to
        resolved.

        """
526 527 528
        check_input("resolve_commissions", self.logger,
                    accept_serials=accept_serials,
                    reject_serials=reject_serials)
529

530
        path = copy(API_COMMISSIONS_ACTION)
531 532 533 534 535 536
        req_headers = {'content-type': 'application/json'}
        req_body = parse_request({"accept": accept_serials,
                                  "reject": reject_serials},
                                 self.logger)
        return self._call_astakos(token, path, req_headers, req_body, "POST")

537

538 539
# --------------------------------------------------------------------
# Private functions
540 541
# We want _doRequest to be a distinct function
# so that we can replace it during unit tests.
542
def _do_request(conn, method, url, **kwargs):
543 544 545 546 547 548
    """The actual request. This function can easily be mocked"""
    conn.request(method, url, **kwargs)
    response = conn.getresponse()
    length = response.getheader('content-length', None)
    data = response.read(length)
    status = int(response.status)
549 550
    message = response.reason
    return (message, data, status)