prettyblocks.php

<?php

/**
 * Copyright (c) Since 2020 PrestaSafe and contributors
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Academic Free License 3.0 (AFL-3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/AFL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to contact@prestasafe.com so we can send you a copy immediately.
 *
 * @author    PrestaSafe <contact@prestasafe.com>
 * @copyright Since 2020 PrestaSafe and contributors
 * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
 * International Registered Trademark & Property of PrestaSafe
 */

use PrestaSafe\PrettyBlocks\Core\Components\Title;
use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
use Symfony\Component\Dotenv\Dotenv;

if (!defined('_PS_VERSION_')) {
    exit;
}
if (file_exists(__DIR__ . '/vendor/autoload.php')) {
    require_once __DIR__ . '/vendor/autoload.php';
}

use PrestaShop\PrestaShop\Core\Grid\Action\Row\RowActionCollectionInterface;
use PrestaShop\PrestaShop\Core\Grid\Definition\GridDefinitionInterface;

class PrettyBlocks extends Module implements WidgetInterface
{
    public $js_path;
    public $css_path;
    public $dev_ps = true;
    public $valid_types = ['jpg', 'jpeg', 'png', 'gif', 'svg', 'webp', 'pdf'];
    public $upload_dir = __DIR__ . '/views/images/';
    public $form_trans = [];
    public $tabs = [
        [
            'name' => 'PrettyBlocks', // One name for all langs
            'class_name' => 'AdminThemeManagerController',
            'visible' => true,
            'parent_class_name' => 'IMPROVE',
        ],
    ];

    public $hooks = [
        'displayHome',
        'displayFooter',
        'displayLeftColumn',
        'displayRightColumn',
        'displayHeader',
        'actionDispatcher',
        'actionFrontControllerSetVariables',
        'ActionRegisterThemeSettings',
        'displayBackOfficeHeader',
        'ActionRegisterBlock',
        'ActionProductGridDefinitionModifier',
        'ActionCategoryGridDefinitionModifier',
        'ActionCmsPageGridDefinitionModifier',
        'BeforeRenderingPrettyblocksFeaturedProduct',
        'BeforeRenderingPrettyBlocksRenderModule',
    ];

    public function __construct()
    {
        $this->name = 'prettyblocks';
        $this->tab = 'administration';
        $this->version = '3.1.0';
        $this->author = 'PrestaSafe';
        $this->need_instance = 1;
        $this->js_path = $this->_path . 'views/js/';
        $this->css_path = $this->_path . 'views/css/';

        $this->bootstrap = true;
        parent::__construct();

        $this->displayName = $this->trans('PrettyBlocks', [], 'Modules.Prettyblocks.Admin');
        $this->description = $this->trans('Configure your design easily', [], 'Modules.Prettyblocks.Admin');
        $this->controllers = ['ajax'];

        $this->ps_versions_compliancy = ['min' => '1.7', 'max' => _PS_VERSION_];
    }

    /**
     * Add button prettyblocks to product grid
     *
     * @param array $params
     *
     * @return void
     */
    public function hookActionProductGridDefinitionModifier(array $params): void
    {
        /** @var GridDefinitionInterface $gridDefinition */
        $gridDefinition = $params['definition'];
        $this->_generateButtonPrettyBLocks($gridDefinition, 'product', 'id_product');
    }

    /**
     * Add button prettyblocks to category grid
     *
     * @param array $params
     *
     * @return void
     */
    public function hookActionCategoryGridDefinitionModifier(array $params): void
    {
        /** @var GridDefinitionInterface $gridDefinition */
        $gridDefinition = $params['definition'];
        $this->_generateButtonPrettyBLocks($gridDefinition, 'category', 'id_category');
    }

    /**
     * Add button prettyblocks to cms grid
     *
     * @param array $params
     *
     * @return void
     */
    public function hookActionCmsPageGridDefinitionModifier(array $params): void
    {
        /** @var GridDefinitionInterface $gridDefinition */
        $gridDefinition = $params['definition'];
        $this->_generateButtonPrettyBLocks($gridDefinition, 'cms', 'id_cms');
    }

