<?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\ORM\Mapping\Driver;

use Doctrine\Common\Cache\ArrayCache,

    Doctrine\Common\Annotations\AnnotationReader,

    Doctrine\Common\Annotations\AnnotationRegistry,

    Doctrine\ORM\Mapping\ClassMetadataInfo,

    Doctrine\ORM\Mapping\MappingException;

/**

 * The AnnotationDriver reads the mapping metadata from docblock annotations.

 *

 * @since 2.0

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

 * @author Guilherme Blanco <guilhermeblanco@hotmail.com>

 * @author Jonathan H. Wage <jonwage@gmail.com>

 * @author Roman Borschel <roman@code-factory.org>

 */

class AnnotationDriver implements Driver

{

    /**

     * The AnnotationReader.

     *

     * @var AnnotationReader

     */

    protected $_reader;

    /**

     * The paths where to look for mapping files.

     *

     * @var array

     */

    protected $_paths = array();

    /**

     * The file extension of mapping documents.

     *

     * @var string

     */

    protected $_fileExtension = '.php';

    /**

     * @param array

     */

    protected $_classNames;

    /**

     * Initializes a new AnnotationDriver that uses the given AnnotationReader for reading

     * docblock annotations.

     *

     * @param AnnotationReader $reader The AnnotationReader to use, duck-typed.

     * @param string|array $paths One or multiple paths where mapping classes can be found.

     */

    public function __construct($reader, $paths = null)

    {

        $this->_reader = $reader;

        if ($paths) {

            $this->addPaths((array) $paths);

        }

    }

    /**

     * Append lookup paths to metadata driver.

     *

     * @param array $paths

     */

    public function addPaths(array $paths)

    {

        $this->_paths = array_unique(array_merge($this->_paths, $paths));

    }

    /**

     * Retrieve the defined metadata lookup paths.

     *

     * @return array

     */

    public function getPaths()

    {

        return $this->_paths;

    }

    /**

     * Get the file extension used to look for mapping files under

     *

     * @return void

     */

    public function getFileExtension()

    {

        return $this->_fileExtension;

    }

    /**

     * Set the file extension used to look for mapping files under

     *

     * @param string $fileExtension The file extension to set

     * @return void

     */

    public function setFileExtension($fileExtension)

    {

        $this->_fileExtension = $fileExtension;

    }

    /**

     * {@inheritdoc}

     */

    public function loadMetadataForClass($className, ClassMetadataInfo $metadata)

    {

        $class = $metadata->getReflectionClass();

        $classAnnotations = $this->_reader->getClassAnnotations($class);

        // Compatibility with Doctrine Common 3.x

        if ($classAnnotations && is_int(key($classAnnotations))) {

            foreach ($classAnnotations as $annot) {

                $classAnnotations[get_class($annot)] = $annot;

            }

        }

        // Evaluate Entity annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\Entity'])) {

            $entityAnnot = $classAnnotations['Doctrine\ORM\Mapping\Entity'];

            $metadata->setCustomRepositoryClass($entityAnnot->repositoryClass);

            if ($entityAnnot->readOnly) {

                $metadata->markReadOnly();

            }

        } else if (isset($classAnnotations['Doctrine\ORM\Mapping\MappedSuperclass'])) {

            $metadata->isMappedSuperclass = true;

        } else {

            throw MappingException::classIsNotAValidEntityOrMappedSuperClass($className);

        }

        // Evaluate Table annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\Table'])) {

            $tableAnnot = $classAnnotations['Doctrine\ORM\Mapping\Table'];

            $primaryTable = array(

                'name' => $tableAnnot->name,

                'schema' => $tableAnnot->schema

            );

            if ($tableAnnot->indexes !== null) {

                foreach ($tableAnnot->indexes as $indexAnnot) {

                    $primaryTable['indexes'][$indexAnnot->name] = array(

                        'columns' => $indexAnnot->columns

                    );

                }

            }

            if ($tableAnnot->uniqueConstraints !== null) {

                foreach ($tableAnnot->uniqueConstraints as $uniqueConstraint) {

                    $primaryTable['uniqueConstraints'][$uniqueConstraint->name] = array(

                        'columns' => $uniqueConstraint->columns

                    );

                }

            }

