<?php

/*

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * This software consists of voluntary contributions made by many individuals

 * and is licensed under the LGPL. For more information, see

 * <http://www.doctrine-project.org>.

 */

namespace Doctrine\Common\Annotations;

use Doctrine\Common\Cache\Cache;

/**

 * A cache aware annotation reader.

 *

 * @author Johannes M. Schmitt <schmittjoh@gmail.com>

 * @author Benjamin Eberlei <kontakt@beberlei.de>

 */

final class CachedReader implements Reader

{

    private static $CACHE_SALT = '@[Annot]';

    /**

     * @var Reader

     */

    private $delegate;

    /**

     * @var Cache

     */

    private $cache;

    /**

     * @var boolean

     */

    private $debug;

    /**

     * @var array

     */

    private $loadedAnnotations;

    /**

     * @param Reader $reader

     * @param Cache $cache

     */

    public function __construct(Reader $reader, Cache $cache, $debug = false)

    {

        $this->delegate = $reader;

        $this->cache = $cache;

        $this->debug = $debug;

    }

    public function getClassAnnotations(\ReflectionClass $class)

    {

        $cacheKey = $class->getName() . self::$CACHE_SALT;

        if (isset($this->loadedAnnotations[$cacheKey])) {

            return $this->loadedAnnotations[$cacheKey];

        }

        // Attempt to grab data from cache

        if (($data = $this->cache->fetch($cacheKey)) !== false) {

            if (!$this->debug || $this->isCacheFresh($cacheKey, $class)) {

                return $data;

            }

        }

        $annots = $this->delegate->getClassAnnotations($class);

        $this->cache->save($cacheKey, $annots);

        $this->cache->save('[C]'.$cacheKey, time());

        return $this->loadedAnnotations[$cacheKey] = $annots;

    }

    public function getClassAnnotation(\ReflectionClass $class, $annotationName)

    {

        foreach ($this->getClassAnnotations($class) as $annot) {

            if ($annot instanceof $annotationName) {

                return $annot;

            }

        }

        return null;

    }

    public function getPropertyAnnotations(\ReflectionProperty $property)

    {

        $class = $property->getDeclaringClass();

        $cacheKey = $class->getName().'$'.$property->getName().self::$CACHE_SALT;

        if (isset($this->loadedAnnotations[$cacheKey])) {

            return $this->loadedAnnotations[$cacheKey];

        }

        // Attempt to grab data from cache

        if (($data = $this->cache->fetch($cacheKey)) !== false) {

            if (!$this->debug || $this->isCacheFresh($cacheKey, $class)) {

                return $data;

            }

        }

        $annots = $this->delegate->getPropertyAnnotations($property);

        $this->cache->save($cacheKey, $annots);

        $this->cache->save('[C]'.$cacheKey, time());

        return $this->loadedAnnotations[$cacheKey] = $annots;

    }

    public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName)

    {

        foreach ($this->getPropertyAnnotations($property) as $annot) {

            if ($annot instanceof $annotationName) {

                return $annot;

            }

        }

        return null;

    }

    public function getMethodAnnotations(\ReflectionMethod $method)

    {

        $class = $method->getDeclaringClass();

        $cacheKey = $class->getName().'#'.$method->getName().self::$CACHE_SALT;

        if (isset($this->loadedAnnotations[$cacheKey])) {

            return $this->loadedAnnotations[$cacheKey];

        }

       // Attempt to grab data from cache

        if (($data = $this->cache->fetch($cacheKey)) !== false) {

            if (!$this->debug || $this->isCacheFresh($cacheKey, $class)) {

                return $data;

            }

        }

        $annots = $this->delegate->getMethodAnnotations($method);

        $this->cache->save($cacheKey, $annots);

        $this->cache->save('[C]'.$cacheKey, time());

        return $this->loadedAnnotations[$cacheKey] = $annots;

    }

    public function getMethodAnnotation(\ReflectionMethod $method, $annotationName)

    {

        foreach ($this->getMethodAnnotations($method) as $annot) {

            if ($annot instanceof $annotationName) {

                return $annot;

            }

        }

        return null;

    }

    public function clearLoadedAnnotations()

    {

        $this->loadedAnnotations = array();

    }

    private function isCacheFresh($cacheKey, \ReflectionClass $class)

    {

        if (false === $filename = $class->getFilename()) {

            return true;

        }

        return $this->cache->fetch('[C]'.$cacheKey) >= filemtime($filename);

    }

}