* @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 PagesNotFound extends Module
{
private $html = '';
public function __construct()
{
$this->name = 'pagesnotfound';
$this->tab = 'analytics_stats';
$this->version = '1.3.3';
$this->author = 'PrestaShop';
$this->need_instance = 0;
parent::__construct();
$this->displayName = $this->l('Pages not found');
$this->description = $this->l('Adds a tab to the Stats dashboard, showing the pages requested by your visitors that have not been found.');
}
public function install()
{
if (!parent::install() || !$this->registerHook('top') || !$this->registerHook('AdminStatsModules'))
return false;
return Db::getInstance()->execute(
'CREATE TABLE `'._DB_PREFIX_.'pagenotfound` (
id_pagenotfound INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
id_shop INTEGER UNSIGNED NOT NULL DEFAULT \'1\',
id_shop_group INTEGER UNSIGNED NOT NULL DEFAULT \'1\',
request_uri VARCHAR(256) NOT NULL,
http_referer VARCHAR(256) NOT NULL,
date_add DATETIME NOT NULL,
PRIMARY KEY(id_pagenotfound),
INDEX (`date_add`)
) ENGINE='._MYSQL_ENGINE_.' DEFAULT CHARSET=utf8;'
);
}
public function uninstall()
{
return (parent::uninstall() && Db::getInstance()->execute('DROP TABLE `'._DB_PREFIX_.'pagenotfound`'));
}
private function getPages()
{
$sql = 'SELECT http_referer, request_uri, COUNT(*) as nb
FROM `'._DB_PREFIX_.'pagenotfound`
WHERE date_add BETWEEN '.ModuleGraph::getDateBetween()
.Shop::addSqlRestriction().
'GROUP BY http_referer, request_uri';
$result = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS($sql);
$pages = array();
foreach ($result as $row)
{
$row['http_referer'] = parse_url($row['http_referer'], PHP_URL_HOST).parse_url($row['http_referer'], PHP_URL_PATH);
if (!isset($row['http_referer']) || empty($row['http_referer']))
$row['http_referer'] = '--';
if (!isset($pages[$row['request_uri']]))
$pages[$row['request_uri']] = array('nb' => 0);
$pages[$row['request_uri']][$row['http_referer']] = $row['nb'];
$pages[$row['request_uri']]['nb'] += $row['nb'];
}
uasort($pages, 'pnfSort');
return $pages;
}
public function hookAdminStatsModules()
{
if (Tools::isSubmit('submitTruncatePNF'))
{
Db::getInstance()->execute('TRUNCATE `'._DB_PREFIX_.'pagenotfound`');
$this->html .= ' '.$this->l('The "pages not found" cache has been emptied.').'
';
} else if (Tools::isSubmit('submitDeletePNF'))
{
Db::getInstance()->execute(
'DELETE FROM `'._DB_PREFIX_.'pagenotfound`
WHERE date_add BETWEEN '.ModuleGraph::getDateBetween()
);
$this->html .= ' '.$this->l('The "pages not found" cache has been deleted.').'
';
}
$this->html .= '
'.$this->displayName.'
'.$this->l('Guide').'
'.$this->l('404 errors').'
'
.$this->l('A 404 error is an HTTP error code which means that the file requested by the user cannot be found. In your case it means that one of your visitors entered a wrong URL in the address bar, or that you or another website has a dead link. When possible, the referrer is shown so you can find the page/site which contains the dead link. If not, it generally means that it is a direct access, so someone may have bookmarked a link which doesn\'t exist anymore.').'
'.$this->l('How to catch these errors?').'
'
.sprintf($this->l('If your webhost supports .htaccess files, you can create one in the root directory of PrestaShop and insert the following line inside: "%s".'), 'ErrorDocument 404 '.__PS_BASE_URI__.'404.php').'
'.
sprintf($this->l('A user requesting a page which doesn\'t exist will be redirected to the following page: %s. This module logs access to this page.'), __PS_BASE_URI__.'404.php').'
';
if (!file_exists(dirname(__FILE__).'/../../.htaccess'))
$this->html .= ''.$this->l('You must use a .htaccess file to redirect 404 errors to the "404.php" page.').'
';
$pages = $this->getPages();
if (count($pages))
{
$this->html .= '
';
} else
$this->html .= ' '.$this->l('No "page not found" issue registered for now.').'
';
if (count($pages))
$this->html .= '
'.$this->l('Empty database').'
';
return $this->html;
}
public function hookTop($params)
{
if (strstr($_SERVER['REQUEST_URI'], '404.php') && isset($_SERVER['REDIRECT_URL']))
$_SERVER['REQUEST_URI'] = $_SERVER['REDIRECT_URL'];
if (!Validate::isUrl($request_uri = $_SERVER['REQUEST_URI']) || strstr($_SERVER['REQUEST_URI'], '-admin404'))
return;
if (get_class(Context::getContext()->controller) == 'PageNotFoundController')
{
$http_referer = isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '';
if (empty($http_referer) || Validate::isAbsoluteUrl($http_referer))
{
Db::getInstance()->execute(
'
INSERT INTO `'._DB_PREFIX_.'pagenotfound` (`request_uri`, `http_referer`, `date_add`, `id_shop`, `id_shop_group`)
VALUES (\''.pSQL($request_uri).'\', \''.pSQL($http_referer).'\', NOW(), '.(int)$this->context->shop->id.', '.(int)$this->context->shop->id_shop_group.')
'
);
}
}
}
}
function pnfSort($a, $b)
{
if ($a['nb'] == $b['nb'])
return 0;
return ($a['nb'] > $b['nb']) ? -1 : 1;
}