ORIENT/plugins/rainlab/pages/classes/Snippet.php

<?php namespace RainLab\Pages\Classes;

use Event;
use Lang;
use Cache;
use Config;
use ApplicationException;
use Cms\Classes\Partial;
use Cms\Classes\ComponentHelpers;
use Cms\Classes\Controller as CmsController;
use ValidationException;
use DOMDocument;

/**
 * Represents a static page snippet.
 *
 * @package rainlab\pages
 * @author Alexey Bobkov, Samuel Georges
 */
class Snippet
{
    /**
     * @var string Specifies the snippet code.
     */
    public $code;

    /**
     * @var string Specifies the snippet description.
     */
    protected $description = null;

    /**
     * @var string Specifies the snippet name.
     */
    protected $name = null;

    /**
     * @var string Snippet properties.
     */
    protected $properties;

    /**
     * @var string Snippet component class name.
     */
    protected $componentClass = null;

    /**
     * @var array Internal cache of snippet declarations defined on a page.
     */
    protected static $pageSnippetMap = [];

    /**
     * @var \Cms\Classes\ComponentBase Snippet component object.
     */
    protected $componentObj = null;

    public function __construct()
    {
    }

    /**
     * Initializes the snippet from a CMS partial.
     * @param \Cms\Classes\Partial $parital A partial to load the configuration from.
     */
    public function initFromPartial($partial)
    {
        $viewBag = $partial->getViewBag();

        $this->code = $viewBag->property('snippetCode');
        $this->description = $partial->description;
        $this->name = $viewBag->property('snippetName');
        $this->properties = $viewBag->property('snippetProperties', []);
    }

    /**
     * Initializes the snippet from a CMS component information.
     * @param string $componentClass Specifies the component class.
     * @param string $componentCode Specifies the component code.
     */
    public function initFromComponentInfo($componentClass, $componentCode)
    {
        $this->code = $componentCode;
        $this->componentClass = $componentClass;
    }

    /**
     * Returns the snippet name.
     * This method should not be used in the front-end request handling.
     * @return string
     */
    public function getName()
    {
        if ($this->name !== null) {
            return $this->name;
        }

        if ($this->componentClass === null) {
            return null;
        }

        $component = $this->getComponent();

        return $this->name = ComponentHelpers::getComponentName($component);
    }

    /**
     * Returns the snippet description.
     * This method should not be used in the front-end request handling.
     * @return string
     */
    public function getDescription()
    {
        if ($this->description !== null) {
            return $this->description;
        }

        if ($this->componentClass === null) {
            return null;
        }

        $component = $this->getComponent();

        return $this->description = ComponentHelpers::getComponentDescription($component);
    }

    /**
     * Returns the snippet component class name.
     * If the snippet is a partial snippet, returns NULL.
     * @return string Returns the snippet component class name
     */
    public function getComponentClass()
    {
        return $this->componentClass;
    }

    /**
     * Returns the snippet property list as array, in format compatible with Inspector.
     */
    public function getProperties()
    {
        if (!$this->componentClass) {
            return self::parseIniProperties($this->properties);
        }
        else {
            return ComponentHelpers::getComponentsPropertyConfig($this->getComponent(), false, true);
        }
    }

    /**
     * Returns a list of component definitions declared on the page.
     * @param string $pageName Specifies the static page file name (the name of the corresponding content block file).
     * @param \Cms\Classes\Theme $theme Specifies a parent theme.
     * @return array Returns an array of component definitions
     */
    public static function listPageComponents($pageName, $theme, $markup)
    {
        $map = self::extractSnippetsFromMarkupCached($theme, $pageName, $markup);

        $result = [];

        foreach ($map as $snippetDeclaration => $snippetInfo) {
            if (!isset($snippetInfo['component'])) {
                continue;
            }

            $result[] = [
                'class'      => $snippetInfo['component'],
                'alias'      => $snippetInfo['code'],
                'properties' => $snippetInfo['properties']
            ];
        }

        return $result;
    }

