Nelexa\GPlay\Scraper\AppDetailScraper

Complexity

Total Complexity

52

Size/Duplication

Total Lines	365
Duplicated Lines	0 %

Test Coverage

Coverage

96.94%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	extractTranslatedFromLocale()	0	8	2
A	extractRecentChanges()	0	5	2
A	extractDeveloper()	0	18	1
C	getScriptData()	0	37	15
A	extractReviews()	0	9	2
A	extractPrice()	0	5	2
A	extractDescription()	0	7	2
A	extractSummary()	0	5	2
A	extractHistogramRating()	0	8	1
A	extractIcon()	0	5	2
B	__invoke()	0	102	5
A	extractReleaseDate()	0	6	2
A	extractVideo()	0	13	4
A	extractScreenshots()	0	5	2
A	extractUpdatedDate()	0	6	2
A	extractCover()	0	5	2
A	extractCategory()	0	8	4

<?php
/** @noinspection MultiAssignmentUsageInspection */
declare(strict_types=1);

/**
 * @author   Ne-Lexa
 * @license  MIT
 * @link     https://github.com/Ne-Lexa/google-play-scraper
 */

namespace Nelexa\GPlay\Scraper;

use Nelexa\GPlay\Exception\GooglePlayException;
use Nelexa\GPlay\GPlayApps;
use Nelexa\GPlay\Http\ResponseHandlerInterface;
use Nelexa\GPlay\Model\AppDetail;
use Nelexa\GPlay\Model\AppId;
use Nelexa\GPlay\Model\Category;
use Nelexa\GPlay\Model\Developer;
use Nelexa\GPlay\Model\GoogleImage;
use Nelexa\GPlay\Model\HistogramRating;
use Nelexa\GPlay\Model\Review;
use Nelexa\GPlay\Model\Video;
use Nelexa\GPlay\Scraper\Extractor\ReviewsExtractor;
use Nelexa\GPlay\Util\DateStringFormatter;
use Nelexa\GPlay\Util\LocaleHelper;
use Nelexa\GPlay\Util\ScraperUtil;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use function GuzzleHttp\Psr7\parse_query;

/**
 * @internal
 */