            $metadata->setPrimaryTable($primaryTable);

        }

        // Evaluate NamedQueries annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\NamedQueries'])) {

            $namedQueriesAnnot = $classAnnotations['Doctrine\ORM\Mapping\NamedQueries'];

            foreach ($namedQueriesAnnot->value as $namedQuery) {

                $metadata->addNamedQuery(array(

                    'name'  => $namedQuery->name,

                    'query' => $namedQuery->query

                ));

            }

        }

        // Evaluate InheritanceType annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\InheritanceType'])) {

            $inheritanceTypeAnnot = $classAnnotations['Doctrine\ORM\Mapping\InheritanceType'];

            $metadata->setInheritanceType(constant('Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_' . $inheritanceTypeAnnot->value));

            if ($metadata->inheritanceType != \Doctrine\ORM\Mapping\ClassMetadata::INHERITANCE_TYPE_NONE) {

                // Evaluate DiscriminatorColumn annotation

                if (isset($classAnnotations['Doctrine\ORM\Mapping\DiscriminatorColumn'])) {

                    $discrColumnAnnot = $classAnnotations['Doctrine\ORM\Mapping\DiscriminatorColumn'];

                    $metadata->setDiscriminatorColumn(array(

                        'name' => $discrColumnAnnot->name,

                        'type' => $discrColumnAnnot->type,

                        'length' => $discrColumnAnnot->length

                    ));

                } else {

                    $metadata->setDiscriminatorColumn(array('name' => 'dtype', 'type' => 'string', 'length' => 255));

                }

                // Evaluate DiscriminatorMap annotation

                if (isset($classAnnotations['Doctrine\ORM\Mapping\DiscriminatorMap'])) {

                    $discrMapAnnot = $classAnnotations['Doctrine\ORM\Mapping\DiscriminatorMap'];

                    $metadata->setDiscriminatorMap($discrMapAnnot->value);

                }

            }

        }

        // Evaluate DoctrineChangeTrackingPolicy annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\ChangeTrackingPolicy'])) {

            $changeTrackingAnnot = $classAnnotations['Doctrine\ORM\Mapping\ChangeTrackingPolicy'];

            $metadata->setChangeTrackingPolicy(constant('Doctrine\ORM\Mapping\ClassMetadata::CHANGETRACKING_' . $changeTrackingAnnot->value));

        }

        // Evaluate annotations on properties/fields

        foreach ($class->getProperties() as $property) {

            if ($metadata->isMappedSuperclass && ! $property->isPrivate()

                ||

                $metadata->isInheritedField($property->name)

                ||

                $metadata->isInheritedAssociation($property->name)) {

                continue;

            }

            $mapping = array();

            $mapping['fieldName'] = $property->getName();

            // Check for JoinColummn/JoinColumns annotations

            $joinColumns = array();

            if ($joinColumnAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\JoinColumn')) {

                $joinColumns[] = array(

                    'name' => $joinColumnAnnot->name,

                    'referencedColumnName' => $joinColumnAnnot->referencedColumnName,

                    'unique' => $joinColumnAnnot->unique,

                    'nullable' => $joinColumnAnnot->nullable,

                    'onDelete' => $joinColumnAnnot->onDelete,

                    'onUpdate' => $joinColumnAnnot->onUpdate,

                    'columnDefinition' => $joinColumnAnnot->columnDefinition,

                );

            } else if ($joinColumnsAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\JoinColumns')) {

                foreach ($joinColumnsAnnot->value as $joinColumn) {

                    $joinColumns[] = array(

                        'name' => $joinColumn->name,

                        'referencedColumnName' => $joinColumn->referencedColumnName,

                        'unique' => $joinColumn->unique,

                        'nullable' => $joinColumn->nullable,

                        'onDelete' => $joinColumn->onDelete,

                        'onUpdate' => $joinColumn->onUpdate,

                        'columnDefinition' => $joinColumn->columnDefinition,

                    );

                }

            }

            // Field can only be annotated with one of:

            // @Column, @OneToOne, @OneToMany, @ManyToOne, @ManyToMany

            if ($columnAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\Column')) {

                if ($columnAnnot->type == null) {

                    throw MappingException::propertyTypeIsRequired($className, $property->getName());

                }

                $mapping['type'] = $columnAnnot->type;

                $mapping['length'] = $columnAnnot->length;

                $mapping['precision'] = $columnAnnot->precision;

                $mapping['scale'] = $columnAnnot->scale;

                $mapping['nullable'] = $columnAnnot->nullable;

                $mapping['unique'] = $columnAnnot->unique;

                if ($columnAnnot->options) {

                    $mapping['options'] = $columnAnnot->options;

                }

                if (isset($columnAnnot->name)) {

                    $mapping['columnName'] = $columnAnnot->name;

                }

                if (isset($columnAnnot->columnDefinition)) {

                    $mapping['columnDefinition'] = $columnAnnot->columnDefinition;

                }

                if ($idAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\Id')) {

                    $mapping['id'] = true;

                }

                if ($generatedValueAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\GeneratedValue')) {

                    $metadata->setIdGeneratorType(constant('Doctrine\ORM\Mapping\ClassMetadata::GENERATOR_TYPE_' . $generatedValueAnnot->strategy));

                }

                if ($versionAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\Version')) {

                    $metadata->setVersionMapping($mapping);

                }

                $metadata->mapField($mapping);

                // Check for SequenceGenerator/TableGenerator definition

                if ($seqGeneratorAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\SequenceGenerator')) {

                    $metadata->setSequenceGeneratorDefinition(array(

                        'sequenceName' => $seqGeneratorAnnot->sequenceName,

                        'allocationSize' => $seqGeneratorAnnot->allocationSize,

                        'initialValue' => $seqGeneratorAnnot->initialValue

                    ));

                } else if ($tblGeneratorAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\TableGenerator')) {

                    throw MappingException::tableIdGeneratorNotImplemented($className);

                }

            } else if ($oneToOneAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\OneToOne')) {

                if ($idAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\Id')) {

                    $mapping['id'] = true;

                }

                $mapping['targetEntity'] = $oneToOneAnnot->targetEntity;

                $mapping['joinColumns'] = $joinColumns;

                $mapping['mappedBy'] = $oneToOneAnnot->mappedBy;

                $mapping['inversedBy'] = $oneToOneAnnot->inversedBy;

                $mapping['cascade'] = $oneToOneAnnot->cascade;

                $mapping['orphanRemoval'] = $oneToOneAnnot->orphanRemoval;

                $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $oneToOneAnnot->fetch);

                $metadata->mapOneToOne($mapping);

            } else if ($oneToManyAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\OneToMany')) {

                $mapping['mappedBy'] = $oneToManyAnnot->mappedBy;

                $mapping['targetEntity'] = $oneToManyAnnot->targetEntity;

                $mapping['cascade'] = $oneToManyAnnot->cascade;

                $mapping['indexBy'] = $oneToManyAnnot->indexBy;

                $mapping['orphanRemoval'] = $oneToManyAnnot->orphanRemoval;

                $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $oneToManyAnnot->fetch);

                if ($orderByAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\OrderBy')) {

                    $mapping['orderBy'] = $orderByAnnot->value;

                }

                $metadata->mapOneToMany($mapping);

            } else if ($manyToOneAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\ManyToOne')) {

                if ($idAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\Id')) {

                    $mapping['id'] = true;

                }

                $mapping['joinColumns'] = $joinColumns;

                $mapping['cascade'] = $manyToOneAnnot->cascade;

                $mapping['inversedBy'] = $manyToOneAnnot->inversedBy;

                $mapping['targetEntity'] = $manyToOneAnnot->targetEntity;

                $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $manyToOneAnnot->fetch);

                $metadata->mapManyToOne($mapping);

            } else if ($manyToManyAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\ManyToMany')) {

                $joinTable = array();

                if ($joinTableAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\JoinTable')) {

                    $joinTable = array(

                        'name' => $joinTableAnnot->name,

                        'schema' => $joinTableAnnot->schema

                    );

                    foreach ($joinTableAnnot->joinColumns as $joinColumn) {

                        $joinTable['joinColumns'][] = array(

                            'name' => $joinColumn->name,

                            'referencedColumnName' => $joinColumn->referencedColumnName,

                            'unique' => $joinColumn->unique,

                            'nullable' => $joinColumn->nullable,

                            'onDelete' => $joinColumn->onDelete,

                            'onUpdate' => $joinColumn->onUpdate,

                            'columnDefinition' => $joinColumn->columnDefinition,

                        );

                    }

                    foreach ($joinTableAnnot->inverseJoinColumns as $joinColumn) {

                        $joinTable['inverseJoinColumns'][] = array(

                            'name' => $joinColumn->name,

                            'referencedColumnName' => $joinColumn->referencedColumnName,

                            'unique' => $joinColumn->unique,

                            'nullable' => $joinColumn->nullable,

                            'onDelete' => $joinColumn->onDelete,

                            'onUpdate' => $joinColumn->onUpdate,

                            'columnDefinition' => $joinColumn->columnDefinition,

                        );

                    }

                }

                $mapping['joinTable'] = $joinTable;

                $mapping['targetEntity'] = $manyToManyAnnot->targetEntity;

                $mapping['mappedBy'] = $manyToManyAnnot->mappedBy;

                $mapping['inversedBy'] = $manyToManyAnnot->inversedBy;

                $mapping['cascade'] = $manyToManyAnnot->cascade;

                $mapping['indexBy'] = $manyToManyAnnot->indexBy;

                $mapping['fetch'] = constant('Doctrine\ORM\Mapping\ClassMetadata::FETCH_' . $manyToManyAnnot->fetch);

                if ($orderByAnnot = $this->_reader->getPropertyAnnotation($property, 'Doctrine\ORM\Mapping\OrderBy')) {

                    $mapping['orderBy'] = $orderByAnnot->value;

                }

                $metadata->mapManyToMany($mapping);

            }

        }

        // Evaluate @HasLifecycleCallbacks annotation

        if (isset($classAnnotations['Doctrine\ORM\Mapping\HasLifecycleCallbacks'])) {

            foreach ($class->getMethods() as $method) {

                // filter for the declaring class only, callbacks from parents will already be registered.

                if ($method->isPublic() && $method->getDeclaringClass()->getName() == $class->name) {

                    $annotations = $this->_reader->getMethodAnnotations($method);

                    // Compatibility with Doctrine Common 3.x

                    if ($annotations && is_int(key($annotations))) {

                        foreach ($annotations as $annot) {

                            $annotations[get_class($annot)] = $annot;

                        }