AniDB::populateTable() - Code Metrics - Inspection of "Update AniDB populate class" - NNTmux/newznab-tmux - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 5e2855...c86289 )

by Darko
created 2024-01-10 20:39 UTC
AniDB::populateTable() A

↳ Parent: AniDB
Complexity

Conditions	3
Paths	3
Size

Total Lines	9
Code Lines	7
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	7
dl	0
loc	9
rs	10
c	0
b	0
f	0
cc	3
nc	3
nop	2
<?php

namespace Blacklight\db\populate;

use App\Models\AnidbEpisode;
use App\Models\AnidbInfo;
use App\Models\AnidbTitle;
use App\Models\Settings;
use Blacklight\ColorCLI;
use Blacklight\ReleaseImage;
use Illuminate\Support\Carbon;

class AniDB
{
    private const CLIENT_VERSION = 2;

    /**
     * Whether to echo message output.
     */
    public bool $echooutput;

    /**
     * The directory to store AniDB covers.
     */
    public string $imgSavePath;

    /**
     * The name of the nZEDb client for AniDB lookups.
     */
    private string $apiKey;

    /**
     * Whether AniDB thinks our client is banned.
     */
    private bool $banned;

    /**
     * The last unixtime a full AniDB update was run.
     */
    private string $lastUpdate;

    /**
     * The number of days between full AniDB updates.
     */
    private string $updateInterval;

    protected ColorCLI $colorCli;

    /**
     * @param  array  $options  Class instances / Echo to cli.
     *
     * @throws \Exception
     */
    public function __construct()
    {
        $this->echooutput = config('nntmux.echocli');
        $this->colorCli = new ColorCLI();

        $anidbupdint = Settings::settingValue('APIs.AniDB.max_update_frequency');
        $lastupdated = Settings::settingValue('APIs.AniDB.last_full_update');

        $this->imgSavePath = storage_path('covers/anime/');
        $this->apiKey = config('nntmux_api.anidb_api_key');

        $this->updateInterval = $anidbupdint ?? '7';
        $this->lastUpdate = $lastupdated ?? '0';
        $this->banned = false;
    }

    /**
     * Main switch that initiates AniDB table population.
     *
     *
     * @throws \Exception
     */
    public function populateTable(string $type = '', int|string $aniDbId = ''): void
    {
        switch ($type) {
            case 'full':
                $this->populateMainTable();
                break;
            case 'info':
                $this->populateInfoTable($aniDbId);
                break;
        }
    }

