\\1
', - $text - ); - if (null === $text) { - throw new WikiFailedRegExp( - sprintf( - 'Failed with %s', - array_flip(get_defined_constants(true)['pcre'])[preg_last_error()] - ) - ); - } - $text = preg_replace( - "/\\1', - $text - ); - if (null === $text) { - throw new WikiFailedRegExp( - sprintf( - 'Failed with %s', - array_flip(get_defined_constants(true)['pcre'])[preg_last_error()] - ) - ); - } - if (!is_string($text)) { - throw new WikiFailedRegExp('Expected string'); - } - return $text; - } + $this->logger->debug(sprintf('Could not parse wiki title %s', $wiki)); return $default; } @@ -107,12 +72,16 @@ public function parseMotionTextForEdit(string $wiki, string $default): string * * @see https://github.com/publicwhip/publicwhip/blob/a4899135b6957abae85da3fc93c4cc3cf9e4fbc1/website/wiki.inc#L112 * - * @param string $wiki - * @param string $default + * @param string $wiki The text to parse. + * @param string $default The text to return if it's not a valid wiki text. + * * @return string */ public function parseMotionText(string $wiki, string $default): string { + if ('' === $wiki) { + return $default; + } $motion = $this->parseMotionTextForEdit($wiki, $default); if (!preg_match('/<\/.*?>/', $motion)) { $motionLines = explode("\n", $motion); @@ -227,11 +196,7 @@ public function parseMotionText(string $wiki, string $default): string $res[] = $motionLine; - if (0 === $binUL) { - $res[] = ''; - } else { - $res[] = ''; - } + $res[] = (0 === $binUL) ? '' : ''; } if ($binUL) { $res[] = ''; @@ -239,12 +204,66 @@ public function parseMotionText(string $wiki, string $default): string $motion = implode("\n", $res); } $motion = $this->cleanHtml($motion); + $this->logger->debug(sprintf('Returning motion %s', $motion)); + return $motion; } + /** + * Get the motion text from the wiki - suitable for editing. + * + * @param string $wiki Wiki text to parse. + * @param string $default If the wiki text was not valid, the text to be returned instead. + * + * @return string + */ + public function parseMotionTextForEdit(string $wiki, string $default): string + { + if ('' === $wiki) { + return $default; + } + if (!preg_match('/--- MOTION EFFECT ---(.*)--- COMMENT/s', $wiki, $matches)) { + $this->logger->debug(sprintf('Could not parse motion text %s', $wiki)); + return $default; + } + $text = $matches[1]; + $text = preg_replace( + "/
\\1
', + $text + ); + if (null === $text) { + throw new WikiFailedRegExp( + sprintf( + 'Failed with %s', + array_flip(get_defined_constants(true)['pcre'])[preg_last_error()] + ) + ); + } + $text = preg_replace( + "/\\1', + $text + ); + if (null === $text) { + throw new WikiFailedRegExp( + sprintf( + 'Failed with %s', + array_flip(get_defined_constants(true)['pcre'])[preg_last_error()] + ) + ); + } + if (!\is_string($text)) { + throw new WikiFailedRegExp('Expected string'); + } + return $text; + } + /** * Cleans the HTML. - * @param string $html + * + * @param string $html The html to clean. + * * @return string */ public function cleanHtml(string $html): string @@ -256,10 +275,12 @@ public function cleanHtml(string $html): string * Takes our safe html and converts it to normal html. * * @see https://github.com/publicwhip/publicwhip/blob/a4899135b6957abae85da3fc93c4cc3cf9e4fbc1/website/pretty.inc#L418 - * @param string $html + * + * @param string $html The 'safe' html to convert back to normal html. + * * @return string */ - public function safeHtmlToNormalHtml(string $html) : string + public function safeHtmlToNormalHtml(string $html): string { $patterns = [ "/&(#?[A-Za-z0-9]+?;)/", @@ -284,7 +305,9 @@ public function safeHtmlToNormalHtml(string $html) : string * Strips bad html. * * @see https://github.com/publicwhip/publicwhip/blob/a4899135b6957abae85da3fc93c4cc3cf9e4fbc1/website/pretty.inc#L313 - * @param string $text + * + * @param string $text Text to strip unwanted html from. + * * @return string */ public function stripBadHtml(string $text): string @@ -336,7 +359,9 @@ public function stripBadHtml(string $text): string * Only keeps approved attributes of HTML. * * @see https://github.com/publicwhip/publicwhip/blob/a4899135b6957abae85da3fc93c4cc3cf9e4fbc1/website/pretty.inc#L334 - * @param array $arr + * + * @param string[] $arr Html element and items to strip away. + * * @return string */ public function filterHtmlAttributes(array $arr): string @@ -388,8 +413,7 @@ public function filterHtmlAttributes(array $arr): string if ($noSpecial) { preg_match_all("/(?:$noSpecial)\s*=\s*\"[^\s\">]+\"/is", $attributes, $matches); - $prepared = - array_merge($prepared, str_replace('"', self::SAFE_QUOTE, $matches[0])); + $prepared = array_merge($prepared, str_replace('"', self::SAFE_QUOTE, $matches[0])); preg_match_all("/(?:$noSpecial)\s*=\s*'[^\s'>]+'/is", $attributes, $matches); $prepared = array_merge($prepared, $matches[0]); preg_match_all("/(?:$noSpecial)\s*=\s*[^\s>'\"][^\s>]*/is", $attributes, $matches); @@ -397,8 +421,7 @@ public function filterHtmlAttributes(array $arr): string } if ($special) { preg_match_all("/(?:$special)\s*=\s*\"[^\"]*\"/is", $attributes, $matches); - $prepared = - array_merge($prepared, str_replace('"', self::SAFE_QUOTE, $matches[0])); + $prepared = array_merge($prepared, str_replace('"', self::SAFE_QUOTE, $matches[0])); preg_match_all("/(?:$special)\s*=\s*'[^']*'/is", $attributes, $matches); $prepared = array_merge($prepared, $matches[0]); preg_match_all("/(?:$special)\s*=\s*[^\s>'\"][^\s>]*/is", $attributes, $matches); diff --git a/src/Providers/WikiParserProviderInterface.php b/src/Providers/WikiParserProviderInterface.php index 91e5a13..8c8d34a 100644 --- a/src/Providers/WikiParserProviderInterface.php +++ b/src/Providers/WikiParserProviderInterface.php @@ -1,35 +1,40 @@ databaseProvider = $databaseProvider; + $this->entityFactory = $entityFactory; + $this->dateTimeFactory = $dateTimeFactory; $this->wikiParser = $wikiParser; - $this->logger = $logger; } @@ -65,6 +81,7 @@ public function getNewestDivisionDate(): string /** * Find a division by its numerical id. + * * @param int $divisionId Numerical id of the division. * * @return DivisionEntity|null @@ -92,58 +109,30 @@ public function findByDivisionId(int $divisionId): ?DivisionEntity } /** - * Find a division by the house, date and division number. + * Build/fill out a division and create a division entity. * - * @param string $house Name of the house - probably 'commons','lords' or 'scotland' - * @param string $date Date in YYYY-MM-DD of the division. - * @param int $divisionNumber Number of the division. + * This is a bit of a mess as it needs to reverse engineer whatever PublicWhip v1 + * has done in the database. * - * @return DivisionEntity|null Entity if found. - */ - public function findByHouseDateAndNumber(string $house, string $date, int $divisionNumber): ?DivisionEntity - { - /** - * Get the basic division data. - * - * @var object|null $basicDivision - */ - $basicDivision = $this->databaseProvider->table('pw_division') - ->where('division_date', '=', $date) - ->where('division_number', '=', $divisionNumber) - ->where('house', '=', $house) - ->first(); - if (null === $basicDivision) { - $this->logger->debug( - __METHOD__ . ': Did not find in {house} date {date} {divisionNumber}', - [ - 'house' => $house, - 'date' => $date, - 'divisionNumber' => $divisionNumber - ] - ); - return null; - } - return $this->buildDivisionEntityFromDivisionTable($basicDivision); - } - - /** - * Build/fill out a division and create a division entity. + * @SuppressWarnings(PHPMD.CyclomaticComplexity) + * + * @param object $basicDivision A division object as returned from the database. * - * @param object $basicDivision * @return DivisionEntity * * @throws BadDatabaseReturnException */ private function buildDivisionEntityFromDivisionTable(object $basicDivision): DivisionEntity { - if (!property_exists($basicDivision, 'division_id') || - !property_exists($basicDivision, 'division_date') || - !property_exists($basicDivision, 'division_number') || - !property_exists($basicDivision, 'source_url') || - !property_exists($basicDivision, 'motion') || - !property_exists($basicDivision, 'division_name') || - !property_exists($basicDivision, 'debate_url') || - !property_exists($basicDivision, 'house')) { + if (!property_exists($basicDivision, 'division_id') + || !property_exists($basicDivision, 'division_date') + || !property_exists($basicDivision, 'division_number') + || !property_exists($basicDivision, 'source_url') + || !property_exists($basicDivision, 'motion') + || !property_exists($basicDivision, 'division_name') + || !property_exists($basicDivision, 'debate_url') + || !property_exists($basicDivision, 'house') + ) { throw new BadDatabaseReturnException('Not a division'); } /** @@ -155,8 +144,8 @@ private function buildDivisionEntityFromDivisionTable(object $basicDivision): Di (string)$basicDivision->motion ); $builtData = [ - 'id' => (int)$basicDivision->division_id, - 'date' => DateTimeImmutable::createFromFormat('!Y-m-d', $basicDivision->division_date), + 'divisionId' => (int)$basicDivision->division_id, + 'date' => $this->dateTimeFactory->dateTimeImmutableFromYyyyMmDd($basicDivision->division_date), 'number' => (int)$basicDivision->division_number, 'sourceUrl' => (string)$basicDivision->source_url, 'motionText' => $this->wikiParser->cleanHtml($motionText), @@ -179,10 +168,10 @@ private function buildDivisionEntityFromDivisionTable(object $basicDivision): Di ->where('division_id', '=', $basicDivision->division_id) ->first(); if ($voteInformation) { - if (!property_exists($voteInformation, 'rebellions') || - !property_exists($voteInformation, 'turnout') || - !property_exists($voteInformation, 'possible_turnout') || - !property_exists($voteInformation, 'aye_majority') + if (!property_exists($voteInformation, 'rebellions') + || !property_exists($voteInformation, 'turnout') + || !property_exists($voteInformation, 'possible_turnout') + || !property_exists($voteInformation, 'aye_majority') ) { throw new BadDatabaseReturnException('Not a divinfo'); } @@ -225,6 +214,41 @@ private function buildDivisionEntityFromDivisionTable(object $basicDivision): Di // General tidy up. $builtData['motionTitle'] = trim(strip_tags($builtData['motionTitle'])); $builtData['motionTitle'] = str_replace(' — ', ' - ', $builtData['motionTitle']); - return DivisionEntity::buildFromArray($builtData); + return $this->entityFactory->division($builtData); + } + + /** + * Find a division by the house, date and division number. + * + * @param string $house Name of the house - probably 'commons','lords' or 'scotland' + * @param string $date Date in YYYY-MM-DD of the division. + * @param int $divisionNumber Number of the division. + * + * @return DivisionEntity|null Entity if found. + */ + public function findByHouseDateAndNumber(string $house, string $date, int $divisionNumber): ?DivisionEntity + { + /** + * Get the basic division data. + * + * @var object|null $basicDivision + */ + $basicDivision = $this->databaseProvider->table('pw_division') + ->where('division_date', '=', $date) + ->where('division_number', '=', $divisionNumber) + ->where('house', '=', $house) + ->first(); + if (null === $basicDivision) { + $this->logger->debug( + __METHOD__ . ': Did not find in {house} date {date} {divisionNumber}', + [ + 'house' => $house, + 'date' => $date, + 'divisionNumber' => $divisionNumber + ] + ); + return null; + } + return $this->buildDivisionEntityFromDivisionTable($basicDivision); } } diff --git a/src/Services/DivisionServiceInterface.php b/src/Services/DivisionServiceInterface.php index 4759ec2..3203688 100644 --- a/src/Services/DivisionServiceInterface.php +++ b/src/Services/DivisionServiceInterface.php @@ -5,6 +5,8 @@ use Psr\Log\LoggerInterface; use PublicWhip\Entities\DivisionEntity; +use PublicWhip\Factories\DateTimeFactoryInterface; +use PublicWhip\Factories\EntityFactoryInterface; use PublicWhip\Providers\DatabaseProviderInterface; use PublicWhip\Providers\WikiParserProviderInterface; use ReflectionException; @@ -14,18 +16,23 @@ * * Reads/writes divisions. * - * @package PublicWhip\Services */ interface DivisionServiceInterface { + /** * DivisionService constructor. - * @param DatabaseProviderInterface $databaseProvider - * @param WikiParserProviderInterface $wikiParser - * @param LoggerInterface $logger + * + * @param DatabaseProviderInterface $databaseProvider Database connection layer. + * @param EntityFactoryInterface $entityFactory Entity factory. + * @param DateTimeFactoryInterface $dateTimeFactory Date time factory. + * @param WikiParserProviderInterface $wikiParser Wiki parser. + * @param LoggerInterface $logger Logger. */ public function __construct( DatabaseProviderInterface $databaseProvider, + EntityFactoryInterface $entityFactory, + DateTimeFactoryInterface $dateTimeFactory, WikiParserProviderInterface $wikiParser, LoggerInterface $logger ); @@ -39,11 +46,12 @@ public function getNewestDivisionDate(): string; /** * Find a division by its numerical id. + * * @param int $divisionId Numerical id of the division. * * @return DivisionEntity|null */ - public function findByDivisionId(int $divisionId) : ?DivisionEntity; + public function findByDivisionId(int $divisionId): ?DivisionEntity; /** * Find a division by the house, date and division number. diff --git a/src/Services/README.md b/src/Services/README.md index 31ee2e0..6782139 100644 --- a/src/Services/README.md +++ b/src/Services/README.md @@ -2,4 +2,4 @@ These are the services you should use to interact with the entities. These handl and similar services. These should be the only parts of the code that interact with the database in any manner and should just -accept/return Entities or scalars. \ No newline at end of file +accept/return Factories or scalars. \ No newline at end of file diff --git a/src/Web.php b/src/Web.php index fc3ed69..63d36b6 100644 --- a/src/Web.php +++ b/src/Web.php @@ -3,20 +3,14 @@ namespace PublicWhip; -use DI\Bridge\Slim\App; use DI\ContainerBuilder; use Exception; use Psr\Http\Message\RequestInterface; use Psr\Http\Message\ResponseInterface; -use Psr\Http\Message\ServerRequestInterface; use Psr\Log\LoggerInterface; -use PublicWhip\Providers\DebuggerProviderInterface; -use PublicWhip\Web\Controllers\DebugBarController; -use PublicWhip\Web\Controllers\DivisionController; -use PublicWhip\Web\Controllers\DocsController; -use PublicWhip\Web\Controllers\IndexController; -use PublicWhip\Web\Controllers\PingController; -use RuntimeException; +use PublicWhip\Exceptions\MissingConfigurationException; +use PublicWhip\Web\Routing; +use Slim\App; use Slim\Exception\MethodNotAllowedException; use Slim\Exception\NotFoundException; use Slim\Http\Response; @@ -25,9 +19,9 @@ * Class Web. * * Handles web access to PublicWhip. - * @package PublicWhip + * */ -class Web extends App +class Web { /** @@ -36,117 +30,45 @@ class Web extends App private $environment; /** - * Web constructor. - * @param string $environment + * @var App The Slim Application. */ - public function __construct(string $environment) - { - $this->environment = $environment; - parent::__construct(); - } + private $app; /** - * Main runner. + * Web constructor. * - * @param bool $silent - * @return ResponseInterface|void - * @throws MethodNotAllowedException - * @throws NotFoundException - */ - public function run($silent = false) - { - $this->setupRouting(); - $this->setupTrailingSlash(); - parent::run($silent); - } - - /** - * Setup routing. + * @param string $environment The name of the environment are setting up. + * @param App|null $app The optional pre-built app. + * + * @throws Exception */ - public function setupRouting(): void + public function __construct(string $environment, ?App $app = null) { - // uptime monitors - $this->group( - '/ping', - function (App $app) { - $app->get('/', [PingController::class, 'indexAction']); - $app->get('/lastDivisionParsed/', [PingController::class, 'lastDivisionParsedAction']); - } - ); - - // index page - $this->get('/', [IndexController::class, 'indexAction']); - // divisions - $this->group( - '/divisions', - function (App $app) { - $app->get('/', [DivisionController::class, 'indexAction']); - $app->get('/{divisionId:[0-9]+}/', [DivisionController::class, 'showDivisionById']); - $app->get( - '/' . - '{house:commons|lords|scotland}/' . - '{date:18|19|20[0-9][0-9]\-[0-1][0-9]\-[0-3][0-9]}/' . - '{divisionId:[0-9]+}/', - [DivisionController::class, 'showDivisionByDateAndNumberAction'] - ); - } - ); - $this->get('/docs/{file:.*}', [DocsController::class, 'render']); - /** - * Register the debugbar only if we are in development/debug mode, - */ - if ($this->getContainer()->get('settings.debug')) { - $this->get('/debugbar/[{filePath:.*}]', [DebugBarController::class, 'staticFileAction']); + $this->environment = $environment; + if (null === $app) { + $containerBuilder = new ContainerBuilder(); + $this->configureContainer($containerBuilder); + $container = $containerBuilder->build(); + $app = new App($container); } + $this->app = $app; } /** - * Handle optional trailing slashes on GET requests. - */ - private function setupTrailingSlash(): void - { - $container = $this->getContainer(); - $this->add( - function (RequestInterface $request, Response $response, callable $next) use ($container) { - $uri = $request->getUri(); - $path = $uri->getPath(); - if (strlen($path) > 1) { - if ('/' !== substr($path, -1) && !pathinfo($path, PATHINFO_EXTENSION)) { - $path .= '/'; - } - } elseif ('' === $path) { - $path = '/'; - } - $new = $uri->withPath($path); - if ($uri->getPath() !== $path) { - $logger = $container->get(LoggerInterface::class); - $logger->debug('Redirecting from ' . $uri . ' to ' . $new); - if ('GET' === $request->getMethod()) { - return $response->withRedirect($new, 301); - } - } - return $next($request->withUri($new), $response); - } - ); - } - - /** - * Call relevant handler from the Container if needed. If it doesn't exist, - * then just re-throw. + * Main runner. + ** * - * @param Exception $e - * @param ServerRequestInterface $request - * @param ResponseInterface $response + * @return ResponseInterface The response interface. * - * @return ResponseInterface - * @throws Exception if a handler is needed and not found + * @throws MethodNotAllowedException + * @throws NotFoundException */ - protected function handleException(Exception $e, ServerRequestInterface $request, ResponseInterface $response) + public function run(): ResponseInterface { - if ($this->getContainer()->has(DebuggerProviderInterface::class)) { - $this->getContainer()->get(DebuggerProviderInterface::class)->addException($e); - } - return parent::handleException($e, $request, $response); + $routing = new Routing(); + $routing->getRouting($this->app); + $routing->setupTrailingSlash($this->app); + return $this->app->run(false); } /** @@ -154,7 +76,11 @@ protected function handleException(Exception $e, ServerRequestInterface $request * * @TODO Add caching if appropriate on production. * - * @param ContainerBuilder $builder + * @param ContainerBuilder $builder The container we we populating. + * + * @return void + * + * @throws MissingConfigurationException */ protected function configureContainer(ContainerBuilder $builder): void { @@ -164,14 +90,18 @@ protected function configureContainer(ContainerBuilder $builder): void /** * Now load our specifics over the top of the prebuilt ones. */ - $environmentSettingsFile = __DIR__ . + $settingsFile = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . $this->environment . '.php'; - if (file_exists($environmentSettingsFile) && is_readable($environmentSettingsFile)) { - $builder->addDefinitions($environmentSettingsFile); - } else { - throw new RuntimeException('Could not find environment file: ' . $environmentSettingsFile); + if (!file_exists($settingsFile) && is_readable($settingsFile)) { + throw new MissingConfigurationException( + sprintf( + 'Could not find environment file: %s', + $settingsFile + ) + ); } + $builder->addDefinitions($settingsFile); } } diff --git a/src/Web/Controllers/DebugBarController.php b/src/Web/Controllers/DebugBarController.php index 812e1a5..5b4c213 100644 --- a/src/Web/Controllers/DebugBarController.php +++ b/src/Web/Controllers/DebugBarController.php @@ -16,34 +16,38 @@ * * Based off https://github.com/php-middleware/phpdebugbar . * - * @package PublicWhip\Web\Controllers */ class DebugBarController { + /** - * @var DebuggerProviderInterface $debuggerProvider + * @var DebuggerProviderInterface $debuggerProvider The debugger. */ private $debuggerProvider; + /** - * @var LoggerInterface $logger + * @var LoggerInterface $logger The logger. */ private $logger; + /** - * @var CacheProvider $cacheProvider + * @var CacheProvider $cacheProvider Http caching system. */ private $cacheProvider; /** * DebugBarController constructor. - * @param DebuggerProviderInterface $debuggerProvider - * @param LoggerInterface $logger - * @param CacheProvider $cacheProvider + * + * @param DebuggerProviderInterface $debuggerProvider The debugger itself. + * @param LoggerInterface $logger The logging system. + * @param CacheProvider $cacheProvider Our Http caching system. */ public function __construct( DebuggerProviderInterface $debuggerProvider, LoggerInterface $logger, CacheProvider $cacheProvider - ) { + ) + { $this->debuggerProvider = $debuggerProvider; $this->logger = $logger; $this->cacheProvider = $cacheProvider; @@ -56,9 +60,10 @@ public function __construct( * * The debug bar should only be enabled on Development environments anyway. * - * @param ServerRequestInterface $request - * @param ResponseInterface $response - * @param string $filePath + * @param ServerRequestInterface $request The server request to populate a not found exception. + * @param ResponseInterface $response The response to populate. + * @param string $filePath The path requested. + * * @return ResponseInterface * @throws NotFoundException */ @@ -66,7 +71,8 @@ public function staticFileAction( ServerRequestInterface $request, ResponseInterface $response, string $filePath - ): ResponseInterface { + ): ResponseInterface + { $fullPathToFile = $this->debuggerProvider->getBasePath() . DIRECTORY_SEPARATOR . $filePath; $this->logger->debug('Fetching {file}', ['file' => $fullPathToFile]); @@ -98,7 +104,7 @@ public function staticFileAction( /** * Get the content type, with more validation if we get something we don't recognise. */ - $contentType = $this->getContentTypeByFileName($realpath); + $contentType = self::getContentTypeByFileName($realpath); if ('' === $contentType) { $this->logger->warning( 'Invalid attempt to access debugbar file {file}: unrecognised content type', @@ -120,12 +126,14 @@ public function staticFileAction( return $this->cacheProvider->withExpires($response, time() + 60 * 60 * 6); } - /** - * @param string $filename + * Get the content type of a file based on its extension. + * + * @param string $filename Name of the file to get the file type of. + * * @return string */ - private function getContentTypeByFileName(string $filename): string + private static function getContentTypeByFileName(string $filename): string { $ext = pathinfo($filename, PATHINFO_EXTENSION); $map = [ diff --git a/src/Web/Controllers/DivisionController.php b/src/Web/Controllers/DivisionController.php index af3bc99..76e343e 100644 --- a/src/Web/Controllers/DivisionController.php +++ b/src/Web/Controllers/DivisionController.php @@ -5,22 +5,21 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; +use PublicWhip\Providers\TemplateProviderInterface; use PublicWhip\Services\DivisionServiceInterface; use Slim\Exception\NotFoundException; -use Slim\Views\Twig; /** * Class DivisionController. * - * @package PublicWhip\Web\Controllers */ class DivisionController { /** - * @var Twig $twig Templating engine. + * @var TemplateProviderInterface $templateProvider Templating engine. */ - private $twig; + private $templateProvider; /** * @var ServerRequestInterface $request @@ -34,33 +33,40 @@ class DivisionController /** * DivisionController constructor. - * @param Twig $twig - * @param ServerRequestInterface $request - * @param DivisionServiceInterface $divisionService + * + * @param TemplateProviderInterface $templateProvider The templating system provider. + * @param ServerRequestInterface $request The actual server request information. + * @param DivisionServiceInterface $divisionService The division service. */ public function __construct( - Twig $twig, + TemplateProviderInterface $templateProvider, ServerRequestInterface $request, DivisionServiceInterface $divisionService - ) { - $this->twig = $twig; + ) + { + $this->templateProvider = $templateProvider; $this->request = $request; $this->divisionService = $divisionService; } /** - * @param ResponseInterface $response + * Just show a basic page for now. + * + * @param ResponseInterface $response The inbound request. + * * @return ResponseInterface */ public function indexAction(ResponseInterface $response): ResponseInterface { - return $this->twig->render($response, 'DivisionController/indexAction.twig', []); + return $this->templateProvider->render($response, 'DivisionController/indexAction.twig', []); } - /** - * @param string $divisionId - * @param ResponseInterface $response + * Show a division by it's id. + * + * @param string $divisionId Has to support string as this is passed from the frontend. + * @param ResponseInterface $response The response to populate. + * * @return ResponseInterface * @throws NotFoundException */ @@ -70,7 +76,7 @@ public function showDivisionById(string $divisionId, ResponseInterface $response if (!$division) { throw new NotFoundException($this->request, $response); } - return $this->twig->render( + return $this->templateProvider->render( $response, 'DivisionController/Division.twig', [ @@ -80,10 +86,13 @@ public function showDivisionById(string $divisionId, ResponseInterface $response } /** - * @param string $house - * @param string $date - * @param string $divisionId - * @param ResponseInterface $response + * Show a division by it's house, date and number. + * + * @param string $house Name of the house. + * @param string $date Date (in YYYY-MM-DD format) + * @param string $divisionNumber The division number. + * @param ResponseInterface $response The response to populate. + * * @return ResponseInterface * @throws NotFoundException * @throws \ReflectionException @@ -91,14 +100,15 @@ public function showDivisionById(string $divisionId, ResponseInterface $response public function showDivisionByDateAndNumberAction( string $house, string $date, - string $divisionId, + string $divisionNumber, ResponseInterface $response - ): ResponseInterface { - $division = $this->divisionService->findByHouseDateAndNumber($house, $date, (int)$divisionId); + ): ResponseInterface + { + $division = $this->divisionService->findByHouseDateAndNumber($house, $date, (int)$divisionNumber); if (!$division) { throw new NotFoundException($this->request, $response); } - return $this->twig->render( + return $this->templateProvider->render( $response, 'DivisionController/Division.twig', [ diff --git a/src/Web/Controllers/DocsController.php b/src/Web/Controllers/DocsController.php index 5684f9f..2492635 100644 --- a/src/Web/Controllers/DocsController.php +++ b/src/Web/Controllers/DocsController.php @@ -7,44 +7,51 @@ use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use Psr\Log\LoggerInterface; +use PublicWhip\Providers\TemplateProviderInterface; use Slim\Exception\NotFoundException; -use Slim\Views\Twig; /** * Class DocsController - * @package PublicWhip\Web\Controllers + * */ class DocsController { /** - * @var Parsedown $parseDown + * @var Parsedown $parseDown Our markdown parser. */ private $parseDown; + /** - * @var string $fileRoot + * @var string $fileRoot The root of our files. */ private $fileRoot; + /** - * @var LoggerInterface $logger + * @var LoggerInterface $logger The logger. */ private $logger; /** - * @var Twig %twig + * @var TemplateProviderInterface $templateProvider The templating engine. */ - private $twig; + private $templateProvider; /** * DocsController constructor. - * @param Parsedown $parseDown - * @param Twig $twig - * @param LoggerInterface $logger + * + * @param Parsedown $parseDown The Markdown parser. + * @param TemplateProviderInterface $templateProvider The templating engine provider. + * @param LoggerInterface $logger The logger. */ - public function __construct(Parsedown $parseDown, Twig $twig, LoggerInterface $logger) + public function __construct( + Parsedown $parseDown, + TemplateProviderInterface $templateProvider, + LoggerInterface $logger + ) { $this->parseDown = $parseDown; - $this->twig = $twig; + $this->templateProvider = $templateProvider; $this->logger = $logger; $this->fileRoot = __DIR__ . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR; @@ -53,13 +60,18 @@ public function __construct(Parsedown $parseDown, Twig $twig, LoggerInterface $l /** * Render a page. * - * @param ServerRequestInterface $request - * @param ResponseInterface $response - * @param string $file + * @param ServerRequestInterface $request The inbound request. + * @param ResponseInterface $response The response to populate. + * @param string $file Which file was requested. + * * @return ResponseInterface * @throws NotFoundException */ - public function render(ServerRequestInterface $request, ResponseInterface $response, string $file) + public function render( + ServerRequestInterface $request, + ResponseInterface $response, + string $file + ): ResponseInterface { if ('' === $file) { $file = 'README.md'; @@ -67,22 +79,23 @@ public function render(ServerRequestInterface $request, ResponseInterface $respo $allowedFiles = [ 'README.md', 'docs/Milestones.md', + 'docs/ChangeLog.md', 'LICENSE.txt', 'docs/CODE_OF_CONDUCT.md', 'docs/CONTRIBUTING.md', 'docs/Contact.md', 'docs/QuickStart.md' ]; - if (!in_array($file, $allowedFiles)) { + if (!\in_array($file, $allowedFiles, true)) { throw new NotFoundException($request, $response); } $fullPath = $this->fileRoot . $file; $this->logger->info('Reading {fullPath}', ['fullPath' => $fullPath]); $text = $this->parseDown->text(file_get_contents($fullPath)); $this->logger->info('Read {fullPath} - parsed', ['fullPath' => $fullPath, 'text' => $text]); - return $this->twig->render($response, 'DocsController/main.twig', [ + return $this->templateProvider->render($response, 'DocsController/main.twig', [ 'file' => $file, - 'content' => $text + 'markdownText' => $text ]); } } diff --git a/src/Web/Controllers/IndexController.php b/src/Web/Controllers/IndexController.php index c0bd456..e989d42 100644 --- a/src/Web/Controllers/IndexController.php +++ b/src/Web/Controllers/IndexController.php @@ -4,22 +4,26 @@ namespace PublicWhip\Web\Controllers; use Psr\Http\Message\ResponseInterface; -use Slim\Views\Twig; +use PublicWhip\Providers\TemplateProviderInterface; /** * Class IndexController - * @package PublicWhip\Web\Controllers + * */ class IndexController { /** - * @param Twig $twig - * @param ResponseInterface $response + * @param TemplateProviderInterface $templateProvider The templating engine. + * @param ResponseInterface $response The response to send back. + * * @return ResponseInterface */ - public function indexAction(Twig $twig, ResponseInterface $response) + public function indexAction( + TemplateProviderInterface $templateProvider, + ResponseInterface $response + ): ResponseInterface { - return $twig->render($response, 'IndexController/indexAction.twig', []); + return $templateProvider->render($response, 'IndexController/indexAction.twig', []); } } diff --git a/src/Web/Controllers/PingController.php b/src/Web/Controllers/PingController.php index 299b718..1522e05 100644 --- a/src/Web/Controllers/PingController.php +++ b/src/Web/Controllers/PingController.php @@ -4,21 +4,22 @@ namespace PublicWhip\Web\Controllers; use Psr\Http\Message\ResponseInterface; -use PublicWhip\Model\Division; use PublicWhip\Services\DivisionServiceInterface; /** * Class PingController. * * Uptime health checks. - * @package PublicWhip\Web\Controllers + * */ class PingController { /** * Simple uptime check. - * @param ResponseInterface $response + * + * @param ResponseInterface $response The response to populate. + * * @return ResponseInterface */ public function indexAction(ResponseInterface $response): ResponseInterface @@ -28,18 +29,19 @@ public function indexAction(ResponseInterface $response): ResponseInterface return $response; } - /** * Returns the date of the last division processed. * - * @param DivisionServiceInterface $divisionService - * @param ResponseInterface $response + * @param DivisionServiceInterface $divisionService The devision service. + * @param ResponseInterface $response The response to populate. + * * @return ResponseInterface */ public function lastDivisionParsedAction( DivisionServiceInterface $divisionService, ResponseInterface $response - ): ResponseInterface { + ): ResponseInterface + { $body = $response->getBody(); $body->write($divisionService->getNewestDivisionDate()); return $response; diff --git a/src/Web/ErrorHandlers/ErrorHandler.php b/src/Web/ErrorHandlers/ErrorHandler.php index daef527..c0748eb 100644 --- a/src/Web/ErrorHandlers/ErrorHandler.php +++ b/src/Web/ErrorHandlers/ErrorHandler.php @@ -3,25 +3,33 @@ namespace PublicWhip\Web\ErrorHandlers; -use Exception; +use Psr\Http\Message\ResponseInterface; +use Psr\Http\Message\ServerRequestInterface; use PublicWhip\Providers\DebuggerProviderInterface; -use Slim\Handlers\Error; +use Slim\Handlers\AbstractError; +use Slim\Http\Body; +use Throwable; +use UnexpectedValueException; /** - * Class ErrorHandler/ - * @package PublicWhip\Web\ErrorHandlers + * Class ErrorHandler. + * + * Mainly based straight of Slim's Error class for now. + * */ -class ErrorHandler extends Error +final class ErrorHandler extends AbstractError { + /** - * @var DebuggerProviderInterface $debuggerProvider + * @var DebuggerProviderInterface $debuggerProvider The debugger. */ private $debuggerProvider; /** * Constructor. - * @param DebuggerProviderInterface $debuggerProvider - * @param bool $displayErrorDetails + * + * @param DebuggerProviderInterface $debuggerProvider The debugger. + * @param bool $displayErrorDetails Should we show error details. Should be false on production. */ public function __construct(DebuggerProviderInterface $debuggerProvider, bool $displayErrorDetails) { @@ -29,29 +37,71 @@ public function __construct(DebuggerProviderInterface $debuggerProvider, bool $d parent::__construct($displayErrorDetails); } + /** + * Invoke error handler + * + * @param ServerRequestInterface $request The most recent Request object + * @param ResponseInterface $response The most recent Response object + * @param Throwable $throwable The caught Throwable object + * + * @return ResponseInterface + * @throws UnexpectedValueException + */ + public function __invoke( + ServerRequestInterface $request, + ResponseInterface $response, + Throwable $throwable + ): ResponseInterface + { + $contentType = $this->determineContentType($request); + switch ($contentType) { + case 'application/json': + $output = $this->renderJsonErrorMessage($throwable); + break; + + case 'text/html': + $output = $this->renderHtmlErrorMessage($throwable); + break; + + default: + throw new UnexpectedValueException('Cannot render unknown content type ' . $contentType); + } + + $this->writeToErrorLog($throwable); + + /** @var resource $fopen */ + $fopen = fopen('php://temp', 'rb+'); + $body = new Body($fopen); + $body->write($output); + + return $response->withStatus(500) + ->withHeader('Content-type', $contentType) + ->withBody($body); + } + /** * Render HTML error page * - * @param Exception $exception + * @param Throwable $throwable The thrown item. * * @return string */ - protected function renderHtmlErrorMessage(Exception $exception): string + private function renderHtmlErrorMessage(Throwable $throwable): string { $title = 'PublicWhip Application Exception'; + $html = '
A website error has occurred. Sorry for the temporary inconvenience.
'; + if ($this->displayErrorDetails) { $html = 'The application could not run because of the following exception:
'; $html .= 'A website error has occurred. Sorry for the temporary inconvenience.
'; } $debugHead = $this->debuggerProvider->renderHead(); $debugBar = $this->debuggerProvider->renderBar(); @@ -70,4 +120,81 @@ protected function renderHtmlErrorMessage(Exception $exception): string return $output; } + + /** + * Render exception or error as HTML. + * + * @param Throwable $throwable The thrown item. + * + * @return string + */ + protected function renderHtmlExceptionOrError(Throwable $throwable): string + { + $html = sprintf('%s', + htmlentities($throwable->getTraceAsString(), ENT_QUOTES) + ); + } + + return $html; + } + + /** + * Render JSON error + * + * @param Throwable $throwable The thrown item. + * + * @return string + */ + private function renderJsonErrorMessage(Throwable $throwable): string + { + $error = [ + 'message' => 'PublicWhip Application Error', + ]; + + if ($this->displayErrorDetails) { + $error['exception'] = []; + + do { + $error['exception'][] = [ + 'type' => \get_class($throwable), + 'code' => $throwable->getCode(), + 'message' => $throwable->getMessage(), + 'file' => $throwable->getFile(), + 'line' => $throwable->getLine(), + 'trace' => explode("\n", $throwable->getTraceAsString()), + ]; + $throwable = $throwable->getPrevious(); + } while ($throwable); + } + + $encoded = json_encode($error, JSON_PRETTY_PRINT); + if (!\is_string($encoded)) { + $encoded = '[]'; + } + return $encoded; + } } diff --git a/src/Web/ErrorHandlers/NotFoundHandler.php b/src/Web/ErrorHandlers/NotFoundHandler.php index 5289670..ba9e460 100644 --- a/src/Web/ErrorHandlers/NotFoundHandler.php +++ b/src/Web/ErrorHandlers/NotFoundHandler.php @@ -3,37 +3,100 @@ namespace PublicWhip\Web\ErrorHandlers; +use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; use PublicWhip\Providers\DebuggerProviderInterface; -use Slim\Handlers\NotFound; +use Slim\Handlers\AbstractHandler; +use Slim\Http\Body; +use UnexpectedValueException; /** * Class NotFoundHandler - * @package PublicWhip\Web\ErrorHandlers + * */ -class NotFoundHandler extends NotFound +final class NotFoundHandler extends AbstractHandler { /** - * @var DebuggerProviderInterface + * @var DebuggerProviderInterface The debugger. */ private $debuggerProvider; /** * Constructor. - * @param DebuggerProviderInterface $debuggerProvider + * + * @param DebuggerProviderInterface $debuggerProvider The debugger. */ public function __construct(DebuggerProviderInterface $debuggerProvider) { $this->debuggerProvider = $debuggerProvider; } + /** + * Invoke not found handler + * + * @param ServerRequestInterface $request The most recent Request object + * @param ResponseInterface $response The most recent Response object + * + * @return ResponseInterface + * @throws UnexpectedValueException + */ + public function __invoke(ServerRequestInterface $request, ResponseInterface $response) + { + // set some defaults + $contentType = 'text/plain'; + $output = $this->renderPlainNotFoundOutput(); + + if ('OPTIONS' !== $request->getMethod()) { + $contentType = $this->determineContentType($request); + switch ($contentType) { + case 'application/json': + $output = $this->renderJsonNotFoundOutput(); + break; + + case 'text/html': + $output = $this->renderHtmlNotFoundOutput($request); + break; + + default: + throw new UnexpectedValueException('Cannot render unknown content type ' . $contentType); + } + } + + /** @var resource $fopen */ + $fopen = fopen('php://temp', 'rb+'); + $body = new Body($fopen); + $body->write($output); + + return $response->withStatus(404) + ->withHeader('Content-type', $contentType) + ->withBody($body); + } + + + /** + * Render plain not found message + * + * @return string + */ + protected function renderPlainNotFoundOutput(): string + { + return 'Not found'; + } + + /** + * Return a response for application/json content not found + * + * @return string + */ + protected function renderJsonNotFoundOutput(): string + { + return '{"message":"Not found"}'; + } /** * Return a response for text/html content not found * - * phpcs:disable -- Slim currently has the wrong typehint on this method. Disabled CodeSniffer for now - * @codingStandardsIgnoreStart * @param ServerRequestInterface $request The most recent Request object * * @return string @@ -44,7 +107,7 @@ protected function renderHtmlNotFoundOutput(ServerRequestInterface $request): st $text = <<