remotelyliving / php-dns

src/Resolvers/Cached.php

<?php

namespace RemotelyLiving\PHPDNS\Resolvers;

use Psr\Cache\CacheItemPoolInterface;
use RemotelyLiving\PHPDNS\Entities\DNSRecordCollection;
use RemotelyLiving\PHPDNS\Entities\DNSRecordType;
use RemotelyLiving\PHPDNS\Entities\Hostname;
use RemotelyLiving\PHPDNS\Resolvers\Traits\Time;
use RemotelyLiving\PHPDNS\Resolvers\Interfaces\Resolver;

use function count;
use function max;
use function md5;
use function min;
use function sprintf;

final class Cached extends ResolverAbstract
{
    use Time;

    protected const DEFAULT_CACHE_TTL = 300;
    private const CACHE_KEY_TEMPLATE = '%s:%s:%s';

    /**
     * Bump this number on breaking changes to invalidate cache
     */
    private const NAMESPACE = 'php-dns-v4.0.1';

    private bool $shouldCacheEmptyResults = true;

    public function __construct(
        private CacheItemPoolInterface $cache,
        private Resolver $resolver,
        private ?int $ttlSeconds = null
    ) {
    }

    public function flush(): void
    {
        $this->cache->clear();
    }

    public function withEmptyResultCachingDisabled(): self
    {
        $emptyCachingDisabled = new self($this->cache, $this->resolver, $this->ttlSeconds);
        $emptyCachingDisabled->shouldCacheEmptyResults = false;

        return $emptyCachingDisabled;
    }

    protected function doQuery(Hostname $hostname, DNSRecordType $recordType): DNSRecordCollection
    {
        $cachedResult = $this->cache->getItem($this->buildCacheKey($hostname, $recordType));

        if ($cachedResult->isHit()) {
            return $this->unwrapResults($cachedResult->get());
        }

        $dnsRecords = $this->resolver->getRecords((string)$hostname, (string)$recordType);
        if ($dnsRecords->isEmpty() && !$this->shouldCacheEmptyResults) {
            return $dnsRecords;
        }

        $ttlSeconds = $this->ttlSeconds ?? $this->extractLowestTTL($dnsRecords);
        $cachedResult->expiresAfter($ttlSeconds);
        $cachedResult->set(['recordCollection' => $dnsRecords, 'timestamp' => $this->getTimeStamp()]);
        $this->cache->save($cachedResult);

        return $dnsRecords;
    }

    private function buildCacheKey(Hostname $hostname, DNSRecordType $recordType): string
    {
        return md5(sprintf(self::CACHE_KEY_TEMPLATE, self::NAMESPACE, (string)$hostname, (string)$recordType));
    }

    private function extractLowestTTL(DNSRecordCollection $recordCollection): int
    {
        $ttls = [];

        /** @var \RemotelyLiving\PHPDNS\Entities\DNSRecord $record */
        foreach ($recordCollection as $record) {
            /** @scrutinizer ignore-call */
            if ($record->getTTL() <= 0) {
                continue;
            }

            $ttls[] = $record->getTTL();

The method getTTL() does not exist on null.

        }

        return count($ttls) ? min($ttls) : self::DEFAULT_CACHE_TTL;
    }

    /**
     * @param array $results ['recordCollection' => $recordCollection, 'timestamp' => $timeStamp]
     */
    private function unwrapResults(array $results): DNSRecordCollection
    {
        /** @var DNSRecordCollection $records */
        $records = $results['recordCollection'];
        /**
         * @var int $key
         * @var \RemotelyLiving\PHPDNS\Entities\DNSRecord $record
         */
        foreach ($records as $key => $record) {
            $records[$key] = $record
                ->setTTL(max($record->getTTL() - ($this->getTimeStamp() - (int)$results['timestamp']), 0));
        }

        return $records;
    }
}