    /**
     * @return array|false
     *
     * @throws \Exception
     */
    private function getAniDbAPI($aniDbId)
    {
        $timestamp = Settings::settingValue('APIs.AniDB.banned') + 90000;
        if ($timestamp > time()) {
            echo 'Banned from AniDB lookups until '.date('Y-m-d H:i:s', $timestamp).PHP_EOL;

            return false;
        }
        $apiResponse = $this->getAniDbResponse($aniDbId);

        $AniDBAPIArray = [];

        if ($apiResponse === false) {

            echo 'AniDB: Error getting response.'.PHP_EOL;
        } elseif (preg_match('/\<error\>Banned\<\/error\>/', $apiResponse)) {
            $this->banned = true;
            Settings::query()->where(['section' => 'APIs', 'subsection' => 'AniDB', 'name' => 'banned'])->update(['value' => time()]);
        } elseif (preg_match('/\<error\>Anime not found\<\/error\>/', $apiResponse)) {
            echo "AniDB   : Anime not yet on site. Remove until next update.\n";
        } elseif ($AniDBAPIXML = new \SimpleXMLElement($apiResponse)) {
            $AniDBAPIArray['similar'] = $this->processAPIResponseElement($AniDBAPIXML->similaranime, 'anime', false);
            $AniDBAPIArray['related'] = $this->processAPIResponseElement($AniDBAPIXML->relatedanime, 'anime', false);
            $AniDBAPIArray['creators'] = $this->processAPIResponseElement($AniDBAPIXML->creators, null, false);
            $AniDBAPIArray['characters'] = $this->processAPIResponseElement($AniDBAPIXML->characters, null, true);
            $AniDBAPIArray['categories'] = $this->processAPIResponseElement($AniDBAPIXML->categories, null, true);

            $episodeArray = [];
            if ($AniDBAPIXML->episodes && $AniDBAPIXML->episodes->episode[0]->attributes()) {
                $i = 1;
                foreach ($AniDBAPIXML->episodes->episode as $episode) {
                    $titleArray = [];

                    $episodeArray[$i]['episode_id'] = (int) $episode->attributes()->id;
                    $episodeArray[$i]['episode_id'] = (int) $episode->/** @scrutinizer ignore-call */ attributes()->id;
                    $episodeArray[$i]['episode_no'] = (int) $episode->epno;
                    $episodeArray[$i]['airdate'] = (string) $episode->airdate;

                    if (! empty($episode->title)) {
                        foreach ($episode->title as $title) {
                            $xmlAttribs = $title->attributes('xml', true);
                            $xmlAttribs = $title->attributes('xml', true);
                            // only english, x-jat imploded episode titles for now
                            if (\in_array($xmlAttribs->lang, ['en', 'x-jat'], false)) {
                                $titleArray[] = $title[0];
                            }
                        }
                    }

                    $episodeArray[$i]['episode_title'] = empty($titleArray) ? '' : implode(', ', $titleArray);
                    $i++;
                }
            }

            //start and end date come from AniDB API as date strings -- no manipulation needed
            $AniDBAPIArray['startdate'] = $AniDBAPIXML->startdate ?? '0000-00-00';
            $AniDBAPIArray['enddate'] = $AniDBAPIXML->enddate ?? '0000-00-00';

            if (isset($AniDBAPIXML->ratings->permanent)) {
                $AniDBAPIArray['rating'] = $AniDBAPIXML->ratings->permanent;
            } else {
                $AniDBAPIArray['rating'] = $AniDBAPIXML->ratings->temporary ?? '';
            }

            $AniDBAPIArray += [
                'type' => isset($AniDBAPIXML->type[0]) ? (string) $AniDBAPIXML->type : '',
                'description' => isset($AniDBAPIXML->description) ? (string) $AniDBAPIXML->description : '',
                'picture' => isset($AniDBAPIXML->picture[0]) ? (string) $AniDBAPIXML->picture : '',
                'epsarr' => $episodeArray,
            ];

            return $AniDBAPIArray;
        }

        return false;
    }

    private function processAPIResponseElement(\SimpleXMLElement $element, ?string $property = null, bool $children = false): string
    {
        $property = $property ?? 'name';
        $temp = '';

        if (count($element) !== 0) {
            $result = $children === true ? $element->children() : $element;
            foreach ($result as $entry) {
                $temp .= $entry->$property.', ';
            }
        }

        return empty($temp) ? '' : substr($temp, 0, -2);
    }

    /**
     * Requests and returns the API data from AniDB.
     */
    private function getAniDbResponse($aniDbId): string
    {
        $curlString = sprintf(
            'http://api.anidb.net:9001/httpapi?request=anime&client=%s&clientver=%d&protover=1&aid=%d',
            $this->apiKey,
            self::CLIENT_VERSION,
            $aniDbId
        );

        $ch = curl_init($curlString);

        $curlOpts = [
            CURLOPT_RETURNTRANSFER => 1,
            CURLOPT_HEADER => 0,
            CURLOPT_FAILONERROR => 1,
            CURLOPT_ENCODING => 'gzip',
        ];

        curl_setopt_array($ch, $curlOpts);
        $apiResponse = curl_exec($ch);
        curl_close($ch);

        return $apiResponse;

    }

