<?php

/**
 *    Copyright (C) 2015 Deciso B.V.
 *
 *    All rights reserved.
 *
 *    Redistribution and use in source and binary forms, with or without
 *    modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice,
 *       this list of conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *
 *    THIS SOFTWARE IS PROVIDED ``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
 *    AUTHOR 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.
 *
 */
namespace OPNsense\Base\FieldTypes;

use Phalcon\Validation\Validator\InclusionIn;
use OPNsense\Base\Validators\CsvListValidator;

/**
 * Class ModelRelationField defines a relation to another entity within the model, acts like a select item.
 * @package OPNsense\Base\FieldTypes
 */
class ModelRelationField extends BaseField
{
    /**
     * @var bool marks if this is a data node or a container
     */
    protected $internalIsContainer = false;

    /**
     * @var bool field may contain multiple data nodes at once
     */
    private $internalMultiSelect = false;

    /**
     * @var string default validation message string
     */
    protected $internalValidationMessage = "option not in list";

    /**
     * @var array collected options
     */
    private static $internalOptionList = array();

    /**
     * @var string cache relations
     */
    private $internalCacheKey = "";

    /**
     * Set model as reference list, use uuid's as key
     * @param $mdlStructure nested array structure defining the usable datasources.
     */
    public function setModel($mdlStructure)
    {
        // only handle array type input
        if (!is_array($mdlStructure)) {
            return;
        }

        // set internal key for this node based on sources and filter criteria
        $this->internalCacheKey = md5(serialize($mdlStructure));

        // only collect options once per source/filter combination, we use a static to save our unique option
        // combinations over the running application.
        if (!array_key_exists($this->internalCacheKey, self::$internalOptionList)) {
            self::$internalOptionList[$this->internalCacheKey] = array();
            foreach ($mdlStructure as $modelData) {
                // only handle valid model sources
                if (array_key_exists('source', $modelData) && array_key_exists('items', $modelData) &&
                    array_key_exists('display', $modelData)) {
                    $className = str_replace(".", "\\", $modelData['source']);
                    $modelObj = new $className;
                    foreach ($modelObj->getNodeByReference($modelData['items'])->__items as $node) {
                        $displayKey = $modelData['display'];
                        if (array_key_exists("uuid", $node->getAttributes()) && $node->$displayKey != null) {
                            // check for filters and apply if found
                            $isMatched = true;
                            if (array_key_exists("filters", $modelData)) {
                                foreach ($modelData['filters'] as $filterKey => $filterValue) {
                                    $fieldData = $node->$filterKey;
                                    if (!preg_match($filterValue, $fieldData) && $fieldData != null) {
                                        $isMatched = false;
                                    }
                                }
                            }
                            if ($isMatched) {
                                $uuid = $node->getAttributes()['uuid'];
                                self::$internalOptionList[$this->internalCacheKey][$uuid] =
                                    $node->$displayKey->__toString();
                            }
                        }
                    }
                    unset($modelObj);
                }
            }
        }
    }

    /**
     * select if multiple data nodes may be selected at once
     * @param $value boolean value Y/N
     */
    public function setMultiple($value)
    {
        if (trim(strtoupper($value)) == "Y") {
            $this->internalMultiSelect = true;
        } else {
            $this->internalMultiSelect = false;
        }
    }

    /**
     * get valid options, descriptions and selected value
     * @return array
     */
    public function getNodeData()
    {
        $result = array ();
        if (array_key_exists($this->internalCacheKey, self::$internalOptionList) &&
            is_array(self::$internalOptionList[$this->internalCacheKey])) {
            // if relation is not required, add empty option
            if (!$this->internalIsRequired) {
                $result[""] = array("value"=>"none", "selected" => 0);
            }

            $datanodes = explode(',', $this->internalValue);
            foreach (self::$internalOptionList[$this->internalCacheKey] as $optKey => $optValue) {
                if (in_array($optKey, $datanodes)) {
                    $selected = 1;
                } else {
                    $selected = 0;
                }
                $result[$optKey] = array("value"=>$optValue, "selected" => $selected);
            }
        }

        return $result;
    }

    /**
     * retrieve field validators for this field type
     * @return array returns Text/regex validator
     */
    public function getValidators()
    {
        $validators = parent::getValidators();
        if ($this->internalValue != null) {
            if ($this->internalMultiSelect) {
                // field may contain more than one entries
                $validators[] = new CsvListValidator(array(
                    'message' => $this->internalValidationMessage,
                    'domain' => array_keys(self::$internalOptionList[$this->internalCacheKey])
                ));
            } else {
                // single value selection
                $validators[] = new InclusionIn(array('message' => $this->internalValidationMessage,
                    'domain' => array_keys(self::$internalOptionList[$this->internalCacheKey])));
            }
        }
        return $validators;
    }
}
