PPP\Module\ModuleEntryPoint

Complexity

Total Complexity

24

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

86.11%

Importance

Changes	11
Bugs	1	Features	1

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	getRequestBody()	0	3	1
A	outputResponse()	0	4	1
A	buildRequestDeserializer()	0	4	1
A	buildResponseSerializer()	0	4	1
A	outputHttpException()	0	4	1
A	exec()	0	12	3
A	filterRequestMethod()	0	11	4
A	getRequest()	0	8	2
B	cleanResponses()	0	26	5
A	serializeResponse()	0	7	2
A	setHttpResponseCode()	0	7	2

<?php

namespace PPP\Module;

use Deserializers\Exceptions\DeserializationException;
use Exception;
use PPP\DataModel\DeserializerFactory;
use PPP\DataModel\SerializerFactory;
use PPP\Module\DataModel\Deserializers\ModuleRequestDeserializer;
use PPP\Module\DataModel\ModuleRequest;
use PPP\Module\DataModel\ModuleResponse;
use PPP\Module\DataModel\Serializers\ModuleResponseSerializer;

/**
 * Entry point for Modules
 *
 * @licence MIT
 * @author Thomas Pellissier Tanon
 */
class ModuleEntryPoint {

	/**
	 * @var RequestHandler
	 */
	private $requestHandler;

	/**
	 * @param RequestHandler $requestHandler
	 */
	public function __construct(RequestHandler $requestHandler) {
		$this->requestHandler = $requestHandler;
	}

	/**
	 * Main function
	 */
	public function exec() {
		try {
			$this->filterRequestMethod();
			$request = $this->getRequest();
			$responses = $this->requestHandler->buildResponse($request);
			$this->outputResponse($this->serializeResponse($this->cleanResponses($responses, $request)));
		} catch(HttpException $e) {
			$this->outputHttpException($e);
		} catch(Exception $e) {
			$this->outputHttpException(new HttpException($e->getMessage(), 500, $e));
		}
	}

	private function filterRequestMethod() {

filterRequestMethod uses the super-global variable $_SERVER which is generally not recommended.

		if(!array_key_exists('REQUEST_METHOD', $_SERVER)) {
			return;
		}
		if($_SERVER['REQUEST_METHOD'] === 'OPTIONS') {
			exit();

The method filterRequestMethod() contains an exit expression.

		}
		if($_SERVER['REQUEST_METHOD'] !== 'POST') {
			new HttpException('Bad request method: ' . $_SERVER['REQUEST_METHOD'], 405);
		}
	}

	/**
	 * @return ModuleRequest
	 */
	private function getRequest() {
		$requestJson = json_decode($this->getRequestBody(), true);
		try {
			return $this->buildRequestDeserializer()->deserialize($requestJson);
		} catch(DeserializationException $e) {
			throw new HttpException($e->getMessage(), 400, $e);
		}
	}

	public function getRequestBody() {
		return file_get_contents("php://input");
	}

	private function cleanResponses(array $responses, ModuleRequest $request) {
		$cleanedResponses = array();

		/** @var ModuleResponse $response */
		foreach($responses as $response) {
			if($request->getSentenceTree()->equals($response->getSentenceTree())) {
				continue;
			}

			/** @var ModuleResponse $existingResponse */
			foreach($cleanedResponses as $existingResponse) {
				if($existingResponse->getSentenceTree()->equals($response->getSentenceTree())) {
					continue 2;
				}
			}

			$cleanedResponses[] = new ModuleResponse(
				$response->getLanguageCode(),
				$response->getSentenceTree(),
				$response->getMeasures() + $request->getMeasures(),
				$response->getTrace()
			);
		}

		return $cleanedResponses;
	}

	private function outputResponse($serialization) {
		@header('Content-type: application/json');

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

		echo json_encode($serialization);
	}

	private function serializeResponse(array $responses) {
		$serialization = array();
		foreach($responses as $response) {
			$serialization[] = $this->buildResponseSerializer()->serialize($response);
		}
		return $serialization;
	}

	private function buildRequestDeserializer() {
		$deserializerFactory = new DeserializerFactory($this->requestHandler->getCustomResourceNodeDeserializers());
		return new ModuleRequestDeserializer($deserializerFactory->newNodeDeserializer());
	}

	private function buildResponseSerializer() {
		$serializerFactory = new SerializerFactory($this->requestHandler->getCustomResourceNodeSerializers());
		return new ModuleResponseSerializer($serializerFactory->newNodeSerializer());
	}

	private function outputHttpException(HttpException $exception) {
		$this->setHttpResponseCode($exception->getCode());
		echo $exception->getMessage();
	}

	private function setHttpResponseCode($code) {
		if(function_exists('http_response_code')) {
			@http_response_code($code);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

		} else {
			@header('X-PHP-Response-Code: '. $code, true, $code);

It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

		}
	}
}