HummingBirdAnimeClient/src/AnimeClient/API/Kitsu/Transformer/HistoryTransformer.php

289 lines
6.3 KiB
PHP
Raw Normal View History

2020-04-22 12:38:59 -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-04-22 12:38:59 -04:00
*
* @package HummingbirdAnimeClient
2022-03-04 12:32:17 -05:00
* @author Timothy J. Warren <tim@timshome.page>
* @copyright 2015 - 2022 Timothy J. Warren
2020-04-22 12:38:59 -04:00
* @license http://www.opensource.org/licenses/mit-license.html MIT License
2020-12-10 17:06:50 -05:00
* @version 5.2
2020-04-22 12:38:59 -04:00
* @link https://git.timshomepage.net/timw4mail/HummingBirdAnimeClient
*/
namespace Aviat\AnimeClient\API\Kitsu\Transformer;
use Aviat\AnimeClient\Kitsu;
use Aviat\AnimeClient\Types\HistoryItem;
2020-04-22 12:38:59 -04:00
use DateTimeImmutable;
use DateTimeInterface;
use DateTimeZone;
abstract class HistoryTransformer
{
2020-04-22 12:38:59 -04:00
/**
* @var string The media type
*/
protected string $type;
/**
* @var string The message for watching/reading a single episode/chapter
*/
protected string $progressAction;
/**
2020-04-24 14:14:52 -04:00
* @var string The message for rewatching/rereading episode(s)/chapter(s)
*/
2020-04-24 14:14:52 -04:00
protected string $reconsumeAction;
/**
* @var string The message for going through a large number of media in a series
*/
protected string $largeAggregateAction;
2020-04-24 14:14:52 -04:00
/**
* @var string The status for items you are rewatching/rereading
*/
protected string $reconsumingStatus;
2020-04-22 12:38:59 -04:00
/**
* @var array The mapping of api status to display status
*/
protected array $statusMap = [];
2020-04-22 12:38:59 -04:00
/**
* Convert raw history
*/
public function transform(array $data): array
{
$base = $data['data']['findProfileBySlug']['libraryEvents']['nodes'] ?? [];
2020-04-22 12:38:59 -04:00
$output = [];
foreach ($base as $entry)
2020-04-22 12:38:59 -04:00
{
// Filter out other media types
2021-02-12 13:09:57 -05:00
if (strtolower($entry['media']['__typename']) !== $this->type)
2020-04-22 12:38:59 -04:00
{
continue;
}
// Hide private library entries
if ($entry['libraryEntry']['private'] === TRUE)
{
continue;
}
2020-04-22 12:38:59 -04:00
$kind = strtolower($entry['kind']);
if ($kind === 'progressed' && ! empty($entry['changedData']['progress']))
2020-04-22 12:38:59 -04:00
{
$transformed = $this->transformProgress($entry);
if ($transformed !== NULL)
{
$output[] = $transformed;
}
2020-04-22 12:38:59 -04:00
}
elseif ($kind === 'updated')
2020-04-22 12:38:59 -04:00
{
$output[] = $this->transformUpdated($entry);
}
}
return $this->aggregate($output);
}
/**
* Combine consecutive 'progressed' events
*/
protected function aggregate(array $singles): array
2020-04-22 12:38:59 -04:00
{
$output = [];
$count = count($singles);
2020-04-22 12:38:59 -04:00
for ($i = 0; $i < $count; $i++)
{
$entries = [];
$entry = $singles[$i];
$prevTitle = $entry['title'];
$nextId = $i;
$next = $singles[$nextId];
2020-04-22 12:38:59 -04:00
while (
$next['kind'] === 'progressed'
&& $next['title'] === $prevTitle
2020-04-22 12:38:59 -04:00
) {
$entries[] = $next;
$prevTitle = $next['title'];
if ($nextId + 1 < $count)
{
$nextId++;
$next = $singles[$nextId];
2020-04-22 12:38:59 -04:00
continue;
}
break;
}
if (count($entries) > 1)
{
$items = [];
2020-04-22 12:38:59 -04:00
$updated = [];
foreach ($entries as $e)
{
$progressItem = $e['original']['changedData']['progress'];
2020-04-24 14:14:52 -04:00
$items[] = array_pop($progressItem);
2020-04-22 12:38:59 -04:00
$updated[] = $e['updated'];
}
$firstItem = min($items);
$lastItem = max($items);
2020-04-22 12:38:59 -04:00
$firstUpdate = min($updated);
$lastUpdate = max($updated);
$title = $entries[0]['title'];
2020-04-24 14:14:52 -04:00
if ($this->isReconsuming($entries[0]['original']))
{
$action = "{$this->reconsumeAction}s {$firstItem}-{$lastItem}";
}
else
{
$action = (count($entries) > 3)
? "{$this->largeAggregateAction} {$firstItem}-{$lastItem}"
: "{$this->progressAction}s {$firstItem}-{$lastItem}";
}
2020-04-22 12:38:59 -04:00
$output[] = HistoryItem::from([
'action' => $action,
'coverImg' => $entries[0]['coverImg'],
'dateRange' => [$firstUpdate, $lastUpdate],
'isAggregate' => TRUE,
2020-04-24 14:14:52 -04:00
'original' => $entries,
2020-04-22 12:38:59 -04:00
'title' => $title,
'updated' => $entries[0]['updated'],
'url' => $entries[0]['url'],
]);
// Skip the rest of the aggregate in the main loop
$i += count($entries) - 1;
2020-04-22 12:38:59 -04:00
continue;
}
$output[] = $entry;
}
return $output;
}
protected function transformProgress(array $entry): ?HistoryItem
2020-04-22 12:38:59 -04:00
{
$data = $entry['media'];
2020-04-22 12:38:59 -04:00
$title = $this->linkTitle($data);
$item = end($entry['changedData']['progress']);
2020-04-24 14:14:52 -04:00
// No showing episode 0 nonsense
if (((int) $item) === 0)
{
return NULL;
}
// Hide the last episode update (Anime)
foreach (['episodeCount', 'chapterCount'] as $count)
{
if ( ! empty($entry['media'][$count]))
{
$update = $entry['changedData']['progress'][1] ?? 0;
if ($update === $entry['media'][$count])
{
return NULL;
}
}
}
2020-04-24 14:14:52 -04:00
$action = ($this->isReconsuming($entry))
? "{$this->reconsumeAction} {$item}"
: "{$this->progressAction} {$item}";
2020-04-22 12:38:59 -04:00
return HistoryItem::from([
2020-04-24 14:14:52 -04:00
'action' => $action,
'coverImg' => Kitsu::getPosterImage($data, 0),
2020-04-22 12:38:59 -04:00
'kind' => 'progressed',
'original' => $entry,
'title' => $title,
'updated' => $this->parseDate($entry['updatedAt']),
2020-04-22 12:38:59 -04:00
'url' => $this->getUrl($data),
]);
}
2021-02-12 13:09:57 -05:00
protected function transformUpdated(array $entry): HistoryItem
2020-04-22 12:38:59 -04:00
{
$data = $entry['media'];
2020-04-22 12:38:59 -04:00
$title = $this->linkTitle($data);
$kind = array_key_first($entry['changedData']);
2020-04-22 12:38:59 -04:00
if ($kind === 'status')
{
$status = array_pop($entry['changedData']['status']);
2020-04-22 12:38:59 -04:00
$statusName = $this->statusMap[$status];
2020-04-24 14:14:52 -04:00
if ($this->isReconsuming($entry))
{
$statusName = ($statusName === 'Completed')
? "Finished {$this->reconsumingStatus}"
: $this->reconsumingStatus;
}
2020-04-22 12:38:59 -04:00
return HistoryItem::from([
'action' => $statusName,
'coverImg' => Kitsu::getPosterImage($data, 0),
2020-04-22 12:38:59 -04:00
'kind' => 'updated',
'original' => $entry,
'title' => $title,
'updated' => $this->parseDate($entry['updatedAt']),
2020-04-22 12:38:59 -04:00
'url' => $this->getUrl($data),
]);
}
2021-02-12 13:09:57 -05:00
return HistoryItem::from($entry);
2020-04-22 12:38:59 -04:00
}
protected function linkTitle(array $data): string
2020-04-22 12:38:59 -04:00
{
return $data['titles']['canonical'];
2020-04-22 12:38:59 -04:00
}
protected function parseDate(string $date): DateTimeImmutable
2020-04-22 12:38:59 -04:00
{
$dateTime = DateTimeImmutable::createFromFormat(
DateTimeInterface::RFC3339,
2020-04-22 12:38:59 -04:00
$date
);
2021-02-12 13:09:57 -05:00
if ($dateTime === FALSE)
{
return new DateTimeImmutable();
}
2020-04-22 12:38:59 -04:00
return $dateTime->setTimezone(new DateTimeZone(date_default_timezone_get()));
}
protected function getUrl(array $data): string
2020-04-22 12:38:59 -04:00
{
return "/{$this->type}/details/{$data['slug']}";
}
2020-04-24 14:14:52 -04:00
protected function isReconsuming(array $entry): bool
2020-04-24 14:14:52 -04:00
{
return $entry['libraryEntry']['reconsuming'];
2020-04-24 14:14:52 -04:00
}
}