    /**
     * Extends the partial form with Snippet fields.
     */
    public static function extendPartialForm($formWidget)
    {
        /*
         * Snippet code field
         */

        $fieldConfig = [
            'tab'     => 'rainlab.pages::lang.snippet.partialtab',
            'type'    => 'text',
            'label'   => 'rainlab.pages::lang.snippet.code',
            'comment' => 'rainlab.pages::lang.snippet.code_comment',
            'span'    => 'left'
        ];

        $formWidget->tabs['fields']['viewBag[snippetCode]'] = $fieldConfig;

        /*
         * Snippet description field
         */

        $fieldConfig = [
            'tab'     => 'rainlab.pages::lang.snippet.partialtab',
            'type'    => 'text',
            'label'   => 'rainlab.pages::lang.snippet.name',
            'comment' => 'rainlab.pages::lang.snippet.name_comment',
            'span'    => 'right'
        ];

        $formWidget->tabs['fields']['viewBag[snippetName]'] = $fieldConfig;

        /*
         * Snippet properties field
         */

        $fieldConfig = [
            'tab'    => 'rainlab.pages::lang.snippet.partialtab',
            'type'   => 'datatable',
            'height' => '150',
            'dynamicHeight' => true,
            'columns' => [
                'title' => [
                    'title' => 'rainlab.pages::lang.snippet.column_property',
                    'validation' => [
                        'required' => [
                            'message' => 'Please provide the property title',
                            'requiredWith' => 'property'
                        ]
                    ]
                ],
                'property' => [
                    'title' => 'rainlab.pages::lang.snippet.column_code',
                    'validation' => [
                        'required' => [
                            'message' => 'Please provide the property code',
                            'requiredWith' => 'title'
                        ],
                        'regex' => [
                            'pattern'   => '^[a-z][a-z0-9]*$',
                            'modifiers' => 'i',
                            'message'   => Lang::get('rainlab.pages::lang.snippet.property_format_error')
                        ]
                    ]
                ],
                'type' => [
                    'title'   => 'rainlab.pages::lang.snippet.column_type',
                    'type'    => 'dropdown',
                    'options' => [
                        'string'   => 'rainlab.pages::lang.snippet.column_type_string',
                        'checkbox' => 'rainlab.pages::lang.snippet.column_type_checkbox',
                        'dropdown' => 'rainlab.pages::lang.snippet.column_type_dropdown'
                    ],
                    'validation' => [
                        'required' => [
                            'requiredWith' => 'title'
                        ]
                    ]
                ],
                'default' => [
                    'title' => 'rainlab.pages::lang.snippet.column_default'
                ],
                'options' => [
                    'title' => 'rainlab.pages::lang.snippet.column_options'
                ]
            ]
        ];

       $formWidget->tabs['fields']['viewBag[snippetProperties]'] = $fieldConfig;
    }