    /**
     * Inserts new anime info from AniDB to anidb table.
     *
     * @param  int  $id  The AniDB ID to be inserted
     * @param  string  $type  The title type
     * @param  string  $lang  The title language
     * @param  string  $title  The title of the Anime
     */
    private function insertAniDb(int $id, string $type, string $lang, string $title): void
    {
        $check = AnidbTitle::query()->where(['anidbid' => $id, 'type' => $type, 'lang' => $lang, 'title' => $title])->first();

        if ($check === null) {
            AnidbTitle::insertOrIgnore(['anidbid' => $id, 'type' => $type, 'lang' => $lang, 'title' => $title]);
        } else {
            $this->colorCli->warning("Duplicate: $id");
        }
    }

    private function insertAniDBInfoEps($aniDbId, array $AniDBInfoArray = []): string
    {
        AnidbInfo::query()
            ->insert(
                [
                    'anidbid' => $aniDbId,
                    'type' => $AniDBInfoArray['type'],
                    'startdate' => $AniDBInfoArray['startdate'],
                    'enddate' => $AniDBInfoArray['enddate'],
                    'related' => $AniDBInfoArray['enddate'],
                    'similar' => $AniDBInfoArray['similar'],
                    'creators' => $AniDBInfoArray['creators'],
                    'description' => $AniDBInfoArray['description'],
                    'rating' => $AniDBInfoArray['rating'],
                    'picture' => $AniDBInfoArray['picture'],
                    'categories' => $AniDBInfoArray['categories'],
                    'characters' => $AniDBInfoArray['characters'],
                    'updated' => now(),
                ]
            );
        if (! empty($AniDBInfoArray['epsarr'])) {
            $this->insertAniDBEpisodes($aniDbId, $AniDBInfoArray['epsarr']);
        }

        return $AniDBInfoArray['picture'];
    }

    private function insertAniDBEpisodes($aniDbId, array $episodeArr = []): void
    {
        if (! empty($episodeArr)) {
            foreach ($episodeArr as $episode) {
                AnidbEpisode::insertOrIgnore(
                    [
                        'anidbid' => $aniDbId,
                        'episodeid' => $episode['episode_id'],
                        'episode_no' => $episode['episode_no'],
                        'episode_title' => $episode['episode_title'],
                        'airdate' => $episode['airdate'],
                    ]
                );
            }
        }
    }

    /**
     *  Grabs AniDB Full Dump XML and inserts it into anidb table.
     */
    private function populateMainTable(): void
    {
        $lastUpdate = Carbon::createFromTimestamp($this->lastUpdate);
        $current = now();

        if ($current->diff($lastUpdate)->format('%d') > $this->updateInterval) {
            if ($this->echooutput) {
                $this->colorCli->header('Updating anime titles by grabbing full data AniDB dump.');
            }

            $animeTitles = new \SimpleXMLElement('compress.zlib://http://anidb.net/api/anime-titles.xml.gz', null, true);

            //Even if the update process fails,
            //we must mark the last update time or risk ban
            $this->setLastUpdated();

            if ($animeTitles) {

                $count = $animeTitles->count();
                if ($this->echooutput) {
                    $this->colorCli->header(
                        'Total of '.number_format($count).' titles to add.'.PHP_EOL
                    );
                }

                foreach ($animeTitles as $anime) {
                    echo "Remaining: $count  \r";
                    foreach ($anime->title as $title) {
                        $xmlAttribs = $title->attributes('xml', true);
                        $this->insertAniDb(
                            (string) $anime['aid'],
                            /** @scrutinizer ignore-type */ (string) $anime['aid'],
                            (string) $title['type'],
                            (string) $xmlAttribs->lang,
                            (string) $title[0]
                        );
                        $this->colorCli->primary(
                            sprintf(
                                'Inserting: %d, %s, %s, %s',
                                $anime['aid'],
                                $title['type'],
                                $xmlAttribs->lang,
                                $title[0]
                            )
                        );
                    }
                    $count--;
                }
            } else {
                echo PHP_EOL.
                    $this->colorCli->error('Error retrieving XML data from AniDB. Please try again later.').
                    PHP_EOL;
            }
        } else {
            $this->colorCli->info(
                'AniDB has been updated within the past '.$this->updateInterval.' days. '.
                'Either set this value lower in Site Edit (at your own risk of being banned) or try again later.'
            );
        }
    }

