2020-08-26 15:24:49 -04:00
|
|
|
<?php declare(strict_types=1);
|
|
|
|
/**
|
|
|
|
* Hummingbird Anime List Client
|
|
|
|
*
|
|
|
|
* An API client for Kitsu to manage anime and manga watch lists
|
|
|
|
*
|
2021-02-04 11:57:01 -05:00
|
|
|
* PHP version 8
|
2020-08-26 15:24:49 -04:00
|
|
|
*
|
2022-03-04 15:50:35 -05:00
|
|
|
* @copyright 2015 - 2022 Timothy J. Warren <tim@timshome.page>
|
2020-08-26 15:24:49 -04:00
|
|
|
* @license http://www.opensource.org/licenses/mit-license.html MIT License
|
2020-12-10 17:06:50 -05:00
|
|
|
* @version 5.2
|
2022-03-04 15:50:35 -05:00
|
|
|
* @link https://git.timshome.page/timw4mail/HummingBirdAnimeClient
|
2020-08-26 15:24:49 -04:00
|
|
|
*/
|
|
|
|
|
|
|
|
namespace Aviat\AnimeClient\Model;
|
|
|
|
|
2022-03-03 17:26:09 -05:00
|
|
|
use Aviat\AnimeClient\API\{Anilist, Kitsu, ParallelAPIRequest};
|
|
|
|
use Aviat\AnimeClient\Types\{AnimeListItem, FormItem, MangaListItem};
|
2020-08-26 15:24:49 -04:00
|
|
|
use Aviat\Ion\Di\ContainerInterface;
|
|
|
|
use Aviat\Ion\Json;
|
|
|
|
|
|
|
|
use Throwable;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Common functionality for Anime/Manga Models
|
|
|
|
*/
|
2022-03-03 17:26:09 -05:00
|
|
|
trait MediaTrait
|
|
|
|
{
|
2020-08-26 15:24:49 -04:00
|
|
|
/**
|
|
|
|
* Is the Anilist API enabled?
|
|
|
|
*/
|
|
|
|
protected bool $anilistEnabled;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Model for making requests to Anilist API
|
|
|
|
*/
|
|
|
|
protected Anilist\Model $anilistModel;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Model for making requests to Kitsu API
|
|
|
|
*/
|
|
|
|
protected Kitsu\Model $kitsuModel;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Anime constructor.
|
|
|
|
*/
|
|
|
|
public function __construct(ContainerInterface $container)
|
|
|
|
{
|
|
|
|
$this->anilistModel = $container->get('anilist-model');
|
|
|
|
$this->kitsuModel = $container->get('kitsu-model');
|
|
|
|
|
|
|
|
$config = $container->get('config');
|
|
|
|
$this->anilistEnabled = (bool) $config->get(['anilist', 'enabled']);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Search for anime by name
|
|
|
|
*
|
2022-03-03 13:25:10 -05:00
|
|
|
* @return mixed[]
|
2020-08-26 15:24:49 -04:00
|
|
|
*/
|
2022-03-03 17:26:09 -05:00
|
|
|
public function search(string $name, bool $inCollection = FALSE): array
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
2021-12-29 17:04:55 -05:00
|
|
|
$data = $this->kitsuModel->search($this->type, urldecode($name));
|
|
|
|
|
|
|
|
if ($inCollection)
|
|
|
|
{
|
|
|
|
// @TODO: allow filtering collection search by existing items
|
|
|
|
}
|
|
|
|
|
|
|
|
return $data;
|
2020-08-26 15:24:49 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get information about a specific list item
|
|
|
|
* for editing/updating that item
|
|
|
|
*/
|
2022-09-22 12:08:21 -04:00
|
|
|
public function getItem(string $itemId): AnimeListItem|MangaListItem
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
return $this->kitsuModel->getListItem($itemId);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add an anime to your list
|
|
|
|
*
|
|
|
|
* @throws Throwable
|
|
|
|
*/
|
2022-09-22 12:08:21 -04:00
|
|
|
public function createItem(array $data): bool
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
2021-02-12 19:17:39 -05:00
|
|
|
$kitsuRequest = $this->kitsuModel->createListItem($data);
|
|
|
|
if ($kitsuRequest === NULL)
|
|
|
|
{
|
|
|
|
return FALSE;
|
|
|
|
}
|
|
|
|
|
|
|
|
$requester->addRequest($kitsuRequest, 'kitsu');
|
2020-08-26 15:24:49 -04:00
|
|
|
|
2022-11-16 10:21:00 -05:00
|
|
|
if ($this->anilistEnabled)
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->createListItem($data, strtoupper($this->type));
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$results = $requester->makeRequests();
|
|
|
|
|
2022-03-03 13:25:10 -05:00
|
|
|
return $results !== [];
|
2020-08-26 15:24:49 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Increment progress for the specified anime
|
|
|
|
*
|
|
|
|
* @throws Throwable
|
2022-03-03 13:25:10 -05:00
|
|
|
* @return array<string, mixed>
|
2020-08-26 15:24:49 -04:00
|
|
|
*/
|
2022-09-22 12:08:21 -04:00
|
|
|
public function incrementItem(FormItem $data): array
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
$requester->addRequest($this->kitsuModel->incrementListItem($data), 'kitsu');
|
|
|
|
|
2022-11-16 10:21:00 -05:00
|
|
|
if ($this->anilistEnabled)
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->incrementListItem($data, strtoupper($this->type));
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$results = $requester->makeRequests();
|
|
|
|
|
|
|
|
$body = Json::decode($results['kitsu']);
|
|
|
|
$statusCode = array_key_exists('error', $body) ? 400 : 200;
|
|
|
|
|
|
|
|
return [
|
|
|
|
'body' => Json::decode($results['kitsu']),
|
2022-03-03 17:26:09 -05:00
|
|
|
'statusCode' => $statusCode,
|
2020-08-26 15:24:49 -04:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update a list entry
|
|
|
|
*
|
|
|
|
* @throws Throwable
|
2022-03-03 13:25:10 -05:00
|
|
|
* @return array<string, mixed>
|
2020-08-26 15:24:49 -04:00
|
|
|
*/
|
2022-09-22 12:08:21 -04:00
|
|
|
public function updateItem(FormItem $data): array
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
|
|
|
$requester->addRequest($this->kitsuModel->updateListItem($data), 'kitsu');
|
|
|
|
|
2022-11-16 10:21:00 -05:00
|
|
|
if ($this->anilistEnabled)
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
// If can't map MAL id, this will be null
|
|
|
|
$maybeRequest = $this->anilistModel->updateListItem($data, strtoupper($this->type));
|
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$results = $requester->makeRequests();
|
|
|
|
|
|
|
|
$body = Json::decode($results['kitsu']);
|
2022-03-03 17:26:09 -05:00
|
|
|
$statusCode = array_key_exists('errors', $body) ? 400 : 200;
|
2020-08-26 15:24:49 -04:00
|
|
|
|
|
|
|
return [
|
|
|
|
'body' => Json::decode($results['kitsu']),
|
2022-03-03 17:26:09 -05:00
|
|
|
'statusCode' => $statusCode,
|
2020-08-26 15:24:49 -04:00
|
|
|
];
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete a list entry
|
|
|
|
*
|
|
|
|
* @throws Throwable
|
|
|
|
*/
|
2022-09-22 12:08:21 -04:00
|
|
|
public function deleteItem(FormItem $data): bool
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
$requester = new ParallelAPIRequest();
|
2022-09-22 12:08:21 -04:00
|
|
|
$requester->addRequest($this->kitsuModel->deleteItem($data), 'kitsu');
|
2020-08-26 15:24:49 -04:00
|
|
|
|
2022-11-16 10:21:00 -05:00
|
|
|
if ($this->anilistEnabled)
|
2020-08-26 15:24:49 -04:00
|
|
|
{
|
|
|
|
// If can't map MAL id, this will be null
|
2022-09-22 12:08:21 -04:00
|
|
|
$maybeRequest = $this->anilistModel->deleteItem($data, strtoupper($this->type));
|
2020-08-26 15:24:49 -04:00
|
|
|
if ($maybeRequest !== NULL)
|
|
|
|
{
|
|
|
|
$requester->addRequest($maybeRequest, 'anilist');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$results = $requester->makeRequests();
|
|
|
|
|
2022-03-03 13:25:10 -05:00
|
|
|
return $results !== [];
|
2020-08-26 15:24:49 -04:00
|
|
|
}
|
2022-03-03 17:26:09 -05:00
|
|
|
}
|