    public static function extendEditorPartialToolbar($dataHolder)
    {
        $dataHolder->buttons[] = [
            'button' => 'rainlab.pages::lang.snippet.partialtab',
            'icon' => 'octo-icon-code-snippet',
            'popupTitle' => 'rainlab.pages::lang.snippet.settings_popup_title',
            'useViewBag' => true,
            'properties' => [
                [
                    'property' => 'snippetCode',
                    'title' => 'rainlab.pages::lang.snippet.code',
                    'description' => 'rainlab.pages::lang.snippet.code_comment',
                    'type' => 'string',
                    'validation' => [
                        'required' => [
                            'message' => 'rainlab.pages::lang.snippet.code_required'
                        ]
                    ]
                ],
                [
                    'property' => 'snippetName',
                    'title' => 'rainlab.pages::lang.snippet.name',
                    'description' => 'rainlab.pages::lang.snippet.name_comment',
                    'type' => 'string',
                    'validation' => [
                        'required' => [
                            'message' => 'rainlab.pages::lang.snippet.name_required'
                        ]
                    ]
                ],
                [
                    'property' => 'snippetProperties',
                    'title' => '',
                    'type' => 'table',
                    'tab' => 'rainlab.pages::lang.snippet.properties',
                    'columns' => [
                        [
                            'column' => 'title',
                            'type' => 'string',
                            'title' => 'rainlab.pages::lang.snippet.column_property',
                            'validation' => [
                                'required' => [
                                    'message' => 'rainlab.pages::lang.snippet.title_required'
                                ]
                            ]
                        ],
                        [
                            'column' => 'property',
                            'type' => 'string',
                            'title' => 'rainlab.pages::lang.snippet.column_code',
                            'validation' => [
                                'required' => [
                                    'message' => 'rainlab.pages::lang.snippet.property_required'
                                ],
                                'regex' => [
                                    'pattern'   => '^[a-z][a-z0-9]*$',
                                    'modifiers' => 'i',
                                    'message'   => 'rainlab.pages::lang.snippet.property_format_error'
                                ]
                            ]
                        ],
                        [
                            'column' => 'type',
                            'title'   => 'rainlab.pages::lang.snippet.column_type',
                            'type'    => 'dropdown',
                            'placeholder' => 'rainlab.pages::lang.snippet.column_type_placeholder',
                            'options' => [
                                'string'   => 'rainlab.pages::lang.snippet.column_type_string',
                                'checkbox' => 'rainlab.pages::lang.snippet.column_type_checkbox',
                                'dropdown' => 'rainlab.pages::lang.snippet.column_type_dropdown'
                            ],
                            'validation' => [
                                'required' => [
                                    'message' => 'rainlab.pages::lang.snippet.type_required'
                                ]
                            ]
                        ],
                        [
                            'column' => 'default',
                            'type' => 'string',
                            'title' => 'rainlab.pages::lang.snippet.column_default'
                        ],
                        [
                            'column' => 'options',
                            'type' => 'string',
                            'title' => 'rainlab.pages::lang.snippet.column_options'
                        ]
                    ]
                ]
            ]
        ];
    }

    /**
     * Returns a component corresponding to the snippet.
     * This method should not be used in the front-end request handling code.
     * @return \Cms\Classes\ComponentBase
     */
    protected function getComponent()
    {
        if ($this->componentClass === null) {
            return null;
        }

        if ($this->componentObj !== null) {
            return $this->componentObj;
        }

        $componentClass = $this->componentClass;

        return $this->componentObj = new $componentClass();
    }

    //
    // Parsing
    //

    /**
     * Parses the static page markup and renders snippets defined on the page.
     * @param string $pageName Specifies the static page file name (the name of the corresponding content block file).
     * @param \Cms\Classes\Theme $theme Specifies a parent theme.
     * @param string $markup Specifies the markup string to process.
     * @return string Returns the processed string.
     */
    public static function processPageMarkup($pageName, $theme, $markup)
    {
        $map = self::extractSnippetsFromMarkupCached($theme, $pageName, $markup);

        $controller = CmsController::getController();
        $partialSnippetMap = SnippetManager::instance()->getPartialSnippetMap($theme);

        foreach ($map as $snippetDeclaration => $snippetInfo) {
            $snippetCode = $snippetInfo['code'];

            if (!isset($snippetInfo['component'])) {
                if (!array_key_exists($snippetCode, $partialSnippetMap)) {
                    throw new ApplicationException(sprintf('Partial for the snippet %s is not found', $snippetCode));
                }

                $partialName = $partialSnippetMap[$snippetCode];
                $generatedMarkup = $controller->renderPartial($partialName, $snippetInfo['properties']);
            }
            else {
                $generatedMarkup = $controller->renderComponent($snippetCode);
            }

            $pattern = preg_quote($snippetDeclaration);
            $markup = mb_ereg_replace($pattern, $generatedMarkup, $markup);
        }

        return $markup;
    }

