* @copyright 2007-2016 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; } include_once __DIR__ . '/classes/Badge.php'; include_once __DIR__ . '/classes/Advice.php'; include_once __DIR__ . '/classes/Condition.php'; include_once __DIR__ . '/classes/GamificationTools.php'; class gamification extends Module { // We recommend to not set it to true in production environment. const TEST_MODE = false; private $url_data = 'https://gamification.prestashop.com/json/'; private $cache_data; public function __construct() { $this->name = 'gamification'; $this->tab = 'administration'; $this->version = '2.5.0'; $this->author = 'PrestaShop'; $this->ps_versions_compliancy = [ 'min' => '1.6.1.0', ]; parent::__construct(); $this->displayName = $this->l('Merchant Expertise'); $this->description = $this->l('Become an e-commerce expert within the blink of an eye!'); $this->cache_data = __DIR__ . '/data/'; // @phpstan-ignore-next-line if (self::TEST_MODE === true) { $this->url_data .= 'test/'; } } public function install() { if (Db::getInstance()->getValue('SELECT `id_module` FROM `' . _DB_PREFIX_ . 'module` WHERE name =\'' . pSQL($this->name) . '\'')) { return true; } Tools::deleteDirectory($this->cache_data, false); return $this->installDb() && $this->installTab() && Configuration::updateGlobalValue('GF_INSTALL_CALC', 0) && Configuration::updateGlobalValue('GF_CURRENT_LEVEL', 1) && Configuration::updateGlobalValue('GF_CURRENT_LEVEL_PERCENT', 0) && Configuration::updateGlobalValue('GF_NOTIFICATION', 0) && parent::install() && $this->registerHook('actionAdminControllerSetMedia') && $this->registerHook('displayBackOfficeHeader') && $this->registerHook('displayAdminAfterHeader') ; } public function uninstall() { if (!parent::uninstall() || !$this->uninstallTab() || !$this->uninstallDb() || !Configuration::updateGlobalValue('GF_CURRENT_LEVEL', 1) || !Configuration::updateGlobalValue('GF_NOTIFICATION', 0) || !Configuration::updateGlobalValue('GF_INSTALL_CALC', 0) || !Configuration::updateGlobalValue('GF_CURRENT_LEVEL_PERCENT', 0)) { return false; } return true; } public function installDb() { $return = true; $sql = include __DIR__ . '/sql_install.php'; foreach ($sql as $s) { $return &= Db::getInstance()->execute($s); } return $return; } public function uninstallDb() { $sql = include __DIR__ . '/sql_install.php'; foreach ($sql as $name => $v) { Db::getInstance()->execute('DROP TABLE ' . $name); } return true; } public function installTab() { $tab = new Tab(); $tab->active = true; $tab->class_name = 'AdminGamification'; $tab->name = []; foreach (Language::getLanguages(true) as $lang) { $tab->name[$lang['id_lang']] = 'Merchant Expertise'; } if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) { //AdminPreferences $tab->id_parent = (int) Db::getInstance((bool) _PS_USE_SQL_SLAVE_) ->getValue( 'SELECT MIN(id_tab) FROM `' . _DB_PREFIX_ . 'tab` WHERE `class_name` = "' . pSQL('ShopParameters') . '"' ); } else { // AdminAdmin $tab->id_parent = (int) Tab::getIdFromClassName('AdminAdmin'); } $tab->module = $this->name; return $tab->add(); } public function uninstallTab() { $id_tab = (int) Tab::getIdFromClassName('AdminGamification'); if ($id_tab) { $tab = new Tab($id_tab); return $tab->delete(); } return false; } public function enable($force_all = false) { return parent::enable($force_all) && Tab::enablingForModule($this->name); } public function disable($force_all = false) { return parent::disable($force_all) && Tab::disablingForModule($this->name); } public function getContent() { Tools::redirectAdmin($this->context->link->getAdminLink('AdminGamification')); } public function __call($name, $arguments) { if (!empty(self::$_batch_mode)) { self::$_defered_func_call[__CLASS__ . '::__call_' . $name] = [[$this, '__call'], [$name, $arguments]]; } else { if (!Validate::isHookName($name)) { return false; } $name = str_replace('hook', '', $name); if ($retro_name = Db::getInstance()->getValue('SELECT `name` FROM `' . _DB_PREFIX_ . 'hook_alias` WHERE `alias` = \'' . pSQL($name) . '\'')) { $name = $retro_name; } $condition_ids = Condition::getIdsByHookCalculation($name); foreach ($condition_ids as $id) { $cond = new Condition((int) $id); $cond->processCalculation(); } } } public function isUpdating() { $db_version = Db::getInstance()->getValue('SELECT `version` FROM `' . _DB_PREFIX_ . 'module` WHERE `name` = \'' . pSQL($this->name) . '\''); return version_compare($this->version, $db_version, '>'); } public function hookActionAdminControllerSetMedia() { if ($this->isUpdating() || !Module::isEnabled($this->name)) { return; } if (method_exists($this->context->controller, 'addJquery')) { $this->context->controller->addCss($this->_path . 'views/css/gamification.css'); if (version_compare(_PS_VERSION_, '1.7.0.0', '<=')) { $this->context->controller->addCss($this->_path . 'views/css/gamification-1.6.css'); $this->context->controller->addJquery(); } $this->context->controller->addJs($this->_path . 'views/js/gamification_bt.js'); $this->context->controller->addJqueryPlugin('fancybox'); } } /** * Calls the server. * * @return bool|string * * @throws PrestaShopException */ public function hookDisplayBackOfficeHeader() { if ($this->isUpdating() || !Module::isEnabled($this->name)) { return false; } return ''; } public function renderHeaderNotification() { //check if currently updating check if module is currently processing update if ($this->isUpdating()) { return false; } $current_level = (int) Configuration::get('GF_CURRENT_LEVEL'); $current_level_percent = (int) Configuration::get('GF_CURRENT_LEVEL_PERCENT'); $badges_to_display = []; //retro compat $unlock_badges = []; $next_badges = []; $not_viewed_badge = explode('|', Configuration::get('GF_NOT_VIEWED_BADGE')); foreach ($not_viewed_badge as $id) { $unlock_badges[] = $badges_to_display[] = new Badge((int) $id, (int) $this->context->language->id); $next_badges[] = $badges_to_display[] = new Badge(end($badges_to_display)->getNextBadgeId(), (int) $this->context->language->id); } $this->context->smarty->assign([ 'link' => $this->context->link, 'current_level_percent' => $current_level_percent, 'current_level' => $current_level, 'badges_to_display' => $badges_to_display, 'unlock_badges' => $unlock_badges, 'next_badges' => $next_badges, 'current_id_tab' => (int) $this->context->controller->id, 'notification' => (int) Configuration::get('GF_NOTIFICATION'), 'advice_hide_url' => 'https://gamification.prestashop.com/api/AdviceHide/', ]); if (version_compare(_PS_VERSION_, '1.6.0', '>=')) { return $this->display(__FILE__, 'notification_bt.tpl'); } else { return $this->display(__FILE__, 'notification.tpl'); } } public function refreshDatas($iso_lang = null) { if (null === $iso_lang) { $iso_lang = $this->context->language->iso_code; } $default_iso_lang = Language::getIsoById((int) Configuration::get('PS_LANG_DEFAULT')); $id_lang = Language::getIdByIso($iso_lang); $iso_country = $this->context->country->iso_code; $iso_currency = $this->context->currency->iso_code; if ($iso_lang != $default_iso_lang) { $this->refreshDatas($default_iso_lang); } $cache_file = $this->cache_data . 'data_' . strtoupper($iso_lang) . '_' . strtoupper($iso_currency) . '_' . strtoupper($iso_country) . '.json'; if (!$this->isFresh($cache_file, 86400)) { if ($this->getData($iso_lang)) { $data = json_decode(Tools::file_get_contents($cache_file)); if (json_last_error() !== JSON_ERROR_NONE || !isset($data->signature)) { return false; } $this->processCleanAdvices(); $public_key = file_get_contents(__DIR__ . '/prestashop.pub'); $signature = isset($data->signature) ? base64_decode($data->signature) : ''; if (isset($data->conditions)) { if ( function_exists('openssl_verify') && self::TEST_MODE === false && isset($data->advices_lang) && !openssl_verify(json_encode([$data->conditions, $data->advices_lang]), $signature, $public_key) ) { return false; } $this->processImportConditions($data->conditions, $id_lang); } if (isset($data->badges) && isset($data->badges_lang)) { if (!isset($data->badges_only_visible_awb) && !isset($data->badges_only_visible_lang_awb)) { $this->processImportBadges($data->badges, $data->badges_lang, $id_lang); } else { $this->processImportBadges( array_merge($data->badges_only_visible_awb, $data->badges), array_merge($data->badges_only_visible_lang_awb, $data->badges_lang), $id_lang ); } } if (isset($data->advices) && isset($data->advices_lang)) { $this->processImportAdvices($data->advices, $data->advices_lang, $id_lang); } if (isset($data->advices_lang_16)) { if ( function_exists('openssl_verify') && self::TEST_MODE === false && !openssl_verify(json_encode([$data->advices_lang_16]), $signature, $public_key) ) { return false; } if (version_compare(_PS_VERSION_, '1.6.0', '>=') === true && isset($data->advices_16)) { $this->processImportAdvices($data->advices_16, $data->advices_lang_16, $id_lang); } } } } } public function getData($iso_lang = null) { if (null === $iso_lang) { $iso_lang = $this->context->language->iso_code; } $iso_country = $this->context->country->iso_code; $iso_currency = $this->context->currency->iso_code; $file_name = 'data_' . strtoupper($iso_lang) . '_' . strtoupper($iso_currency) . '_' . strtoupper($iso_country) . '.json'; $versioning = '?v=' . $this->version . '&ps_version=' . _PS_VERSION_; $data = GamificationTools::retrieveJsonApiFile($this->url_data . $file_name . $versioning); return (bool) file_put_contents($this->cache_data . 'data_' . strtoupper($iso_lang) . '_' . strtoupper($iso_currency) . '_' . strtoupper($iso_country) . '.json', $data, FILE_USE_INCLUDE_PATH); } public function processCleanAdvices() { $current_advices = []; $result = Db::getInstance()->ExecuteS('SELECT `id_advice`, `id_ps_advice` FROM `' . _DB_PREFIX_ . 'advice`'); foreach ($result as $row) { $current_advices[(int) $row['id_ps_advice']] = (int) $row['id_advice']; } // Delete advices that are not in the file anymore foreach ($current_advices as $id_advice) { // Check that the advice is used in this language $html = Db::getInstance()->getValue('SELECT `html` FROM `' . _DB_PREFIX_ . 'advice_lang` WHERE id_advice = ' . (int) $id_advice . ' AND id_lang = ' . (int) $this->context->language->id); if (!$html) { continue; } $adv = new Advice($id_advice); $adv->delete(); } } public function processImportConditions($conditions, $id_lang) { $current_conditions = []; $result = Db::getInstance()->ExecuteS('SELECT `id_ps_condition` FROM `' . _DB_PREFIX_ . 'condition`'); foreach ($result as $row) { $current_conditions[] = (int) $row['id_ps_condition']; } if (is_array($conditions) || is_object($conditions)) { foreach ($conditions as $condition) { if (isset($condition->id)) { unset($condition->id); } try { $cond = new Condition(); if (in_array($condition->id_ps_condition, $current_conditions)) { $cond = new Condition(Condition::getIdByIdPs($condition->id_ps_condition)); unset($current_conditions[(int) array_search($condition->id_ps_condition, $current_conditions)]); } $cond->hydrate((array) $condition, (int) $id_lang); $cond->date_upd = date('Y-m-d H:i:s', strtotime('-' . (int) $cond->calculation_detail . 'DAY')); $cond->date_add = date('Y-m-d H:i:s'); $condition->calculation_detail = trim($condition->calculation_detail); $cond->save(false, false); if ($condition->calculation_type == 'hook' && !$this->isRegisteredInHook($condition->calculation_detail) && Validate::isHookName($condition->calculation_detail)) { $this->registerHook($condition->calculation_detail); } unset($cond); } catch (Exception $e) { continue; } } } // Delete conditions that are not in the file anymore foreach ($current_conditions as $id_ps_condition) { $cond = new Condition(Condition::getIdByIdPs((int) $id_ps_condition)); $cond->delete(); } } public function processImportBadges($badges, $badges_lang, $id_lang) { $formated_badges_lang = []; foreach ($badges_lang as $lang) { $formated_badges_lang[$lang->id_ps_badge] = [ 'name' => [$id_lang => $lang->name], 'description' => [$id_lang => $lang->description], 'group_name' => [$id_lang => $lang->group_name], ]; } $current_badges = []; $result = Db::getInstance()->ExecuteS('SELECT `id_ps_badge` FROM `' . _DB_PREFIX_ . 'badge`'); foreach ($result as $row) { $current_badges[] = (int) $row['id_ps_badge']; } $cond_ids = $this->getFormatedConditionsIds(); foreach ($badges as $badge) { try { //if badge already exist we update language data if (in_array((int) $badge->id_ps_badge, $current_badges)) { $bdg = new Badge(Badge::getIdByIdPs((int) $badge->id_ps_badge)); $bdg->name[$id_lang] = $formated_badges_lang[$badge->id_ps_badge]['name'][$id_lang]; $bdg->description[$id_lang] = $formated_badges_lang[$badge->id_ps_badge]['description'][$id_lang]; $bdg->group_name[$id_lang] = $formated_badges_lang[$badge->id_ps_badge]['group_name'][$id_lang]; $bdg->update(); unset($current_badges[(int) array_search($badge->id_ps_badge, $current_badges)]); } else { $badge_data = array_merge((array) $badge, $formated_badges_lang[$badge->id_ps_badge]); $bdg = new Badge(); $bdg->hydrate($badge_data, (int) $id_lang); $bdg->add(); foreach ($badge->conditions as $cond) { Db::getInstance()->insert('condition_badge', ['id_condition' => $cond_ids[$cond], 'id_badge' => $bdg->id]); } } unset($bdg); } catch (Exception $e) { continue; } } // Delete badges that are not in the file anymore foreach ($current_badges as $id_ps_badge) { $bdg = new Badge(Badge::getIdByIdPs((int) $id_ps_badge)); $bdg->delete(); } } public function processImportAdvices($advices, $advices_lang, $id_lang) { $formated_advices_lang = []; foreach ($advices_lang as $lang) { $formated_advices_lang[$lang->id_ps_advice] = ['html' => [$id_lang => $lang->html]]; } $current_advices = []; $result = Db::getInstance()->ExecuteS('SELECT `id_advice`, `id_ps_advice` FROM `' . _DB_PREFIX_ . 'advice`'); foreach ($result as $row) { $current_advices[(int) $row['id_ps_advice']] = (int) $row['id_advice']; } $cond_ids = $this->getFormatedConditionsIds(); foreach ($advices as $advice) { try { //if advice already exist we update language data if (isset($current_advices[$advice->id_ps_advice])) { $adv = new Advice($current_advices[$advice->id_ps_advice]); $adv->html[$id_lang] = $formated_advices_lang[$advice->id_ps_advice]['html'][$id_lang]; $adv->update(); $this->processAdviceAsso($adv->id, $advice->display_conditions, $advice->hide_conditions, $advice->tabs, $cond_ids); unset($current_advices[$advice->id_ps_advice]); } else { $advice_data = array_merge((array) $advice, $formated_advices_lang[$advice->id_ps_advice]); $adv = new Advice(); $adv->hydrate($advice_data, (int) $id_lang); $adv->id_tab = (int) Tab::getIdFromClassName($advice->tab); $adv->add(); $this->processAdviceAsso($adv->id, $advice->display_conditions, $advice->hide_conditions, $advice->tabs, $cond_ids); } unset($adv); } catch (Exception $e) { continue; } } } public function processAdviceAsso($id_advice, $display_conditions, $hide_conditions, $tabs, $cond_ids) { Db::getInstance()->delete('condition_advice', 'id_advice=' . (int) $id_advice); if (is_array($display_conditions)) { foreach ($display_conditions as $cond) { Db::getInstance()->insert( 'condition_advice', [ 'id_condition' => (int) $cond_ids[$cond], 'id_advice' => (int) $id_advice, 'display' => 1, ] ); } } if (is_array($hide_conditions)) { foreach ($hide_conditions as $cond) { Db::getInstance()->insert( 'condition_advice', [ 'id_condition' => (int) $cond_ids[$cond], 'id_advice' => (int) $id_advice, 'display' => 0, ] ); } } Db::getInstance()->delete('tab_advice', 'id_advice=' . (int) $id_advice); if (isset($tabs) && is_array($tabs) && count($tabs)) { foreach ($tabs as $tab) { Db::getInstance()->insert( 'tab_advice', [ 'id_tab' => (int) Tab::getIdFromClassName($tab), 'id_advice' => (int) $id_advice, ] ); } } } public function getFormatedConditionsIds() { $cond_ids = []; $result = Db::getInstance()->executeS('SELECT `id_condition`, `id_ps_condition` FROM `' . _DB_PREFIX_ . 'condition`'); foreach ($result as $res) { $cond_ids[$res['id_ps_condition']] = $res['id_condition']; } return $cond_ids; } public function isFresh($file, $timeout = 86400000) { if (!file_exists($file)) { return false; } $lastFileUpdate = filemtime($file) + $timeout; $now = time(); return $now < $lastFileUpdate; } /** * Display PrestaShop Paylater with PayPlug & Oney * * @return string */ public function hookDisplayAdminAfterHeader() { // PrestaShop Paylater with PayPlug & Oney is available only from PrestaShop 1.7 if (version_compare(_PS_VERSION_, '1.7.0.0', '<')) { return ''; } // Display PrestaShop Paylater with PayPlug & Oney only if PrestaShop Checkout is enabled and onboarded for FR & IT located merchant if ('AdminPayment' === Tools::getValue('controller') && in_array($this->getShopCountryCode(), ['FR', 'IT'], true) && Module::isEnabled('ps_checkout') && Configuration::get('PS_CHECKOUT_PAYPAL_ID_MERCHANT') ) { $this->context->smarty->assign([ 'pspaylater_install_link' => $this->getModuleInstallUrl('pspaylater'), 'pspaylater_configure_link' => $this->context->link->getAdminLink('AdminModules', true) . '&configure=pspaylater', 'pspaylater_img_path' => $this->getPathUri() . 'views/img/pspaylater.png', 'pspaylater_enabled' => Module::isEnabled('pspaylater'), ]); return $this->display(__FILE__, 'displayBackOfficeHeader.tpl'); } return ''; } /** * @return string */ private function getShopCountryCode() { $defaultCountry = ''; if (empty($defaultCountry) && Configuration::hasKey('PS_COUNTRY_DEFAULT')) { $defaultCountry = (new Country((int) Configuration::get('PS_COUNTRY_DEFAULT')))->iso_code; } return $defaultCountry ? strtoupper($defaultCountry) : ''; } /** * @param string $name * * @return string */ private function getModuleInstallUrl($name) { if (version_compare(_PS_VERSION_, '1.7.0.0', '>=')) { return $this->context->link->getAdminLink( 'AdminModulesSf', true, [ 'route' => 'admin_module_manage_action', 'action' => 'install', 'module_name' => $name, ] ); } return $this->context->link->getAdminLink('AdminModules') . '&install=' . $name . '&tab_module=payments_gateways&module_name=' . $name . '&anchor=' . ucfirst($name); } }