Phraseanet/lib/Alchemy/Phrasea/SearchEngine/Elastic/Structure/LimitedStructure.php

<?php
/**
 * This file is part of Phraseanet
 *
 * (c) 2005-2016 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Phrasea\SearchEngine\Elastic\Structure;

use Alchemy\Phrasea\SearchEngine\SearchEngineOptions;

/**
 * Proxy structure request to underlying structure and filter results according
 * to user rights (handled in search options object).
 *
 * Private fields without access allowed in any collection are implicitely
 * removed from structure responses.
 *
 * @todo Strip unrestricted fields used only by disallowed collections.
 */
final class LimitedStructure implements Structure
{
    private $structure;
    private $search_options;
    private $allowedCollections;

    // all collections (base_id) with allowed private field access (user rights are computed in options object)
    private $allowedBusinessCollections;

    public function __construct(Structure $structure, SearchEngineOptions $search_options)
    {
        $this->structure = $structure;
        $this->search_options = $search_options;
        $this->allowedCollections =  $search_options->getBasesIds();
        $this->allowedBusinessCollections = $search_options->getBusinessFieldsOn();
    }

    public function getDataboxes()
    {
        return array_keys($this->search_options->getCollectionsReferencesByDatabox());
    }

    public function getAllFields()
    {
        return $this->limit($this->structure->getAllFields());
    }

    public function getUnrestrictedFields()
    {
        // return $this->structure->getUnrestrictedFields();
        return $this->limit($this->structure->getUnrestrictedFields());
    }

    public function getPrivateFields()
    {
        return $this->limit($this->structure->getPrivateFields());
    }

    public function getThesaurusEnabledFields()
    {
        return $this->limit($this->structure->getThesaurusEnabledFields());
    }

    public function getDateFields()
    {
        return $this->limit($this->structure->getDateFields());
    }

    public function get($name)
    {
        $field = $this->structure->get($name);
        return $field ? $this->limitField($field) : $field;
    }

    public function typeOf($name)
    {
        return $this->structure->typeOf($name);
    }

    public function isPrivate($name)
    {
        return $this->structure->isPrivate($name);
    }

    public function getAllFlags()
    {
        return $this->structure->getAllFlags();
    }

    public function getFlagByName($name)
    {
        return $this->structure->getFlagByName($name);
    }

    public function getMetadataTags()
    {
        return $this->structure->getMetadataTags();
    }

    public function getMetadataTagByName($name)
    {
        return $this->structure->getMetadataTagByName($name);
    }

    /*
    private function old_limit(array $fields)
    {
        $allowedBusinessCollections = $this->allowedBusinessCollections;
        // Filter private field collections (base_id) on which access is restricted.
        $limited_fields = [];
        foreach ($fields as $name => $field) {
            if ($field->isPrivate()) {
                $field = $this->limitField($field, $allowedBusinessCollections);
                // Private fields without collections can't be ever visible, we skip them
                if (!$field->getDependantCollections()) {
                    continue;
                }
            }
            $limited_fields[$name] = $field;
        }
        return $limited_fields;
    }
    */

    /**
     * @param Field[] $fields
     * @return Field[]
     */
    private function limit(array $fields)
    {
        // Filter private field collections (base_id) on which access is restricted.
        $limited_fields = [];
        foreach ($fields as $name => $field) {
            $field = $this->limitField($field);
            if(!empty($field->getDependantCollections())) {
                $limited_fields[$name] = $field;
            }
        }
        return $limited_fields;
    }

    private function limitField(Field $field)
    {
        $collections = array_values(array_intersect(
            $field->getDependantCollections(),
            $field->isPrivate() ? $this->allowedBusinessCollections : $this->allowedCollections
        ));

        return $field->withOptions([
            'used_by_collections' => $collections
        ]);
    }
}