gbv / jskos-http

src/Server.php

<?php declare(strict_types = 1);

namespace JSKOS;

use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Http\Message\ResponseFactory;
use Http\Discovery\MessageFactoryDiscovery;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;

/**
 * A JSKOS Server.
 */
class Server implements \Psr\Log\LoggerAwareInterface
{
    protected $service;
    protected $responseFactory;
    protected $logger;

    public function __construct(
        Service $service, 
        ResponseFactory $responseFactory=null,
        LoggerInterface $logger=null 
    )
    {
        $this->service = $service;
        $this->responseFactory = $responseFactory ?: MessageFactoryDiscovery::find();
        $this->logger = $logger ?: new NullLogger();
    }

    public function setLogger(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function queryService(array $query, string $path=''): ResponseInterface 
    {
        if (preg_match('/^[$A-Z_][0-9A-Z_$.]*$/i', $query['callback'] ?? '')) {
            $callback = $query['callback'];
            unset($query['callback']);
        }

        # TODO: detect conflicting parameters?
        # if (isset($params['uri']) and isset($params['search'])) {

80% of this comment could be valid code. Did you maybe forget this after debugging?

        #   $error = new Error(422, 'request_error', 'Conflicting request parameters uri & search');

56% of this comment could be valid code. Did you maybe forget this after debugging?

        # }

        try {
            $result = $this->service->query($query, $path);
            // TODO
        } catch(Error $error) {
            $result = $error;
        }

        # TODO: catch other kinds of errors:
        # } catch (\Exception $e) {

50% of this comment could be valid code. Did you maybe forget this after debugging?

        # $this->logger->error('Service Exception', ['exception' => $e]);

69% of this comment could be valid code. Did you maybe forget this after debugging?

        # $error = new Error(500, 'Internal server error');

54% of this comment could be valid code. Did you maybe forget this after debugging?

        return $this->buildResponse($result, 'GET', $callback ?? null);
    }

    public function query(RequestInterface $request): ResponseInterface
    {    
        $method = $request->getMethod();

        if ($method == 'OPTIONS') {            
            return $this->optionsResponse();
        } elseif ($method != 'GET' && $method != 'HEAD') {
            return $this->buildResponse(new Error(405, 'Method not allowed'));
        }

        $uri = $request->getUri();
        $path = $uri->getPath();        
        $query = [];
        parse_str($uri->getQuery(), $query);

        # TODO: get language parameter from headers

        return $this->queryService($query, $path);

It seems like $query can also be of type null; however, JSKOS\Server::queryService() does only seem to accept array, maybe add an additional type check?

    }

    protected function buildResponse($result, $method='GET', $callback=null): ResponseInterface
    {
        $body = $result->json();
        $context = Resource::DEFAULT_CONTEXT;

        $headers = [
            'Access-Control-Allow-Origin' => '*',
            'Content-Type' => 'application/json; charset=UTF-8',
            'Content-Length' => strlen($body),
            'Link' => "<$context>; rel=\"http://www.w3.org/ns/json-ld#context\"; type=\"application/ld+json\""
        ];

        if ($method == 'HEAD') {
            $body = '';
        }

        if ($callback) {
            $body = "/**/$callback($body);";
            $headers['Content-Type'] = 'application/javascript; charset=UTF-8';
        }

        if ($result instanceof Result) {
            $headers['X-Total-Count'] = $result->getTotalCount();
            $code = '200';
        } else {
            $code = $result->code;
        }
 
        return $this->responseFactory->createResponse($code, null, $headers, $body);
    }

    public function optionsResponse(): ResponseInterface
    {
        $headers = [
            'Access-Control-Allow-Methods' => 'GET, HEAD, OPTIONS',
        ];

        # TODO:
        # if (isset($_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD']) &&

77% of this comment could be valid code. Did you maybe forget this after debugging?

        #    $_SERVER['HTTP_ACCESS_CONTROL_REQUEST_METHOD'] == 'GET') {

59% of this comment could be valid code. Did you maybe forget this after debugging?

        #    $response->headers['Access-Control-Allow-Origin'] = '*';

59% of this comment could be valid code. Did you maybe forget this after debugging?

        #    $response->headers['Acess-Control-Expose-Headers'] = 'Link, X-Total-Count';

59% of this comment could be valid code. Did you maybe forget this after debugging?

        return $this->responseFactory->createResponse(200, null, $headers, '');
    }

    /**
     * TODO: Extract requested languages(s) from request.
    public function extractRequestLanguage($params)
    {
        $language = null;

        # get query modifier: language
        if (isset($params['language'])) {
            $language = $params['language'];
            unset($params['language']);
            # TODO: parse language
        } elseif (isset($_SERVER['HTTP_ACCEPT_LANGUAGE'])) {
            # parse accept-language-header
            preg_match_all(
                '/([a-z]+(?:-[a-z]+)?)\s*(?:;\s*q\s*=\s*(1|0?\.[0-9]+))?/i',
                $_SERVER['HTTP_ACCEPT_LANGUAGE'],
                $match);
            if (count($match[1])) {
                foreach ($match[1] as $i => $l) {
                    if (isset($match[2][$i]) && $match[2][$i] != '') {
                        $langs[strtolower($l)] = (float) $match[2][$i];
                    } else {
                        $langs[strtolower($l)] = 1;
                    }
                }
                arsort($langs, SORT_NUMERIC);
                reset($langs);
                $language = key($langs); # most wanted language
            }
        }
        
        return $language;
    }
*/

	/**
	 * Utility function to emit a Response without additional framework.
	 */
    public static function sendResponse(ResponseInterface $response) 
    {
		$code = $response->getStatusCode();
		$reason = $response->getReasonPhrase();
		header(
			sprintf('HTTP/%s %s %s', $response->getProtocolVersion(), $code, $reason),
			true, $code 
		);

		foreach ($response->getHeaders() as $header => $values) {
			foreach ($values as $value) {
				header("$header: $value", false);
			}
		}

		echo $response->getBody();
	}
}