Files
taome/controllers/admin/AdminReferrersController.php
2020-10-07 10:37:15 +02:00

526 lines
22 KiB
PHP

<?php
/**
* 2007-2019 PrestaShop and Contributors
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 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/OSL-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 license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://www.prestashop.com for more information.
*
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2007-2019 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
use PrestaShop\PrestaShop\Core\Addon\Module\ModuleManagerBuilder;
/**
* @property Referrer $object
*/
class AdminReferrersControllerCore extends AdminController
{
public function __construct()
{
$this->bootstrap = true;
$this->table = 'referrer';
$this->className = 'Referrer';
parent::__construct();
$this->fields_list = array(
'id_referrer' => array(
'title' => $this->trans('ID', array(), 'Admin.Global'),
'width' => 25,
'align' => 'center',
),
'name' => array(
'title' => $this->trans('Name', array(), 'Admin.Global'),
'width' => 80,
),
'cache_visitors' => array(
'title' => $this->trans('Visitors', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'cache_visits' => array(
'title' => $this->trans('Visits', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'cache_pages' => array(
'title' => $this->trans('Pages', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'cache_registrations' => array(
'title' => $this->trans('Reg.', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'cache_orders' => array(
'title' => $this->trans('Orders', array(), 'Admin.Global'),
'width' => 30,
'align' => 'center',
),
'cache_sales' => array(
'title' => $this->trans('Sales', array(), 'Admin.Global'),
'width' => 80,
'align' => 'right',
'prefix' => '<b>',
'suffix' => '</b>',
'price' => true,
),
'cart' => array(
'title' => $this->trans('Avg. cart', array(), 'Admin.Shopparameters.Feature'),
'width' => 50,
'align' => 'right',
'price' => true,
'havingFilter' => true,
),
'cache_reg_rate' => array(
'title' => $this->trans('Reg. rate', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'cache_order_rate' => array(
'title' => $this->trans('Order rate', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'center',
),
'fee0' => array(
'title' => $this->trans('Click', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'right',
'price' => true,
'havingFilter' => true,
),
'fee1' => array(
'title' => $this->trans('Base', array(), 'Admin.Shopparameters.Feature'),
'width' => 30,
'align' => 'right',
'price' => true,
'havingFilter' => true,
),
'fee2' => array(
'title' => $this->trans('Percent', array(), 'Admin.Global'),
'width' => 30,
'align' => 'right',
'price' => true,
'havingFilter' => true,
),
);
$this->bulk_actions = array(
'delete' => array(
'text' => $this->trans('Delete selected', array(), 'Admin.Actions'),
'confirm' => $this->trans('Delete selected items?', array(), 'Admin.Notifications.Warning'),
'icon' => 'icon-trash',
),
);
}
public function setMedia($isNewTheme = false)
{
parent::setMedia($isNewTheme);
$this->context->controller->addJqueryUI('ui.datepicker');
}
public function initPageHeaderToolbar()
{
if (empty($this->display)) {
$this->page_header_toolbar_btn['new_referrer'] = array(
'href' => self::$currentIndex . '&addreferrer&token=' . $this->token,
'desc' => $this->trans('Add new referrer', array(), 'Admin.Shopparameters.Feature'),
'icon' => 'process-icon-new',
);
}
parent::initPageHeaderToolbar();
}
public function renderList()
{
// Display list Referrers:
$this->addRowAction('view');
$this->addRowAction('edit');
$this->addRowAction('delete');
$this->_select = 'SUM(sa.cache_visitors) AS cache_visitors, SUM(sa.cache_visits) AS cache_visits, SUM(sa.cache_pages) AS cache_pages,
SUM(sa.cache_registrations) AS cache_registrations, SUM(sa.cache_orders) AS cache_orders, SUM(sa.cache_sales) AS cache_sales,
IF(sa.cache_orders > 0, ROUND(sa.cache_sales/sa.cache_orders, 2), 0) as cart, (sa.cache_visits*click_fee) as fee0,
(sa.cache_orders*base_fee) as fee1, (sa.cache_sales*percent_fee/100) as fee2';
$this->_join = '
LEFT JOIN `' . _DB_PREFIX_ . 'referrer_shop` sa
ON (sa.`' . bqSQL($this->identifier) . '` = a.`' . bqSQL($this->identifier) . '` AND sa.id_shop IN (' . implode(', ', Shop::getContextListShopID()) . '))';
$this->_group = 'GROUP BY sa.id_referrer';
$this->tpl_list_vars = array(
'enable_calendar' => $this->enableCalendar(),
'calendar_form' => $this->displayCalendar(),
'settings_form' => $this->displaySettings(),
);
return parent::renderList();
}
public function renderForm()
{
$uri = Tools::getHttpHost(true, true) . __PS_BASE_URI__;
$this->fields_form[0] = array('form' => array(
'legend' => array(
'title' => $this->trans('Affiliate', array(), 'Admin.Shopparameters.Feature'),
'icon' => 'icon-group',
),
'input' => array(
array(
'type' => 'text',
'label' => $this->trans('Name', array(), 'Admin.Global'),
'name' => 'name',
'required' => true,
'autocomplete' => false,
),
array(
'type' => 'password',
'label' => $this->trans('Password', array(), 'Admin.Global'),
'name' => 'passwd',
'desc' => $this->trans('Leave blank if no change.', array(), 'Admin.Shopparameters.Help'),
'autocomplete' => false,
),
),
'submit' => array('title' => $this->trans('Save', array(), 'Admin.Actions')),
));
$moduleManagerBuilder = ModuleManagerBuilder::getInstance();
$moduleManager = $moduleManagerBuilder->build();
if ($moduleManager->isInstalled('trackingfront')) {
$this->fields_form[0]['form']['desc'] = array(
$this->trans('Affiliates can access their data with this name and password.', array(), 'Admin.Shopparameters.Feature'),
$this->trans('Front access:', array(), 'Admin.Shopparameters.Feature') . ' <a class="btn btn-link" href="' . $uri . 'modules/trackingfront/stats.php" onclick="return !window.open(this.href);"><i class="icon-external-link-sign"></i> ' . $uri . 'modules/trackingfront/stats.php</a>',
);
} else {
$this->fields_form[0]['form']['desc'] = array(
$this->trans(
'Please install the "%modulename%" module in order to give your affiliates access to their own statistics.',
array(
'%modulename%' => Module::getModuleName('trackingfront'),
),
'Admin.Shopparameters.Notification'
),
);
}
$this->fields_form[1] = array('form' => array(
'legend' => array(
'title' => $this->trans('Commission plan', array(), 'Admin.Shopparameters.Feature'),
'icon' => 'icon-dollar',
),
'input' => array(
array(
'type' => 'text',
'label' => $this->trans('Click fee', array(), 'Admin.Shopparameters.Feature'),
'name' => 'click_fee',
'desc' => $this->trans('Fee given for each visit.', array(), 'Admin.Shopparameters.Help'),
),
array(
'type' => 'text',
'label' => $this->trans('Base fee', array(), 'Admin.Shopparameters.Feature'),
'name' => 'base_fee',
'desc' => $this->trans('Fee given for each order placed.', array(), 'Admin.Shopparameters.Help'),
),
array(
'type' => 'text',
'label' => $this->trans('Percent fee', array(), 'Admin.Shopparameters.Feature'),
'name' => 'percent_fee',
'desc' => $this->trans('Percent of the sales.', array(), 'Admin.Shopparameters.Notification'),
),
),
'submit' => array('title' => $this->trans('Save', array(), 'Admin.Actions')),
));
if (Shop::isFeatureActive()) {
$this->fields_form[1]['form']['input'][] = array(
'type' => 'shop',
'label' => $this->trans('Shop association', array(), 'Admin.Global'),
'name' => 'checkBoxShopAsso',
);
}
$this->fields_form[2] = array('form' => array(
'legend' => array(
'title' => $this->trans('Technical information -- Simple mode', array(), 'Admin.Shopparameters.Feature'),
'icon' => 'icon-cogs',
),
'help' => true,
'input' => array(
array(
'type' => 'textarea',
'label' => $this->trans('Include', array(), 'Admin.Shopparameters.Feature'),
'name' => 'http_referer_like',
'cols' => 40,
'rows' => 1,
'legend' => $this->trans('HTTP referrer', array(), 'Admin.Shopparameters.Feature'),
),
array(
'type' => 'textarea',
'label' => $this->trans('Exclude', array(), 'Admin.Shopparameters.Feature'),
'name' => 'http_referer_like_not',
'cols' => 40,
'rows' => 1,
),
array(
'type' => 'textarea',
'label' => $this->trans('Include', array(), 'Admin.Shopparameters.Feature'),
'name' => 'request_uri_like',
'cols' => 40,
'rows' => 1,
'legend' => $this->trans('Request URI', array(), 'Admin.Shopparameters.Feature'),
),
array(
'type' => 'textarea',
'label' => $this->trans('Exclude', array(), 'Admin.Shopparameters.Feature'),
'name' => 'request_uri_like_not',
'cols' => 40,
'rows' => 1,
),
),
'desc' => $this->trans(
'If you know how to use MySQL regular expressions, you can use the [1]expert mode[/1].',
array(
'[1]' => '<a style="cursor: pointer; font-weight: bold;" onclick="$(\'#tracking_expert\').slideToggle();">',
'[/1]' => '</a>',
),
'Admin.Shopparameters.Help'
),
'submit' => array(
'title' => $this->trans('Save', array(), 'Admin.Actions'),
),
));
$this->fields_form[3] = array('form' => array(
'legend' => array(
'title' => $this->trans('Technical information -- Expert mode', array(), 'Admin.Shopparameters.Feature'),
'icon' => 'icon-cogs',
),
'input' => array(
array(
'type' => 'textarea',
'label' => $this->trans('Include', array(), 'Admin.Shopparameters.Feature'),
'name' => 'http_referer_regexp',
'cols' => 40,
'rows' => 1,
'legend' => $this->trans('HTTP referrer', array(), 'Admin.Shopparameters.Feature'),
),
array(
'type' => 'textarea',
'label' => $this->trans('Exclude', array(), 'Admin.Shopparameters.Feature'),
'name' => 'http_referer_regexp_not',
'cols' => 40,
'rows' => 1,
),
array(
'type' => 'textarea',
'label' => $this->trans('Include', array(), 'Admin.Shopparameters.Feature'),
'name' => 'request_uri_regexp',
'cols' => 40,
'rows' => 1,
'legend' => $this->trans('Request URI', array(), 'Admin.Shopparameters.Feature'),
),
array(
'type' => 'textarea',
'label' => $this->trans('Exclude', array(), 'Admin.Shopparameters.Feature'),
'name' => 'request_uri_regexp_not',
'cols' => 40,
'rows' => 1,
),
),
));
$this->multiple_fieldsets = true;
if (!($obj = $this->loadObject(true))) {
return;
}
$this->fields_value = array(
'click_fee' => number_format((float) ($this->getFieldValue($obj, 'click_fee')), 2),
'base_fee' => number_format((float) ($this->getFieldValue($obj, 'base_fee')), 2),
'percent_fee' => number_format((float) ($this->getFieldValue($obj, 'percent_fee')), 2),
'http_referer_like' => str_replace('\\', '\\\\', htmlentities($this->getFieldValue($obj, 'http_referer_like'), ENT_COMPAT, 'UTF-8')),
'http_referer_like_not' => str_replace('\\', '\\\\', htmlentities($this->getFieldValue($obj, 'http_referer_like_not'), ENT_COMPAT, 'UTF-8')),
'request_uri_like' => str_replace('\\', '\\\\', htmlentities($this->getFieldValue($obj, 'request_uri_like'), ENT_COMPAT, 'UTF-8')),
'request_uri_like_not' => str_replace('\\', '\\\\', htmlentities($this->getFieldValue($obj, 'request_uri_like_not'), ENT_COMPAT, 'UTF-8')),
);
$this->tpl_form_vars = array('uri' => $uri);
return parent::renderForm();
}
public function displayAjaxProductFilter()
{
$this->ajaxRender(
Referrer::getAjaxProduct(
(int) Tools::getValue('id_referrer'),
(int) Tools::getValue('id_product'),
new Employee((int) Tools::getValue('id_employee'))
));
}
public function displayAjaxFillProducts()
{
$json_array = array();
$result = Db::getInstance()->executeS('
SELECT p.id_product, pl.name
FROM ' . _DB_PREFIX_ . 'product p
LEFT JOIN ' . _DB_PREFIX_ . 'product_lang pl
ON (p.id_product = pl.id_product AND pl.id_lang = ' . (int) Tools::getValue('id_lang') . ')
' . (Tools::getValue('filter') != 'undefined' ? 'WHERE name LIKE "%' . pSQL(Tools::getValue('filter')) . '%"' : '')
);
foreach ($result as $row) {
$json_array[] = [
'id_product' => (int) $row['id_product'],
'name' => $row['name'],
];
}
$this->ajaxRender('[' . implode(',', $json_array) . ']');
}
public function displayCalendar($action = null, $table = null, $identifier = null, $id = null)
{
return AdminReferrersController::displayCalendarForm(array(
'Calendar' => $this->trans('Calendar', array(), 'Admin.Global'),
'Day' => $this->trans('Today', array(), 'Admin.Global'),
'Month' => $this->trans('Month', array(), 'Admin.Global'),
'Year' => $this->trans('Year', array(), 'Admin.Global'),
), $this->token, $action, $table, $identifier, $id);
}
public static function displayCalendarForm($translations, $token, $action = null, $table = null, $identifier = null, $id = null)
{
$context = Context::getContext();
$tpl = $context->controller->createTemplate('calendar.tpl');
$context->controller->addJqueryUI('ui.datepicker');
$tpl->assign(array(
'current' => self::$currentIndex,
'token' => $token,
'action' => $action,
'table' => $table,
'identifier' => $identifier,
'id' => $id,
'translations' => $translations,
'datepickerFrom' => Tools::getValue('datepickerFrom', $context->employee->stats_date_from),
'datepickerTo' => Tools::getValue('datepickerTo', $context->employee->stats_date_to),
));
return $tpl->fetch();
}
public function displaySettings()
{
if (!Tools::isSubmit('viewreferrer')) {
$tpl = $this->createTemplate('form_settings.tpl');
$statsdata = Module::getInstanceByName('statsdata');
$statsdata_name = false;
if (Validate::isLoadedObject($statsdata)) {
$statsdata_name = $statsdata->displayName;
}
$tpl->assign(array(
'statsdata_name' => $statsdata_name,
'current' => self::$currentIndex,
'token' => $this->token,
'tracking_dt' => (int) Tools::getValue('tracking_dt', Configuration::get('TRACKING_DIRECT_TRAFFIC')),
'exclude_tx' => (int) Tools::getValue('exclude_tx', Configuration::get('REFERER_TAX')),
'exclude_ship' => (int) Tools::getValue('exclude_ship', Configuration::get('REFERER_SHIPPING')),
));
return $tpl->fetch();
}
}
protected function enableCalendar()
{
return !Tools::isSubmit('add' . $this->table) && !Tools::isSubmit('submitAdd' . $this->table) && !Tools::isSubmit('update' . $this->table);
}
public function postProcess()
{
if ($this->enableCalendar()) {
// Warning, instantiating a controller here changes the controller in the Context...
$calendar_tab = new AdminStatsController();
$calendar_tab->postProcess();
// ...so we set it back to the correct one here
$this->context->controller = $this;
}
if (Tools::isSubmit('submitSettings')) {
if ($this->access('edit')) {
if (Configuration::updateValue('TRACKING_DIRECT_TRAFFIC', (int) Tools::getValue('tracking_dt'))
&& Configuration::updateValue('REFERER_TAX', (int) Tools::getValue('exclude_tx'))
&& Configuration::updateValue('REFERER_SHIPPING', (int) Tools::getValue('exclude_ship'))) {
Tools::redirectAdmin(self::$currentIndex . '&conf=4&token=' . Tools::getValue('token'));
}
}
}
if (ModuleGraph::getDateBetween() != Configuration::get('PS_REFERRERS_CACHE_LIKE') || Tools::isSubmit('submitRefreshCache')) {
Referrer::refreshCache();
}
if (Tools::isSubmit('submitRefreshIndex')) {
Referrer::refreshIndex();
}
return parent::postProcess();
}
public function renderView()
{
$referrer = new Referrer((int) Tools::getValue('id_referrer'));
$display_tab = array(
'uniqs' => $this->trans('Unique visitors', array(), 'Admin.Shopparameters.Feature'),
'visitors' => $this->trans('Visitors', array(), 'Admin.Shopparameters.Feature'),
'visits' => $this->trans('Visits', array(), 'Admin.Shopparameters.Feature'),
'pages' => $this->trans('Pages viewed', array(), 'Admin.Shopparameters.Feature'),
'registrations' => $this->trans('Registrations', array(), 'Admin.Shopparameters.Feature'),
'orders' => $this->trans('Orders', array(), 'Admin.Global'),
'sales' => $this->trans('Sales', array(), 'Admin.Global'),
'reg_rate' => $this->trans('Registration rate', array(), 'Admin.Shopparameters.Feature'),
'order_rate' => $this->trans('Order rate', array(), 'Admin.Shopparameters.Feature'),
'click_fee' => $this->trans('Click fee', array(), 'Admin.Shopparameters.Feature'),
'base_fee' => $this->trans('Base fee', array(), 'Admin.Shopparameters.Feature'),
'percent_fee' => $this->trans('Percent fee', array(), 'Admin.Shopparameters.Feature'),
);
$this->tpl_view_vars = array(
'enable_calendar' => $this->enableCalendar(),
'calendar_form' => $this->displayCalendar($this->action, $this->table, $this->identifier, (int) Tools::getValue($this->identifier)),
'referrer' => $referrer,
'display_tab' => $display_tab,
'id_employee' => (int) $this->context->employee->id,
'id_lang' => (int) $this->context->language->id,
);
return parent::renderView();
}
}