    // actionCmsPageCategoryGridDefinitionModifier

    /**
     * Add button prettyblocks to product grid
     *
     * @param GridDefinitionInterface $definition
     *
     * @return GridDefinitionInterface
     */
    private function _generateButtonPrettyBLocks($definition, $endpoint = 'custom', $field = 'id_product')
    {
        /** @var RowActionCollectionInterface $actionsCollection */
        $prettyblocksImg = HelperBuilder::pathFormattedToUrl('$/modules/prettyblocks/logo.png');
        $columnCollection = (new PrestaSafe\PrettyBlocks\Core\Grid\Column\Type\PrettyBlocksButtonColumn('edit2'))
            ->setName($this->trans('Open in PrettyBlocks', [], 'Modules.Prettyblocks.Admin'))
            ->setOptions([
                'route' => 'admin_prettyblocks',
                'route_param_name' => 'id',
                'route_param_field' => $field,
                'icon' => $prettyblocksImg,
                'field' => $field,
                'endpoint' => $endpoint,
            ]);

        return $definition->getColumns()->add($columnCollection);
    }

    public function isUsingNewTranslationSystem()
    {
        return true;
    }

    /**
     * get .env parameters
     *
     * @return void
     */
    public function loadDotEnv()
    {
        // register .env
        $env_file = _PS_MODULE_DIR_ . '/prettyblocks/.env';

        if (file_exists($env_file)) {
            $dotenv = new Dotenv();
            $dotenv->load($env_file);
        }
    }

    /**
     * create tables on install.
     *
     * @return bool
     */
    private function createBlockDb()
    {
        $db = [];
        $db[] = 'CREATE TABLE IF NOT EXISTS `' . _DB_PREFIX_ . 'prettyblocks` (
            `id_prettyblocks` int(11) unsigned NOT NULL AUTO_INCREMENT,
            `instance_id` text DEFAULT NULL,
            `config` longtext DEFAULT NULL,
            `code` varchar(255) DEFAULT NULL,
            `template` longtext DEFAULT NULL,
            `default_params` longtext DEFAULT NULL,
            `name` varchar(255) DEFAULT NULL,   
            `zone_name` varchar(255) DEFAULT NULL,
            `position` int(11) DEFAULT 0,
            `date_add` datetime DEFAULT NULL,
            `date_upd` datetime DEFAULT NULL,
            `id_shop` int(11) DEFAULT NULL,
            `id_lang` int(11) DEFAULT NULL,
            `state` longtext,          
            PRIMARY KEY (`id_prettyblocks`)
          ) ENGINE=' . _MYSQL_ENGINE_ . ' DEFAULT CHARSET=utf8mb4;';

        $isOk = true;
        foreach ($db as $sql) {
            $isOk &= Db::getInstance()->execute($sql);
        }
        $isOk &= $this->makeSettingsTable();