    public static function processTemplateSettingsArray($settingsArray)
    {
        if (
            !isset($settingsArray['viewBag']['snippetProperties']['TableData']) &&
            !isset($settingsArray['viewBag']['snippetProperties']) // CMS Editor
        ) {
            return $settingsArray;
        }

        $properties = [];

        if (isset($settingsArray['viewBag']['snippetProperties']['TableData'])) {
            $rows = $settingsArray['viewBag']['snippetProperties']['TableData'];
        }
        else {
            $rows = $settingsArray['viewBag']['snippetProperties'];
        }

        foreach ($rows as $row) {
            $property = array_get($row, 'property');
            $settings = array_only($row, ['title', 'type', 'default', 'options']);

            if (isset($settings['options'])) {
                $settings['options'] = self::dropDownOptionsToArray($settings['options']);
            }

            $properties[$property] = $settings;
        }

        $settingsArray['viewBag']['snippetProperties'] = [];

        foreach ($properties as $name => $value) {
            $settingsArray['viewBag']['snippetProperties'][$name] = $value;
        }

        return $settingsArray;
    }

    public static function processTemplateSettings($template, $context = null)
    {
        if (!isset($template->viewBag['snippetProperties'])) {
            return;
        }

        $parsedProperties = self::parseIniProperties($template->viewBag['snippetProperties']);

        foreach ($parsedProperties as $index => &$property) {
            if ($context !== 'editor') {
                $property['id'] = $index;
            }

            if (isset($property['options']) && is_array($property['options'])) {
                $property['options'] = self::dropDownOptionsToString($property['options']);
            }
        }

        $template->viewBag['snippetProperties'] = $parsedProperties;

        if ($context == 'editor') {
            $template->settings['components']['viewBag'] = $template->viewBag;
        }
    }

    /**
     * Apples default property values and fixes property names.
     *
     * As snippet properties are defined with data attributes, they are lower case, whereas
     * real property names are case sensitive. This method finds original property names defined
     * in snippet classes or partials and replaces property names defined in the static page markup.
     */
    protected static function preprocessPropertyValues($theme, $snippetCode, $componentClass, $properties)
    {
        $snippet = SnippetManager::instance()->findByCodeOrComponent($theme, $snippetCode, $componentClass, true);
        if (!$snippet) {
            throw new ApplicationException(Lang::get('rainlab.pages::lang.snippet.not_found', ['code' => $snippetCode]));
        }

        $properties = array_change_key_case($properties);
        $snippetProperties = $snippet->getProperties();

        foreach ($snippetProperties as $propertyInfo) {
            $propertyCode = $propertyInfo['property'];
            $lowercaseCode = strtolower($propertyCode);

            if (!array_key_exists($lowercaseCode, $properties)) {
                if (array_key_exists('default', $propertyInfo)) {
                    $properties[$propertyCode] = $propertyInfo['default'];
                }
            }
            else {
                $markupPropertyInfo = $properties[$lowercaseCode];
                unset($properties[$lowercaseCode]);
                $properties[$propertyCode] = $markupPropertyInfo;
            }
        }

        return $properties;
    }

    /**
     * Converts a keyed object to an array, converting the index to the "property" value.
     * @return array
     */
    protected static function parseIniProperties($properties)
    {
        foreach ($properties as $index => $value) {
            $properties[$index]['property'] = $index;
        }

        return array_values($properties);
    }

    protected static function dropDownOptionsToArray($optionsString)
    {
        $options = explode('|', $optionsString);

        $result = [];
        foreach ($options as $index => $optionStr) {
            $parts = explode(':', $optionStr, 2);

            if (count($parts) > 1 ) {
                $key = trim($parts[0]);

                if (strlen($key)) {
                    if (!preg_match('/^[0-9a-z-_]+$/i', $key)) {
                        throw new ValidationException(['snippetProperties' => Lang::get('rainlab.pages::lang.snippet.invalid_option_key', ['key'=>$key])]);
                    }

                    $result[$key] = trim($parts[1]);
                }
                else {
                    $result[$index] = trim($optionStr);
                }
            }
            else {
                $result[$index] = trim($optionStr);
            }
        }

        return $result;
    }

