HummingBirdAnimeClient/src/AnimeClient/API/Kitsu/Model.php

544 lines
12 KiB
PHP
Raw Normal View History

2016-12-21 12:46:20 -05:00
<?php declare(strict_types=1);
/**
2017-02-15 16:13:32 -05:00
* Hummingbird Anime List Client
2016-12-21 12:46:20 -05:00
*
2018-08-22 13:48:27 -04:00
* An API client for Kitsu to manage anime and manga watch lists
2016-12-21 12:46:20 -05:00
*
* PHP version 7.4
2016-12-21 12:46:20 -05: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
2020-08-04 09:30:21 -04:00
* @version 5.1
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\Kitsu;
2016-12-21 12:46:20 -05:00
use function Amp\Promise\wait;
2017-03-07 17:51:08 -05:00
2020-03-11 16:26:17 -04:00
use Amp\Http\Client\Request;
use Aviat\AnimeClient\API\{
CacheTrait,
JsonAPI,
Kitsu as K,
ParallelAPIRequest
};
2017-01-03 21:06:49 -05:00
use Aviat\AnimeClient\API\Kitsu\Transformer\{
2017-02-04 15:18:34 -05:00
AnimeTransformer,
AnimeListTransformer,
2020-08-24 13:07:47 -04:00
LibraryEntryTransformer,
2017-02-04 15:18:34 -05:00
MangaTransformer,
2017-01-27 12:35:28 -05:00
MangaListTransformer
2017-01-03 21:06:49 -05:00
};
2019-12-09 14:34:23 -05:00
use Aviat\Banker\Exception\InvalidArgumentException;
use Aviat\Ion\{Di\ContainerAware, Json};
2016-12-21 12:46:20 -05:00
2019-12-09 14:34:23 -05:00
use Throwable;
2016-12-21 12:46:20 -05:00
/**
* Kitsu API Model
*/
final class Model {
use CacheTrait;
use ContainerAware;
2020-08-06 09:39:12 -04:00
use RequestBuilderTrait;
use AnimeTrait;
use MangaTrait;
use MutationTrait;
2016-12-21 12:46:20 -05:00
2020-08-17 18:08:58 -04:00
protected const LIST_PAGE_SIZE = 75;
/**
* @var ListItem
*/
2020-07-28 16:11:13 -04:00
protected ListItem $listItem;
2017-02-04 15:18:34 -05:00
/**
2017-02-17 11:37:22 -05:00
* Constructor
*
* @param ListItem $listItem
*/
public function __construct(ListItem $listItem)
2016-12-21 12:46:20 -05:00
{
$this->animeTransformer = new AnimeTransformer();
2016-12-21 12:46:20 -05:00
$this->animeListTransformer = new AnimeListTransformer();
2017-01-04 13:16:58 -05:00
$this->mangaTransformer = new MangaTransformer();
2017-01-03 21:06:49 -05:00
$this->mangaListTransformer = new MangaListTransformer();
2018-11-09 10:38:35 -05:00
$this->listItem = $listItem;
2016-12-21 12:46:20 -05:00
}
2017-03-28 14:34:33 -04:00
/**
* Get the access token from the Kitsu API
*
* @param string $username
* @param string $password
* @return bool|array
2019-12-09 14:34:23 -05:00
* @throws Throwable
2017-03-28 14:34:33 -04:00
*/
public function authenticate(string $username, string $password)
{
// K::AUTH_URL
$response = $this->requestBuilder->getResponse('POST', K::AUTH_URL, [
'headers' => [
'accept' => NULL,
'Content-type' => 'application/x-www-form-urlencoded',
'client_id' => NULL,
'client_secret' => NULL
],
2017-03-28 14:34:33 -04:00
'form_params' => [
'grant_type' => 'password',
'username' => $username,
'password' => $password
]
]);
2020-03-11 16:26:17 -04:00
$data = Json::decode(wait($response->getBody()->buffer()));
2018-01-16 14:58:07 -05:00
if (array_key_exists('error', $data))
{
2020-08-17 10:23:32 -04:00
dump([
'method' => __CLASS__ . '\\' . __METHOD__,
'error' => $data['error'],
'response' => $response,
]);
die();
}
2018-10-05 14:32:05 -04:00
if (array_key_exists('access_token', $data))
{
return $data;
}
2017-03-28 14:34:33 -04:00
return FALSE;
}
/**
* Extend the current session with a refresh token
*
* @param string $token
* @return bool|array
2019-12-09 14:34:23 -05:00
* @throws Throwable
*/
public function reAuthenticate(string $token)
{
$response = $this->requestBuilder->getResponse('POST', K::AUTH_URL, [
'headers' => [
'accept' => NULL,
'Content-type' => 'application/x-www-form-urlencoded',
'Accept-encoding' => '*'
],
'form_params' => [
'grant_type' => 'refresh_token',
'refresh_token' => $token
]
]);
2020-03-11 16:26:17 -04:00
$data = Json::decode(wait($response->getBody()->buffer()));
if (array_key_exists('error', $data))
{
2020-08-17 10:23:32 -04:00
dump([
'method' => __CLASS__ . '\\' . __METHOD__,
'error' => $data['error'],
'response' => $response,
]);
die();
}
if (array_key_exists('access_token', $data))
{
return $data;
}
return FALSE;
}
/**
* Get the userid for a username from Kitsu
*
* @param string $username
* @return string
2019-12-09 14:34:23 -05:00
* @throws InvalidArgumentException
2020-05-08 19:18:10 -04:00
* @throws Throwable
*/
2017-03-08 12:55:49 -05:00
public function getUserIdByUsername(string $username = NULL): string
{
2018-02-02 09:50:58 -05:00
if ($username === NULL)
2017-01-27 12:35:28 -05:00
{
$username = $this->getUsername();
}
2017-02-04 15:18:34 -05:00
2020-05-08 19:15:21 -04:00
return $this->getCached(K::AUTH_USER_ID_KEY, function(string $username) {
$data = $this->requestBuilder->getRequest('users', [
'query' => [
'filter' => [
'name' => $username
]
]
]);
2020-05-08 19:15:21 -04:00
return $data['data'][0]['id'] ?? NULL;
}, [$username]);
}
2017-03-08 12:55:49 -05:00
/**
* Get information about a character
*
* @param string $slug
* @return array
*/
public function getCharacter(string $slug): array
{
return $this->requestBuilder->runQuery('CharacterDetails', [
'slug' => $slug
2017-03-08 12:55:49 -05:00
]);
}
/**
* Get information about a person
*
* @param string $id
* @return array
2019-12-09 14:34:23 -05:00
* @throws InvalidArgumentException
*/
public function getPerson(string $id): array
{
return $this->getCached("kitsu-person-{$id}", fn () => $this->requestBuilder->getRequest("people/{$id}", [
2020-05-08 19:18:10 -04:00
'query' => [
'filter' => [
'id' => $id,
],
2020-05-08 19:18:10 -04:00
'fields' => [
'characters' => 'canonicalName,slug,image',
'characterVoices' => 'mediaCharacter',
'anime' => 'canonicalTitle,abbreviatedTitles,titles,slug,posterImage',
'manga' => 'canonicalTitle,abbreviatedTitles,titles,slug,posterImage',
'mediaCharacters' => 'role,media,character',
'mediaStaff' => 'role,media,person',
],
'include' => 'voices.mediaCharacter.media,voices.mediaCharacter.character,staff.media',
],
]));
}
2017-03-08 13:46:50 -05:00
/**
* Get profile information for the configured user
*
* @param string $username
* @return array
*/
2017-03-08 12:55:49 -05:00
public function getUserData(string $username): array
{
return $this->requestBuilder->getRequest('users', [
2017-03-08 12:55:49 -05:00
'query' => [
2017-03-31 13:37:53 -04:00
'filter' => [
'name' => $username,
],
'fields' => [
2018-10-30 11:42:32 -04:00
'anime' => 'slug,canonicalTitle,posterImage',
'manga' => 'slug,canonicalTitle,posterImage',
'characters' => 'slug,canonicalName,image',
2017-03-31 13:37:53 -04:00
],
2018-10-30 11:42:32 -04:00
'include' => 'waifu,favorites.item,stats'
2017-03-08 12:55:49 -05:00
]
]);
}
2016-12-21 12:46:20 -05:00
/**
2017-03-28 14:34:33 -04:00
* Search for an anime or manga
2016-12-21 12:46:20 -05:00
*
2017-03-28 14:34:33 -04:00
* @param string $type - 'anime' or 'manga'
* @param string $query - name of the item to search for
* @return array
2016-12-21 12:46:20 -05:00
*/
2017-03-28 14:34:33 -04:00
public function search(string $type, string $query): array
2016-12-21 12:46:20 -05:00
{
2017-03-28 14:34:33 -04:00
$options = [
'query' => [
'filter' => [
'text' => $query,
2017-03-28 14:34:33 -04:00
],
'page' => [
'offset' => 0,
'limit' => 20
],
'include' => 'mappings'
]
2017-03-28 14:34:33 -04:00
];
2016-12-21 12:46:20 -05:00
$raw = $this->requestBuilder->getRequest($type, $options);
$raw['included'] = JsonAPI::organizeIncluded($raw['included']);
2017-03-28 14:34:33 -04:00
foreach ($raw['data'] as &$item)
{
2017-03-28 14:34:33 -04:00
$item['attributes']['titles'] = K::filterTitles($item['attributes']);
array_shift($item['attributes']['titles']);
// Map the mal_id if it exists for syncing with other APIs
foreach($item['relationships']['mappings']['data'] as $rel)
{
$mapping = $raw['included']['mappings'][$rel['id']];
if ($mapping['attributes']['externalSite'] === "myanimelist/{$type}")
{
$item['mal_id'] = $mapping['attributes']['externalId'];
}
}
2016-12-21 12:46:20 -05:00
}
2017-03-28 14:34:33 -04:00
return $raw;
2016-12-21 12:46:20 -05:00
}
/**
* Find a media item on Kitsu by its associated MAL id
*
* @param string $malId
* @param string $type "anime" or "manga"
2017-04-10 15:31:35 -04:00
* @return string|NULL
*/
2018-11-09 10:38:35 -05:00
public function getKitsuIdFromMALId(string $malId, string $type='anime'): ?string
{
$options = [
'query' => [
'filter' => [
'external_site' => "myanimelist/{$type}",
'external_id' => $malId
],
'fields' => [
'media' => 'id,slug'
],
'include' => 'item'
]
];
$raw = $this->requestBuilder->getRequest('mappings', $options);
2017-04-10 15:31:35 -04:00
if ( ! array_key_exists('included', $raw))
{
return NULL;
}
return $raw['included'][0]['id'];
}
/**
* Get the data for a specific list item, generally for editing
*
* @param string $listId - The unique identifier of that list item
* @return mixed
*/
public function getListItem(string $listId)
{
$baseData = $this->listItem->get($listId);
2020-08-24 13:07:47 -04:00
if ( ! isset($baseData['data']['findLibraryEntryById']))
{
2020-08-24 13:07:47 -04:00
return [];
}
2018-10-19 10:40:11 -04:00
2020-08-24 13:07:47 -04:00
return (new LibraryEntryTransformer())->transform($baseData['data']['findLibraryEntryById']);
}
/**
2020-07-28 16:11:13 -04:00
* Get the data to sync Kitsu anime/manga list with another API
*
2020-07-28 16:11:13 -04:00
* @param string $type
* @return array
* @throws InvalidArgumentException
* @throws Throwable
*/
public function getSyncList(string $type): array
{
$options = [
'filter' => [
'user_id' => $this->getUserId(),
'kind' => $type,
],
'include' => "{$type},{$type}.mappings",
2020-08-17 18:08:58 -04:00
// 'sort' => '-updated_at'
];
return $this->getRawSyncList($type, $options);
}
2020-04-21 19:22:56 -04:00
/**
* Get the aggregated pages of anime or manga history
*
* @param string $type
* @param int $entries
* @return array
* @throws InvalidArgumentException
* @throws Throwable
*/
protected function getRawHistoryList(string $type = 'anime', int $entries = 120): array
2020-04-21 19:22:56 -04:00
{
$size = 20;
$pages = ceil($entries / $size);
$requester = new ParallelAPIRequest();
// Set up requests
for ($i = 0; $i < $pages; $i++)
{
$offset = $i * $size;
$requester->addRequest($this->getRawHistoryPage($type, $offset, $size));
}
$responses = $requester->makeRequests();
$output = [];
foreach($responses as $response)
{
$data = Json::decode($response);
$output[] = $data;
}
return array_merge_recursive(...$output);
}
/**
* Retrieve one page of the anime or manga history
*
* @param string $type
* @param int $offset
* @param int $limit
* @return Request
* @throws InvalidArgumentException
*/
protected function getRawHistoryPage(string $type, int $offset, int $limit = 20): Request
{
return $this->requestBuilder->setUpRequest('GET', 'library-events', [
2020-04-21 19:22:56 -04:00
'query' => [
'filter' => [
'kind' => 'progressed,updated',
'userId' => $this->getUserId(),
2020-04-21 19:22:56 -04:00
],
'page' => [
'offset' => $offset,
'limit' => $limit,
],
2020-04-24 14:14:52 -04:00
'fields' => [
'anime' => 'canonicalTitle,titles,slug,posterImage',
'manga' => 'canonicalTitle,titles,slug,posterImage',
'libraryEntry' => 'reconsuming,reconsumeCount',
],
2020-04-21 19:22:56 -04:00
'sort' => '-updated_at',
2020-04-24 14:14:52 -04:00
'include' => 'anime,manga,libraryEntry',
2020-04-21 19:22:56 -04:00
],
]);
}
private function getUserId(): string
{
static $userId = NULL;
if ($userId === NULL)
{
$userId = $this->getUserIdByUsername($this->getUsername());
}
return $userId;
}
/**
* Get the kitsu username from config
*
* @return string
*/
private function getUsername(): string
{
return $this->getContainer()
->get('config')
->get(['kitsu_username']);
}
2017-02-04 15:18:34 -05:00
private function getListCount(string $type, string $status = ''): int
{
$options = [
'query' => [
'filter' => [
'user_id' => $this->getUserId(),
'kind' => $type,
],
'page' => [
'limit' => 1
],
'sort' => '-updated_at'
]
];
if ( ! empty($status))
{
$options['query']['filter']['status'] = $status;
}
$response = $this->requestBuilder->getRequest('library-entries', $options);
return $response['meta']['count'];
}
/**
* Get the full anime list
*
* @param string $type
* @param array $options
* @return array
* @throws InvalidArgumentException
* @throws Throwable
*/
private function getRawSyncList(string $type, array $options): array
{
$count = $this->getListCount($type);
$size = static::LIST_PAGE_SIZE;
$pages = ceil($count / $size);
$requester = new ParallelAPIRequest();
// Set up requests
for ($i = 0; $i < $pages; $i++)
{
$offset = $i * $size;
$requester->addRequest($this->getRawSyncListPage($type, $size, $offset, $options));
}
$responses = $requester->makeRequests();
$output = [];
foreach($responses as $response)
{
$data = Json::decode($response);
$output[] = $data;
}
return array_merge_recursive(...$output);
}
/**
* Get the full anime list in paginated form
*
* @param string $type
* @param int $limit
* @param int $offset
* @param array $options
* @return Request
* @throws InvalidArgumentException
*/
private function getRawSyncListPage(string $type, int $limit, int $offset = 0, array $options = []): Request
{
$defaultOptions = [
'filter' => [
'user_id' => $this->getUserId(),
'kind' => $type,
],
'page' => [
'offset' => $offset,
'limit' => $limit
],
'sort' => '-updated_at'
];
$options = array_merge($defaultOptions, $options);
return $this->requestBuilder->setUpRequest('GET', 'library-entries', ['query' => $options]);
}
2016-12-21 12:46:20 -05:00
}