<?php
namespace AmeliaBooking\Application\Controller;
use AmeliaBooking\Application\Commands\Command;
use AmeliaBooking\Application\Commands\CommandResult;
use AmeliaBooking\Application\Common\Exceptions\AccessDeniedException;
use AmeliaBooking\Application\Services\User\UserApplicationService;
use AmeliaBooking\Domain\Common\Exceptions\AuthorizationException;
use AmeliaBooking\Domain\Common\Exceptions\CustomException;
use AmeliaBooking\Domain\Common\Exceptions\PaymentValidationException;
use AmeliaBooking\Domain\Events\DomainEventBus;
use AmeliaBooking\Domain\Services\DateTime\DateTimeService;
use AmeliaBooking\Domain\Services\Logger\LoggerInterface;
use AmeliaBooking\Domain\Services\Permissions\PermissionsService;
use AmeliaBooking\Domain\Services\Settings\SettingsService;
use AmeliaBooking\Infrastructure\Common\Container;
use AmeliaBooking\Infrastructure\WP\SettingsService\SettingsStorage;
use AmeliaBooking\Infrastructure\WP\Translations\FrontendStrings;
use AmeliaVendor\Psr\Http\Message\ResponseInterface as Response;
use AmeliaVendor\Psr\Http\Message\ServerRequestInterface as Request;
use League\Tactician\CommandBus;
/**
* Class Controller
*
* @package AmeliaBooking\Application\Controller
*/
abstract class Controller
{
public const STATUS_OK = 200;
public const STATUS_REDIRECT = 302;
public const STATUS_FORBIDDEN = 403;
public const STATUS_NOT_FOUNT = 404;
public const STATUS_CONFLICT = 409;
public const STATUS_INTERNAL_SERVER_ERROR = 500;
/**
* @var CommandBus
*/
protected $commandBus;
/**
* @var DomainEventBus
*/
protected $eventBus;
/**
* @var PermissionsService
*/
protected $permissionsService;
/**
* @var LoggerInterface
*/
protected $logger;
protected $allowedFields = [
'ameliaNonce',
'wpAmeliaNonce',
];
protected $sendJustData = false;
/**
* @var UserApplicationService
*/
private $userApplicationService;
/**
* Base Controller constructor.
*
* @param Container $container
* @param bool $fromApi
*/
public function __construct(Container $container, $fromApi = false)
{
$this->commandBus = $container->getCommandBus();
$this->eventBus = $container->getEventBus();
$this->permissionsService = $fromApi ? $container->getApiPermissionsService() : $container->getPermissionsService();
$this->userApplicationService = $fromApi ? $container->getApiUserApplicationService() : $container->getUserApplicationService();
$this->logger = $container->getLoggerService()->channel(LoggerInterface::CHANNEL_HTTP);
}
/**
* @param Request $request
* @param $args
*
* @return mixed
*/
abstract protected function instantiateCommand(Request $request, $args);
/**
* Emit a success domain event, do nothing by default
*
* @param DomainEventBus $eventBus
*
* @param CommandResult $result
*
* @return void
*/
protected function emitSuccessEvent(DomainEventBus $eventBus, CommandResult $result)
{
}
/**
* Emit a failure domain event, do nothing by default
*
* @param DomainEventBus $eventBus
*
* @param CommandResult $data
*
* @return null
*/
protected function emitFailureEvent(DomainEventBus $eventBus, CommandResult $data)
{
return null;
}
/**
* @param Request $request
* @param Response $response
* @param $args
*
* @return Response
* @throws \InvalidArgumentException
* @throws \RuntimeException
*/
public function __invoke(Request $request, Response $response, $args, $validApiCall = false)
{
/** @var Command $command */
$command = $this->instantiateCommand($request, $args);
/** @var SettingsService $settingsService */
$settingsService = new SettingsService(new SettingsStorage());
if (!$validApiCall && !$command->validateNonce($request)) {
return $response->withStatus(self::STATUS_FORBIDDEN);
}
if (!$validApiCall && !$command->validateCron($request)) {
return $response->withStatus(self::STATUS_FORBIDDEN);
}
$command->setPermissionService($this->permissionsService);
$command->setUserApplicationService($this->userApplicationService);
$command->setValidApiCall($validApiCall);
try {
/** @var CommandResult $commandResult */
$commandResult = $this->commandBus->handle($command);
} catch (PaymentValidationException $e) {
$commandResult = new CommandResult();
$commandResult->setResult(CommandResult::RESULT_ERROR);
$commandResult->setMessage(FrontendStrings::getCommonStrings()['payment_error']);
$commandResult->setData(
[
'paymentSuccessful' => false,
]
);
} catch (AccessDeniedException $e) {
$response = $response->withHeader('Content-Type', 'application/json;charset=utf-8');
$response = $response->withStatus(self::STATUS_FORBIDDEN);
$response->getBody()->write(
json_encode(
[
'data' => [
'message' => $e->getMessage()
]
]
)
);
return $response;
} catch (CustomException $e) {
try {
$this->logger->error('Unhandled exception in controller', [
'command' => get_class($command),
'exception' => $e,
]);
} catch (\Throwable $loggingError) {
// Telemetry must not block the JSON 500 response.
}
$response = $response->withHeader('Content-Type', 'application/json;charset=utf-8');
$response = $response->withStatus(self::STATUS_INTERNAL_SERVER_ERROR);
$response->getBody()->write(
json_encode(
[
'data' => [
'message' => $e->getMessage()
]
]
)
);
return $response;
} catch (AuthorizationException $e) {
$commandResult = new CommandResult();
$commandResult->setResult(CommandResult::RESULT_ERROR);
$commandResult->setData(
[
'reauthorize' => true,
]
);
}
if (in_array($commandResult->getResult(), [CommandResult::RESULT_ERROR, CommandResult::RESULT_CONFLICT], true)) {
$this->logger->warning('Command returned non-success result', [
'command' => get_class($command),
'result' => $commandResult->getResult(),
'message' => $commandResult->getMessage(),
]);
}
if ($commandResult->getResult() === CommandResult::RESULT_ERROR) {
if ($settingsService->getSetting('activation', 'responseErrorAsConflict')) {
$commandResult->setResult(CommandResult::RESULT_CONFLICT);
}
}
if ($commandResult->getUrl() !== null) {
$this->emitSuccessEvent($this->eventBus, $commandResult);
/** @var Response $response */
$response = $response->withHeader('Location', $commandResult->getUrl());
$response = $response->withStatus(self::STATUS_REDIRECT);
return $response;
}
if ($commandResult->hasAttachment() === false && $commandResult->getHtml() === null) {
$responseBody = [
'message' => $commandResult->getMessage(),
'data' => $commandResult->getData()
];
$this->emitSuccessEvent($this->eventBus, $commandResult);
switch ($commandResult->getResult()) {
case (CommandResult::RESULT_SUCCESS):
$response = $response->withStatus(self::STATUS_OK);
break;
case (CommandResult::RESULT_CONFLICT):
$response = $response->withStatus(self::STATUS_CONFLICT);
break;
default:
$response = $response->withStatus(self::STATUS_INTERNAL_SERVER_ERROR);
break;
}
/** @var Response $response */
$response = $response->withHeader('Content-Type', 'application/json;charset=utf-8');
$response->getBody()->write(
$this->sendJustData ? $commandResult->getData() :
json_encode(
$commandResult->hasDataInResponse() ?
$responseBody : array_merge($responseBody, ['data' => []])
)
);
}
if (($html = $commandResult->getHtml()) !== null) {
/** @var Response $response */
$this->emitSuccessEvent($this->eventBus, $commandResult);
switch ($commandResult->getResult()) {
case (CommandResult::RESULT_SUCCESS):
$response = $response->withStatus(self::STATUS_OK);
break;
case (CommandResult::RESULT_CONFLICT):
$response = $response->withStatus(self::STATUS_CONFLICT);
break;
default:
$response = $response->withStatus(self::STATUS_INTERNAL_SERVER_ERROR);
break;
}
$response = $response->withHeader('Content-Type', 'text/html; charset=utf-8');
$response = $response->withHeader('Cache-Control', 'max-age=0');
$response->getBody()->write($html);
}
if (($file = $commandResult->getFile()) !== null) {
/** @var Response $response */
$response = $response->withHeader('Content-Type', $file['type']);
$response = $response->withHeader('Content-Disposition', 'inline; filename=' . '"' . $file['name'] . '"');
$response = $response->withHeader('Cache-Control', 'max-age=0');
if (array_key_exists('size', $file)) {
$response = $response->withHeader('Content-Length', $file['size']);
}
$response->getBody()->write($file['content']);
}
return $response;
}
/**
* @param Command $command
* @param $requestBody
*/
protected function setCommandFields($command, $requestBody)
{
foreach ($this->allowedFields as $field) {
if (!isset($requestBody[$field])) {
continue;
}
$command->setField($field, $requestBody[$field]);
}
}
/**
* @param mixed $params
* @param array $keys
*/
protected function setArrayParams(&$params, $keys = [])
{
$names = array_merge([
'customers',
'categories',
'services',
'packages',
'employees',
'providers',
'providerIds',
'locations',
'locationIds',
'ids',
'events',
'tag',
'dates',
'types',
'fields',
'statuses',
'stats',
'bookingTypes',
], $keys);
foreach ($names as $name) {
if (!empty($params[$name])) {
$params[$name] = is_array($params[$name]) ? $params[$name] : explode(',', $params[$name]);
}
}
if (isset($params['dates'][0])) {
$params['dates'][0] = preg_match("/^\d{4}-\d{2}-\d{2}$/", $params['dates'][0]) ?
$params['dates'][0] : DateTimeService::getNowDate();
}
if (isset($params['dates'][1]) && $params['dates'][1]) {
$params['dates'][1] = preg_match("/^\d{4}-\d{2}-\d{2}$/", $params['dates'][1]) ?
$params['dates'][1] : DateTimeService::getNowDate();
}
if (isset($params['date'])) {
$params['date'] = preg_match("/^\d{4}-\d{2}-\d{2}$/", $params['date']) ?
$params['date'] : DateTimeService::getNowDate();
}
}
/**
* @param array $data
* @param string $field
* @param string $translationField
*
* @return void
*/
private function filterField(&$data, $field, $translationField)
{
if (!empty($data[$field])) {
global $allowedposttags;
$data[$field] = wp_kses($data[$field], $allowedposttags);
if (!empty($data['translations']) && ($translations = json_decode($data['translations'], true)) !== null) {
if (!empty($translations[$translationField])) {
foreach ($translations[$translationField] as $lang => $translation) {
$translations[$translationField][$lang] = wp_kses(
$translations[$translationField][$lang],
$allowedposttags
);
}
$data['translations'] = json_encode($translations);
}
}
}
}
/**
* @param array $requestBody
*
* @return void
*/
protected function filter(&$requestBody)
{
if (!current_user_can('unfiltered_html') && $requestBody) {
$this->filterField($requestBody, 'description', 'description');
$this->filterField($requestBody, 'label', 'name');
foreach (!empty($requestBody['extras']) ? $requestBody['extras'] : [] as $index => $extra) {
$this->filterField($requestBody['extras'][$index], 'description', 'description');
}
}
}
/**
* Helper to set HTML content on CommandResult as an inline file
* so the controller can respond with a text/html body.
*
* @param CommandResult $result
* @param string $html
* @param string $filename
*
* @return void
*/
protected function setResultHtml(CommandResult $result, $html, $filename = 'content.html')
{
$result->setFile([
'type' => 'text/html; charset=utf-8',
'name' => $filename,
'size' => strlen($html),
'content' => $html,
]);
}
/**
* @param mixed $default
*
* @return mixed
*/
public static function getParam(Request $request, string $key, $default = null)
{
$params = $request->getQueryParams();
return array_key_exists($key, $params) ? $params[$key] : $default;
}
}