2015-06-16 11:11:35 -04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-11-16 11:40:01 -05:00
|
|
|
* Hummingbird Anime Client
|
|
|
|
*
|
|
|
|
* An API client for Hummingbird to manage anime and manga watch lists
|
|
|
|
*
|
|
|
|
* @package HummingbirdAnimeClient
|
|
|
|
* @author Timothy J. Warren
|
|
|
|
* @copyright Copyright (c) 2015
|
|
|
|
* @link https://github.com/timw4mail/HummingBirdAnimeClient
|
|
|
|
* @license MIT
|
2015-06-16 11:11:35 -04:00
|
|
|
*/
|
2015-09-14 19:54:34 -04:00
|
|
|
namespace Aviat\AnimeClient\Model;
|
2015-09-14 10:54:50 -04:00
|
|
|
|
2015-09-15 13:19:29 -04:00
|
|
|
use Aviat\AnimeClient\Model\API;
|
2015-10-09 22:29:59 -04:00
|
|
|
use Aviat\AnimeClient\Hummingbird\Transformer;
|
|
|
|
use Aviat\AnimeClient\Hummingbird\Enum\MangaReadingStatus;
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-11-16 15:57:37 -05:00
|
|
|
use GuzzleHttp\Cookie\Cookiejar;
|
|
|
|
use GuzzleHttp\Cookie\SetCookie;
|
|
|
|
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
|
|
|
* Model for handling requests dealing with the manga list
|
|
|
|
*/
|
2015-09-14 10:54:50 -04:00
|
|
|
class Manga extends API {
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
const READING = 'Reading';
|
|
|
|
const PLAN_TO_READ = 'Plan to Read';
|
|
|
|
const DROPPED = 'Dropped';
|
|
|
|
const ON_HOLD = 'On Hold';
|
|
|
|
const COMPLETED = 'Completed';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Map API constants to display constants
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
protected $const_map = [
|
|
|
|
MangaReadingStatus::READING => self::READING,
|
|
|
|
MangaReadingStatus::PLAN_TO_READ => self::PLAN_TO_READ,
|
|
|
|
MangaReadingStatus::ON_HOLD => self::ON_HOLD,
|
|
|
|
MangaReadingStatus::DROPPED => self::DROPPED,
|
|
|
|
MangaReadingStatus::COMPLETED => self::COMPLETED
|
|
|
|
];
|
|
|
|
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
2015-06-26 16:39:10 -04:00
|
|
|
* The base url for api requests
|
|
|
|
* @var string
|
2015-06-16 11:11:35 -04:00
|
|
|
*/
|
2015-06-17 08:50:01 -04:00
|
|
|
protected $base_url = "https://hummingbird.me/";
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-06-24 16:01:35 -04:00
|
|
|
/**
|
|
|
|
* Update the selected manga
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function update($data)
|
|
|
|
{
|
|
|
|
$id = $data['id'];
|
|
|
|
unset($data['id']);
|
|
|
|
|
2015-11-16 15:57:37 -05:00
|
|
|
$token = $this->container->get('auth')
|
|
|
|
->get_auth_token();
|
|
|
|
$domain = $this->container->get('request')
|
|
|
|
->server->get('HTTP_HOST');
|
|
|
|
|
|
|
|
// Set the token cookie, with the authentication token
|
|
|
|
// from the auth class.
|
|
|
|
$cookieJar = $this->cookieJar;
|
|
|
|
$cookie_data = new SetCookie([
|
|
|
|
'Name' => 'token',
|
|
|
|
'Value' => $token,
|
|
|
|
'Domain' => 'hummingbird.me'
|
|
|
|
]);
|
|
|
|
$cookieJar->setCookie($cookie_data);
|
|
|
|
|
2015-10-15 09:25:30 -04:00
|
|
|
$result = $this->put("manga_library_entries/{$id}", [
|
2015-11-16 15:57:37 -05:00
|
|
|
'cookies' => $cookieJar,
|
2015-06-24 16:01:35 -04:00
|
|
|
'json' => ['manga_library_entry' => $data]
|
|
|
|
]);
|
|
|
|
|
2015-10-15 09:25:30 -04:00
|
|
|
return json_decode($result->getBody(), TRUE);
|
2015-06-24 16:01:35 -04:00
|
|
|
}
|
|
|
|
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
|
|
|
* Get the full set of anime lists
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_all_lists()
|
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
$data = $this->_get_list_from_api();
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-11-05 11:26:03 -05:00
|
|
|
foreach ($data as &$val)
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
|
|
|
$this->sort_by_name($val);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get a category out of the full list
|
|
|
|
*
|
|
|
|
* @param string $status
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_list($status)
|
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
$data = $this->_get_list_from_api($status);
|
2015-06-16 11:11:35 -04:00
|
|
|
$this->sort_by_name($data);
|
|
|
|
|
|
|
|
return $data;
|
|
|
|
}
|
|
|
|
|
2015-10-14 09:20:52 -04:00
|
|
|
/**
|
|
|
|
* Retrieve the list from the hummingbird api
|
2015-10-15 09:25:30 -04:00
|
|
|
*
|
2015-10-14 09:20:52 -04:00
|
|
|
* @param string $status
|
|
|
|
* @return array
|
|
|
|
*/
|
2015-10-06 10:24:48 -04:00
|
|
|
private function _get_list_from_api($status = "All")
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
|
|
|
|
|
|
|
$config = [
|
|
|
|
'query' => [
|
2015-10-06 11:38:20 -04:00
|
|
|
'user_id' => $this->config->get('hummingbird_username')
|
2015-06-16 11:11:35 -04:00
|
|
|
],
|
2015-06-29 10:26:50 -04:00
|
|
|
'allow_redirects' => FALSE
|
2015-06-16 11:11:35 -04:00
|
|
|
];
|
|
|
|
|
2015-10-15 09:25:30 -04:00
|
|
|
$response = $this->get('manga_library_entries', $config);
|
2015-10-12 14:11:00 -04:00
|
|
|
$data = $this->_check_cache($response);
|
2015-10-05 16:54:25 -04:00
|
|
|
$output = $this->map_by_status($data);
|
|
|
|
|
|
|
|
return (array_key_exists($status, $output)) ? $output[$status] : $output;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Check the status of the cache and return the appropriate response
|
|
|
|
*
|
|
|
|
* @param \GuzzleHttp\Message\Response $response
|
2015-11-17 16:45:41 -05:00
|
|
|
* @codeCoverageIgnore
|
2015-10-05 16:54:25 -04:00
|
|
|
* @return array
|
|
|
|
*/
|
2015-10-12 14:11:00 -04:00
|
|
|
private function _check_cache($response)
|
2015-10-05 16:54:25 -04:00
|
|
|
{
|
|
|
|
// Bail out early if there isn't any manga data
|
|
|
|
$api_data = json_decode($response->getBody(), TRUE);
|
2015-11-05 11:26:03 -05:00
|
|
|
if ( ! array_key_exists('manga', $api_data))
|
|
|
|
{
|
|
|
|
return [];
|
|
|
|
}
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-06 11:38:20 -04:00
|
|
|
$cache_file = _dir($this->config->get('data_cache_path'), 'manga.json');
|
|
|
|
$transformed_cache_file = _dir($this->config->get('data_cache_path'), 'manga-transformed.json');
|
2015-10-05 16:54:25 -04:00
|
|
|
|
2015-10-21 11:57:58 -04:00
|
|
|
|
|
|
|
$cached_data = file_exists($cache_file)
|
|
|
|
? json_decode(file_get_contents($cache_file), TRUE)
|
|
|
|
: [];
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
if ($cached_data === $api_data && file_exists($transformed_cache_file))
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
return json_decode(file_get_contents($transformed_cache_file), TRUE);
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
file_put_contents($cache_file, json_encode($api_data));
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
$zippered_data = $this->zipper_lists($api_data);
|
2015-10-09 22:29:59 -04:00
|
|
|
$transformer = new Transformer\MangaListTransformer();
|
2015-10-05 16:54:25 -04:00
|
|
|
$transformed_data = $transformer->transform_collection($zippered_data);
|
|
|
|
file_put_contents($transformed_cache_file, json_encode($transformed_data));
|
|
|
|
return $transformed_data;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
2015-10-05 16:54:25 -04:00
|
|
|
}
|
2015-06-16 11:11:35 -04:00
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
/**
|
|
|
|
* Map transformed anime data to be organized by reading status
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
private function map_by_status($data)
|
|
|
|
{
|
|
|
|
$output = [
|
|
|
|
self::READING => [],
|
|
|
|
self::PLAN_TO_READ => [],
|
|
|
|
self::ON_HOLD => [],
|
|
|
|
self::DROPPED => [],
|
|
|
|
self::COMPLETED => [],
|
2015-06-16 11:11:35 -04:00
|
|
|
];
|
|
|
|
|
2015-10-06 10:24:48 -04:00
|
|
|
foreach ($data as &$entry)
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
$entry['manga']['image'] = $this->get_cached_image($entry['manga']['image'], $entry['manga']['slug'], 'manga');
|
|
|
|
$key = $this->const_map[$entry['reading_status']];
|
|
|
|
$output[$key][] = $entry;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
|
2015-10-05 16:54:25 -04:00
|
|
|
return $output;
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
|
2015-09-21 09:48:15 -04:00
|
|
|
/**
|
|
|
|
* Combine the two manga lists into one
|
|
|
|
* @param array $raw_data
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
private function zipper_lists($raw_data)
|
|
|
|
{
|
2015-11-04 16:36:54 -05:00
|
|
|
return (new Transformer\MangaListsZipper($raw_data))->transform();
|
2015-09-21 09:48:15 -04:00
|
|
|
}
|
|
|
|
|
2015-06-16 11:11:35 -04:00
|
|
|
/**
|
|
|
|
* Sort the manga entries by their title
|
|
|
|
*
|
|
|
|
* @param array $array
|
|
|
|
* @return void
|
|
|
|
*/
|
|
|
|
private function sort_by_name(&$array)
|
|
|
|
{
|
|
|
|
$sort = array();
|
|
|
|
|
2015-10-06 10:24:48 -04:00
|
|
|
foreach ($array as $key => $item)
|
2015-06-16 11:11:35 -04:00
|
|
|
{
|
2015-10-05 16:54:25 -04:00
|
|
|
$sort[$key] = $item['manga']['title'];
|
2015-06-16 11:11:35 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
array_multisort($sort, SORT_ASC, $array);
|
|
|
|
}
|
|
|
|
}
|
2015-10-05 16:54:25 -04:00
|
|
|
// End of MangaModel.php
|