HummingBirdAnimeClient/src/API/Kitsu/Model.php

675 lines
15 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
*
* An API client for Kitsu and MyAnimeList to manage anime and manga watch lists
*
* PHP version 7
*
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>
2017-01-11 10:30:53 -05:00
* @copyright 2015 - 2017 Timothy J. Warren
2017-01-06 23:34:56 -05:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
* @version 4.0
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\Kitsu;
2016-12-21 12:46:20 -05:00
2017-03-07 17:51:08 -05:00
use function Amp\{all, wait};
use Amp\Artax\{Client, Request};
use Aviat\AnimeClient\API\{CacheTrait, JsonAPI, Kitsu as K};
2017-03-07 18:41:51 -05:00
use Aviat\AnimeClient\API\Enum\{
AnimeWatchingStatus\Title,
MangaReadingStatus\Kitsu as KitsuReadingStatus
2017-02-20 13:37:08 -05:00
};
use Aviat\AnimeClient\API\Mapping\{AnimeWatchingStatus, MangaReadingStatus};
2017-01-03 21:06:49 -05:00
use Aviat\AnimeClient\API\Kitsu\Transformer\{
2017-02-04 15:18:34 -05:00
AnimeTransformer,
AnimeListTransformer,
MangaTransformer,
2017-01-27 12:35:28 -05:00
MangaListTransformer
2017-01-03 21:06:49 -05:00
};
use Aviat\Ion\{Di\ContainerAware, Json};
2016-12-21 12:46:20 -05:00
/**
* Kitsu API Model
*/
class Model {
use CacheTrait;
use ContainerAware;
2016-12-21 12:46:20 -05:00
use KitsuTrait;
2017-03-10 12:50:29 -05:00
const FULL_TRANSFORMED_LIST_CACHE_KEY = 'kitsu-full-organized-anime-list';
2017-03-07 17:51:08 -05:00
2016-12-21 12:46:20 -05:00
/**
* Class to map anime list items
* to a common format used by
* templates
*
* @var AnimeListTransformer
*/
protected $animeListTransformer;
/**
* @var AnimeTransformer
*/
protected $animeTransformer;
/**
* @var ListItem
*/
protected $listItem;
/**
* @var MangaTransformer
*/
protected $mangaTransformer;
2017-01-04 13:16:58 -05:00
/**
* @var MangaListTransformer
*/
2017-01-03 21:06:49 -05:00
protected $mangaListTransformer;
2017-02-04 15:18:34 -05:00
2017-01-03 21:06:49 -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();
$this->listItem = $listItem;
2017-01-04 13:16:58 -05:00
$this->mangaTransformer = new MangaTransformer();
2017-01-03 21:06:49 -05:00
$this->mangaListTransformer = new MangaListTransformer();
2016-12-21 12:46:20 -05:00
}
/**
* Get the userid for a username from Kitsu
*
* @param string $username
* @return string
*/
2017-03-08 12:55:49 -05:00
public function getUserIdByUsername(string $username = NULL): string
{
2017-01-27 12:35:28 -05:00
if (is_null($username))
{
$username = $this->getUsername();
}
2017-02-04 15:18:34 -05:00
2017-01-27 12:35:28 -05:00
$cacheItem = $this->cache->getItem(K::AUTH_USER_ID_KEY);
2017-02-04 15:18:34 -05:00
if ( ! $cacheItem->isHit())
{
$data = $this->getRequest('users', [
'query' => [
'filter' => [
'name' => $username
]
]
]);
$cacheItem->set($data['data'][0]['id']);
$cacheItem->save();
}
2017-02-04 15:18:34 -05:00
return $cacheItem->get();
}
2017-03-08 12:55:49 -05:00
/**
* Get information about a character
*
* @param string $slug
* @return array
*/
public function getCharacter(string $slug): array
{
2017-03-20 13:14:01 -04:00
// @todo catch non-existent characters and show 404
2017-03-08 12:55:49 -05:00
$data = $this->getRequest('/characters', [
'query' => [
'filter' => [
'slug' => $slug
],
// 'include' => 'primaryMedia,castings'
]
]);
return $data;
}
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
{
$userId = $this->getUserIdByUsername($username);
$data = $this->getRequest("/users/{$userId}", [
'query' => [
2017-03-08 13:46:50 -05:00
'include' => 'waifu,pinnedPost,blocks,linkedAccounts,profileLinks,profileLinks.profileLinkSite,mediaFollows,userRoles'
2017-03-08 12:55:49 -05:00
]
]);
// $data['included'] = JsonAPI::organizeIncludes($data['included']);
return $data;
}
2016-12-21 12:46:20 -05:00
/**
* Get the access token from the Kitsu API
*
* @param string $username
* @param string $password
* @return bool|string
*/
public function authenticate(string $username, string $password)
{
$response = $this->getResponse('POST', K::AUTH_URL, [
'headers' => [],
'form_params' => [
2016-12-21 12:46:20 -05:00
'grant_type' => 'password',
'username' => $username,
'password' => $password
]
2016-12-21 12:46:20 -05:00
]);
$data = Json::decode((string)$response->getBody());
if (array_key_exists('access_token', $data))
{
2017-01-27 12:35:28 -05:00
return $data;
2016-12-21 12:46:20 -05:00
}
2017-02-17 11:37:22 -05:00
return FALSE;
2016-12-21 12:46:20 -05:00
}
/**
* Get information about a particular anime
*
2017-01-16 13:49:51 -05:00
* @param string $slug
* @return array
*/
2017-01-16 13:49:51 -05:00
public function getAnime(string $slug): array
{
// @TODO catch non-existent anime
2017-01-16 13:49:51 -05:00
$baseData = $this->getRawMediaData('anime', $slug);
2017-03-20 13:14:01 -04:00
$transformed = $this->animeTransformer->transform($baseData);
$transformed['included'] = $baseData['included'];
return $transformed;
2017-01-16 13:49:51 -05:00
}
2017-02-04 15:18:34 -05:00
/**
* Get information about a particular anime
*
* @param string $animeId
* @return array
*/
2017-01-16 13:49:51 -05:00
public function getAnimeById(string $animeId): array
{
$baseData = $this->getRawMediaDataById('anime', $animeId);
return $this->animeTransformer->transform($baseData);
}
2017-02-04 15:18:34 -05:00
/**
* Get the mal id for the anime represented by the kitsu id
* to enable updating MyAnimeList
*
* @param string $kitsuAnimeId The id of the anime on Kitsu
* @return string|null Returns the mal id if it exists, otherwise null
*/
public function getMalIdForAnime(string $kitsuAnimeId)
{
$options = [
'query' => [
'include' => 'mappings'
]
];
$data = $this->getRequest("anime/{$kitsuAnimeId}", $options);
$mappings = array_column($data['included'], 'attributes');
foreach($mappings as $map)
{
if ($map['externalSite'] === 'myanimelist/anime')
{
return $map['externalId'];
}
}
2017-02-17 11:37:22 -05:00
return NULL;
2017-02-04 15:18:34 -05:00
}
/**
* Get information about a particular manga
*
* @param string $mangaId
* @return array
*/
2017-01-04 13:16:58 -05:00
public function getManga(string $mangaId): array
{
2017-01-04 13:16:58 -05:00
$baseData = $this->getRawMediaData('manga', $mangaId);
return $this->mangaTransformer->transform($baseData);
}
/**
* Get the number of anime list items
*
2017-03-14 14:28:08 -04:00
* @param string $status - Optional status to filter by
* @return int
*/
2017-03-14 14:28:08 -04:00
public function getAnimeListCount(string $status = '') : int
{
$options = [
'query' => [
'filter' => [
'user_id' => $this->getUserIdByUsername(),
'media_type' => 'Anime'
],
'page' => [
'limit' => 1
],
'sort' => '-updated_at'
]
];
2017-03-14 14:28:08 -04:00
if ( ! empty($status))
{
$options['query']['filter']['status'] = $status;
}
$response = $this->getRequest('library-entries', $options);
return $response['meta']['count'];
}
2017-02-04 15:18:34 -05:00
/**
2017-03-07 17:51:08 -05:00
* Get the full anime list in paginated form
2017-02-04 15:18:34 -05:00
*
2017-02-17 11:37:22 -05:00
* @param int $limit
* @param int $offset
2017-03-14 14:28:08 -04:00
* @param array $options
* @return Request
2017-02-04 15:18:34 -05:00
*/
2017-03-14 14:28:08 -04:00
public function getPagedAnimeList(int $limit = 100, int $offset = 0, array $options = [
'include' => 'anime.mappings'
]): Request
2017-02-04 15:18:34 -05:00
{
2017-03-14 14:28:08 -04:00
$defaultOptions = [
'filter' => [
'user_id' => $this->getUserIdByUsername($this->getUsername()),
'media_type' => 'Anime'
],
'page' => [
'offset' => $offset,
'limit' => $limit
],
'sort' => '-updated_at'
];
2017-03-14 14:28:08 -04:00
$options = array_merge($defaultOptions, $options);
2017-03-14 14:28:08 -04:00
return $this->setUpRequest('GET', 'library-entries', ['query' => $options]);
2017-02-04 15:18:34 -05:00
}
2017-03-07 17:51:08 -05:00
/**
* Get the full anime list
*
2017-03-14 14:28:08 -04:00
* @param array $options
* @return array
2017-03-07 17:51:08 -05:00
*/
2017-03-14 14:28:08 -04:00
public function getFullAnimeList(array $options = [
'include' => 'anime.mappings'
]): array
2017-03-07 17:51:08 -05:00
{
$count = $this->getAnimeListCount();
$size = 75;
$pages = ceil($count / $size);
$requests = [];
// Set up requests
for ($i = 0; $i < $pages; $i++)
{
$offset = $i * $size;
2017-03-14 14:28:08 -04:00
$requests[] = $this->getPagedAnimeList($size, $offset, $options);
2017-03-07 17:51:08 -05:00
}
$promiseArray = (new Client())->requestMulti($requests);
$responses = wait(all($promiseArray));
$output = [];
foreach($responses as $response)
{
$data = Json::decode($response->getBody());
$output = array_merge_recursive($output, $data);
}
return $output;
}
2017-02-04 15:18:34 -05:00
/**
2017-01-27 12:35:28 -05:00
* Get the raw (unorganized) anime list for the configured user
*
* @param string $status - The watching status to filter the list with
* @param int $limit - The number of list entries to fetch for a page
* @param int $offset - The page offset
* @return array
*/
2017-01-27 12:35:28 -05:00
public function getRawAnimeList(string $status, int $limit = 600, int $offset = 0): array
{
$options = [
2016-12-21 12:46:20 -05:00
'query' => [
'filter' => [
'user_id' => $this->getUserIdByUsername($this->getUsername()),
'media_type' => 'Anime',
'status' => $status,
],
'include' => 'media,media.genres,media.mappings,anime.streamingLinks',
'page' => [
'offset' => $offset,
'limit' => $limit
2017-01-27 12:35:28 -05:00
],
'sort' => '-updated_at'
2016-12-21 12:46:20 -05:00
]
];
2017-02-04 15:18:34 -05:00
2017-01-27 12:35:28 -05:00
return $this->getRequest('library-entries', $options);
}
/**
* Get all the anine entries, that are organized for output to html
*
* @return array
*/
2017-03-07 17:51:08 -05:00
public function getFullOrganizedAnimeList(): array
{
$cacheItem = $this->cache->getItem(self::FULL_TRANSFORMED_LIST_CACHE_KEY);
if ( ! $cacheItem->isHit())
{
$output = [
Title::WATCHING => [],
Title::PLAN_TO_WATCH => [],
Title::ON_HOLD => [],
Title::DROPPED => [],
Title::COMPLETED => []
];
$statusMap = AnimeWatchingStatus::KITSU_TO_TITLE;
2017-03-14 14:28:08 -04:00
$data = $this->getFullAnimeList([
'include' => 'media,media.genres,media.mappings,anime.streamingLinks'
]);
2017-03-07 17:51:08 -05:00
$included = JsonAPI::organizeIncludes($data['included']);
$included = JsonAPI::inlineIncludedRelationships($included, 'anime');
foreach($data['data'] as $i => &$item)
{
$item['included'] = $included;
}
$transformed = $this->animeListTransformer->transformCollection($data['data']);
foreach($transformed as $item)
{
$key = $statusMap[$item['watching_status']];
$output[$key][] = $item;
}
$cacheItem->set($output);
$cacheItem->save();
}
return $cacheItem->get();
}
2017-01-27 12:35:28 -05:00
/**
* Get the anime list for the configured user
*
* @param string $status - The watching status to filter the list with
* @param int $limit - The number of list entries to fetch for a page
* @param int $offset - The page offset
* @return array
*/
public function getAnimeList(string $status, int $limit = 600, int $offset = 0): array
{
2017-03-10 12:50:29 -05:00
$cacheItem = $this->cache->getItem("kitsu-anime-list-{$status}");
2017-02-04 15:18:34 -05:00
if ( ! $cacheItem->isHit())
2016-12-21 12:46:20 -05:00
{
2017-01-27 12:35:28 -05:00
$data = $this->getRawAnimeList($status, $limit, $offset);
$included = JsonAPI::organizeIncludes($data['included']);
$included = JsonAPI::inlineIncludedRelationships($included, 'anime');
foreach($data['data'] as $i => &$item)
{
$item['included'] = $included;
}
$transformed = $this->animeListTransformer->transformCollection($data['data']);
2017-02-04 15:18:34 -05:00
$cacheItem->set($transformed);
$cacheItem->save();
2016-12-21 12:46:20 -05:00
}
return $cacheItem->get();
2016-12-21 12:46:20 -05:00
}
/**
* Get all Manga lists
*
* @return array
*/
2017-03-07 18:41:51 -05:00
public function getFullOrganizedMangaList(): array
{
$statuses = KitsuReadingStatus::getConstList();
$output = [];
foreach ($statuses as $status)
{
$mappedStatus = MangaReadingStatus::KITSU_TO_TITLE[$status];
$output[$mappedStatus] = $this->getMangaList($status);
}
return $output;
}
/**
* Get the manga list for the configured user
*
* @param string $status - The reading status by which to filter the list
* @param int $limit - The number of list items to fetch per page
* @param int $offset - The page offset
* @return array
*/
public function getMangaList(string $status, int $limit = 200, int $offset = 0): array
2017-01-04 13:16:58 -05:00
{
$options = [
'query' => [
'filter' => [
'user_id' => $this->getUserIdByUsername($this->getUsername()),
2017-01-04 13:16:58 -05:00
'media_type' => 'Manga',
'status' => $status,
],
'include' => 'media',
'page' => [
'offset' => $offset,
'limit' => $limit
2017-01-04 13:16:58 -05:00
],
'sort' => '-updated_at'
]
];
2017-02-04 15:18:34 -05:00
2017-03-10 12:50:29 -05:00
$cacheItem = $this->cache->getItem("kitsu-manga-list-{$status}");
2017-01-04 13:16:58 -05:00
2017-01-16 14:14:45 -05:00
if ( ! $cacheItem->isHit())
2017-01-04 13:16:58 -05:00
{
2017-01-16 14:14:45 -05:00
$data = $this->getRequest('library-entries', $options);
2017-01-31 12:52:43 -05:00
$data = JsonAPI::inlineRawIncludes($data, 'manga');
2017-01-04 13:16:58 -05:00
2017-01-31 12:52:43 -05:00
$transformed = $this->mangaListTransformer->transformCollection($data);
2017-01-04 13:16:58 -05:00
2017-01-16 14:14:45 -05:00
$cacheItem->set($transformed);
$cacheItem->save();
}
2017-02-04 15:18:34 -05:00
2017-01-16 14:14:45 -05:00
return $cacheItem->get();
2017-01-04 13:16:58 -05:00
}
2017-01-03 21:06:49 -05:00
/**
* Search for an anime or manga
*
* @param string $type - 'anime' or 'manga'
* @param string $query - name of the item to search for
* @return array
*/
public function search(string $type, string $query): array
{
$options = [
'query' => [
'filter' => [
'text' => $query
2017-01-10 21:13:44 -05:00
],
'page' => [
'offset' => 0,
'limit' => 20
],
]
];
$raw = $this->getRequest($type, $options);
foreach ($raw['data'] as &$item)
{
$item['attributes']['titles'] = K::filterTitles($item['attributes']);
array_shift($item['attributes']['titles']);
}
return $raw;
}
/**
* Create a list item
*
* @param array $data
* @return Request
*/
public function createListItem(array $data): Request
2017-01-10 21:13:44 -05:00
{
$data['user_id'] = $this->getUserIdByUsername($this->getUsername());
return $this->listItem->create($data);
}
/**
* Get the data for a specific list item, generally for editing
*
* @param string $listId - The unique identifier of that list item
* @return array
*/
public function getListItem(string $listId): array
{
$baseData = $this->listItem->get($listId);
$included = JsonAPI::organizeIncludes($baseData['included']);
switch (TRUE)
{
case in_array('anime', array_keys($included)):
$included = JsonAPI::inlineIncludedRelationships($included, 'anime');
$baseData['data']['included'] = $included;
return $this->animeListTransformer->transform($baseData['data']);
case in_array('manga', array_keys($included)):
$included = JsonAPI::inlineIncludedRelationships($included, 'manga');
$baseData['data']['included'] = $included;
$baseData['data']['manga'] = $baseData['included'][0];
return $this->mangaListTransformer->transform($baseData['data']);
default:
return $baseData['data'];
}
}
/**
* Modify a list item
*
* @param array $data
* @return Request
*/
public function updateListItem(array $data): Request
{
return $this->listItem->update($data['id'], $data['data']);
}
/**
* Remove a list item
*
* @param string $id - The id of the list item to remove
* @return Request
*/
public function deleteListItem(string $id): Request
{
return $this->listItem->delete($id);
}
/**
* 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
/**
* Get the raw data for the anime id
*
* @param string $type
* @param string $id
* @return array
*/
2017-01-16 13:49:51 -05:00
private function getRawMediaDataById(string $type, string $id): array
{
$options = [
'query' => [
'include' => ($type === 'anime')
? 'genres,mappings,streamingLinks'
: 'genres,mappings',
]
];
$data = $this->getRequest("{$type}/{$id}", $options);
$baseData = $data['data']['attributes'];
$baseData['included'] = $data['included'];
return $baseData;
}
/**
* Get media item by slug
*
* @param string $type
* @param string $slug
* @return array
*/
private function getRawMediaData(string $type, string $slug): array
{
$options = [
'query' => [
'filter' => [
'slug' => $slug
],
'include' => ($type === 'anime')
2017-03-20 13:14:01 -04:00
? 'genres,mappings,streamingLinks,animeCharacters.character'
: 'genres,mappings',
]
];
$data = $this->getRequest($type, $options);
$baseData = $data['data'][0]['attributes'];
$baseData['included'] = $data['included'];
return $baseData;
}
2016-12-21 12:46:20 -05:00
}