QueryRegexFinder::getName() - Code Metrics - Inspection of "Use cURL callback to only partially download remot..." - ArthurHoaro/web-thumbnailer - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#2)

by Arthur
created 2018-04-18 18:06 UTC
QueryRegexFinder::getName() A

↳ Parent: QueryRegexFinder
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace WebThumbnailer\Finder;

use WebThumbnailer\Application\ConfigManager;
use WebThumbnailer\Application\WebAccess\WebAccess;
use WebThumbnailer\Application\WebAccess\WebAccessCUrl;
use WebThumbnailer\Application\WebAccess\WebAccessFactory;
use WebThumbnailer\Exception\BadRulesException;
use WebThumbnailer\Utils\FinderUtils;

/**
 * Class QueryRegexFinder
 *
 * Generic Finder using regex rules on remote web content.
 * It will use regex rules to resolve a thumbnail in web a page.
 *
 * Mandatory rules:
 *   - image_regex
 *   - thumbnail_url
 *
 * Example:
 *   1. `http://domain.tld/page` content will be downloaded.
 *   2. `image_regex` will be apply on the content
 *   3. Matches will be use to generate `thumbnail_url`.
 *
 * @package WebThumbnailer\Finder
 */
class QueryRegexFinder extends FinderCommon
{
    /**
     * @var WebAccess instance.
     */
    protected $webAccess;

    /**
    * @var string thumbnail_url rule.
    */
    protected $thumbnailUrlFormat;

    /**
     * @var string Regex to apply on provided URL.
     */
    protected $urlRegex;

    /**
     * @inheritdoc
     *
     * @throws BadRulesException
     */
    public function __construct($domain, $url, $rules, $options)
    {
        $this->webAccess = WebAccessFactory::getWebAccess($url);
        $this->url = $url;
        $this->domains = $domain;
        $this->loadRules($rules);
        $this->finderOptions = $options;
    }

    /**
     * This finder downloads target URL page, and apply the regex given in rules on its content
     * to extract the thumbnail image.
     * The thumb URL must include ${number} to be replaced from the regex match.
     * Also replace eventual URL options.
     *
     * @inheritdoc
     *
     * @throws BadRulesException
     */
    public function find()
    {
        $thumbnail = $content = null;
        $callback = $this->webAccess instanceof WebAccessCUrl
            ? $this->getCurlCallback($content, $thumbnail)
            : null;
        list($headers, $content) = $this->webAccess->getContent(
            $this->url,
            ConfigManager::get('settings.default.timeout', 30),
            /** @scrutinizer ignore-type */ ConfigManager::get('settings.default.timeout', 30),
            ConfigManager::get('settings.default.max_img_dl', 16777216),
            /** @scrutinizer ignore-type */ ConfigManager::get('settings.default.max_img_dl', 16777216),
            $callback,
            $content
        );
        if (empty($content)
            || empty($headers)
            || (empty($thumbnail) && strpos($headers[0], '200') === false)
        ) {
            return false;
        }

        // With curl, the thumb is extracted during the download
        if ($this->webAccess instanceof WebAccessCUrl && ! empty($thumbnail)) {
            return $thumbnail;
        }

        return $this->extractThumbContent($content);
    }

    /**
     * Get a callback for curl write function.
     *
     * @param string $content   A variable reference in which the downloaded content should be stored.
     * @param string $thumbnail A variable reference in which extracted thumb URL should be stored.
     *
     * @return \Closure CURLOPT_WRITEFUNCTION callback
     */
    protected function getCurlCallback(&$content, &$thumbnail)
    {
        $url = $this->url;
        /**
         * cURL callback function for CURLOPT_WRITEFUNCTION (called during the download).
         *
         * While downloading the remote page, we check that the HTTP code is 200 and content type is 'html/text'
         * Then we extract the title and the charset and stop the download when it's done.
         *
         * Note that when using CURLOPT_WRITEFUNCTION, we have to manually handle the content retrieved,
         * hence the $content reference variable.
         *
         * @param resource $ch   cURL resource
         * @param string   $data chunk of data being downloaded
         *
         * @return int|bool length of $data or false if we need to stop the download
         */
        return function(&$ch, $data) use ($url, &$content, &$thumbnail) {

            $content .= $data;
            $responseCode = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);

            if (!empty($responseCode) && $responseCode != 200) {
                return false;
            }
            $contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
            if (!empty($contentType) && strpos($contentType, 'text/html') === false) {
                return false;
            }
            if (empty($thumbnail)) {
                $thumbnail = $this->extractThumbContent($data);
            }
            // We got everything we want, stop the download.
            if (!empty($responseCode) && !empty($contentType) && !empty($thumbnail)) {
                return false;
            }

            return strlen($data);
        };
    }

    /**
     * @param $content
     * @return bool|mixed|string
     * @throws BadRulesException
     */
    public function extractThumbContent($content)
    {
        $thumbnailUrl = $this->thumbnailUrlFormat;
        if (preg_match($this->urlRegex, $content, $matches) != false) {

            for ($i = 1; $i < count($matches); $i++) {
for ($i=0; $i<count($array); $i++) { // calls count() on each iteration
}

// Better
for ($i=0, $c=count($array); $i<$c; $i++) { // calls count() just once
}
                $thumbnailUrl = str_replace('${'. $i . '}', $matches[$i], $thumbnailUrl);
            }

            // Match only options (not ${number})
            if (preg_match_all('/\${((?!\d)\w+?)}/', $thumbnailUrl, $optionsMatch, PREG_PATTERN_ORDER)) {
                foreach ($optionsMatch[1] as $value) {
                    $thumbnailUrl = $this->replaceOption($thumbnailUrl, $value);
                }
            }
            return $thumbnailUrl;
        }
        return false;
    }

    /**
     * @inheritdoc
     */
    public function checkRules($rules)
    {
        if (! FinderUtils::checkMandatoryRules($rules, [
            'image_regex',
            'thumbnail_url'
        ])) {
            throw new BadRulesException();
        }
    }

    /**
     * @inheritdoc
     *
     * @throws BadRulesException
     */
    public function loadRules($rules)
    {
        $this->checkRules($rules);
        $this->urlRegex = FinderUtils::buildRegex($rules['image_regex'], 'im');
        $this->thumbnailUrlFormat = $rules['thumbnail_url'];
    }

    /**
     * @inheritdoc
     */
    public function getName()
    {
        return 'Query Regex';
    }
}

ArthurHoaro / web-thumbnailer

Pull Request — master (#2)

QueryRegexFinder::getName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
