mirror of
https://github.com/NNTmux/newznab-tmux.git
synced 2026-08-29 01:08:56 +00:00
DariusIII
433 lines
16 KiB
PHP
Executable File
433 lines
16 KiB
PHP
Executable File
<?php
|
|
|
|
namespace Blacklight\processing\tv;
|
|
|
|
use Blacklight\ColorCLI;
|
|
use Blacklight\ReleaseImage;
|
|
use JPinkney\TVMaze\TVMaze as Client;
|
|
|
|
/**
|
|
* Class TVMaze.
|
|
*
|
|
* Process information retrieved from the TVMaze API.
|
|
*/
|
|
class TVMaze extends TV
|
|
{
|
|
private const MATCH_PROBABILITY = 75;
|
|
|
|
/**
|
|
* Client for TVMaze API.
|
|
*
|
|
* @var \JPinkney\TVMaze\TVMaze
|
|
*/
|
|
public $client;
|
|
|
|
/**
|
|
* @var string The URL for the medium sized image for poster
|
|
*/
|
|
public $posterUrl;
|
|
|
|
/**
|
|
* TVMaze constructor.
|
|
*
|
|
* @param array $options
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function __construct(array $options = [])
|
|
{
|
|
parent::__construct($options);
|
|
$this->client = new Client();
|
|
}
|
|
|
|
/**
|
|
* Fetch banner from site.
|
|
*
|
|
* @param $videoId
|
|
* @param $siteID
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getBanner($videoId, $siteID): bool
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Main processing director function for scrapers
|
|
* Calls work query function and initiates processing.
|
|
*
|
|
* @param $groupID
|
|
* @param $guidChar
|
|
* @param $process
|
|
* @param bool $local
|
|
*/
|
|
public function processSite($groupID, $guidChar, $process, $local = false): void
|
|
{
|
|
$res = $this->getTvReleases($groupID, $guidChar, $process, parent::PROCESS_TVMAZE);
|
|
|
|
$tvCount = \count($res);
|
|
|
|
if ($this->echooutput && $tvCount > 0) {
|
|
ColorCLI::header('Processing TVMaze lookup for '.number_format($tvCount).' release(s).');
|
|
}
|
|
|
|
if ($res instanceof \Traversable) {
|
|
$this->titleCache = [];
|
|
|
|
foreach ($res as $row) {
|
|
$this->posterUrl = '';
|
|
$tvMazeId = false;
|
|
|
|
// Clean the show name for better match probability
|
|
$release = $this->parseInfo($row['searchname']);
|
|
if (\is_array($release) && $release['name'] !== '') {
|
|
if (\in_array($release['cleanname'], $this->titleCache, false)) {
|
|
if ($this->echooutput) {
|
|
ColorCLI::headerOver('Title: ').
|
|
ColorCLI::warningOver($release['cleanname']).
|
|
ColorCLI::header(' already failed lookup for this site. Skipping.');
|
|
}
|
|
$this->setVideoNotFound(parent::PROCESS_TMDB, $row['id']);
|
|
continue;
|
|
}
|
|
|
|
// Find the Video ID if it already exists by checking the title against stored TVMaze titles
|
|
$videoId = $this->getByTitle($release['cleanname'], parent::TYPE_TV, parent::SOURCE_TVMAZE);
|
|
|
|
// Force local lookup only
|
|
//$local = true, $lookupsetting = false and vice versa
|
|
$lookupSetting = $local !== true;
|
|
|
|
if ($videoId === false && $lookupSetting) {
|
|
// If lookups are allowed lets try to get it.
|
|
if ($this->echooutput) {
|
|
ColorCLI::primaryOver('Checking TVMaze for previously failed title: ').
|
|
ColorCLI::headerOver($release['cleanname']).
|
|
ColorCLI::primary('.');
|
|
}
|
|
|
|
// Get the show from TVMaze
|
|
$tvMazeShow = $this->getShowInfo((string) $release['cleanname']);
|
|
|
|
if (\is_array($tvMazeShow)) {
|
|
$tvMazeId = (int) $tvMazeShow['tvmaze'];
|
|
// Check if we have the TVDB ID already, if we do use that Video ID, unless it is 0
|
|
$dupeCheck = false;
|
|
if ((int) $tvMazeShow['tvdb'] !== 0) {
|
|
$dupeCheck = $this->getVideoIDFromSiteID('tvdb', $tvMazeShow['tvdb']);
|
|
}
|
|
if ($dupeCheck === false) {
|
|
$videoId = $this->add($tvMazeShow);
|
|
} else {
|
|
$videoId = $dupeCheck;
|
|
// Update any missing fields and add site IDs
|
|
$this->update($videoId, $tvMazeShow);
|
|
$tvMazeId = $this->getSiteIDFromVideoID('tvmaze', $videoId);
|
|
}
|
|
}
|
|
} else {
|
|
if ($this->echooutput) {
|
|
ColorCLI::primaryOver('Found local TVMaze match for: ').
|
|
ColorCLI::headerOver($release['cleanname']).
|
|
ColorCLI::primary('. Attempting episode lookup!');
|
|
}
|
|
$tvMazeId = $this->getSiteIDFromVideoID('tvmaze', $videoId);
|
|
}
|
|
|
|
if (is_numeric($videoId) && $videoId > 0 && is_numeric($tvMazeId) && $tvMazeId > 0) {
|
|
// Now that we have valid video and tvmaze ids, try to get the poster
|
|
$this->getPoster($videoId, $tvMazeId);
|
|
|
|
$seasonNo = preg_replace('/^S0*/i', '', $release['season']);
|
|
$episodeNo = preg_replace('/^E0*/i', '', $release['episode']);
|
|
|
|
if ($episodeNo === 'all') {
|
|
// Set the video ID and leave episode 0
|
|
$this->setVideoIdFound($videoId, $row['id'], 0);
|
|
ColorCLI::primary('Found TVMaze Match for Full Season!');
|
|
continue;
|
|
}
|
|
|
|
// Download all episodes if new show to reduce API usage
|
|
if ($this->countEpsByVideoID($videoId) === false) {
|
|
$this->getEpisodeInfo($tvMazeId, -1, -1, '', $videoId);
|
|
}
|
|
|
|
// Check if we have the episode for this video ID
|
|
$episode = $this->getBySeasonEp($videoId, $seasonNo, $episodeNo, $release['airdate']);
|
|
|
|
if ($episode === false) {
|
|
// Send the request for the episode to TVMaze
|
|
$tvMazeEpisode = $this->getEpisodeInfo(
|
|
$tvMazeId,
|
|
$seasonNo,
|
|
$episodeNo,
|
|
$release['airdate']
|
|
);
|
|
|
|
if ($tvMazeEpisode) {
|
|
$episode = $this->addEpisode($videoId, $tvMazeEpisode);
|
|
}
|
|
}
|
|
|
|
if ($episode !== false && is_numeric($episode) && $episode > 0) {
|
|
// Mark the releases video and episode IDs
|
|
$this->setVideoIdFound($videoId, $row['id'], $episode);
|
|
if ($this->echooutput) {
|
|
ColorCLI::primary('Found TVMaze Match!');
|
|
}
|
|
continue;
|
|
}
|
|
//Processing failed, set the episode ID to the next processing group
|
|
$this->setVideoNotFound(parent::PROCESS_TMDB, $row['id']);
|
|
} else {
|
|
//Processing failed, set the episode ID to the next processing group
|
|
$this->setVideoNotFound(parent::PROCESS_TMDB, $row['id']);
|
|
$this->titleCache[] = $release['cleanname'];
|
|
}
|
|
} else {
|
|
//Processing failed, set the episode ID to the next processing group
|
|
$this->setVideoNotFound(parent::PROCESS_TMDB, $row['id']);
|
|
$this->titleCache[] = $release['cleanname'];
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Calls the API to lookup the TvMaze info for a given TVDB or TVRage ID
|
|
* Returns a formatted array of show data or false if no match.
|
|
*
|
|
* @param $site
|
|
* @param $siteId
|
|
*
|
|
* @return array|false
|
|
*/
|
|
protected function getShowInfoBySiteID($site, $siteId)
|
|
{
|
|
$return = $response = false;
|
|
|
|
//Try for the best match with AKAs embedded
|
|
$response = $this->client->getShowBySiteID($site, $siteId);
|
|
|
|
sleep(1);
|
|
|
|
if (\is_array($response)) {
|
|
$return = $this->formatShowInfo($response);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Calls the API to perform initial show name match to TVDB title
|
|
* Returns a formatted array of show data or false if no match.
|
|
*
|
|
*
|
|
* @param string $cleanName
|
|
*
|
|
* @return array|false
|
|
*/
|
|
protected function getShowInfo($cleanName)
|
|
{
|
|
$return = $response = false;
|
|
|
|
// TVMaze does NOT like shows with the year in them even without the parentheses
|
|
// Do this for the API Search only as a local lookup should require it
|
|
$cleanName = preg_replace('# \((19|20)\d{2}\)$#', '', $cleanName);
|
|
|
|
//Try for the best match with AKAs embedded
|
|
$response = $this->client->singleSearchAkas($cleanName);
|
|
|
|
sleep(1);
|
|
|
|
if (\is_array($response)) {
|
|
$return = $this->matchShowInfo($response, $cleanName);
|
|
}
|
|
if ($return === false) {
|
|
//Try for the best match via full search (no AKAs can be returned but the search is better)
|
|
$response = $this->client->search($cleanName);
|
|
if (\is_array($response)) {
|
|
$return = $this->matchShowInfo($response, $cleanName);
|
|
}
|
|
}
|
|
//If we didn't get any aliases do a direct alias lookup
|
|
if (\is_array($return) && empty($return['aliases']) && is_numeric($return['tvmaze'])) {
|
|
$return['aliases'] = $this->client->getShowAKAs($return['tvmaze']);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* @param $shows
|
|
* @param $cleanName
|
|
*
|
|
* @return array|false
|
|
*/
|
|
private function matchShowInfo(array $shows, $cleanName)
|
|
{
|
|
$return = false;
|
|
$highestMatch = 0;
|
|
$highest = null;
|
|
|
|
foreach ($shows as $show) {
|
|
if ($this->checkRequiredAttr($show, 'tvmazeS')) {
|
|
// Check for exact title match first and then terminate if found
|
|
if (strtolower($show->name) === strtolower($cleanName)) {
|
|
$highest = $show;
|
|
break;
|
|
}
|
|
// Check each show title for similarity and then find the highest similar value
|
|
$matchPercent = $this->checkMatch(strtolower($show->name), strtolower($cleanName), self::MATCH_PROBABILITY);
|
|
|
|
// If new match has a higher percentage, set as new matched title
|
|
if ($matchPercent > $highestMatch) {
|
|
$highestMatch = $matchPercent;
|
|
$highest = $show;
|
|
}
|
|
|
|
// Check for show aliases and try match those too
|
|
if (\is_array($show->akas) && ! empty($show->akas)) {
|
|
foreach ($show->akas as $key => $aka) {
|
|
$matchPercent = $this->checkMatch(strtolower($aka['name']), strtolower($cleanName), $matchPercent);
|
|
if ($matchPercent > $highestMatch) {
|
|
$highestMatch = $matchPercent;
|
|
$highest = $show;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if ($highest !== null) {
|
|
$return = $this->formatShowInfo($highest);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the poster art for the processed show.
|
|
*
|
|
* @param int $videoId -- the local Video ID
|
|
* @param int $showId -- the TVMaze ID
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getPoster($videoId, $showId = 0): int
|
|
{
|
|
$ri = new ReleaseImage();
|
|
|
|
// Try to get the Poster
|
|
$hasCover = $ri->saveImage($videoId, $this->posterUrl, $this->imgSavePath);
|
|
|
|
// Mark it retrieved if we saved an image
|
|
if ($hasCover === 1) {
|
|
$this->setCoverFound($videoId);
|
|
}
|
|
|
|
return $hasCover;
|
|
}
|
|
|
|
/**
|
|
* Gets the specific episode info for the parsed release after match
|
|
* Returns a formatted array of episode data or false if no match.
|
|
*
|
|
* @param int $tvMazeId
|
|
* @param int $season
|
|
* @param int $episode
|
|
* @param string $airDate
|
|
* @param int $videoId
|
|
*
|
|
* @return array|false
|
|
*/
|
|
protected function getEpisodeInfo($tvMazeId, $season, $episode, $airDate = '', $videoId = 0)
|
|
{
|
|
$return = $response = false;
|
|
|
|
if ($airDate !== '') {
|
|
$response = $this->client->getEpisodesByAirdate($tvMazeId, $airDate);
|
|
} elseif ($videoId > 0) {
|
|
$response = $this->client->getEpisodesByShowID($tvMazeId);
|
|
} else {
|
|
$response = $this->client->getEpisodeByNumber($tvMazeId, $season, $episode);
|
|
}
|
|
|
|
sleep(1);
|
|
|
|
//Handle Single Episode Lookups
|
|
if (\is_object($response)) {
|
|
if ($this->checkRequiredAttr($response, 'tvmazeE')) {
|
|
$return = $this->formatEpisodeInfo($response);
|
|
}
|
|
} elseif (\is_array($response)) {
|
|
//Handle new show/all episodes and airdate lookups
|
|
foreach ($response as $singleEpisode) {
|
|
if ($this->checkRequiredAttr($singleEpisode, 'tvmazeE')) {
|
|
// If this is an airdate lookup and it matches the airdate, set a return
|
|
if ($airDate !== '' && $airDate === $singleEpisode->airdate) {
|
|
$return = $this->formatEpisodeInfo($singleEpisode);
|
|
} else {
|
|
// Insert the episode
|
|
$this->addEpisode($videoId, $this->formatEpisodeInfo($singleEpisode));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* Assigns API show response values to a formatted array for insertion
|
|
* Returns the formatted array.
|
|
*
|
|
* @param $show
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function formatShowInfo($show): array
|
|
{
|
|
$this->posterUrl = (string) ($show->mediumImage ?? '');
|
|
|
|
return [
|
|
'type' => parent::TYPE_TV,
|
|
'title' => (string) $show->name,
|
|
'summary' => (string) $show->summary,
|
|
'started' => (string) $show->premiered,
|
|
'publisher' => (string) $show->network,
|
|
'country' => (string) $show->country,
|
|
'source' => parent::SOURCE_TVMAZE,
|
|
'imdb' => 0,
|
|
'tvdb' => (int) ($show->externalIDs['thetvdb'] ?? 0),
|
|
'tvmaze' => (int) $show->id,
|
|
'trakt' => 0,
|
|
'tvrage' => (int) ($show->externalIDs['tvrage'] ?? 0),
|
|
'tmdb' => 0,
|
|
'aliases' => ! empty($show->akas) ? (array) $show->akas : '',
|
|
'localzone' => "''",
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Assigns API episode response values to a formatted array for insertion
|
|
* Returns the formatted array.
|
|
*
|
|
* @param $episode
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function formatEpisodeInfo($episode): array
|
|
{
|
|
return [
|
|
'title' => (string) $episode->name,
|
|
'series' => (int) $episode->season,
|
|
'episode' => (int) $episode->number,
|
|
'se_complete' => 'S'.sprintf('%02d', $episode->season).'E'.sprintf('%02d', $episode->number),
|
|
'firstaired' => (string) $episode->airdate,
|
|
'summary' => (string) $episode->summary,
|
|
];
|
|
}
|
|
}
|