<?php

namespace LimeSurvey\Models\Services;

/**
 * Provides question attribute definitions from question types
 */

class CoreQuestionAttributeProvider extends QuestionAttributeProvider
{
    /** @inheritdoc */
    public function getDefinitions($options = [])
    {
        /** @var string question type */
        $questionType = self::getQuestionType($options);
        if (empty($questionType)) {
            return [];
        }

        /** @var boolean */
        $advancedOnly = !empty($options['advancedOnly']);

        return $this->getQuestionAttributes($questionType, $advancedOnly);
    }

    /**
     * Return the question attribute settings for the passed type (parameter)
     *
     * @param string $questionType : type of question (this is the attribute 'question_type' in table question_theme)
     * @param boolean $advancedOnly If true, only fetch advanced attributes
     * @return array<string,array> the attribute settings for this question type
     *                 returns values from getGeneralAttributesFromXml and getAdvancedAttributesFromXml if this fails
     *                 getAttributesDefinition and getDefaultSettings are returned
     *
     * @throws \CException
     */
    protected function getQuestionAttributes($questionType, $advancedOnly = false)
    {
        $xmlFilePath = \QuestionTheme::getQuestionXMLPathForBaseType($questionType);
        if ($advancedOnly) {
            $generalAttributes = [];
        } else {
            // Get attributes from config.xml
            $generalAttributes = $this->getGeneralAttibutesFromXml($xmlFilePath);
        }
        $advancedAttributes = $this->getAdvancedAttributesFromXml($xmlFilePath);

        /** @var array<string,array> An array of question attributes */
        $attributes = array_merge($generalAttributes, $advancedAttributes);

        return $attributes;
    }

    /**
     * Read question attributes from XML file and convert it to array
     *
     * @param string $xmlFilePath Path to XML
     *
     * @return array<string,array> The general attribute settings for this question type
     */
    protected function getGeneralAttibutesFromXml($xmlFilePath)
    {
        /** @var array<string,array> An array of question attributes */
        $attributes = [];

        if (file_exists($xmlFilePath)) {
            $extensionConfig = \ExtensionConfig::loadFromFile($xmlFilePath);
            $xmlAttributes = $extensionConfig->getNodeAsArray('generalattributes');
            // if only one attribute, then it doesn't return numeric index
            if (!empty($xmlAttributes) && !array_key_exists('0', $xmlAttributes['attribute'])) {
                $temp = $xmlAttributes['attribute'];
                unset($xmlAttributes);
                $xmlAttributes['attribute'][0] = $temp;
            }
        } else {
            return [];
        }

        // set $attributes array with attribute data
        if (!empty($xmlAttributes['attribute'])) {
            foreach ($xmlAttributes['attribute'] as $xmlAttribute) {
                /* settings the default value */
                $attributes[$xmlAttribute] = self::getBaseDefinition();
                /* settings the xml value */
                $attributes[$xmlAttribute]['name'] = $xmlAttribute;
            }
        }

        return $attributes;
    }

    /**
     * Read question attributes from XML file and convert it to array
     *
     * @param string $xmlFilePath Path to XML
     *
     * @return array<string,array> The advanced attribute settings for this question type
     */
    protected function getAdvancedAttributesFromXml($xmlFilePath)
    {
        /** @var array<string,array> An array of question attributes */
        $attributes = [];

        if (file_exists($xmlFilePath)) {
            $extensionConfig = \ExtensionConfig::loadFromFile($xmlFilePath);
            $xmlAttributes = $extensionConfig->getNodeAsArray('attributes');
            // if only one attribute, then it doesn't return numeric index
            if (!empty($xmlAttributes) && !array_key_exists('0', $xmlAttributes['attribute'])) {
                $temp = $xmlAttributes['attribute'];
                unset($xmlAttributes);
                $xmlAttributes['attribute'][0] = $temp;
            }
        } else {
            return [];
        }

        // set $attributes array with attribute data
        if (!empty($xmlAttributes['attribute'])) {
            foreach ($xmlAttributes['attribute'] as $attribute) {
                if (empty($attribute['name'])) {
                    /* Allow comments in attributes */
                    continue;
                }
                /* settings the default value */
                $attributes[$attribute['name']] = self::getBaseDefinition();
                /* settings the xml value */
                foreach ($attribute as $property => $propertyValue) {
                    if ($property === 'options' && !empty($propertyValue)) {
                        foreach ($propertyValue['option'] as $option) {
                            if (isset($option['value'])) {
                                $value = is_array($option['value']) ? '' : $option['value'];
                                $attributes[$attribute['name']]['options'][$value] = $option['text'];
                            }
                        }
                    } else {
                        $attributes[$attribute['name']][$property] = $propertyValue;
                    }
                }
            }
        }

        return $attributes;
    }
}
