2016-10-20 22:09:36 -04:00
|
|
|
<?php declare(strict_types=1);
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
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
|
|
|
*
|
2020-03-11 15:15:05 -04:00
|
|
|
* PHP version 7.3
|
2016-08-30 10:01:18 -04:00
|
|
|
*
|
2017-02-15 16:13:32 -05:00
|
|
|
* @package HummingbirdAnimeClient
|
2017-01-06 23:34:56 -05:00
|
|
|
* @author Timothy J. Warren <tim@timshomepage.net>
|
2020-01-08 15:39:49 -05:00
|
|
|
* @copyright 2015 - 2020 Timothy J. Warren
|
2017-01-06 23:34:56 -05:00
|
|
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License
|
2019-12-06 09:16:35 -05:00
|
|
|
* @version 4.2
|
2017-03-07 20:53:58 -05:00
|
|
|
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
|
2017-01-11 10:34:24 -05:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Aviat\AnimeClient\Model;
|
2017-02-08 15:48:20 -05:00
|
|
|
|
2019-12-09 13:13:31 -05:00
|
|
|
use Aviat\AnimeClient\API\Anilist\Model as AnilistModel;
|
|
|
|
use Aviat\AnimeClient\API\Kitsu\Model as KitsuModel;
|
2017-02-20 13:37:08 -05:00
|
|
|
use Aviat\AnimeClient\API\ParallelAPIRequest;
|
2017-03-01 22:07:51 -05:00
|
|
|
use Aviat\AnimeClient\API\Mapping\AnimeWatchingStatus;
|
2018-08-08 10:12:45 -04:00
|
|
|
use Aviat\AnimeClient\Types\{
|
|
|
|
Anime as AnimeType,
|
2018-09-27 16:45:12 -04:00
|
|
|
FormItem,
|
2018-08-08 11:18:57 -04:00
|
|
|
AnimeListItem
|
2018-08-08 10:12:45 -04:00
|
|
|
};
|
2016-12-21 12:46:20 -05:00
|
|
|
use Aviat\Ion\Di\ContainerInterface;
|
2016-10-20 22:32:17 -04:00
|
|
|
use Aviat\Ion\Json;
|
2015-06-26 16:39:10 -04:00
|
|
|
|
2019-12-09 14:34:23 -05:00
|
|
|
use Throwable;
|
|
|
|
|
2015-05-22 12:36:26 -04:00
|
|
|
/**
|
|
|
|
* Model for handling requests dealing with the anime list
|
|
|
|
*/
|
2018-08-08 13:05:38 -04:00
|
|
|
class Anime extends API {
|
2018-09-20 10:41:28 -04:00
|
|
|
|
2018-09-26 22:31:04 -04:00
|
|
|
/**
|
|
|
|
* Is the Anilist API enabled?
|
|
|
|
*
|
|
|
|
* @var boolean
|
|
|
|
*/
|
|
|
|
protected $anilistEnabled;
|
|
|
|
|
2018-09-20 10:41:28 -04:00
|
|
|
/**
|
|
|
|
* Model for making requests to Anilist API
|
|
|
|
*
|
2019-12-09 13:13:31 -05:00
|
|
|
* @var AnilistModel
|
2018-09-20 10:41:28 -04:00
|
|
|
*/
|
|
|
|
protected $anilistModel;
|
|
|
|
|
2017-02-17 10:55:17 -05:00
|
|
|
/**
|
|
|
|
* Model for making requests to Kitsu API
|
|
|
|
*
|
2019-12-09 13:13:31 -05:00
|
|
|
* @var KitsuModel
|
2017-02-17 10:55:17 -05:00
|
|
|
*/
|
2017-02-04 15:18:34 -05:00
|
|
|
protected $kitsuModel;
|
|
|
|
|
2016-12-22 21:36:23 -05:00
|
|
|
/**
|
|
|
|
* Anime constructor.
|
2017-02-17 10:55:17 -05:00
|
|
|
*
|
2016-12-22 21:36:23 -05:00
|
|
|
* @param ContainerInterface $container
|
|
|
|
*/
|
2017-03-01 22:07:51 -05:00
|
|
|
public function __construct(ContainerInterface $container)
|
2017-02-17 10:55:17 -05:00
|
|
|
{
|
2018-09-20 10:41:28 -04:00
|
|
|
$this->anilistModel = $container->get('anilist-model');
|
2016-12-22 21:36:23 -05:00
|
|
|
$this->kitsuModel = $container->get('kitsu-model');
|
2018-09-26 22:31:04 -04:00
|
|
|
|
|
|
|
$config = $container->get('config');
|
|
|
|
$this->anilistEnabled = (bool) $config->get(['anilist', 'enabled']);
|
2016-12-21 12:46:20 -05:00
|
|
|
}
|
|
|
|
|
2015-05-22 12:36:26 -04:00
|
|
|
/**
|
|
|
|
* Get a category out of the full list
|
|
|
|
*
|
2015-06-09 18:18:53 -04:00
|
|
|
* @param string $status
|
2015-05-22 12:36:26 -04:00
|
|
|
* @return array
|
|
|
|
*/
|
2017-03-29 12:32:36 -04:00
|
|
|
public function getList($status): array
|
2015-05-22 12:36:26 -04:00
|
|
|
{
|
2016-12-22 21:36:23 -05:00
|
|
|
$data = $this->kitsuModel->getAnimeList($status);
|
2017-01-05 13:41:32 -05:00
|
|
|
$this->sortByName($data, 'anime');
|
2015-05-22 12:36:26 -04:00
|
|
|
|
2017-03-01 22:07:51 -05:00
|
|
|
$key = AnimeWatchingStatus::KITSU_TO_TITLE[$status];
|
|
|
|
|
2015-05-22 12:36:26 -04:00
|
|
|
$output = [];
|
2017-03-01 22:07:51 -05:00
|
|
|
$output[$key] = $data;
|
2015-05-22 12:36:26 -04:00
|
|
|
|
|
|
|
return $output;
|
|
|
|
}
|
|
|
|
|
2017-03-29 12:32:36 -04:00
|
|
|
/**
|
|
|
|
* Get data for the 'all' anime page
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getAllLists(): array
|
2017-03-07 17:51:08 -05:00
|
|
|
{
|
|
|
|
$data = $this->kitsuModel->getFullOrganizedAnimeList();
|
|
|
|
|
|
|
|
foreach($data as $section => &$list)
|
|
|
|
{
|
|
|
|
$this->sortByName($list, 'anime');
|
|
|
|
}
|
|
|
|
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
|
2015-06-24 16:01:35 -04:00
|
|
|
/**
|
2017-01-16 13:49:51 -05:00
|
|
|
* Get information about an anime from its slug
|
2015-06-24 16:01:35 -04:00
|
|
|
*
|
2017-01-16 13:49:51 -05:00
|
|
|
* @param string $slug
|
2018-08-08 10:12:45 -04:00
|
|
|
* @return AnimeType
|
2015-06-24 16:01:35 -04:00
|
|
|
*/
|
2018-11-09 10:38:35 -05:00
|
|
|
public function getAnime(string $slug): AnimeType
|
2017-01-05 13:41:32 -05:00
|
|
|
{
|
2017-01-16 13:49:51 -05:00
|
|
|
return $this->kitsuModel->getAnime($slug);
|
|
|
|
}
|
2017-02-04 15:18:34 -05:00
|
|
|
|
2017-02-08 15:48:20 -05:00
|
|
|
/**
|
|
|
|
* Get anime by its kitsu id
|
|
|
|
*
|
|
|
|
* @param string $animeId
|
2018-08-20 13:01:16 -04:00
|
|
|
* @return AnimeType
|
2017-02-08 15:48:20 -05:00
|
|
|
*/
|
2018-08-20 13:01:16 -04:00
|
|
|
public function getAnimeById(string $animeId): AnimeType
|
2017-01-16 13:49:51 -05:00
|
|
|
{
|
2017-02-08 15:48:20 -05:00
|
|
|
return $this->kitsuModel->getAnimeById($animeId);
|
2017-01-05 13:41:32 -05:00
|
|
|
}
|
|
|
|
|
2017-01-06 21:39:01 -05:00
|
|
|
/**
|
|
|
|
* Search for anime by name
|
|
|
|
*
|
|
|
|
* @param string $name
|
|
|
|
* @return array
|
|
|
|
*/
|
2017-03-29 12:32:36 -04:00
|
|
|
public function search(string $name): array
|
2017-01-06 21:39:01 -05:00
|
|
|
{
|
2018-09-20 16:08:46 -04:00
|
|
|
return $this->kitsuModel->search('anime', urldecode($name));
|
2017-01-06 21:39:01 -05:00
|
|
|
}
|
|
|
|
|
2017-01-05 13:41:32 -05:00
|
|
|
/**
|
|
|
|
* Get information about a specific list item
|
|
|
|
* for editing/updating that item
|
|
|
|
*
|
|
|
|
* @param string $itemId
|
2018-08-08 10:12:45 -04:00
|
|
|
* @return AnimeListItem
|
2017-01-05 13:41:32 -05:00
|
|
|
*/
|
2018-08-08 10:12:45 -04:00
|
|
|
public function getLibraryItem(string $itemId): AnimeListItem
|
2017-01-05 13:41:32 -05:00
|
|
|
{
|
2018-09-20 10:41:28 -04:00
|
|
|
$item = $this->kitsuModel->getListItem($itemId);
|
|
|
|
$array = $item->toArray();
|
|
|
|
|
2018-11-09 10:38:35 -05:00
|
|
|
if (\is_array($array['notes']))
|
2018-09-20 16:08:46 -04:00
|
|
|
{
|
|
|
|
$array['notes'] = '';
|
|
|
|
}
|
|
|
|
|
2018-09-20 10:41:28 -04:00
|
|
|
return new AnimeListItem($array);
|
2017-01-05 13:41:32 -05:00
|
|
|
}
|
|
|
|
|
2017-02-04 15:18:34 -05:00
|
|
|
/**
|
|
|
|
* Add an anime to your list
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return bool
|
2019-12-09 14:34:23 -05:00
|
|
|
* @throws Throwable
|
2017-02-04 15:18:34 -05:00
|
|
|
*/
|
2017-01-10 12:35:46 -05:00
|
|
|
public function createLibraryItem(array $data): bool
|
|
|
|
{
|
2017-02-20 13:37:08 -05:00
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
$requester->addRequest($this->kitsuModel->createListItem($data), 'kitsu');
|
2017-02-04 15:18:34 -05:00
|
|
|
|
2019-08-10 10:09:07 -04:00
|
|
|
if ($this->anilistEnabled && $data['mal_id'] !== null)
|
2018-09-26 22:31:04 -04:00
|
|
|
{
|
2020-01-15 12:35:37 -05:00
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->createListItem($data, 'ANIME');
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
2018-09-20 16:08:46 -04:00
|
|
|
}
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
2017-02-08 15:48:20 -05:00
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
return count($results) > 0;
|
2017-01-10 12:35:46 -05:00
|
|
|
}
|
|
|
|
|
2018-09-20 10:41:28 -04:00
|
|
|
/**
|
|
|
|
* Increment progress for the specified anime
|
|
|
|
*
|
2018-09-27 16:45:12 -04:00
|
|
|
* @param FormItem $data
|
2018-09-20 10:41:28 -04:00
|
|
|
* @return array
|
2019-12-09 14:34:23 -05:00
|
|
|
* @throws Throwable
|
2018-09-20 10:41:28 -04:00
|
|
|
*/
|
2018-09-27 16:45:12 -04:00
|
|
|
public function incrementLibraryItem(FormItem $data): array
|
2018-09-20 10:41:28 -04:00
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
$requester->addRequest($this->kitsuModel->incrementListItem($data), 'kitsu');
|
|
|
|
|
2019-10-07 20:10:27 -04:00
|
|
|
if (( ! empty($data['mal_id'])) && $this->anilistEnabled)
|
2018-09-26 22:31:04 -04:00
|
|
|
{
|
2020-01-15 12:35:37 -05:00
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->incrementListItem($data, 'ANIME');
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
2018-09-20 10:41:28 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
$results = $requester->makeRequests();
|
|
|
|
|
|
|
|
$body = Json::decode($results['kitsu']);
|
|
|
|
$statusCode = array_key_exists('error', $body) ? 400 : 200;
|
|
|
|
|
|
|
|
return [
|
|
|
|
'body' => Json::decode($results['kitsu']),
|
|
|
|
'statusCode' => $statusCode
|
|
|
|
];
|
|
|
|
}
|
|
|
|
|
2017-01-05 13:41:32 -05:00
|
|
|
/**
|
2017-01-06 21:39:01 -05:00
|
|
|
* Update a list entry
|
2017-01-05 13:41:32 -05:00
|
|
|
*
|
2018-09-27 16:45:12 -04:00
|
|
|
* @param FormItem $data
|
2017-01-05 13:41:32 -05:00
|
|
|
* @return array
|
2019-12-09 14:34:23 -05:00
|
|
|
* @throws Throwable
|
2017-01-05 13:41:32 -05:00
|
|
|
*/
|
2018-09-27 16:45:12 -04:00
|
|
|
public function updateLibraryItem(FormItem $data): array
|
2015-06-24 16:01:35 -04:00
|
|
|
{
|
2017-03-01 22:07:51 -05:00
|
|
|
$requester = new ParallelAPIRequest();
|
2017-02-20 13:37:08 -05:00
|
|
|
$requester->addRequest($this->kitsuModel->updateListItem($data), 'kitsu');
|
2017-02-09 20:10:13 -05:00
|
|
|
|
2019-10-07 20:10:27 -04:00
|
|
|
if (( ! empty($data['mal_id'])) && $this->anilistEnabled)
|
2018-09-20 10:41:28 -04:00
|
|
|
{
|
2020-01-15 12:35:37 -05:00
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->updateListItem($data, 'ANIME');
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
2018-09-20 10:41:28 -04:00
|
|
|
}
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
2018-09-20 10:41:28 -04:00
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$body = Json::decode($results['kitsu']);
|
2018-01-30 16:57:13 -05:00
|
|
|
$statusCode = array_key_exists('error', $body) ? 400: 200;
|
2017-03-01 22:07:51 -05:00
|
|
|
|
2017-02-09 20:10:13 -05:00
|
|
|
return [
|
2017-12-08 22:32:00 -05:00
|
|
|
'body' => Json::decode($results['kitsu']),
|
|
|
|
'statusCode' => $statusCode
|
2017-02-09 20:10:13 -05:00
|
|
|
];
|
2015-06-24 16:01:35 -04:00
|
|
|
}
|
2017-01-09 20:36:48 -05:00
|
|
|
|
2017-02-04 15:18:34 -05:00
|
|
|
/**
|
|
|
|
* Delete a list entry
|
|
|
|
*
|
|
|
|
* @param string $id
|
|
|
|
* @param string|null $malId
|
|
|
|
* @return bool
|
2019-12-09 14:34:23 -05:00
|
|
|
* @throws Throwable
|
2017-02-04 15:18:34 -05:00
|
|
|
*/
|
2017-02-17 10:55:17 -05:00
|
|
|
public function deleteLibraryItem(string $id, string $malId = NULL): bool
|
2017-01-09 20:36:48 -05:00
|
|
|
{
|
2017-02-20 13:37:08 -05:00
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
$requester->addRequest($this->kitsuModel->deleteListItem($id), 'kitsu');
|
2017-02-08 15:48:20 -05:00
|
|
|
|
2019-08-10 10:09:07 -04:00
|
|
|
if ($this->anilistEnabled && $malId !== null)
|
2018-09-26 22:31:04 -04:00
|
|
|
{
|
2020-01-15 12:35:37 -05:00
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->deleteListItem($malId, 'ANIME');
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
2018-09-20 16:08:46 -04:00
|
|
|
}
|
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
$results = $requester->makeRequests();
|
2017-02-08 15:48:20 -05:00
|
|
|
|
2017-12-08 22:32:00 -05:00
|
|
|
return count($results) > 0;
|
2017-01-09 20:36:48 -05:00
|
|
|
}
|
2017-03-07 17:51:08 -05:00
|
|
|
}
|