class AppDetailScraper implements ResponseHandlerInterface
{
    /**
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @return AppDetail
     * @throws GooglePlayException
     */
    public function __invoke(RequestInterface $request, ResponseInterface $response): AppDetail
    {
        $query = parse_query($request->getUri()->getQuery());

        $id = $query[GPlayApps::REQ_PARAM_ID];
        $locale = $query[GPlayApps::REQ_PARAM_LOCALE] ?? GPlayApps::DEFAULT_LOCALE;
        $country = $query[GPlayApps::REQ_PARAM_COUNTRY] ?? GPlayApps::DEFAULT_COUNTRY;

        [
            $scriptDataInfo,
            $scriptDataRating,
            $scriptDataPrice,
            $scriptDataVersion,
            $scriptDataReviews,
        ] = $this->getScriptData($request, $response);

        $name = $scriptDataInfo[0][0][0];
        $description = $this->extractDescription($scriptDataInfo);
        $translatedFromLocale = $this->extractTranslatedFromLocale($scriptDataInfo, $locale);
        $developer = $this->extractDeveloper($scriptDataInfo);
        $category = $this->extractCategory($scriptDataInfo[0][12][13][0]);
        $summary = $this->extractSummary($scriptDataInfo);
        $installs = $scriptDataInfo[0][12][9][2] ?? 0;
        $score = (float)($scriptDataRating[0][6][0][1] ?? 0);
        $numberVoters = (int)($scriptDataRating[0][6][2][1] ?? 0);
        $numberReviews = (int)($scriptDataRating[0][6][3][1] ?? 0);
        $histogramRating = $this->extractHistogramRating($scriptDataRating);
        $price = $this->extractPrice($scriptDataPrice);
        $currency = $scriptDataPrice[0][2][0][0][0][1][0][1];
        $priceText = $scriptDataPrice[0][2][0][0][0][1][0][2] ?: null;
        $offersIAPCost = $scriptDataInfo[0][12][12][0] ?? null;
        $containsAds = (bool)$scriptDataInfo[0][12][14][0];

        [$size, $appVersion, $androidVersion] = $scriptDataVersion;
        if (LocaleHelper::isDependOnDevice($locale, $size)) {
            $size = null;
        }
        if (LocaleHelper::isDependOnDevice($locale, $appVersion)) {
            $appVersion = null;
        }
        if (LocaleHelper::isDependOnDevice($locale, $androidVersion)) {
            $androidVersion = null;
            $minAndroidVersion = null;
        } else {
            $minAndroidVersion = preg_replace('~.*?(\d+(\.\d+)*).*~', '$1', $androidVersion);
        }

        $editorsChoice = !empty($scriptDataInfo[0][12][15][1][1]);
        $privacyPoliceUrl = $scriptDataInfo[0][12][7][2] ?? '';
        $categoryFamily = $this->extractCategory($scriptDataInfo[0][12][13][1] ?? []);
        $icon = $this->extractIcon($scriptDataInfo);
        $cover = $this->extractCover($scriptDataInfo);
        $screenshots = $this->extractScreenshots($scriptDataInfo);
        $video = $this->extractVideo($scriptDataInfo);
        $contentRating = $scriptDataInfo[0][12][4][0] ?? '';
        $released = $this->extractReleaseDate($scriptDataInfo, $locale);
        $updated = $this->extractUpdatedDate($scriptDataInfo);
        $recentChanges = $this->extractRecentChanges($scriptDataInfo);
        $reviews = $this->extractReviews(new AppId($id, $locale, $country), $scriptDataReviews);

        return new AppDetail(
            AppDetail::newBuilder()
                ->setId($id)
                ->setLocale($locale)
                ->setCountry($country)
                ->setName($name)
                ->setDescription($description)
                ->setTranslatedFromLocale($translatedFromLocale)
                ->setSummary($summary)
                ->setIcon($icon)
                ->setCover($cover)
                ->setScreenshots($screenshots)
                ->setDeveloper($developer)
                ->setCategory($category)
                ->setCategoryFamily($categoryFamily)
                ->setVideo($video)
                ->setRecentChanges($recentChanges)
                ->setEditorsChoice($editorsChoice)
                ->setPrivacyPoliceUrl($privacyPoliceUrl)
                ->setInstalls($installs)
                ->setScore($score)
                ->setRecentChanges($recentChanges)
                ->setEditorsChoice($editorsChoice)
                ->setPrivacyPoliceUrl($privacyPoliceUrl)
                ->setInstalls($installs)
                ->setScore($score)
                ->setNumberVoters($numberVoters)
                ->setHistogramRating($histogramRating)
                ->setPrice($price)
                ->setCurrency($currency)
                ->setPriceText($priceText)
                ->setOffersIAPCost($offersIAPCost)
                ->setContainsAds($containsAds)
                ->setSize($size)
                ->setAppVersion($appVersion)
                ->setAndroidVersion($androidVersion)
                ->setMinAndroidVersion($minAndroidVersion)
                ->setContentRating($contentRating)
                ->setReleased($released)
                ->setUpdated($updated)
                ->setNumberReviews($numberReviews)
                ->setReviews($reviews)
        );
    }

