WebThumbnailer\Finder\FinderFactory

Complexity

Total Complexity

18

Size/Duplication

Total Lines	110
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getFinder()	0	17	3
A	checkMetaFormat()	0	10	3
C	getThumbnailMeta()	0	46	12

<?php

declare(strict_types=1);

namespace WebThumbnailer\Finder;

use WebThumbnailer\Application\ConfigManager;
use WebThumbnailer\Exception\BadRulesException;
use WebThumbnailer\Exception\IOException;
use WebThumbnailer\Exception\UnsupportedDomainException;
use WebThumbnailer\Utils\DataUtils;
use WebThumbnailer\Utils\FileUtils;
use WebThumbnailer\Utils\FinderUtils;
use WebThumbnailer\Utils\UrlUtils;

/**
 * Find the appropriate Finder for a given URL, instantiate it and load its rules.
 */
class FinderFactory
{
    /**
     * Creates a finder object for a given URL.
     *
     * @param string $url given URL.
     *
     * @return Finder object.
     *
     * @throws BadRulesException
     * @throws IOException
     */
    public static function getFinder(string $url): Finder
    {
        $domain = UrlUtils::getDomain($url);
        try {
            list($domain, $finder, $rules, $options) = static::getThumbnailMeta($domain, $url);

            $className = '\\WebThumbnailer\\Finder\\' . $finder . 'Finder';
            if (!class_exists($className)) {
                throw new UnsupportedDomainException();
            }
        } catch (UnsupportedDomainException $e) {
            $className = '\\WebThumbnailer\\Finder\\DefaultFinder';
            $rules = [];
            $options = [];
        }

        return new $className($domain, $url, $rules, $options);
    }

    /**
     * Retrieve JSON metadata for the given domains.
     *
     * @param string $inputDomain Domain to search.
     * @param string $url         Complete URL.
     *
     * @return mixed[] [domains, finder name, rules, options].
     *
     * @throws UnsupportedDomainException No rules found for the domains.
     * @throws BadRulesException          Mandatory rules not found for the domains.
     * @throws IOException
     */
    public static function getThumbnailMeta(string $inputDomain, string $url): array
    {
        // Load JSON rule files.
        $jsonFiles = ConfigManager::get('settings.rules_filename', ['rules.json']);
        $allRules = [];
        foreach ($jsonFiles as $file) {
            $allRules = array_merge($allRules, DataUtils::loadJson(FileUtils::RESOURCES_PATH . $file));
        }

        $domain = null;

        foreach ($allRules as $value) {
            static::checkMetaFormat($value);

            $domainFound = false;
            foreach ($value['domains'] as $domain) {
                if (strpos($inputDomain, $domain) !== false) {
                    $domainFound = true;
                    break;
                }
            }

            if (!$domainFound) {
                continue;
            }

            if (!empty($value['url_exclude'])) {
                preg_match(FinderUtils::buildRegex($value['url_exclude'], 'i'), $url, $match);
                if (!empty($match)) {
                    continue;
                }
            }

            if (!empty($value['url_require'])) {
                preg_match(FinderUtils::buildRegex($value['url_require'], 'i'), $url, $match);
                if (empty($match)) {
                    continue;
                }
            }

            $value['rules'] = !empty($value['rules']) ? $value['rules'] : [];
            $value['options'] = !empty($value['options']) ? $value['options'] : [];
            return [$domain, $value['finder'], $value['rules'], $value['options']];
        }

        throw new UnsupportedDomainException();
    }

    /**
     * Make sure that mandatory directives are present in the metadata.
     *
     * @param mixed[] $rules JSON directives.
     *
     * @return bool True if the check is successful.
     *
     * @throws BadRulesException Mandatory rules not found for the domains.
     */
    public static function checkMetaFormat(array $rules): bool
    {
        $mandatoryDirectives = ['domains', 'finder'];
        foreach ($mandatoryDirectives as $mandatoryDirective) {
            if (empty($rules[$mandatoryDirective])) {
                throw new BadRulesException();
            }
        }

        return true;
    }
}