    protected static function dropDownOptionsToString($optionsArray)
    {
        $result = [];
        $isAssoc = (bool) count(array_filter(array_keys($optionsArray), 'is_string'));

        foreach ($optionsArray as $optionIndex => $optionValue) {
            $result[] = $isAssoc
                ? $optionIndex.':'.$optionValue
                : $optionValue;
        }

        return implode(' | ', $result);
    }

    protected static function extractSnippetsFromMarkup($markup, $theme)
    {
        $map = [];
        $matches = [];

        if (preg_match_all('/\<figure\s+[^\>]+\>.*\<\/figure\>/i', $markup, $matches)) {
            foreach ($matches[0] as $snippetDeclaration) {
                $nameMatch = [];

                if (!preg_match('/data\-snippet\s*=\s*"([^"]+)"/', $snippetDeclaration, $nameMatch)) {
                    continue;
                }

                $snippetCode = $nameMatch[1];

                $properties = [];

                $propertyMatches = [];
                if (preg_match_all('/data\-property-(?<property>[^=]+)\s*=\s*\"(?<value>[^\"]+)\"/i', $snippetDeclaration, $propertyMatches)) {
                    foreach ($propertyMatches['property'] as $index => $propertyName) {
                        $properties[$propertyName] = $propertyMatches['value'][$index];
                    }
                }

                $componentMatch = [];
                $componentClass = null;

                if (preg_match('/data\-component\s*=\s*"([^"]+)"/', $snippetDeclaration, $componentMatch)) {
                    $componentClass = $componentMatch[1];
                }

                // Apply default values for properties not defined in the markup
                // and normalize property code names.
                $properties = self::preprocessPropertyValues($theme, $snippetCode, $componentClass, $properties);

                $map[$snippetDeclaration] = [
                    'code'       => $snippetCode,
                    'component'  => $componentClass,
                    'properties' => $properties
                ];
            }
        }

        return $map;
    }

    protected static function extractSnippetsFromMarkupCached($theme, $pageName, $markup)
    {
        if (array_key_exists($pageName, self::$pageSnippetMap)) {
            return self::$pageSnippetMap[$pageName];
        }

        $key = self::getMapCacheKey($theme);

        $map = null;
        $cached = Cache::get($key, false);

        if ($cached !== false && ($cached = @unserialize($cached)) !== false) {
            if (array_key_exists($pageName, $cached)) {
                $map = $cached[$pageName];
            }
        }

        if (!is_array($map)) {
            $map = self::extractSnippetsFromMarkup($markup, $theme);

            if (!is_array($cached)) {
                $cached = [];
            }

            $cached[$pageName] = $map;
            $comboConfig = Config::get('cms.parsedPageCacheTTL', Config::get('cms.template_cache_ttl', 10));
            $expiresAt = now()->addMinutes($comboConfig);
            Cache::put($key, serialize($cached), $expiresAt);
        }

        self::$pageSnippetMap[$pageName] = $map;

        return $map;
    }

    /**
     * Returns a cache key for this record.
     */
    protected static function getMapCacheKey($theme)
    {
        $key = crc32($theme->getPath()).'snippet-map';
        /**
         * @event pages.snippet.getMapCacheKey
         * Enables modifying the key used to reference cached RainLab.Pages snippet maps
         *
         * Example usage:
         *
         *     Event::listen('pages.snippet.getMapCacheKey', function (&$key) {
         *          $key = $key . '-' . App::getLocale();
         *     });
         *
         */
        Event::fire('pages.snippet.getMapCacheKey', [&$key]);
        return $key;
    }

    /**
     * Clears the snippet map item cache
     * @param \Cms\Classes\Theme $theme Specifies the current theme.
     */
    public static function clearMapCache($theme)
    {
        Cache::forget(self::getMapCacheKey($theme));
    }
}