    /**
     * @param RequestInterface $request
     * @param ResponseInterface $response
     * @return array
     * @throws GooglePlayException
     */
    private function getScriptData(RequestInterface $request, ResponseInterface $response): array
    {
        $scriptData = ScraperUtil::extractScriptData($response->getBody()->getContents());

        $scriptDataInfo = null;
        $scriptDataRating = null;
        $scriptDataPrice = null;
        $scriptDataVersion = null;
        $scriptDataReviews = [];

        foreach ($scriptData as $key => $scriptValue) {
            if (isset($scriptValue[0][12][5][5][4][2])) { // ds:5
                $scriptDataInfo = $scriptValue;
            } elseif (isset($scriptValue[0][2][0][0][0][1][0][0])) { // ds:3
                $scriptDataPrice = $scriptValue;
            } elseif (isset($scriptValue[0][0][0])
                && is_string($scriptValue[0][0][0])
                && strpos($scriptValue[0][0][0], 'gp:') === 0) { // ds:15
                $scriptDataReviews = $scriptValue;
            } elseif (isset($scriptValue[0][6][3][1])) { // ds:7
                $scriptDataRating = $scriptValue;
            } elseif (isset($scriptValue[0])
                && is_string($scriptValue[0])
                && count($scriptValue) === 3) { // ds:8
                $scriptDataVersion = $scriptValue;
            }
        }

        if (
            $scriptDataInfo === null ||
            $scriptDataRating === null ||
            $scriptDataPrice === null ||
            $scriptDataVersion === null

The condition $scriptDataVersion === null is always true.

        ) {
            throw (new GooglePlayException('Unable to get data for this application.'))->setUrl($request->getUri()->__toString());
        }
        return [$scriptDataInfo, $scriptDataRating, $scriptDataPrice, $scriptDataVersion, $scriptDataReviews];
    }

    /**
     * @param $scriptDataInfo
     * @param string $locale
     * @return string|null
     */
    private function extractTranslatedFromLocale(array $scriptDataInfo, string $locale): ?string
    {
        return isset($scriptDataInfo[0][19][1]) ?
            LocaleHelper::findPreferredLanguage(
                $locale,
                $scriptDataInfo[0][19][1]
            ) :
            null;
    }

    /**
     * @param array $scriptDataInfo
     * @return string
     */
    private function extractDescription(array $scriptDataInfo): string
    {
        if (isset($scriptDataInfo[0][19][0][0][1])) {
            return ScraperUtil::html2text($scriptDataInfo[0][19][0][0][1]);
        }

        return ScraperUtil::html2text($scriptDataInfo[0][10][0][1]);
    }

    /**
     * @param $scriptDataInfo
     * @return string|null
     */
    private function extractSummary(array $scriptDataInfo): ?string
    {
        return empty($scriptDataInfo[0][10][1][1]) ?
            null :
            ScraperUtil::html2text($scriptDataInfo[0][10][1][1]);
    }

    /**
     * @param array $scriptDataInfo
     * @return Developer
     */
    private function extractDeveloper(array $scriptDataInfo): Developer
    {
        $developerPage = GPlayApps::GOOGLE_PLAY_URL . $scriptDataInfo[0][12][5][5][4][2];
        $developerId = parse_query(parse_url($developerPage, PHP_URL_QUERY))[GPlayApps::REQ_PARAM_ID];
        $developerName = $scriptDataInfo[0][12][5][1];
        $developerEmail = $scriptDataInfo[0][12][5][2][0];
        $developerWebsite = $scriptDataInfo[0][12][5][3][5][2];
        $developerAddress = $scriptDataInfo[0][12][5][4][0];
//        $developerInternalID = (int)$scriptDataInfo[0][12][5][0][0];

        return new Developer(
            Developer::newBuilder()
                ->setId($developerId)
                ->setUrl($developerPage)
                ->setName($developerName)
                ->setEmail($developerEmail)
                ->setAddress($developerAddress)
                ->setWebsite($developerWebsite)
        );
    }

    /**
     * @param array $data
     * @return Category|null
     */
    private function extractCategory(array $data): ?Category
    {
        if (isset($data[0]) && $data[0] !== null && $data[2] !== null) {
            $genreId = (string)$data[2];
            $genreName = (string)$data[0];
            return new Category($genreId, $genreName);
        }
        return null;
    }

