* @copyright Since 2007 PrestaShop SA and Contributors * @license https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0 */ if (!defined('_PS_VERSION_')) { exit; } if (file_exists(__DIR__ . '/vendor/autoload.php')) { require_once __DIR__ . '/vendor/autoload.php'; } use PrestaShop\Module\LinkList\DataMigration; use PrestaShop\Module\LinkList\Filter\BestSalesRouteFilter; use PrestaShop\Module\LinkList\Filter\LinkFilter; use PrestaShop\Module\LinkList\LegacyLinkBlockRepository; use PrestaShop\Module\LinkList\Model\LinkBlockLang; use PrestaShop\Module\LinkList\Presenter\LinkBlockPresenter; use PrestaShop\Module\LinkList\Repository\LinkBlockRepository; use PrestaShop\PrestaShop\Adapter\SymfonyContainer; use PrestaShop\PrestaShop\Core\Module\WidgetInterface; /** * Class Ps_Linklist. */ class Ps_Linklist extends Module implements WidgetInterface { /** * @var string Name of the module running on PS 1.6.x. Used for data migration. */ const PS_16_EQUIVALENT_MODULE = 'blockcms'; const MODULE_NAME = 'ps_linklist'; protected $_html; protected $_display; /** * @var LinkBlockPresenter */ private $linkBlockPresenter; /** * @var LegacyLinkBlockRepository */ private $legacyBlockRepository; /** * @var LinkBlockRepository|LegacyLinkBlockRepository|null */ private $repository; public $templateFile; /** * @var string */ public $templateFileColumn; public function __construct() { $this->name = 'ps_linklist'; $this->author = 'PrestaShop'; $this->version = '6.0.7'; $this->need_instance = 0; $this->tab = 'front_office_features'; $tabNames = []; foreach (Language::getLanguages(true) as $lang) { $tabNames[$lang['locale']] = $this->trans('Link List', [], 'Modules.Linklist.Admin', $lang['locale']); } $this->tabs = [ [ 'route_name' => 'admin_link_block_list', 'class_name' => 'AdminLinkWidget', 'visible' => true, 'name' => $tabNames, 'parent_class_name' => 'AdminParentThemes', 'wording' => 'Link List', 'wording_domain' => 'Modules.Linklist.Admin', ], ]; $this->bootstrap = true; parent::__construct(); $this->displayName = $this->trans('Link List', [], 'Modules.Linklist.Admin'); $this->description = $this->trans('Give more visibility to your content/static pages (CMS, external pages, or else), where you want and when you want, to make your visitors feel like shopping on your store.', [], 'Modules.Linklist.Admin'); $this->ps_versions_compliancy = ['min' => '8.1.0', 'max' => _PS_VERSION_]; $this->templateFile = 'module:ps_linklist/views/templates/hook/linkblock.tpl'; $this->templateFileColumn = 'module:ps_linklist/views/templates/hook/linkblock-column.tpl'; $this->linkBlockPresenter = new LinkBlockPresenter( new Link(), $this->context->language, new LinkFilter([ new BestSalesRouteFilter(), ]) ); $this->legacyBlockRepository = new LegacyLinkBlockRepository(Db::getInstance(), $this->context->shop, $this->context->getTranslator()); } public function install() { if (Shop::isFeatureActive()) { Shop::setContext(Shop::CONTEXT_ALL); } if (!parent::install()) { return false; } $tablesInstalledWithSuccess = $this->createTables(); if (!$tablesInstalledWithSuccess) { $this->uninstall(); return false; } $old16ModuleUninstalledWithSuccess = $this->uninstallPrestaShop16Module(); if ($old16ModuleUninstalledWithSuccess) { (new DataMigration(Db::getInstance()))->migrateData(); $dataLoadedWithSuccess = true; } else { $dataLoadedWithSuccess = $this->installFixtures(); } $dataLoadedWithSuccess = $dataLoadedWithSuccess && $this->registerHook('displayFooter') && $this->registerHook('actionUpdateLangAfter') && $this->registerHook('actionGeneralPageSave'); if ($dataLoadedWithSuccess) { return true; } $this->uninstall(); return false; } /** * @return bool * * @throws \Doctrine\DBAL\Exception */ private function createTables() { $result = $this->getRepository()->createTables(); if (false === $result || (is_array($result) && !empty($result))) { if (is_array($result)) { $this->addModuleErrors($result); } return false; } return true; } /** * @return bool * * @throws \Doctrine\DBAL\Exception */ private function installFixtures() { $result = $this->getRepository()->installFixtures(); if (false === $result || (is_array($result) && !empty($result))) { if (is_array($result)) { $this->addModuleErrors($result); } return false; } return true; } public function uninstall() { $uninstalled = true; $result = $this->getRepository()->dropTables(); if (false === $result || (is_array($result) && !empty($result))) { if (is_array($result)) { $this->addModuleErrors($result); } $uninstalled = false; } return $uninstalled && parent::uninstall(); } /** * Migrate data from 1.6 equivalent module (if applicable), then uninstall */ private function uninstallPrestaShop16Module() { if (!Module::isInstalled(self::PS_16_EQUIVALENT_MODULE)) { return false; } $oldModule = Module::getInstanceByName(self::PS_16_EQUIVALENT_MODULE); if ($oldModule) { // This closure calls the parent class to prevent data to be erased // It allows the new module to be configured without migration $parentUninstallClosure = function () { return parent::uninstall(); }; $parentUninstallClosure = $parentUninstallClosure->bindTo($oldModule, get_class($oldModule)); $parentUninstallClosure(); } return true; } public function hookActionUpdateLangAfter($params) { if (!empty($params['lang']) && $params['lang'] instanceof Language) { Language::updateMultilangFromClass(_DB_PREFIX_ . 'link_block_lang', LinkBlockLang::class, $params['lang']); } } public function hookActionGeneralPageSave() { $this->_clearCache(''); } public function _clearCache($template, $cache_id = null, $compile_id = null) { return array_sum([ parent::_clearCache($this->templateFile), parent::_clearCache($this->templateFileColumn), ]); } public function getContent() { // We need to explicitely get Symfony container, because $this->get will use the admin legacy container $sfContainer = SymfonyContainer::getInstance(); $router = $sfContainer->get('router'); Tools::redirectAdmin( $router->generate('admin_link_block_list') ); } public function renderWidget($hookName, array $configuration) { $key = 'ps_linklist|' . $hookName; if ( in_array($hookName, [ 'displayLeftColumn', 'displayLeftColumnProduct', 'displayRightColumn', 'displayRightColumnProduct', ]) ) { $template = $this->templateFileColumn; } else { $template = $this->templateFile; } if (!$this->isCached($template, $this->getCacheId($key))) { $this->smarty->assign($this->getWidgetVariables($hookName, $configuration)); } return $this->fetch($template, $this->getCacheId($key)); } public function getWidgetVariables($hookName, array $configuration) { $id_hook = Hook::getIdByName($hookName); $linkBlocks = $this->legacyBlockRepository->getByIdHook($id_hook); $blocks = []; foreach ($linkBlocks as $block) { $blocks[] = $this->linkBlockPresenter->present($block); } return [ 'linkBlocks' => $blocks, 'hookName' => $hookName, ]; } /** * @param array $errors */ private function addModuleErrors(array $errors) { foreach ($errors as $error) { $this->_errors[] = $this->trans($error['key'], $error['parameters'], $error['domain']); } } /** * @return LinkBlockRepository|LegacyLinkBlockRepository */ private function getRepository() { if (null === $this->repository) { try { $this->repository = $this->get('prestashop.module.link_block.repository'); } catch (Throwable $e) { try { $container = SymfonyContainer::getInstance(); if (null !== $container) { $this->repository = $container->get('prestashop.module.link_block.repository'); } } catch (Throwable $e) { } } } // Container is not available so we use legacy repository as fallback if (!$this->repository) { $this->repository = $this->legacyBlockRepository; } return $this->repository; } }