HummingBirdAnimeClient/src/AnimeClient/Controller/Anime.php

369 lines
7.7 KiB
PHP
Raw Normal View History

2016-10-20 22:09:36 -04:00
<?php declare(strict_types=1);
/**
2017-02-15 16:13:32 -05:00
* 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
*
2017-02-15 16:13:32 -05:00
* @package HummingbirdAnimeClient
2022-03-04 12:32:17 -05:00
* @author Timothy J. Warren <tim@timshome.page>
* @copyright 2015 - 2022 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
*/
namespace Aviat\AnimeClient\Controller;
2019-12-09 13:13:31 -05:00
use Aura\Router\Exception\RouteNotFound;
2018-01-16 14:58:07 -05:00
use Aviat\AnimeClient\API\Enum\AnimeWatchingStatus\Kitsu as KitsuWatchingStatus;
use Aviat\AnimeClient\API\Kitsu\Transformer\AnimeListTransformer;
use Aviat\AnimeClient\API\Mapping\AnimeWatchingStatus;
use Aviat\AnimeClient\Controller as BaseController;
2020-04-10 20:01:46 -04:00
use Aviat\AnimeClient\Model\Anime as AnimeModel;
2018-09-27 16:45:12 -04:00
use Aviat\AnimeClient\Types\FormItem;
2016-10-20 22:32:17 -04:00
use Aviat\Ion\Di\ContainerInterface;
use Aviat\Ion\Di\Exception\{ContainerException, NotFoundException};
use Aviat\Ion\Json;
2015-06-26 16:39:10 -04:00
2019-12-09 14:34:23 -05:00
use InvalidArgumentException;
use Throwable;
2020-04-21 19:22:56 -04:00
use TypeError;
2019-12-09 14:34:23 -05:00
/**
* Controller for Anime-related pages
*/
final class Anime extends BaseController
{
/**
* The anime list model
*/
2020-04-10 20:01:46 -04:00
protected AnimeModel $model;
/**
* Constructor
*
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
{
parent::__construct($container);
2015-12-08 16:39:49 -05:00
$this->model = $container->get('anime-model');
2016-01-04 10:53:03 -05:00
2017-02-15 11:30:16 -05:00
$this->baseData = array_merge($this->baseData, [
2015-10-09 14:34:55 -04:00
'menu_name' => 'anime_list',
'other_type' => 'manga',
2018-12-21 15:52:34 -05:00
'url_type' => 'anime',
2015-09-14 15:49:20 -04:00
]);
2015-05-22 12:36:26 -04:00
}
2015-10-06 11:38:20 -04:00
/**
* Show a portion, or all of the anime list
*
2022-01-07 12:33:01 -05:00
* @param int|string $status - The section of the list
2020-12-10 15:59:37 -05:00
* @param string|null $view - List or cover view
2019-12-09 14:34:23 -05:00
* @throws InvalidArgumentException
* @throws Throwable
2015-10-06 11:38:20 -04:00
*/
2022-01-07 12:33:01 -05:00
public function index(int|string $status = KitsuWatchingStatus::WATCHING, ?string $view = NULL): void
2015-05-22 12:36:26 -04:00
{
2020-12-10 15:59:37 -05:00
if ( ! in_array($status, [
'all',
'watching',
'plan_to_watch',
'on_hold',
'dropped',
'completed',
], TRUE))
{
$this->errorPage(404, 'Not Found', 'Page not found');
}
2020-12-10 15:59:37 -05:00
$title = array_key_exists($status, AnimeWatchingStatus::ROUTE_TO_TITLE)
2017-03-24 09:58:27 -04:00
? $this->formatTitle(
$this->config->get('whose_list') . "'s Anime List",
2020-12-10 15:59:37 -05:00
AnimeWatchingStatus::ROUTE_TO_TITLE[$status]
2017-03-24 09:58:27 -04:00
)
: '';
2017-02-15 16:30:14 -05:00
$viewMap = [
'' => 'cover',
'list' => 'list',
];
2020-12-10 15:59:37 -05:00
$data = ($status !== 'all')
? $this->model->getList(AnimeWatchingStatus::ROUTE_TO_KITSU[$status])
2017-03-07 17:51:08 -05:00
: $this->model->getAllLists();
2016-04-05 13:19:35 -04:00
2017-02-15 16:30:14 -05:00
$this->outputHTML('anime/' . $viewMap[$view], [
2015-05-22 12:36:26 -04:00
'title' => $title,
'sections' => $data,
]);
2015-05-22 12:36:26 -04:00
}
2015-05-27 09:03:42 -04:00
2016-01-04 10:53:03 -05:00
/**
* Form to add an anime
*
2019-12-09 13:13:31 -05:00
* @throws ContainerException
* @throws InvalidArgumentException
2019-12-09 13:13:31 -05:00
* @throws NotFoundException
* @throws RouteNotFound
2019-12-09 14:34:23 -05:00
* @throws Throwable
2016-01-04 10:53:03 -05:00
*/
2018-02-02 09:50:58 -05:00
public function addForm(): void
2016-01-04 10:53:03 -05:00
{
$this->checkAuth();
2017-02-16 14:30:06 -05:00
$this->setSessionRedirect();
2016-01-04 10:53:03 -05:00
$this->outputHTML('anime/add', [
2017-03-24 09:58:27 -04:00
'title' => $this->formatTitle(
$this->config->get('whose_list') . "'s Anime List",
'Add'
),
2017-03-30 16:16:40 -04:00
'action_url' => $this->url->generate('anime.add.post'),
'status_list' => AnimeWatchingStatus::KITSU_TO_TITLE,
2016-01-04 10:53:03 -05:00
]);
}
/**
* Add an anime to the list
*
2019-12-09 14:34:23 -05:00
* @throws Throwable
2016-01-04 10:53:03 -05:00
*/
2018-02-02 09:50:58 -05:00
public function add(): void
2016-01-04 10:53:03 -05:00
{
$this->checkAuth();
$data = (array) $this->request->getParsedBody();
if (empty($data['mal_id']))
{
unset($data['mal_id']);
}
2016-01-04 10:53:03 -05:00
if ( ! array_key_exists('id', $data))
{
$this->redirect('anime/add', 303);
2016-01-04 10:53:03 -05:00
}
$result = $this->model->createLibraryItem($data);
2016-01-04 10:53:03 -05:00
if ($result)
2016-01-04 10:53:03 -05:00
{
2017-02-17 08:25:19 -05:00
$this->setFlashMessage('Added new anime to list', 'success');
2017-01-16 11:26:19 -05:00
$this->cache->clear();
2016-01-04 10:53:03 -05:00
}
else
{
2017-02-17 08:25:19 -05:00
$this->setFlashMessage('Failed to add new anime to list', 'error');
2016-01-04 10:53:03 -05:00
}
2017-02-16 14:30:06 -05:00
$this->sessionRedirect();
2016-01-04 10:53:03 -05:00
}
/**
* Form to edit details about a series
*/
2022-01-07 12:33:01 -05:00
public function edit(string $id, string $status = 'all'): void
2016-01-04 10:53:03 -05:00
{
$this->checkAuth();
2019-01-29 16:01:31 -05:00
2018-01-16 14:58:07 -05:00
$item = $this->model->getLibraryItem($id);
2017-02-16 14:30:06 -05:00
$this->setSessionRedirect();
2016-01-04 10:53:03 -05:00
$this->outputHTML('anime/edit', [
2017-03-24 09:58:27 -04:00
'title' => $this->formatTitle(
$this->config->get('whose_list') . "'s Anime List",
'Edit'
),
2016-01-04 10:53:03 -05:00
'item' => $item,
'statuses' => AnimeWatchingStatus::KITSU_TO_TITLE,
2017-03-30 16:16:40 -04:00
'action' => $this->url->generate('update.post', [
'controller' => 'anime',
2017-03-30 16:16:40 -04:00
]),
2016-01-04 10:53:03 -05:00
]);
}
2015-10-20 16:41:51 -04:00
/**
* Search for anime
*/
2018-02-02 09:50:58 -05:00
public function search(): void
2015-10-20 16:41:51 -04:00
{
$queryParams = $this->request->getQueryParams();
$query = $queryParams['query'];
2020-07-31 16:22:32 -04:00
$this->outputJSON($this->model->search($query), 200);
2015-10-20 16:41:51 -04:00
}
2016-01-04 10:53:03 -05:00
/**
* Update an anime item via a form submission
*
2019-12-09 14:34:23 -05:00
* @throws Throwable
2016-01-04 10:53:03 -05:00
*/
2018-02-02 09:50:58 -05:00
public function formUpdate(): void
2016-01-04 10:53:03 -05:00
{
$this->checkAuth();
2019-01-29 16:01:31 -05:00
$data = (array) $this->request->getParsedBody();
2016-01-04 10:53:03 -05:00
// Do some minor data manipulation for
// large form-based updates
2020-10-21 15:02:25 -04:00
$transformer = new AnimeListTransformer();
2017-02-15 15:35:41 -05:00
$postData = $transformer->untransform($data);
$fullResult = $this->model->updateLibraryItem(FormItem::from($postData));
2016-01-04 10:53:03 -05:00
if ($fullResult['statusCode'] === 200)
2016-01-04 10:53:03 -05:00
{
2018-01-16 14:58:07 -05:00
$this->setFlashMessage('Successfully updated.', 'success');
2017-01-16 11:26:19 -05:00
$this->cache->clear();
2016-01-04 10:53:03 -05:00
}
else
{
2017-02-17 08:25:19 -05:00
$this->setFlashMessage('Failed to update anime.', 'error');
2016-01-04 10:53:03 -05:00
}
2017-02-16 14:30:06 -05:00
$this->sessionRedirect();
2016-01-04 10:53:03 -05:00
}
/**
* Increase the watched count for an anime item
*
2019-12-09 14:34:23 -05:00
* @throws Throwable
*/
public function increment(): void
{
$this->checkAuth();
2021-02-17 20:02:51 -05:00
if (str_contains($this->request->getHeader('content-type')[0], 'application/json'))
{
$data = Json::decode((string) $this->request->getBody());
}
else
{
$data = (array) $this->request->getParsedBody();
}
if (empty($data))
{
$this->errorPage(400, 'Bad Request', '');
2020-08-17 10:23:32 -04:00
exit();
}
$response = $this->model->incrementLibraryItem(FormItem::from($data));
$this->cache->clear();
$this->outputJSON($response['body'], $response['statusCode']);
}
/**
* Remove an anime from the list
2016-08-30 10:57:41 -04:00
*
2019-12-09 14:34:23 -05:00
* @throws Throwable
*/
2018-02-02 09:50:58 -05:00
public function delete(): void
{
$this->checkAuth();
$body = (array) $this->request->getParsedBody();
2017-02-04 15:18:34 -05:00
$response = $this->model->deleteLibraryItem($body['id'], $body['mal_id']);
if ($response === TRUE)
{
$this->setFlashMessage('Successfully deleted anime.', 'success');
2017-01-16 11:26:19 -05:00
$this->cache->clear();
}
else
{
2017-02-17 08:25:19 -05:00
$this->setFlashMessage('Failed to delete anime.', 'error');
}
2017-02-16 14:30:06 -05:00
$this->sessionRedirect();
}
/**
* View details of an anime
*
2019-12-09 14:34:23 -05:00
* @throws InvalidArgumentException
*/
2020-12-10 15:59:37 -05:00
public function details(string $id): void
{
2019-08-10 10:09:07 -04:00
try
{
2020-12-10 15:59:37 -05:00
$data = $this->model->getAnime($id);
2019-08-10 10:09:07 -04:00
if ($data->isEmpty())
{
$this->notFound(
$this->config->get('whose_list') .
"'s Anime List &middot; Anime &middot; " .
'Anime not found',
'Anime Not Found'
);
return;
}
$this->outputHTML('anime/details', [
'title' => $this->formatTitle(
$this->config->get('whose_list') . "'s Anime List",
'Anime',
2021-02-16 14:43:51 -05:00
$data->title ?? ''
2019-08-10 10:09:07 -04:00
),
'data' => $data,
]);
}
2021-02-03 09:46:36 -05:00
catch (TypeError)
{
2018-01-16 14:58:07 -05:00
$this->notFound(
$this->config->get('whose_list') .
2019-08-10 10:09:07 -04:00
"'s Anime List &middot; Anime &middot; " .
'Anime not found',
'Anime Not Found'
);
}
}
2020-12-10 15:59:37 -05:00
public function random(): void
{
try
{
$data = $this->model->getRandomAnime();
if ($data->isEmpty())
{
$this->notFound(
$this->config->get('whose_list') .
"'s Anime List &middot; Anime &middot; " .
'Anime not found',
'Anime Not Found'
);
return;
}
$this->outputHTML('anime/details', [
'title' => $this->formatTitle(
$this->config->get('whose_list') . "'s Anime List",
'Anime',
2021-02-16 14:43:51 -05:00
$data->title ?? ''
),
'data' => $data,
]);
}
2021-02-03 09:46:36 -05:00
catch (TypeError)
{
$this->notFound(
$this->config->get('whose_list') .
"'s Anime List &middot; Anime &middot; " .
'Anime not found',
'Anime Not Found'
);
}
}
2015-05-22 12:36:26 -04:00
}
// End of AnimeController.php