HummingBirdAnimeClient/src/AnimeClient/Controller.php

426 lines
9.5 KiB
PHP
Raw Normal View History

2016-10-20 22:09:36 -04:00
<?php declare(strict_types=1);
/**
* Hummingbird Anime List Client
2015-11-16 11:40:01 -05:00
*
2018-08-22 13:48:27 -04:00
* An API client for Kitsu to manage anime and manga watch lists
2015-11-16 11:40:01 -05:00
*
2021-02-04 11:57:01 -05:00
* PHP version 8
2016-08-30 10:01:18 -04:00
*
2015-11-16 11:40:01 -05:00
* @package HummingbirdAnimeClient
2016-08-30 10:01:18 -04:00
* @author Timothy J. Warren <tim@timshomepage.net>
2021-01-13 01:52:03 -05:00
* @copyright 2015 - 2021 Timothy J. Warren
2016-08-30 10:01:18 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2020-12-10 17:06:50 -05:00
* @version 5.2
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
2016-10-20 22:09:36 -04:00
2015-09-15 13:19:29 -04:00
namespace Aviat\AnimeClient;
2017-03-30 16:57:58 -04:00
use function Aviat\Ion\_dir;
2017-02-22 14:46:35 -05:00
2020-05-08 19:15:21 -04:00
use Aviat\AnimeClient\Enum\EventType;
2019-12-09 13:13:31 -05:00
use Aura\Router\Generator;
use Aura\Session\Segment;
use Aviat\AnimeClient\API\Kitsu\Auth;
use Aviat\Ion\ConfigInterface;
use Psr\Http\Message\ServerRequestInterface;
2020-05-08 19:15:21 -04:00
use Psr\SimpleCache\CacheInterface;
2019-12-09 13:13:31 -05:00
2018-01-16 14:58:07 -05:00
use Aviat\Ion\Di\{
ContainerAware,
2019-12-09 13:13:31 -05:00
ContainerInterface,
Exception\ContainerException,
Exception\NotFoundException
2018-01-16 14:58:07 -05:00
};
use Aviat\Ion\Event;
2017-12-06 14:40:13 -05:00
use Aviat\Ion\Exception\DoubleRenderException;
2016-12-20 12:58:37 -05:00
use Aviat\Ion\View\{HtmlView, HttpView, JsonView};
2016-10-20 22:09:36 -04:00
use InvalidArgumentException;
2015-09-17 23:11:18 -04:00
/**
2015-09-17 23:11:18 -04:00
* Controller base, defines output methods
*/
class Controller {
2017-03-31 13:37:53 -04:00
use ContainerAware;
/**
* The authentication object
*/
2020-04-10 20:01:46 -04:00
protected Auth $auth;
2017-03-31 13:37:53 -04:00
/**
* Cache manager
*/
2020-05-08 19:15:21 -04:00
protected CacheInterface $cache;
2017-03-31 13:37:53 -04:00
/**
* The global configuration object
*/
2020-04-10 20:01:46 -04:00
public ConfigInterface $config;
2017-03-31 13:37:53 -04:00
/**
* Request object
*/
2020-04-10 20:01:46 -04:00
protected ServerRequestInterface $request;
2017-03-31 13:37:53 -04:00
/**
* Url generation class
*/
2020-04-10 20:01:46 -04:00
protected UrlGenerator $urlGenerator;
2017-03-31 13:37:53 -04:00
/**
* Aura url generator
*/
2020-04-10 20:01:46 -04:00
protected Generator $url;
2017-03-31 13:37:53 -04:00
/**
* Session segment
*/
2020-04-10 20:01:46 -04:00
protected Segment $session;
2017-03-31 13:37:53 -04:00
/**
* Common data to be sent to views
*/
2020-04-10 20:01:46 -04:00
protected array $baseData = [];
2015-06-26 16:39:10 -04:00
/**
* Controller constructor.
*
* @param ContainerInterface $container
2019-12-09 13:13:31 -05:00
* @throws ContainerException
* @throws NotFoundException
*/
2015-09-17 23:11:18 -04:00
public function __construct(ContainerInterface $container)
2015-05-22 12:36:26 -04:00
{
2015-09-17 23:11:18 -04:00
$this->setContainer($container);
2018-12-21 15:52:34 -05:00
2016-03-03 16:53:17 -05:00
$auraUrlGenerator = $container->get('aura-router')->getGenerator();
2018-12-21 15:52:34 -05:00
$session = $container->get('session');
2015-09-17 23:11:18 -04:00
$urlGenerator = $container->get('url-generator');
2018-12-21 15:52:34 -05:00
$this->auth = $container->get('auth');
2016-04-21 11:14:21 -04:00
$this->cache = $container->get('cache');
$this->config = $container->get('config');
$this->request = $container->get('request');
2018-12-21 15:52:34 -05:00
$this->session = $session->getSegment(SESSION_SEGMENT);
2017-03-30 16:16:40 -04:00
$this->url = $auraUrlGenerator;
2015-09-17 23:11:18 -04:00
$this->urlGenerator = $urlGenerator;
2016-01-04 10:53:03 -05:00
2018-12-21 15:52:34 -05:00
$this->baseData = [
'auth' => $container->get('auth'),
'config' => $this->config,
'menu_name' => '',
'message' => $this->session->getFlash('message'), // Get message box data if it exists
'other_type' => 'manga',
'url' => $auraUrlGenerator,
'url_type' => 'anime',
'urlGenerator' => $urlGenerator,
];
2020-05-08 19:15:21 -04:00
// Set up 'global' events
Event::on(EventType::CLEAR_CACHE, fn () => clearCache($this->cache));
Event::on(EventType::RESET_CACHE_KEY, fn (string $key) => $this->cache->delete($key));
2017-03-08 12:55:49 -05:00
}
2015-11-04 16:36:54 -05:00
/**
2017-03-31 13:37:53 -04:00
* Set the current url in the session as the target of a future redirect
2015-11-04 16:36:54 -05:00
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
* @param string|NULL $url
2019-12-09 13:13:31 -05:00
* @throws ContainerException
* @throws NotFoundException
2015-11-04 16:36:54 -05:00
*/
public function setSessionRedirect(string $url = NULL): void
2015-11-04 16:36:54 -05:00
{
2017-03-31 13:37:53 -04:00
$serverParams = $this->request->getServerParams();
2015-11-04 16:36:54 -05:00
2017-03-31 13:37:53 -04:00
if ( ! array_key_exists('HTTP_REFERER', $serverParams))
{
return;
}
$util = $this->container->get('util');
$doubleFormPage = $serverParams['HTTP_REFERER'] === $this->request->getUri();
2021-02-17 20:02:51 -05:00
$isLoginPage = str_contains($serverParams['HTTP_REFERER'], 'login');
2017-03-31 13:37:53 -04:00
// Don't attempt to set the redirect url if
// the page is one of the form type pages,
2018-12-21 15:52:34 -05:00
// and the previous page is also a form type
2017-12-06 14:40:13 -05:00
if ($doubleFormPage || $isLoginPage)
2017-03-31 13:37:53 -04:00
{
return;
}
2020-03-13 09:53:31 -04:00
if (NULL === $url)
2017-03-31 13:37:53 -04:00
{
$url = $util->isViewPage()
? (string) $this->request->getUri()
2017-03-31 13:37:53 -04:00
: $serverParams['HTTP_REFERER'];
}
$this->session->set('redirect_url', $url);
}
/**
* Redirect to the url previously set in the session
*
2018-12-21 15:52:34 -05:00
* If one is not set, redirect to default url
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-12-06 14:40:13 -05:00
* @throws InvalidArgumentException
2017-03-31 13:37:53 -04:00
* @return void
*/
2018-11-09 10:38:35 -05:00
public function sessionRedirect(): void
2017-03-31 13:37:53 -04:00
{
2018-12-21 15:52:34 -05:00
$target = $this->session->get('redirect_url') ?? '/';
$this->redirect($target, 303);
$this->session->set('redirect_url', NULL);
2017-03-31 13:37:53 -04:00
}
2015-11-04 16:36:54 -05:00
/**
* Check if the current user is authenticated, else error and exit
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
*/
protected function checkAuth(): void
{
if ( ! $this->auth->isAuthenticated())
{
$this->errorPage(
403,
'Forbidden',
'You must <a href="/login">log in</a> to perform this action.'
);
}
}
2017-03-31 13:37:53 -04:00
/**
* Get the string output of a partial template
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param HtmlView $view
* @param string $template
* @param array $data
* @return string
*/
2021-02-11 19:54:22 -05:00
protected function loadPartial(HtmlView $view, string $template, array $data = []): string
2017-03-31 13:37:53 -04:00
{
$router = $this->container->get('dispatcher');
if (isset($this->baseData))
2015-11-04 16:36:54 -05:00
{
2017-03-31 13:37:53 -04:00
$data = array_merge($this->baseData, $data);
2015-11-04 16:36:54 -05:00
}
2017-03-31 13:37:53 -04:00
$route = $router->getRoute();
2018-12-21 15:52:34 -05:00
$data['route_path'] = $route !== FALSE ? $route->path : '';
2017-03-31 13:37:53 -04:00
$templatePath = _dir($this->config->get('view_path'), "{$template}.php");
2016-01-04 10:53:03 -05:00
2017-03-31 13:37:53 -04:00
if ( ! is_file($templatePath))
{
throw new InvalidArgumentException("Invalid template : {$template}");
}
return $view->renderTemplate($templatePath, $data);
2017-03-31 13:37:53 -04:00
}
/**
* Render a template with header and footer
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param HtmlView $view
* @param string $template
* @param array $data
* @return HtmlView
2017-03-31 13:37:53 -04:00
*/
2021-02-11 19:54:22 -05:00
protected function renderFullPage(HtmlView $view, string $template, array $data): HtmlView
2017-03-31 13:37:53 -04:00
{
$csp = [
2022-01-10 17:19:28 -05:00
"default-src 'self' media.kitsu.io kitsu-production-media.s3.us-west-002.backblazeb2.com",
"object-src 'none'",
2021-02-18 07:15:43 -05:00
"child-src 'self' *.youtube.com polyfill.io",
];
$view->addHeader('Content-Security-Policy', implode('; ', $csp));
2017-03-31 13:37:53 -04:00
$view->appendOutput($this->loadPartial($view, 'header', $data));
if (array_key_exists('message', $data) && \is_array($data['message']))
2017-03-31 13:37:53 -04:00
{
$view->appendOutput($this->loadPartial($view, 'message', $data['message']));
}
$view->appendOutput($this->loadPartial($view, $template, $data));
$view->appendOutput($this->loadPartial($view, 'footer', $data));
return $view;
2017-03-31 13:37:53 -04:00
}
/**
* 404 action
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-12-06 14:40:13 -05:00
* @param string $title
* @param string $message
* @throws InvalidArgumentException
2017-03-31 13:37:53 -04:00
* @return void
*/
public function notFound(
string $title = 'Sorry, page not found',
string $message = 'Page Not Found'
2018-12-21 15:52:34 -05:00
): void
2017-03-31 13:37:53 -04:00
{
$this->outputHTML('404', [
'title' => $title,
'message' => $message,
], NULL, 404);
2020-08-24 13:10:43 -04:00
exit();
2017-03-31 13:37:53 -04:00
}
/**
* Display a generic error page
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param int $httpCode
* @param string $title
* @param string $message
2020-03-13 09:53:31 -04:00
* @param string $longMessage
2017-12-06 14:40:13 -05:00
* @throws InvalidArgumentException
2017-03-31 13:37:53 -04:00
* @return void
*/
2020-03-13 09:53:31 -04:00
public function errorPage(int $httpCode, string $title, string $message, string $longMessage = ''): void
2017-03-31 13:37:53 -04:00
{
$this->outputHTML('error', [
'title' => $title,
'message' => $message,
2020-03-13 09:53:31 -04:00
'long_message' => $longMessage
2017-03-31 13:37:53 -04:00
], NULL, $httpCode);
}
/**
* Redirect to the default controller/url from an empty path
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2018-02-02 09:50:58 -05:00
* @throws InvalidArgumentException
* @return void
*/
public function redirectToDefaultRoute(): void
{
$defaultType = $this->config->get('default_list');
$this->redirect($this->urlGenerator->defaultUrl($defaultType), 303);
}
2017-03-31 13:37:53 -04:00
/**
* Set a session flash variable to display a message on
* next page load
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param string $message
* @param string $type
* @return void
*/
public function setFlashMessage(string $message, string $type = 'info'): void
2017-03-31 13:37:53 -04:00
{
static $messages;
if ( ! $messages)
{
$messages = [];
}
$messages[] = [
'message_type' => $type,
2015-11-04 16:36:54 -05:00
'message' => $message
2017-03-31 13:37:53 -04:00
];
$this->session->setFlash('message', $messages);
}
/**
* Helper for consistent page titles
*
2019-12-09 13:13:31 -05:00
* @param string ...$parts Title segments
2017-03-31 13:37:53 -04:00
* @return string
*/
public function formatTitle(string ...$parts) : string
{
return implode(' &middot; ', $parts);
}
/**
* Add a message box to the page
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param HtmlView $view
* @param string $type
* @param string $message
2017-12-06 14:40:13 -05:00
* @throws InvalidArgumentException
2017-03-31 13:37:53 -04:00
* @return string
*/
2021-02-11 19:54:22 -05:00
protected function showMessage(HtmlView $view, string $type, string $message): string
2017-03-31 13:37:53 -04:00
{
return $this->loadPartial($view, 'message', [
'message_type' => $type,
'message' => $message
]);
2015-11-04 16:36:54 -05:00
}
2015-11-13 11:33:27 -05:00
/**
2017-03-31 13:37:53 -04:00
* Output a template to HTML, using the provided data
2015-11-13 11:33:27 -05:00
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param string $template
* @param array $data
2020-03-13 09:53:31 -04:00
* @param HtmlView|NULL $view
2017-03-31 13:37:53 -04:00
* @param int $code
2015-11-18 10:48:05 -05:00
* @return void
2022-01-07 12:33:01 -05:00
*@throws InvalidArgumentException
2015-11-13 11:33:27 -05:00
*/
2022-01-07 12:33:01 -05:00
protected function outputHTML(string $template, array $data = [], HtmlView $view = NULL, int $code = 200): void
2015-11-13 11:33:27 -05:00
{
2020-03-13 09:53:31 -04:00
if (NULL === $view)
2015-11-13 11:33:27 -05:00
{
2017-03-31 13:37:53 -04:00
$view = new HtmlView($this->container);
2015-11-13 11:33:27 -05:00
}
2017-03-31 13:37:53 -04:00
$view->setStatusCode($code);
$this->renderFullPage($view, $template, $data)->send();
2015-11-13 11:33:27 -05:00
}
/**
2017-03-31 13:37:53 -04:00
* Output a JSON Response
2015-11-13 11:33:27 -05:00
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param mixed $data
* @param int $code - the http status code
2017-12-06 14:40:13 -05:00
* @throws DoubleRenderException
2015-11-13 11:33:27 -05:00
* @return void
*/
2021-02-11 19:54:22 -05:00
protected function outputJSON(mixed $data, int $code): void
2015-11-13 11:33:27 -05:00
{
2020-07-31 16:22:32 -04:00
(new JsonView())
->setOutput($data)
2017-03-31 13:37:53 -04:00
->setStatusCode($code)
2020-07-31 16:22:32 -04:00
->send();
2017-03-31 13:37:53 -04:00
}
2015-11-13 11:33:27 -05:00
2017-03-31 13:37:53 -04:00
/**
* Redirect to the selected page
*
2021-02-26 14:42:07 -05:00
* @codeCoverageIgnore
2017-03-31 13:37:53 -04:00
* @param string $url
* @param int $code
* @return void
*/
protected function redirect(string $url, int $code): void
2017-03-31 13:37:53 -04:00
{
2020-08-26 15:25:31 -04:00
try
{
(new HttpView())->redirect($url, $code)->send();
}
2021-02-11 19:54:22 -05:00
catch (\Throwable) {}
2015-11-13 11:33:27 -05:00
}
}
2015-09-15 13:19:29 -04:00
// End of BaseController.php