Limonte\AdblockParser

Complexity

Total Complexity

32

Size/Duplication

Total Lines	194
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

13 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	initRules()	0	5	1
A	addRules()	0	15	3
B	loadRules()	0	20	6
A	getRules()	0	4	1
B	shouldBlock()	0	21	7
A	shouldNotBlock()	0	4	1
A	getCacheFolder()	0	4	1
A	setCacheFolder()	0	4	1
A	getCacheExpire()	0	4	1
A	setCacheExpire()	0	4	1
A	clearCache()	0	8	3
A	getCachedResource()	0	23	5

<?php
namespace Limonte;

class AdblockParser
{
    /**
     * @var AdblockRule[]
     */
    private $rules;

    private $cacheFolder;

    private $cacheExpire = 1; // 1 day

    public function __construct(array $rules = [])
    {
        $this->initRules($rules);
    }

    /**
     * @param array $rules
     */
    public function initRules(array $rules = [])
    {
        $this->rules = [];
        $this->addRules($rules);
    }

    /**
     * @param  string[]  $rules
     */
    public function addRules($rules)
    {
        foreach ($rules as $rule) {
            try {
                $this->rules[] = new AdblockRule($rule);
            } catch (InvalidRuleException $e) {
                // Skip invalid rules
            }
        }

        // Sort rules, exceptions first
        usort($this->rules, function (AdblockRule $a, AdblockRule $b) {
            return (int)$a->isException() < (int)$b->isException();
        });
    }

    /**
     * @param  string|array  $path
     */
    public function loadRules($path)
    {
        // single resource
        if (is_string($path)) {
            if (filter_var($path, FILTER_VALIDATE_URL)) {
                $content = $this->getCachedResource($path);
            } else {
                $content = @file_get_contents($path);
            }
            if ($content) {
                $rules = preg_split("/(\r\n|\n|\r)/", $content);
                $this->addRules($rules);
            }
            // array of resources
        } elseif (is_array($path)) {
            foreach ($path as $item) {
                $this->loadRules($item);
            }
        }
    }

    /**
     * @return  array
     */
    public function getRules()
    {
        return $this->rules;
    }

    /**
     * @param string $url
     * @return string[]
     * @throws \Exception
     */
    public function shouldBlock($url)
    {
        $rules = [];
        $url = trim($url);

        if (filter_var($url, FILTER_VALIDATE_URL) === false) {
            throw new \Exception("Invalid URL");
        }

        foreach ($this->rules as $rule) {
            if ($rule->isComment() || $rule->isHtml() || $rule->isException()) {
                continue;
            }

            if ($rule->matchUrl($url)) {
                $rules[] = $rule->getRule();
            }
        }

        return $rules;
    }

    /**
     * @param  string  $url
     *
     * @return boolean
     */
    public function shouldNotBlock($url)
    {
        return !$this->shouldBlock($url);
    }

    /**
     * Get cache folder
     *
     * @return string
     */
    public function getCacheFolder()
    {
        return $this->cacheFolder;
    }

    /**
     * Set cache folder
     *
     * @param  string  $cacheFolder
     */
    public function setCacheFolder($cacheFolder)
    {
        $this->cacheFolder = rtrim($cacheFolder, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR;
    }

    /**
     * Get cache expire (in days)
     *
     * @return integer
     */
    public function getCacheExpire()
    {
        return $this->cacheExpire;
    }

    /**
     * Set cache expire (in days)
     *
     * @param  integer  $expireInDays
     */
    public function setCacheExpire($expireInDays)
    {
        $this->cacheExpire = $expireInDays;
    }

    /**
     * Clear external resources cache
     */
    public function clearCache()
    {
        if ($this->cacheFolder) {
            foreach (glob($this->cacheFolder . '*') as $file) {
                unlink($file);
            }
        }
    }

    /**
     * @param  string  $url
     *
     * @return string
     */
    private function getCachedResource($url)
    {
        if (!$this->cacheFolder) {
            return @file_get_contents($url);
        }

        $cacheFile = $this->cacheFolder . basename($url) . md5($url);

        if (file_exists($cacheFile) && (filemtime($cacheFile) > (time() - 60 * 24 * $this->cacheExpire))) {
            // Cache file is less than five minutes old.
            // Don't bother refreshing, just use the file as-is.
            $content = @file_get_contents($cacheFile);
        } else {
            // Our cache is out-of-date, so load the data from our remote server,
            // and also save it over our cache for next time.
            $content = @file_get_contents($url);
            if ($content) {
                file_put_contents($cacheFile, $content, LOCK_EX);
            }
        }

        return $content;
    }
}