Phraseanet/lib/Alchemy/Phrasea/Controller/Api/Result.php

<?php

/*
 * This file is part of Phraseanet
 *
 * (c) 2005-2014 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Phrasea\Controller\Api;

use Alchemy\Phrasea\ControllerProvider\Api\V1;
use Alchemy\Phrasea\ControllerProvider\Api\V3;
use Alchemy\Phrasea\Utilities\Stopwatch;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Yaml\Dumper;

class Result
{
    private static $defaultVersion = '1.0.0';

    /** @var string */
    private $responseTime;

    /** @var integer */
    private $code = 200;

    /** @var string */
    private $errorType;

    /** @var string */
    private $errorMessage;

    /** @var string */
    private $errorDetails;

    /** @var Request */
    private $request;

    /** @var mixed */
    private $data;

    /** @var string */
    private $responseType;

    /** @var string */
    private $version;

    const FORMAT_JSON = 'json';
    const FORMAT_YAML = 'yaml';
    const FORMAT_JSONP = 'jsonp';

    const FORMAT_JSON_EXTENDED = 'json+extended';
    const FORMAT_YAML_EXTENDED = 'yaml+extended';
    const FORMAT_JSONP_EXTENDED = 'jsonp+extended';

    const ERROR_BAD_REQUEST = 'Bad Request';
    const ERROR_UNAUTHORIZED = 'Unauthorized';
    const ERROR_FORBIDDEN = 'Forbidden';
    const ERROR_NOTFOUND = 'Not Found';
    const ERROR_MAINTENANCE = 'Service Temporarily Unavailable';
    const ERROR_METHODNOTALLOWED = 'Method Not Allowed';
    const ERROR_INTERNALSERVERERROR = 'Internal Server Error';
    const ERROR_UNACCEPTABLE = 'Unacceptable';
    const ERROR_UNPROCESSABLEENTITY = 'Unprocessable Entity';

    public function __construct(Request $request, array $data = null, $code = 200, $errorType = null, $errorMessage = null, $errorDetails = null)
    {
        $date = new \DateTime();

        $this->request = $request;
        $this->responseTime = $date->format(DATE_ATOM);
        $this->data = new \stdClass();

        $this->parseResponseType();

        $this->setData($data);
        $this->code = $code;
        $this->errorType = $errorType;
        $this->errorMessage = $errorMessage;
        $this->errorDetails = $errorDetails;
    }

    /**
     * Creates a Symfony Response
     *
     * include lapses from stopwatch(es) as server-timing headers
     *
     * @param Stopwatch[] $stopwatches
     * @return Response
     */
    public function createResponse($stopwatches=[])
    {
        $response = $this->format();
        $response->headers->set('content-type', $this->getContentType());
        // add specific timing debug
        foreach($stopwatches as $stopwatch) {
            $response->headers->set('Server-Timing', $stopwatch->getLapsesAsServerTimingHeader(), false);
        }
        $response->setStatusCode($this->getStatusCode());
        $response->setCharset('UTF-8');

        // add general timing debug
        $duration = (microtime(true) - $this->request->server->get('REQUEST_TIME_FLOAT')) * 1000.0;
        $h = '_global;' . 'dur=' . $duration;
        $response->headers->set('Server-Timing', $h, false);    // false : add header (don't replace)

        return $response;
    }


    /**
     * @param Request $request
     * @param $data
     *
     * @return Result
     */
    public static function create(Request $request, $data)
    {
        return new static($request, $data);
    }

    /**
     * @param Request $request
     * @param $code
     * @param $message
     *
     * @return Result
     *
     * @throws \InvalidArgumentException
     */
    public static function createError(Request $request, $code, $message)
    {
        $errorDetails = $message;

        switch ($code) {
            case 400:
                $errorType = self::ERROR_BAD_REQUEST;
                $errorMessage = 'Parameter is invalid or missing';
                break;
            case 401:
                $errorType = self::ERROR_UNAUTHORIZED;
                $errorMessage = 'The OAuth token was provided but was invalid.';
                break;
            case 403:
                $errorType = self::ERROR_FORBIDDEN;
                $errorMessage = 'Access to the requested resource is forbidden';
                break;
            case 404:
                $errorType = self::ERROR_NOTFOUND;
                $errorMessage = 'Requested resource is not found';
                break;
            case 405:
                $errorType = self::ERROR_METHODNOTALLOWED;
                $errorMessage = 'Attempting to use POST with a GET-only endpoint, or vice-versa';
                break;
            case 406:
                $errorType = self::ERROR_UNACCEPTABLE;
                $errorMessage = 'Request content type is not acceptable';
                break;
            case 422:
                $errorType = self::ERROR_UNPROCESSABLEENTITY;
                $errorMessage = 'Request content is unprocessable';
                break;
            case 500:
                $errorType = self::ERROR_INTERNALSERVERERROR;
                $errorMessage = 'Internal Server Error';
                break;
            case 503:
                $errorType = self::ERROR_MAINTENANCE;
                $errorMessage = 'Server is offline for maintenance, try again soon.';
                break;
            default:
                throw new \InvalidArgumentException('Unable to generate a response.');
        }

        return new static($request, null, $code, $errorType, $errorMessage, $errorDetails);
    }

    public static function createBadRequest(Request $request, $message = '')
    {
        $response = self::createError($request, 400, $message)->createResponse();
        $response->headers->set('X-Status-Code', $response->getStatusCode());

        return $response;
    }

    private function parseResponseType()
    {
        if (trim($this->request->get('callback')) !== '') {
            return $this->responseType = self::FORMAT_JSONP;
        }

        $responseTypes = array_map('strtolower', $this->request->getAcceptableContentTypes());

        if (in_array('application/json', $responseTypes)) {
            return $this->responseType = self::FORMAT_JSON;
        }
        if (in_array('application/yaml', $responseTypes)) {
            return $this->responseType = self::FORMAT_YAML;
        }
        if (in_array('text/yaml', $responseTypes)) {
            return $this->responseType = self::FORMAT_YAML;
        }

        return $this->responseType = self::FORMAT_JSON;
    }

    /**
     * Sets data to the response.
     *
     * If no datas provided, a stdClass if set,
     * so the serialized datas will be objects
     *
     * @param array $datas
     *
     * @return Result
     */
    private function setData(array $data = null)
    {
        if (null === $data || count($data) === 0) {
            $data = new \stdClass();
        }

        $this->data = $data;

        return $this;
    }

    /**
     * Formats the data and return serialized string
     *
     * @return Response
     */
    private function format()
    {
        $request_uri = sprintf('%s %s', $this->request->getMethod(), $this->request->getBasePath().$this->request->getPathInfo());

        $ret = [
            'meta' => [
                'api_version'   => $this->getVersion(),
                'request'       => $request_uri,
                'response_time' => $this->responseTime,
                'http_code'     => $this->code,
                'error_type'    => $this->errorType,
                'error_message' => $this->errorMessage,
                'error_details' => $this->errorDetails,
                'charset'       => 'UTF-8',
            ],
            'response'          => $this->data,
        ];

        switch ($this->responseType) {
            case self::FORMAT_JSON:
            default:
                return new JsonResponse($ret);
            case self::FORMAT_YAML:
                if ($ret['response'] instanceof \stdClass) {
                    $ret['response'] = [];
                }

                $dumper = new Dumper();

                return new Response($dumper->dump($ret, 8));
            case self::FORMAT_JSONP:
                $response = new JsonResponse($ret);
                $response->setCallback(trim($this->request->get('callback')));

                return $response;
                break;
        }
    }

    /**
     * @param string|null $version
     */
    public function setVersion($version)
    {
        $this->version = (string)$version;
    }

    public static function setDefaultVersion($version)
    {
        self::$defaultVersion = $version;
    }

    public function getVersion()
    {
        if (null === $this->version) {
            if ($this->request->attributes->get('api_version')) {
                $this->version = $this->request->attributes->get('api_version');
            } elseif (mb_strpos($this->request->getPathInfo(), '/api/v1') !== FALSE) {
                $this->version = V1::VERSION;
            }  elseif (mb_strpos($this->request->getPathInfo(), '/api/v3') !== FALSE) {
                $this->version = V3::VERSION;
            } else {
                $this->version = self::$defaultVersion;
            }
        }

        return $this->version;
    }

    /**
     * Returns serialized data content type
     *
     * @return string
     */
    private function getContentType()
    {
        switch ($this->responseType) {
            case self::FORMAT_JSON:
            default:
                return 'application/json';
            case self::FORMAT_YAML:
                return 'application/yaml';
            case self::FORMAT_JSONP:
                return 'text/javascript';
        }
    }

    /**
     * Returns the correct http code depending on the errors
     *
     * @return integer
     */
    private function getStatusCode()
    {
        if ($this->responseType == self::FORMAT_JSONP && $this->code != 500) {
            return 200;
        }

        return $this->code;
    }
}