    /**
     * @param array $scriptDataRating
     * @return HistogramRating
     */
    private function extractHistogramRating(array $scriptDataRating): HistogramRating
    {
        return new HistogramRating(
            $scriptDataRating[0][6][1][5][1] ?? 0,
            $scriptDataRating[0][6][1][4][1] ?? 0,
            $scriptDataRating[0][6][1][3][1] ?? 0,
            $scriptDataRating[0][6][1][2][1] ?? 0,
            $scriptDataRating[0][6][1][1][1] ?? 0
        );
    }

    /**
     * @param $scriptDataPrice
     * @return float
     */
    protected function extractPrice(array $scriptDataPrice): ?float
    {
        return isset($scriptDataPrice[0][2][0][0][0][1][0][0]) ?
            (float)($scriptDataPrice[0][2][0][0][0][1][0][0] / 1000000) :
            0.0;
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage|null
     */
    protected function extractIcon(array $scriptDataInfo): ?GoogleImage
    {
        return empty($scriptDataInfo[0][12][1][3][2]) ?
            null :
            new GoogleImage($scriptDataInfo[0][12][1][3][2]);
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage|null
     */
    protected function extractCover(array $scriptDataInfo): ?GoogleImage
    {
        return empty($scriptDataInfo[0][12][2][3][2]) ?
            null :
            new GoogleImage($scriptDataInfo[0][12][2][3][2]);
    }

    /**
     * @param array $scriptDataInfo
     * @return GoogleImage[]
     */
    private function extractScreenshots(array $scriptDataInfo): array
    {
        return !empty($scriptDataInfo[0][12][0]) ? array_map(static function (array $v) {
            return new GoogleImage($v[3][2]);
        }, $scriptDataInfo[0][12][0]) : [];
    }

    /**
     * @param array $scriptDataInfo
     * @return Video|null
     */
    private function extractVideo(array $scriptDataInfo): ?Video
    {
        if (
            isset($scriptDataInfo[0][12][3][0][3][2]) &&
            $scriptDataInfo[0][12][3][0][3][2] !== null &&
            $scriptDataInfo[0][12][3][1][3][2] !== null
        ) {
            $videoThumb = (string)$scriptDataInfo[0][12][3][1][3][2];
            $videoUrl = (string)$scriptDataInfo[0][12][3][0][3][2];

            return new Video($videoThumb, $videoUrl);
        }
        return null;
    }

    /**
     * @param array $scriptDataInfo
     * @param string $locale
     * @return \DateTimeInterface|null
     */
    private function extractReleaseDate(array $scriptDataInfo, string $locale): ?\DateTimeInterface
    {
        if (isset($scriptDataInfo[0][12][36])) {
            return DateStringFormatter::formatted($locale, $scriptDataInfo[0][12][36]);
        }
        return null;
    }

    /**
     * @param array $scriptDataInfo
     * @return \DateTimeInterface|null
     */
    private function extractUpdatedDate(array $scriptDataInfo): ?\DateTimeInterface
    {
        if (isset($scriptDataInfo[0][12][8][0])) {
            return DateStringFormatter::unixTimeToDateTime($scriptDataInfo[0][12][8][0]);
        }
        return null;
    }

    /**
     * @param $scriptDataInfo
     * @return string|null
     */
    protected function extractRecentChanges($scriptDataInfo): ?string
    {
        return empty($scriptDataInfo[0][12][6][1]) ?
            null :
            ScraperUtil::html2text($scriptDataInfo[0][12][6][1]);
    }

    /**
     * @param AppId $appId
     * @param array $scriptDataReviews
     * @param int $limit
     * @return Review[]
     */
    private function extractReviews(AppId $appId, array $scriptDataReviews, int $limit = 4): array
    {
        if (empty($scriptDataReviews[0])) {
            return [];
        }

        return ReviewsExtractor::extractReviews(
            $appId,
            array_slice($scriptDataReviews[0], 0, $limit)
        );
    }
}