    /**
     * Directs flow for populating the AniDB Info/Episodes table.
     *
     *
     * @throws \Exception
     */
    private function populateInfoTable(string $aniDbId = ''): void
    {
        if (empty($aniDbId)) {
            $anidbIds = AnidbTitle::query()
                ->selectRaw('DISTINCT anidb_titles.anidbid')
                ->leftJoin('anidb_info as ai', 'ai.anidbid', '=', 'anidb_titles.anidbid')
                ->whereNull('ai.updated')
                ->get();

            foreach ($anidbIds as $anidb) {
                $AniDBAPIArray = $this->getAniDbAPI($anidb['anidbid']);

                if ($this->banned) {
                    $this->colorCli->error(
                        'AniDB Banned, import will fail, please wait 24 hours before retrying.'
                    );
                    exit;

                }

                if ($AniDBAPIArray === false && $this->echooutput) {
                    $this->colorCli->info(
                        'Anime ID: '.$anidb['anidbid'].' not available for update yet.'
                    );
                } else {
                    $this->updateAniChildTables($anidb['anidbid'], $AniDBAPIArray);
                    $this->updateAniChildTables($anidb['anidbid'], /** @scrutinizer ignore-type */ $AniDBAPIArray);
                }
                sleep(random_int(120, 240));
            }
        } else {
            $AniDBAPIArray = $this->getAniDbAPI($aniDbId);

            if ($this->banned) {
                $this->colorCli->error(
                    'AniDB Banned, import will fail, please wait 24 hours before retrying.'
                );
                exit;

            }

            if ($AniDBAPIArray === false && $this->echooutput) {
                $this->colorCli->info(
                    'Anime ID: '.$aniDbId.' not available for update yet.'
                );
            } else {
                $this->updateAniChildTables($aniDbId, $AniDBAPIArray);
            }
        }
    }

    /**
     * Sets the database time for last full AniDB update.
     */
    private function setLastUpdated(): void
    {
        Settings::query()->where(['section' => 'APIs', 'subsection' => 'AniDB', 'name' => 'last_full_update'])->update(['value' => time()]);
    }

    private function updateAniDBInfoEps($aniDbId, array $AniDBInfoArray = []): string
    {
        AnidbInfo::query()
            ->where('anidbid', $aniDbId)
            ->update(
                [
                    'type' => $AniDBInfoArray['type'],
                    'startdate' => $AniDBInfoArray['startdate'],
                    'enddate' => $AniDBInfoArray['enddate'],
                    'related' => $AniDBInfoArray['enddate'],
                    'similar' => $AniDBInfoArray['similar'],
                    'creators' => $AniDBInfoArray['creators'],
                    'description' => $AniDBInfoArray['description'],
                    'rating' => $AniDBInfoArray['rating'],
                    'picture' => $AniDBInfoArray['picture'],
                    'categories' => $AniDBInfoArray['categories'],
                    'characters' => $AniDBInfoArray['characters'],
                    'updated' => now(),
                ]
            );
        if (! empty($AniDBInfoArray['epsarr'])) {
            $this->insertAniDBEpisodes($aniDbId, $AniDBInfoArray['epsarr']);
        }

        return $AniDBInfoArray['picture'];
    }

    private function updateAniChildTables($aniDbId, array $AniDBInfoArray = []): void
    {
        $check = AnidbInfo::query()->where('anidbid', $aniDbId)->first(['anidbid']);

        if ($check === null) {
            $picture = $this->insertAniDBInfoEps($aniDbId, $AniDBInfoArray);
        } else {
            $picture = $this->updateAniDBInfoEps($aniDbId, $AniDBInfoArray);
        }

        if (! empty($picture) && ! file_exists($this->imgSavePath.$aniDbId.'.jpg')) {
            (new ReleaseImage())->saveImage(
                $aniDbId,
                'http://img7.anidb.net/pics/anime/'.$picture,
                $this->imgSavePath
            );
        }
    }
}

NNTmux / newznab-tmux

Push — master ( 5e2855...c86289 )

AniDB::populateTable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
