* @copyright 2007-2014 PrestaShop SA * @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0) * International Registered Trademark & Property of PrestaShop SA */ if (!defined('_PS_VERSION_')) exit; class BlockLink extends Module { /* @var boolean error */ protected $error = false; public function __construct() { $this->name = 'blocklink'; $this->tab = 'front_office_features'; $this->version = '1.5.4'; $this->author = 'PrestaShop'; $this->need_instance = 0; $this->bootstrap = true; parent::__construct(); $this->displayName = $this->l('Link block'); $this->description = $this->l('Adds a block with additional links.'); $this->confirmUninstall = $this->l('Are you sure you want to delete all your links?'); $this->ps_versions_compliancy = array('min' => '1.6', 'max' => _PS_VERSION_); } public function install() { if (!parent::install() || !$this->registerHook('header')) return false; $success = Configuration::updateValue('PS_BLOCKLINK_TITLE', array('1' => 'Block link', '2' => 'Bloc lien')); $success &= Db::getInstance()->execute(' CREATE TABLE '._DB_PREFIX_.'blocklink ( `id_blocklink` int(10) NOT NULL AUTO_INCREMENT, `url` varchar(254) NOT NULL, `new_window` TINYINT(1) NOT NULL, PRIMARY KEY(`id_blocklink`)) ENGINE='._MYSQL_ENGINE_.' default CHARSET=utf8'); $success &= Db::getInstance()->execute(' CREATE TABLE '._DB_PREFIX_.'blocklink_shop ( `id_blocklink` int(10) NOT NULL AUTO_INCREMENT, `id_shop` int(10) NOT NULL, PRIMARY KEY(`id_blocklink`, `id_shop`)) ENGINE='._MYSQL_ENGINE_.' default CHARSET=utf8'); $success &= Db::getInstance()->execute(' CREATE TABLE '._DB_PREFIX_.'blocklink_lang ( `id_blocklink` int(10) NOT NULL, `id_lang` int(10) NOT NULL, `text` varchar(62) NOT NULL, PRIMARY KEY(`id_blocklink`, `id_lang`)) ENGINE='._MYSQL_ENGINE_.' default CHARSET=utf8'); if (!$success) { parent::uninstall(); return false; } // Hook the module either on the left or right column $theme = new Theme(Context::getContext()->shop->id_theme); if ((!$theme->default_left_column || !$this->registerHook('leftColumn')) && (!$theme->default_right_column || !$this->registerHook('rightColumn')) ) { // If there are no colums implemented by the template, throw an error and uninstall the module $this->_errors[] = $this->l('This module needs to be hooked to a column, but your theme does not implement one'); parent::uninstall(); return false; } return true; } public function uninstall() { if (!parent::uninstall() || !Db::getInstance()->execute('DROP TABLE '._DB_PREFIX_.'blocklink') || !Db::getInstance()->execute('DROP TABLE '._DB_PREFIX_.'blocklink_lang') || !Db::getInstance()->execute('DROP TABLE '._DB_PREFIX_.'blocklink_shop') || !Configuration::deleteByName('PS_BLOCKLINK_TITLE') || !Configuration::deleteByName('PS_BLOCKLINK_URL') ) return false; return true; } public function hookLeftColumn($params) { $links = $this->getLinks(); $this->smarty->assign(array( 'blocklink_links' => $links, 'title' => Configuration::get('PS_BLOCKLINK_TITLE', $this->context->language->id), 'url' => Configuration::get('PS_BLOCKLINK_URL'), 'lang' => 'text_'.$this->context->language->id )); if (!$links) return false; return $this->display(__FILE__, 'blocklink.tpl'); } public function hookRightColumn($params) { return $this->hookLeftColumn($params); } public function hookHeader($params) { $this->context->controller->addCSS($this->_path.'blocklink.css', 'all'); } /** * @param $id * * @return bool|array */ public function getLinkById($id) { if ((int)$id > 0) { $sql = 'SELECT b.`id_blocklink`, b.`url`, b.`new_window` FROM `'._DB_PREFIX_.'blocklink` b WHERE b.id_blocklink='.$id; if (!$results = Db::getInstance()->getRow($sql)) return false; $link['id_blocklink'] = $results['id_blocklink']; $link['url'] = $results['url']; $link['newWindow'] = $results['new_window']; $results_lang = Db::getInstance()->executeS('SELECT `id_lang`, `text` FROM '._DB_PREFIX_.'blocklink_lang WHERE `id_blocklink`='.(int)$link['id_blocklink']); foreach ($results_lang as $result_lang) $link['text'][$result_lang['id_lang']] = $result_lang['text']; return $link; } return false; } public function getLinks() { $result = array(); // Get id and url $sql = 'SELECT b.`id_blocklink`, b.`url`, b.`new_window` FROM `'._DB_PREFIX_.'blocklink` b'; if (Shop::isFeatureActive() && Shop::getContext() != Shop::CONTEXT_ALL) $sql .= ' JOIN `'._DB_PREFIX_.'blocklink_shop` bs ON b.`id_blocklink` = bs.`id_blocklink` AND bs.`id_shop` IN ('.implode(', ', Shop::getContextListShopID()).') '; $sql .= (int)Configuration::get('PS_BLOCKLINK_ORDERWAY') == 1 ? ' ORDER BY `id_blocklink` DESC' : ''; if (!$links = Db::getInstance()->executeS($sql)) return false; $i = 0; foreach ($links as $link) { $result[$i]['id'] = $link['id_blocklink']; $result[$i]['url'] = $link['url']; $result[$i]['newWindow'] = $link['new_window']; // Get multilingual text if (!$texts = Db::getInstance()->executeS('SELECT `id_lang`, `text` FROM '._DB_PREFIX_.'blocklink_lang WHERE `id_blocklink`='.(int)$link['id_blocklink']) ) return false; foreach ($texts as $text) $result[$i]['text_'.$text['id_lang']] = $text['text']; $i++; } return $result; } public function addLink() { if (!($languages = Language::getLanguages(true))) return false; $id_lang_default = (int)Configuration::get('PS_LANG_DEFAULT'); if ((int)Tools::getValue('id_blocklink') > 0) { $id_link = (int)Tools::getValue('id_blocklink'); if (!Db::getInstance()->execute('UPDATE '._DB_PREFIX_.'blocklink SET `url` = \''.pSQL(Tools::getValue('url')).'\', `new_window` = '.(isset($_POST['newWindow']) ? 1 : 0).' WHERE `id_blocklink` = '.(int)$id_link)) return false; if (!Db::getInstance()->execute('DELETE FROM '._DB_PREFIX_.'blocklink_lang WHERE `id_blocklink` = '.(int)$id_link)) return false; foreach ($languages as $language) if (!empty($_POST['text_'.$language['id_lang']])) { if (!Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'blocklink_lang (`id_blocklink`, `id_lang`, `text`) VALUES ('.(int)$id_link.', '.(int)($language['id_lang']).', \''.pSQL($_POST['text_'.$language['id_lang']]).'\')')) return false; } else if (!Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'blocklink_lang VALUES ('.(int)$id_link.', '.$language['id_lang'].', \''.pSQL($_POST['text_'.$id_lang_default]).'\')')) return false; } else { if (!Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'blocklink (`id_blocklink`, `url`, `new_window`) VALUES (NULL, \''.pSQL(Tools::getValue('url')).'\', '.((isset($_POST['newWindow']) && Tools::getValue('newWindow')) == 'on' ? 1 : 0).')') || !$id_link = Db::getInstance()->Insert_ID() ) return false; foreach ($languages as $language) if (!empty($_POST['text_'.$language['id_lang']])) { if (!Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'blocklink_lang (`id_blocklink`, `id_lang`, `text`) VALUES ('.(int)$id_link.', '.(int)$language['id_lang'].', \''.pSQL(Tools::getValue('text_'.$language['id_lang'])).'\')') ) return false; } else if (!Db::getInstance()->execute('INSERT INTO '._DB_PREFIX_.'blocklink_lang (`id_blocklink`, `id_lang`, `text`) VALUES ('.(int)$id_link.', '.(int)($language['id_lang']).', \''.pSQL($_POST['text_'.$id_lang_default]).'\')')) return false; } Db::getInstance()->execute('DELETE FROM '._DB_PREFIX_.'blocklink_shop WHERE id_blocklink='.(int)$id_link); $shops = Shop::getShops(true, null, true); if (!Shop::isFeatureActive() || (Shop::isFeatureActive() && count($shops) == 1)) { Db::getInstance()->insert('blocklink_shop', array( 'id_blocklink' => (int)$id_link, 'id_shop' => (int)Context::getContext()->shop->id, )); } else { $assos_shop = Tools::getValue('checkBoxShopAsso_configuration'); if (empty($assos_shop)) return false; foreach ($assos_shop as $id_shop => $row) Db::getInstance()->insert('blocklink_shop', array( 'id_blocklink' => (int)$id_link, 'id_shop' => (int)$id_shop, )); } return true; } public function deleteLink() { return (Db::getInstance()->execute('DELETE FROM '._DB_PREFIX_.'blocklink WHERE `id_blocklink` = '.(int)Tools::getValue('id')) && Db::getInstance()->execute('DELETE FROM '._DB_PREFIX_.'blocklink_shop WHERE `id_blocklink` = '.(int)Tools::getValue('id')) && Db::getInstance()->execute('DELETE FROM '._DB_PREFIX_.'blocklink_lang WHERE `id_blocklink` = '.(int)Tools::getValue('id'))); } public function updateTitle() { $languages = Language::getLanguages(); $result = array(); foreach ($languages as $language) $result[$language['id_lang']] = Tools::getValue('title_'.$language['id_lang']); if (!Configuration::updateValue('PS_BLOCKLINK_TITLE', $result)) return false; return Configuration::updateValue('PS_BLOCKLINK_URL', Tools::getValue('title_url')); } public function getContent() { $this->_html = ''; // Add a link if (Tools::isSubmit('submitLinkAdd') /* || Tools::isSubmit('updateblocklink')*/) { if (empty($_POST['text_'.Configuration::get('PS_LANG_DEFAULT')]) || empty($_POST['url'])) $this->_html .= $this->displayError($this->l('You must fill in all fields.')); elseif (!Validate::isUrl(str_replace('http://', '', $_POST['url']))) $this->_html .= $this->displayError($this->l('Bad URL')); else if ($this->addLink()) $this->_html .= $this->displayConfirmation($this->l('The link has been added.')); else $this->_html .= $this->displayError($this->l('An error occurred during link creation.')); } // Update the block title elseif (Tools::isSubmit('submitTitle')) { if (empty($_POST['title_'.Configuration::get('PS_LANG_DEFAULT')])) $this->_html .= $this->displayError($this->l('"title" field cannot be empty.')); elseif (!empty($_POST['title_url']) && !Validate::isUrl(str_replace('http://', '', $_POST['title_url']))) $this->_html .= $this->displayError($this->l('The \'title\' field is invalid')); elseif (!Validate::isGenericName($_POST['title_'.Configuration::get('PS_LANG_DEFAULT')])) $this->_html .= $this->displayError($this->l('The \'title\' field is invalid')); elseif (!$this->updateTitle()) $this->_html .= $this->displayError($this->l('An error occurred during title updating.')); else $this->_html .= $this->displayConfirmation($this->l('The block title has been updated.')); } // Delete a link elseif (Tools::isSubmit('deleteblocklink') && Tools::getValue('id')) { if (!is_numeric(Tools::getValue('id')) || !$this->deleteLink()) $this->_html .= $this->displayError($this->l('An error occurred during link deletion.')); else $this->_html .= $this->displayConfirmation($this->l('The link has been deleted.')); } if (isset($_POST['submitOrderWay'])) { if (Configuration::updateValue('PS_BLOCKLINK_ORDERWAY', (int)(Tools::getValue('orderWay')))) $this->_html .= $this->displayConfirmation($this->l('Sort order updated')); else $this->_html .= $this->displayError($this->l('An error occurred during sort order set-up.')); } $this->_html .= $this->renderForm(); $this->_html .= $this->renderList(); return $this->_html; } public function renderList() { $fields_list = array( 'id' => array( 'title' => $this->l('Link ID'), 'type' => 'text', ), 'text_'.$this->context->language->id => array( 'title' => $this->l('Link text'), 'type' => 'text', ), 'url' => array( 'title' => $this->l('URL'), 'type' => 'text', ), ); $helper = new HelperList(); $helper->shopLinkType = ''; $helper->simple_header = true; $helper->identifier = 'id'; $helper->actions = array('edit', 'delete'); $helper->show_toolbar = false; $helper->title = $this->l('Link list'); $helper->table = $this->name; $helper->token = Tools::getAdminTokenLite('AdminModules'); $helper->currentIndex = AdminController::$currentIndex.'&configure='.$this->name; $links = $this->getLinks(); if (is_array($links) && count($links)) return $helper->generateList($links, $fields_list); else return false; } public function renderForm() { $fields_form_1 = array( 'form' => array( 'legend' => array( 'title' => $this->l('Add a new link'), 'icon' => 'icon-plus-sign-alt' ), 'input' => array( array( 'type' => 'hidden', 'name' => 'id_blocklink', ), array( 'type' => 'text', 'label' => $this->l('Link text'), 'name' => 'text', 'lang' => true, ), array( 'type' => 'text', 'label' => $this->l('URL'), 'name' => 'url', ), array( 'type' => 'switch', 'label' => $this->l('Open in a new window'), 'name' => 'newWindow', 'is_bool' => true, 'values' => array( array( 'id' => 'active_on', 'value' => 1, 'label' => $this->l('Enabled') ), array( 'id' => 'active_off', 'value' => 0, 'label' => $this->l('Disabled') ) ), ), ), 'submit' => array( 'title' => $this->l('Save'), 'name' => 'submitLinkAdd', ) ), ); if (Shop::isFeatureActive()) { $fields_form_1['form']['input'][] = array( 'type' => 'shop', 'label' => $this->l('Shop association'), 'name' => 'checkBoxShopAsso', ); } $fields_form_2 = array( 'form' => array( 'legend' => array( 'title' => $this->l('Block settings'), 'icon' => 'icon-plus-sign-alt' ), 'input' => array( array( 'type' => 'text', 'label' => $this->l('Block title'), 'name' => 'title', 'lang' => true, ), array( 'type' => 'text', 'label' => $this->l('URL for the block\'s title'), 'name' => 'title_url', ), ), 'submit' => array( 'title' => $this->l('Save'), 'name' => 'submitTitle', ) ), ); $fields_form_3 = array( 'form' => array( 'legend' => array( 'title' => $this->l('Link display settings'), 'icon' => 'icon-cogs' ), 'input' => array( array( 'type' => 'select', 'label' => $this->l('List order'), 'name' => 'orderWay', 'options' => array( 'query' => array( array( 'id' => 0, 'name' => $this->l('most recent links first') ), array( 'id' => 1, 'name' => $this->l('oldest links first') ) ), 'id' => 'id', 'name' => 'name', ) ), ), 'submit' => array( 'title' => $this->l('Save'), 'name' => 'submitOrderWay', ) ), ); $helper = new HelperForm(); $helper->show_toolbar = false; $lang = new Language((int)Configuration::get('PS_LANG_DEFAULT')); $helper->default_form_language = $lang->id; $helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') ? Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') : 0; $this->fields_form = array(); $helper->identifier = 'id_blocklink'; $helper->submit_action = 'submit'; $helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false).'&configure='.$this->name.'&tab_module='.$this->tab.'&module_name='.$this->name; $helper->token = Tools::getAdminTokenLite('AdminModules'); $helper->tpl_vars = array( 'fields_value' => $this->getConfigFieldsValues(), 'languages' => $this->context->controller->getLanguages(), 'id_language' => $this->context->language->id ); return $helper->generateForm(array($fields_form_1, $fields_form_2, $fields_form_3)); } public function getConfigFieldsValues() { $fields_values = array( 'id_blocklink' => Tools::getValue('id_blocklink'), 'url' => Tools::getValue('url'), 'newWindow' => Tools::getValue('newWindow'), 'orderWay' => Tools::getValue('orderWay', Configuration::get('PS_BLOCKLINK_ORDERWAY')), 'title_url' => Tools::getValue('title_url', Configuration::get('PS_BLOCKLINK_URL')), ); $languages = Language::getLanguages(false); foreach ($languages as $lang) { $fields_values['text'][$lang['id_lang']] = Tools::getValue('text_'.(int)$lang['id_lang']); $fields_values['title'][$lang['id_lang']] = Tools::getValue('title', Configuration::get('PS_BLOCKLINK_TITLE', $lang['id_lang'])); } if (Tools::getIsset('updateblocklink') && (int)Tools::getValue('id') > 0) $fields_values = array_merge($fields_values, $this->getLinkById((int)Tools::getValue('id'))); return $fields_values; } }