HummingBirdAnimeClient/src/Controller.php

463 lines
9.3 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
*
* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists
2015-11-16 11:40:01 -05:00
*
2016-10-20 22:09:36 -04:00
* PHP version 7
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>
* @copyright 2015 - 2017 Timothy J. Warren
2016-08-30 10:01:18 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 4.0
2015-11-16 11:40:01 -05:00
* @link https://github.com/timw4mail/HummingBirdAnimeClient
*/
2016-10-20 22:09:36 -04:00
2015-09-15 13:19:29 -04:00
namespace Aviat\AnimeClient;
use const Aviat\AnimeClient\SESSION_SEGMENT;
2016-12-20 12:58:37 -05:00
use Aviat\Ion\Di\{ContainerAware, ContainerInterface};
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
2015-10-06 10:44:33 -04:00
*
* @property Response object $response
*/
class Controller {
2015-05-22 12:36:26 -04:00
2016-10-20 22:09:36 -04:00
use ContainerAware;
2015-09-17 23:11:18 -04:00
2016-04-21 11:14:21 -04:00
/**
* Cache manager
* @var \Aviat\Ion\Cache\CacheInterface
*/
protected $cache;
/**
* The global configuration object
* @var Aviat\Ion\ConfigInterface $config
*/
protected $config;
2015-05-22 12:36:26 -04:00
2015-10-06 11:38:20 -04:00
/**
* Request object
* @var object $request
*/
protected $request;
/**
* Response object
* @var object $response
*/
protected $response;
2015-06-26 16:39:10 -04:00
/**
* The api model for the current controller
* @var object
*/
protected $model;
2015-09-14 15:49:20 -04:00
/**
2016-08-30 10:57:41 -04:00
* Url generation class
2015-09-14 15:49:20 -04:00
* @var UrlGenerator
*/
protected $urlGenerator;
2016-01-04 10:53:03 -05:00
/**
* Session segment
* @var [type]
*/
protected $session;
2015-06-26 16:39:10 -04:00
/**
* Common data to be sent to views
* @var array
*/
2017-02-15 11:30:16 -05:00
protected $baseData = [
'url_type' => 'anime',
'other_type' => 'manga',
2015-10-09 14:34:55 -04:00
'menu_name' => ''
];
2015-06-26 16:39:10 -04:00
/**
* Constructor
*
* @param ContainerInterface $container
*/
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);
2016-03-03 16:53:17 -05:00
$auraUrlGenerator = $container->get('aura-router')->getGenerator();
2015-09-17 23:11:18 -04:00
$urlGenerator = $container->get('url-generator');
2016-04-21 11:14:21 -04:00
$this->cache = $container->get('cache');
$this->config = $container->get('config');
$this->request = $container->get('request');
$this->response = $container->get('response');
2017-02-17 08:25:19 -05:00
$this->baseData = array_merge((array)$this->baseData, [
'url' => $auraUrlGenerator,
'urlGenerator' => $urlGenerator,
'auth' => $container->get('auth'),
'config' => $this->config
]);
2015-09-17 23:11:18 -04:00
$this->urlGenerator = $urlGenerator;
2016-01-04 10:53:03 -05:00
$session = $container->get('session');
$this->session = $session->getSegment(SESSION_SEGMENT);
2016-01-04 10:53:03 -05:00
// Set a 'previous' flash value for better redirects
2017-02-16 14:30:06 -05:00
$serverParams = $this->request->getServerParams();
if (array_key_exists('HTTP_REFERER', $serverParams))
{
2017-02-16 14:30:06 -05:00
$this->session->setFlash('previous', $serverParams['HTTP_REFERER']);
}
2016-01-04 10:53:03 -05:00
// Set a message box if available
2017-02-15 11:30:16 -05:00
$this->baseData['message'] = $this->session->getFlash('message');
2015-05-22 12:36:26 -04:00
}
2015-10-20 16:41:51 -04:00
/**
* Redirect to the default controller/url from an empty path
2016-08-30 10:57:41 -04:00
*
* @return void
2015-10-20 16:41:51 -04:00
*/
public function redirectToDefaultRoute()
2015-10-20 16:41:51 -04:00
{
2017-02-16 14:30:06 -05:00
$defaultType = $this->config->get(['routes', 'route_config', 'default_list']);
$this->redirect($this->urlGenerator->defaultUrl($defaultType), 303);
2015-10-20 16:41:51 -04:00
}
2016-01-04 10:53:03 -05:00
/**
* Redirect to the previous page
*
* @return void
*/
2017-02-16 14:30:06 -05:00
public function redirectToPrevious()
2016-01-04 10:53:03 -05:00
{
$previous = $this->session->getFlash('previous');
$this->redirect($previous, 303);
}
/**
* Set the current url in the session as the target of a future redirect
*
* @param string|null $url
* @return void
*/
2017-02-16 14:30:06 -05:00
public function setSessionRedirect($url = NULL)
2016-01-04 10:53:03 -05:00
{
2017-02-16 14:30:06 -05:00
$serverParams = $this->request->getServerParams();
2016-04-19 13:23:49 -04:00
2017-02-16 14:30:06 -05:00
if ( ! array_key_exists('HTTP_REFERER', $serverParams))
2016-04-19 13:23:49 -04:00
{
return;
}
$util = $this->container->get('util');
2017-02-16 14:30:06 -05:00
$doubleFormPage = $serverParams['HTTP_REFERER'] === $this->request->getUri();
2016-01-04 10:53:03 -05:00
// Don't attempt to set the redirect url if
// the page is one of the form type pages,
// and the previous page is also a form type page_segments
2017-02-16 14:30:06 -05:00
if ($doubleFormPage)
2016-01-04 10:53:03 -05:00
{
return;
}
if (is_null($url))
{
2017-02-16 14:30:06 -05:00
$url = $util->isViewPage()
2016-01-04 10:53:03 -05:00
? $this->request->url->get()
2017-02-16 14:30:06 -05:00
: $serverParams['HTTP_REFERER'];
2016-01-04 10:53:03 -05:00
}
$this->session->set('redirect_url', $url);
}
/**
* Redirect to the url previously set in the session
*
* @return void
*/
2017-02-16 14:30:06 -05:00
public function sessionRedirect()
2016-01-04 10:53:03 -05:00
{
$target = $this->session->get('redirect_url');
if (empty($target))
{
2016-12-20 12:58:37 -05:00
$this->notFound();
2016-01-04 10:53:03 -05:00
}
else
{
$this->redirect($target, 303);
$this->session->set('redirect_url', NULL);
}
}
/**
* Get a class member
*
* @param string $key
2016-10-20 22:09:36 -04:00
* @return mixed
*/
2016-10-20 22:09:36 -04:00
public function __get(string $key)
{
2015-09-17 23:11:18 -04:00
$allowed = ['response', 'config'];
if (in_array($key, $allowed))
{
return $this->$key;
}
return NULL;
}
2015-05-22 12:36:26 -04:00
/**
* Get the string output of a partial template
2015-05-22 12:36:26 -04:00
*
2015-10-06 11:38:20 -04:00
* @param HtmlView $view
2015-05-22 12:36:26 -04:00
* @param string $template
2015-10-06 12:15:19 -04:00
* @param array $data
2016-10-20 22:09:36 -04:00
* @throws InvalidArgumentException
* @return string
2015-05-22 12:36:26 -04:00
*/
2017-02-16 14:30:06 -05:00
protected function loadPartial($view, $template, array $data = [])
2015-05-22 12:36:26 -04:00
{
2015-10-09 14:34:55 -04:00
$router = $this->container->get('dispatcher');
2015-09-17 23:11:18 -04:00
2017-02-15 11:30:16 -05:00
if (isset($this->baseData))
{
2017-02-15 11:30:16 -05:00
$data = array_merge($this->baseData, $data);
}
2016-12-20 12:58:37 -05:00
$route = $router->getRoute();
$data['route_path'] = $route ? $router->getRoute()->path : '';
2015-05-22 12:36:26 -04:00
2017-02-16 14:30:06 -05:00
$templatePath = _dir($this->config->get('view_path'), "{$template}.php");
2017-02-16 14:30:06 -05:00
if ( ! is_file($templatePath))
2015-05-22 12:36:26 -04:00
{
2016-10-20 22:09:36 -04:00
throw new InvalidArgumentException("Invalid template : {$template}");
2015-05-22 12:36:26 -04:00
}
2017-02-16 14:30:06 -05:00
return $view->renderTemplate($templatePath, (array)$data);
2015-09-17 23:11:18 -04:00
}
2015-05-22 12:36:26 -04:00
2015-09-17 23:11:18 -04:00
/**
* Render a template with header and footer
*
* @param HtmlView $view
2015-09-17 23:11:18 -04:00
* @param string $template
2015-10-09 14:34:55 -04:00
* @param array $data
2015-09-17 23:11:18 -04:00
* @return void
*/
2017-02-16 14:30:06 -05:00
protected function renderFullPage($view, $template, array $data)
2015-09-17 23:11:18 -04:00
{
2017-02-16 14:30:06 -05:00
$view->appendOutput($this->loadPartial($view, 'header', $data));
2016-01-04 10:53:03 -05:00
if (array_key_exists('message', $data) && is_array($data['message']))
{
2017-02-16 14:30:06 -05:00
$view->appendOutput($this->loadPartial($view, 'message', $data['message']));
2016-01-04 10:53:03 -05:00
}
2017-02-16 14:30:06 -05:00
$view->appendOutput($this->loadPartial($view, $template, $data));
$view->appendOutput($this->loadPartial($view, 'footer', $data));
}
2015-11-04 16:36:54 -05:00
/**
* Show the login form
*
* @codeCoverageIgnore
* @param string $status
* @return void
*/
2016-10-20 22:09:36 -04:00
public function login(string $status = '')
2015-11-04 16:36:54 -05:00
{
2016-10-20 22:09:36 -04:00
$message = '';
2015-11-04 16:36:54 -05:00
$view = new HtmlView($this->container);
2016-10-20 22:09:36 -04:00
if ($status !== '')
2015-11-04 16:36:54 -05:00
{
2017-02-16 14:30:06 -05:00
$message = $this->showMessage($view, 'error', $status);
2015-11-04 16:36:54 -05:00
}
2016-01-04 10:53:03 -05:00
// Set the redirect url
2017-02-16 14:30:06 -05:00
$this->setSessionRedirect();
2016-01-04 10:53:03 -05:00
2015-11-04 16:36:54 -05:00
$this->outputHTML('login', [
'title' => 'Api login',
'message' => $message
], $view);
}
2015-11-13 11:33:27 -05:00
/**
* Attempt login authentication
*
2015-11-18 10:48:05 -05:00
* @return void
2015-11-13 11:33:27 -05:00
*/
2016-12-20 12:58:37 -05:00
public function loginAction()
2015-11-13 11:33:27 -05:00
{
$auth = $this->container->get('auth');
$post = $this->request->getParsedBody();
if ($auth->authenticate($post['password']))
2015-11-13 11:33:27 -05:00
{
2017-02-16 14:30:06 -05:00
return $this->sessionRedirect();
2015-11-13 11:33:27 -05:00
}
2017-02-16 14:30:06 -05:00
$this->setFlashMessage('Invalid username or password.');
2017-01-12 15:41:20 -05:00
$this->redirect($this->urlGenerator->url('login'), 303);
2015-11-13 11:33:27 -05:00
}
/**
* Deauthorize the current user
*
* @return void
*/
public function logout()
{
$auth = $this->container->get('auth');
$auth->logout();
$this->redirectToDefaultRoute();
2015-11-13 11:33:27 -05:00
}
/**
* 404 action
*
* @return void
*/
2016-12-20 12:58:37 -05:00
public function notFound()
2015-11-13 11:33:27 -05:00
{
$this->outputHTML('404', [
'title' => 'Sorry, page not found'
], NULL, 404);
2015-11-13 11:33:27 -05:00
}
2016-01-06 11:08:56 -05:00
/**
* Display a generic error page
*
2017-02-15 11:30:16 -05:00
* @param int $httpCode
2016-01-06 11:08:56 -05:00
* @param string $title
* @param string $message
* @param string $long_message
* @return void
*/
2017-02-15 11:30:16 -05:00
public function errorPage($httpCode, $title, $message, $long_message = "")
2016-01-06 11:08:56 -05:00
{
$this->outputHTML('error', [
'title' => $title,
'message' => $message,
'long_message' => $long_message
2017-02-15 11:30:16 -05:00
], NULL, $httpCode);
2016-01-06 11:08:56 -05:00
}
2016-01-04 10:53:03 -05:00
/**
* Set a session flash variable to display a message on
* next page load
*
* @param string $message
* @param string $type
* @return void
*/
2017-02-16 14:30:06 -05:00
public function setFlashMessage($message, $type = "info")
2016-01-04 10:53:03 -05:00
{
2017-02-16 14:30:06 -05:00
static $messages;
if (!$messages)
{
$messages = [];
}
$messages[] = [
2016-01-04 10:53:03 -05:00
'message_type' => $type,
'message' => $message
2017-02-16 14:30:06 -05:00
];
$this->session->setFlash('message', $messages);
2016-01-04 10:53:03 -05:00
}
2016-04-21 11:14:21 -04:00
/**
* Purges the API cache
*
* @return void
*/
2016-12-20 12:58:37 -05:00
public function clearCache()
2016-04-21 11:14:21 -04:00
{
2017-01-16 11:26:19 -05:00
$this->cache->clear();
2016-04-21 11:14:21 -04:00
$this->outputHTML('blank', [
'title' => 'Cache cleared'
], NULL, 200);
}
2015-11-04 16:36:54 -05:00
/**
* Add a message box to the page
*
* @codeCoverageIgnore
* @param HtmlView $view
* @param string $type
* @param string $message
* @return string
*/
2016-12-20 12:58:37 -05:00
protected function showMessage($view, $type, $message)
2015-11-04 16:36:54 -05:00
{
2017-02-16 14:30:06 -05:00
return $this->loadPartial($view, 'message', [
2016-01-04 10:53:03 -05:00
'message_type' => $type,
2015-11-04 16:36:54 -05:00
'message' => $message
]);
}
/**
* Output a template to HTML, using the provided data
*
* @param string $template
2015-10-09 14:34:55 -04:00
* @param array $data
2015-11-04 16:53:22 -05:00
* @param HtmlView|null $view
* @param int $code
* @return void
*/
protected function outputHTML($template, array $data = [], $view = NULL, $code = 200)
{
2015-11-04 16:36:54 -05:00
if (is_null($view))
{
$view = new HtmlView($this->container);
}
$view->setStatusCode($code);
2017-02-16 14:30:06 -05:00
$this->renderFullPage($view, $template, $data);
2015-09-17 23:11:18 -04:00
}
2015-09-17 23:11:18 -04:00
/**
* Output a JSON Response
*
* @param mixed $data
2016-02-02 11:34:03 -05:00
* @param int $code - the http status code
2015-09-17 23:11:18 -04:00
* @return void
*/
protected function outputJSON($data = 'Empty response', int $code = 200)
2015-09-17 23:11:18 -04:00
{
(new JsonView($this->container))
->setStatusCode($code)
->setOutput($data)
->send();
2015-05-22 12:36:26 -04:00
}
/**
* Redirect to the selected page
*
2015-10-20 16:41:51 -04:00
* @param string $url
* @param int $code
* @return void
*/
2015-11-04 16:36:54 -05:00
protected function redirect($url, $code)
{
2015-09-17 23:11:18 -04:00
$http = new HttpView($this->container);
$http->redirect($url, $code);
}
}
2015-09-15 13:19:29 -04:00
// End of BaseController.php