        return $isOk;
    }

    public function makeSettingsTable()
    {
        $sql = 'CREATE TABLE `' . _DB_PREFIX_ . 'prettyblocks_settings` (
            `id_prettyblocks_settings` int(11) unsigned NOT NULL AUTO_INCREMENT,
            `theme_name` varchar(255) DEFAULT NULL,
            `profile` varchar(255) DEFAULT NULL,
            `id_shop` int(11) DEFAULT NULL,
            `settings` longtext,
            PRIMARY KEY (`id_prettyblocks_settings`)
          ) ENGINE=' . _MYSQL_ENGINE_ . ' DEFAULT CHARSET=utf8mb4;';

        return Db::getInstance()->execute($sql);
    }

    /**
     * Remove DB on uninstall.
     *
     * @return bool
     */
    private function removeDb()
    {
        $db = [];
        $db[] = 'DROP TABLE IF EXISTS `' . _DB_PREFIX_ . 'prettyblocks`';
        $db[] = 'DROP TABLE IF EXISTS `' . _DB_PREFIX_ . 'prettyblocks_lang`';
        $db[] = 'DROP TABLE IF EXISTS `' . _DB_PREFIX_ . 'prettyblocks_settings`';

        $isOk = true;
        foreach ($db as $sql) {
            $isOk &= Db::getInstance()->execute($sql);
        }

        return $isOk;
    }

    public function getContent()
    {
        // $this->registerHook('displayBackOfficeHeader');
        return Tools::redirect($this->getPrettyBlocksUrl());
    }

    private function getPrettyBlocksUrl()
    {
        $domain = Tools::getShopDomainSsl(true);

        return $domain . Link::getUrlSmarty([
            'entity' => 'sf',
            'route' => 'admin_prettyblocks',
        ]);
    }

    private function loadDefault()
    {
        return Configuration::updateGlobalValue('_PRETTYBLOCKS_TOKEN_', Tools::passwdGen(25));
    }

    /**
     * hook display BackOfficeHeader
     */
    public function hookdisplayBackOfficeHeader($params)
    {
        if (version_compare(_PS_VERSION_, '8.0.0', '<')) {
            $route = (new Link())->getAdminLink('AdminThemeManagerControllerRouteGenerator');
            Media::addJsDef([
                'prettyblocks_route_generator' => $route,
                'prettyblocks_logo' => HelperBuilder::pathFormattedToUrl('$/modules/prettyblocks/logo.png'),
            ]);

            $this->context->controller->addJS($this->_path . 'views/js/back.js');
        }
        $this->context->controller->addCSS($this->_path . 'views/css/back.css');

    }

    public function install()
    {
        return parent::install()
            && $this->loadDefault()
            && $this->createBlockDb()
            && $this->registerHook($this->hooks);
    }

    public function uninstall()
    {
        return parent::uninstall()
            && $this->removeDb();
    }

    public function hookActionFrontControllerSetVariables()
    {
        return [
            // 'ajax_builder_url' => $this->context->link->getModuleLink($this->name,'ajax'),
            'theme_settings' => PrettyBlocksModel::getThemeSettings(false, 'front'),
            'id_shop' => (int) $this->context->shop->id,
            'shop_name' => $this->context->shop->name,
            'shop_current_url' => $this->context->shop->getBaseURL(true, true),
        ];
    }

    /**
     * Generate $state to block view
     *
     * @return array
     */
    public function getWidgetVariables($hookName = null, array $configuration = [])
    {
        $block = (isset($configuration['block'])) ? PrettyBlocksModel::loadBlock($configuration['block']) : [];

        return [
            'block' => $block,
            'hookName' => $hookName,
            'configuration' => $configuration,
        ];
    }

    private function _addDynamicZones()
    {
        $this->loadDotEnv();
        $smartyVars = $this->context->smarty->getTemplateVars();

        if ($this->context->controller->php_self == 'product') {
            // product description
            if (isset($smartyVars['product']['description'])) {
                $product = $smartyVars['product'];
                $zone_name = 'product-description-' . $smartyVars['product']['id_product'];
                // if no blocks on this zone, feed product description
                if (!HelperBuilder::zoneHasBlock($zone_name) && !filter_var(getenv('DISABLE_AUTO_FEED_ZONE_PRODUCT_DESCRIPTION'))) {
                    $this->registerBlockToZone($zone_name, 'prettyblocks_product_description');
                }
                $description = $this->renderZone(
                    [
                        'zone_name' => $zone_name,
                        'priority' => true,
                        'alias' => $this->l('Product description'),
                    ]
                );
                $product['description'] = $description;
                $this->context->smarty->assign('product', $product);
            }

            // product description short
            if (isset($smartyVars['product']['description_short'])) {
                $product = $smartyVars['product'];
                $zone_name = 'product-description-short-' . $smartyVars['product']['id_product'];
                // if no blocks on this zone, feed product description
                if (!HelperBuilder::zoneHasBlock($zone_name) && !filter_var(getenv('DISABLE_AUTO_FEED_ZONE_PRODUCT_DESCRIPTION_SHORT'))) {
                    $this->registerBlockToZone($zone_name, 'prettyblocks_product_description_short');
                }
                $description_short = $this->renderZone(
                    [
                        'zone_name' => $zone_name,
                        'priority' => false,
                        'alias' => $this->l('Product description short'),
                    ]
                );
                $product['description_short'] = $description_short;
                $this->context->smarty->assign('product', $product);
            }
        }

        if ($this->context->controller->php_self == 'category') {
            // categories
            if (isset($smartyVars['category'])) {
                $category = $smartyVars['category'];
                $zone_name = 'category-description-' . $smartyVars['category']['id'];
                // if no blocks on this zone, feed product description
                if (!HelperBuilder::zoneHasBlock($zone_name) && !filter_var(getenv('DISABLE_AUTO_FEED_ZONE_CATEGORY_DESCRIPTION'), FILTER_VALIDATE_BOOLEAN)) {
                    $this->registerBlockToZone($zone_name, 'prettyblocks_category_description');
                }
                $description = $this->renderZone(
                    [
                        'zone_name' => $zone_name,
                        'priority' => true,
                        'alias' => $this->l('Category description'),
                    ]
                );
                $category['description'] = $description;
                $this->context->smarty->assign('category', $category);
            }
        }
        // cms
        if ($this->context->controller->php_self == 'cms') {
            if (isset($smartyVars['cms'])) {
                $cms = $smartyVars['cms'];
                $zone_name = 'cms-description-' . $smartyVars['cms']['id'];
                // if no blocks on this zone, feed product description
                if (!HelperBuilder::zoneHasBlock($zone_name) && !filter_var(getenv('DISABLE_AUTO_FEED_ZONE_CMS_CONTENT'))) {
                    $this->registerBlockToZone($zone_name, 'prettyblocks_cms_content');
                }
                $description = $this->renderZone(
                    [
                        'zone_name' => $zone_name,
                        'priority' => true,
                        'alias' => $this->l('CMS content'),
                    ]
                );
                $cms['content'] = $description;
                $this->context->smarty->assign('cms', $cms);
            }
        }
    }

    /**
     * hook display Header
     */
    public function hookdisplayHeader($params)
    {
        $this->_addDynamicZones();
        if ((isset($_SERVER['HTTP_SEC_FETCH_DEST']) && $_SERVER['HTTP_SEC_FETCH_DEST'] == 'iframe') || Tools::getValue('prettyblocks') === '1') {
            $this->context->controller->registerJavascript(
                'prettyblocks',
                'modules/' . $this->name . '/views/js/build/build.js',
                [
                    'position' => 'bottom',
                    'priority' => 150,
                ]
            );
            $this->context->controller->registerStylesheet(
                'prettyblocks',
                'modules/' . $this->name . '/views/css/iframe.css',
                [
                    'media' => 'all',
                    'priority' => 200,
                ]
            );
            $this->context->smarty->assign([
                'prettyblocks' => true,
            ]);
            // todo register css and js on iframe only from Hook
        }
        // load default blocks styles
        if (!TplSettings::getSettings('remove_default_blocks')) {
            $this->context->controller->registerStylesheet(
                'tiny-slider-css',
                'https://cdnjs.cloudflare.com/ajax/libs/tiny-slider/2.9.4/tiny-slider.css',
                [
                    'media' => 'all',
                    'priority' => 200,
                    'server' => 'remote', // added remote option
                ]
            );

            $this->context->controller->registerJavascript(
                'tiny-slider-js',
                'https://cdnjs.cloudflare.com/ajax/libs/tiny-slider/2.9.2/min/tiny-slider.js',
                [
                    'media' => 'all',
                    'priority' => 150,
                    'server' => 'remote', // added remote option
                ]
            );

            $this->context->controller->registerJavascript(
                'prettyblocks-init',
                'modules/' . $this->name . '/views/js/front.js',
                [
                    'media' => 'all',
                    'priority' => 200,
                ]
            );

            $this->context->controller->registerStylesheet(
                'prettyblocks-front',
                'modules/' . $this->name . '/views/css/dist/main.css',
                [
                    'media' => 'all',
                    'priority' => 250,
                ]
            );
        }
    }

    /**
     * Hook before rendering prettyblocks featured product
     *
     * @param array $params
     *
     * @return array
     */
    public function hookBeforeRenderingPrettyblocksFeaturedProduct($params)
    {
        $settings = $params['block']['settings'];
        $nProducts = (int) $settings['number'] ?? 8;
        if ($settings) {
            if (isset($settings['category']['id'])) {
                $id_category = (int) $settings['category']['id'];

                return ['products' => HelperBuilder::getProductsCategory($id_category, $nProducts)];
            }
        }

        return ['products' => false];
    }

    /**
     * Hook before rendering prettyblocks render module
     *
     * @param array $params
     *
     * @return array
     */
    public function hookBeforeRenderingPrettyBlocksRenderModule($params)
    {
        $settings = $params['block']['settings'];
        $module_name = $settings['module_name'];

        if (isset($module_name) && $module_name && Validate::isModuleName($module_name)) {
            $module = Module::getInstanceByName($module_name);
            if ($module && $module instanceof WidgetInterface) {
                return ['module' => $module_name];
            }
        }

        return ['module' => false];
    }

    /**
     * Return la view
     */
    public function renderWidget($hookName = null, array $configuration = [])
    {
        $vars = $this->getWidgetVariables($hookName, $configuration);
        $this->smarty->assign($vars);
        if (isset($configuration['zone_name'])) {
            return $this->renderZone(['zone_name' => pSQL($configuration['zone_name'])]);
        }
        if (isset($configuration['action']) && $configuration['action'] == 'GetBlockRender') {
            $block = $configuration['data'];
            $vars = [
                'id_prettyblocks' => $block['id_prettyblocks'],
                'instance_id' => $block['instance_id'],
                'state' => $block['repeater_db'],
                'block' => $block,
                'test' => Hook::exec('beforeRenderingBlock', ['state' => $configuration['data']], null, true),
            ];
            $this->smarty->assign($vars);
            $template = $block['templates'][$block['templateSelected']] ?? 'module:prettyblocks/views/templates/blocks/welcome.tpl';

            return $this->fetch($template);
        }
        if ($vars['hookName'] !== null) {
            return $this->renderZone(['zone_name' => $vars['hookName']]);
        }
    }

    public function registerBlockToZone($zone_name, $block_code)
    {
        return PrettyBlocksModel::registerBlockToZone($zone_name, $block_code);
    }

    /**
     * Hook dispatcher for registering smarty function
     */
    public function hookActionDispatcher()
    {
        /* @deprecated {magic_zone} is deprecated since v1.1.0. Use {prettyblocks_zone} instead. */
        $this->context->smarty->registerPlugin('function', 'magic_zone', [$this, 'renderZone']);
        $this->context->smarty->registerPlugin('function', 'prettyblocks_zone', [$this, 'renderZone']);
        $this->context->smarty->registerPlugin('function', 'prettyblocks_title', [$this, 'renderTitle']);
        // $this->context->smarty->registerPlugin('function', 'prettyblocks', [$this, 'renderBlocks']);
    }

    /**
     * Render blocks
     * BUG with cache
     * $block.states is not defined
     * Not used for now.
     */
    public function renderBlocks($params)
    {
        $template = $params['file'];
        $instance_id = $params['instance_id'];
        $id_prettyblocks = $params['id_prettyblocks'];
        $data = $params['data'];

        $cacheId = 'prettyblocks_' . $id_prettyblocks . '_' . $instance_id;
        $cacheSettings = isset($block['settings']['default']['is_cached']) ? (bool) $block['settings']['default']['is_cached'] : false;

        if ($cacheSettings && !$this->isCached($template, $this->getCacheId($cacheId))) {
            $this->smarty->assign([
                'template' => $template,
                'block' => $data,
                'instance_id' => $instance_id,
                'id_prettyblocks' => $id_prettyblocks,
                'states' => $data['states'],
            ]);
        }

        return $this->fetch($template, $this->getCacheId($cacheId));
    }

    /**
     * Render dynamic title
     *
     * @param array $params
     *
     * @return string
     */
    public static function renderTitle($params)
    {
        $tag = $params['tag'] ?? null;
        $value = $params['value'] ?? '';
        $field = $params['field'];
        $block = $params['block'];
        $classes = $params['classes'] ?? [];

        $title = new Title($tag, $classes, $block, $field);
        if (isset($params['index'])) {
            $title->setIndex((int) $params['index']);
        }

        return $title->setValueFromBlock(true)
            ->setValue($value)->render();
    }

    /**
     * Render zone
     */
    public function renderZone($params)
    {
        $zone_name = $params['zone_name'];
        $priority = $params['priority'] ?? false;
        $alias = $params['alias'] ?? '';

        if (empty($zone_name)) {
            return false;
        }
        $templateFile = 'module:prettyblocks/views/templates/front/zone.tpl';
        $context = Context::getContext();

        $id_lang = $context->language->id;
        $id_shop = $context->shop->id;
        $blocks = PrettyBlocksModel::getInstanceByZone($zone_name, 'front', $id_lang, $id_shop);

        $context->smarty->assign([
            'zone_name' => $zone_name,
            'priority' => $priority,
            'alias' => $alias,
            'blocks' => $blocks,
        ]);

        return $this->fetch($templateFile);
    }

    /**
     * Hook for adding theme settings
     * quick fix for adding tinyMCE api key.
     */
    public function hookActionRegisterThemeSettings()
    {
        return [
            'tinymce_api_key' => [
                'type' => 'text', // type of field
                'label' => $this->l('TinyMCE api key'), // label to display
                'description' => $this->l('Add your TinyMCE api key (free) https://www.tiny.cloud/pricing/'), // description to display
                'tab' => 'Settings',
                'default' => 'no-api-key', // default value (Boolean)
                'private' => true,
            ],
            'remove_default_blocks' => [
                'type' => 'checkbox', // type of field
                'label' => $this->l('Remove default blocks (if you using yours custom blocks)'), // label to display
                'description' => $this->l('Remove default blocks (if you using yours custom blocks)'), // description to display
                'tab' => 'Settings',
                'default' => false, // default value (Boolean)
                'private' => true,
            ],
        ];
    }

    /**
     * Register blocks into prettyblocks
     * register smartyblock
     */
    public function hookActionRegisterBlock($params)
    {
        $defaultsBlocks = [
            new PrettyBlocksProductDescriptionBlock($this),
            new PrettyBlocksProductDescriptionShortBlock($this),
            new PrettyBlocksCmsContentBlock($this),
            new PrettyBlocksCategoryDescriptionBlock($this),
        ];

        if (!TplSettings::getSettings('remove_default_blocks')) {
            $defaultsBlocks[] = new PrettyBlocksTinySlider($this);
            $defaultsBlocks[] = new PrettyBlocksCustomImage($this);
            $defaultsBlocks[] = new PrettyBlocksFAQ($this);
            $defaultsBlocks[] = new PrettyBlocksCustomText($this);
            $defaultsBlocks[] = new PrettyBlocksFeaturedProducts($this);
            $defaultsBlocks[] = new PrettyBlocksTitle($this);
            $defaultsBlocks[] = new PrettyBlocksRenderModule($this);
            $defaultsBlocks[] = new PrettyBlocksRenderHook($this);
        }

        return HelperBuilder::renderBlocks($defaultsBlocks);
    }

    protected function getCacheId($name = null)
    {
        $cacheId = 'prettyblocks|' . parent::getCacheId($name);
        /* if (!empty($this->context->customer->id)) {
            $cacheId .= '|' . $this->context->customer->id;
        } */

        return $cacheId;
    }

    public function clearCache($var)
    {
        $this->_clearCache($var);
    }
}