Initial commit

modules/pagesnotfound/CHANGELOG.txt

@@ -0,0 +1,3 @@
+2014-04-17 11:35:25 +0200	Bug fix (PS 1.5): ps_version_compliancy removed
+2014-03-24 15:22:14 +0100	/ MO pagesnotfound : ps_versions_compliancy added
+2014-03-20 14:35:27 +0100	Initial commit

modules/pagesnotfound/config.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<module>
+	<name>pagesnotfound</name>
+	<displayName><![CDATA[Pages not found]]></displayName>
+	<version><![CDATA[2.0.0]]></version>
+	<description><![CDATA[Displays the pages requested by your visitors that have not been found.]]></description>
+	<author><![CDATA[PrestaShop]]></author>
+	<tab><![CDATA[analytics_stats]]></tab>
+	<is_configurable>0</is_configurable>
+	<need_instance>0</need_instance>
+	<limited_countries></limited_countries>
+</module>

modules/pagesnotfound/config_fr.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<module>
+    <name>pagesnotfound</name>
+    <displayName><![CDATA[Pages introuvables]]></displayName>
+    <version><![CDATA[2.0.0]]></version>
+    <description><![CDATA[Ajoute un onglet au tableau de bord de statistiques, affichant les pages demand&eacute;es par vos visiteurs mais qui n&#039;ont pas &eacute;t&eacute; trouv&eacute;es.]]></description>
+    <author><![CDATA[PrestaShop]]></author>
+    <tab><![CDATA[analytics_stats]]></tab>
+    <is_configurable>0</is_configurable>
+    <need_instance>0</need_instance>
+	<limited_countries></limited_countries>
+</module>

modules/pagesnotfound/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 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:
+* http://opensource.org/licenses/afl-3.0.php
+* 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 http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @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
+*/
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: '.gmdate('D, d M Y H:i:s').' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

modules/pagesnotfound/pagesnotfound.php

@@ -0,0 +1,224 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 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:
+* http://opensource.org/licenses/afl-3.0.php
+* 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 http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @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;
+
+class PagesNotFound extends Module
+{
+	private $html = '';
+
+	public function __construct()
+	{
+		$this->name = 'pagesnotfound';
+		$this->tab = 'analytics_stats';
+		$this->version = '2.0.0';
+		$this->author = 'PrestaShop';
+		$this->need_instance = 0;
+
+		parent::__construct();
+
+		$this->displayName = $this->trans('Pages not found', array(), 'Modules.Pagesnotfound.Admin');
+		$this->description = $this->trans('Adds a tab to the Stats dashboard, showing the pages requested by your visitors that have not been found.', array(), 'Modules.Pagesnotfound.Admin');
+		$this->ps_versions_compliancy = array('min' => '1.7.1.0', 'max' => _PS_VERSION_);
+	}
+
+	public function install()
+	{
+		if (defined(_PS_VERSION_) && version_compare(_PS_VERSION_, '1.5.0.1', '>=')) {
+			$hookName = 'displayTop';
+		} else {
+			$hookName = 'top';
+		}
+		if (!parent::install() || !$this->registerHook($hookName) || !$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 .= '<div class="alert alert-warning"> '.$this->trans('The "pages not found" cache has been emptied.', array(), 'Modules.Pagesnotfound.Admin').'</div>';
+		} else if (Tools::isSubmit('submitDeletePNF'))
+		{
+			Db::getInstance()->execute(
+				'DELETE FROM `'._DB_PREFIX_.'pagenotfound`
+				WHERE date_add BETWEEN '.ModuleGraph::getDateBetween()
+			);
+			$this->html .= '<div class="alert alert-warning"> '.$this->trans('The "pages not found" cache has been deleted.', array(), 'Modules.Pagesnotfound.Admin').'</div>';
+		}
+
+		$this->html .= '
+			<div class="panel-heading">
+				'.$this->displayName.'
+			</div>
+			<h4>'.$this->trans('Guide', array(), 'Modules.Pagesnotfound.Admin').'</h4>
+			<div class="alert alert-warning">
+				<h4>'.$this->trans('404 errors', array(), 'Modules.Pagesnotfound.Admin').'</h4>
+				<p>'
+			.$this->trans('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.', array(), 'Modules.Pagesnotfound.Admin').'
+				</p>
+				<p>&nbsp;</p>
+				<h4>'.$this->trans('How to catch these errors?', array(), 'Modules.Pagesnotfound.Admin').'</h4>
+				<p>'
+			.sprintf($this->trans('If your webhost supports .htaccess files, you can create one in the root directory of PrestaShop and insert the following line inside: "%s".', array(), 'Modules.Pagesnotfound.Admin'), 'ErrorDocument 404 '.__PS_BASE_URI__.'404.php').'<br />'.
+			sprintf($this->trans('A user requesting a page which doesn\'t exist will be redirected to the following page: %s. This module logs access to this page.', array(), 'Modules.Pagesnotfound.Admin'), __PS_BASE_URI__.'404.php').'
+				</p>
+			</div>';
+		if (!file_exists($this->_normalizeDirectory(_PS_ROOT_DIR_).'.htaccess'))
+			$this->html .= '<div class="alert alert-warning">'.$this->trans('You must use a .htaccess file to redirect 404 errors to the "404.php" page.', array(), 'Modules.Pagesnotfound.Admin').'</div>';
+
+		$pages = $this->getPages();
+		if (count($pages))
+		{
+			$this->html .= '
+			<table class="table">
+				<thead>
+					<tr>
+						<th><span class="title_box active">'.$this->trans('Page', array(), 'Modules.Pagesnotfound.Admin').'</span></th>
+						<th><span class="title_box active">'.$this->trans('Referrer', array(), 'Modules.Pagesnotfound.Admin').'</span></th>
+						<th><span class="title_box active">'.$this->trans('Counter', array(), 'Modules.Pagesnotfound.Admin').'</span></th>
+					</tr>
+				</thead>
+				<tbody>';
+			foreach ($pages as $ru => $hrs)
+				foreach ($hrs as $hr => $counter)
+					if ($hr != 'nb')
+						$this->html .= '
+						<tr>
+							<td><a href="'.$ru.'-admin404">'.wordwrap($ru, 30, '<br />', true).'</a></td>
+							<td><a href="'.Tools::getProtocol().$hr.'">'.wordwrap($hr, 40, '<br />', true).'</a></td>
+							<td>'.$counter.'</td>
+						</tr>';
+			$this->html .= '
+				</tbody>
+			</table>';
+		} else
+			$this->html .= '<div class="alert alert-warning"> '.$this->trans('No "page not found" issue registered for now.', array(), 'Modules.Pagesnotfound.Admin').'</div>';
+
+		if (count($pages))
+			$this->html .= '
+				<h4>'.$this->trans('Empty database', array(), 'Modules.Pagesnotfound.Admin').'</h4>
+				<form action="'.Tools::htmlEntitiesUtf8($_SERVER['REQUEST_URI']).'" method="post">
+					<button type="submit" class="btn btn-default" name="submitDeletePNF">
+						<i class="icon-remove"></i> '.$this->trans('Empty ALL "pages not found" notices for this period', array(), 'Modules.Pagesnotfound.Admin').'
+					</button>
+					<button type="submit" class="btn btn-default" name="submitTruncatePNF">
+						<i class="icon-remove"></i> '.$this->trans('Empty ALL "pages not found" notices', array(), 'Modules.Pagesnotfound.Admin').'
+					</button>
+				</form>';
+
+		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.')
+				'
+				);
+			}
+		}
+	}
+
+	private function _normalizeDirectory($directory)
+	{
+		$last = $directory[strlen($directory) - 1];
+
+		if (in_array($last, array('/', '\\')))
+		{
+			$directory[strlen($directory) - 1] = DIRECTORY_SEPARATOR;
+			return $directory;
+		}
+
+		$directory .= DIRECTORY_SEPARATOR;
+		return $directory;
+	}
+}
+
+function pnfSort($a, $b)
+{
+	if ($a['nb'] == $b['nb'])
+		return 0;
+
+	return ($a['nb'] > $b['nb']) ? -1 : 1;
+}

modules/pagesnotfound/translations/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2016 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 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:
+* http://opensource.org/licenses/afl-3.0.php
+* 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 http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <contact@prestashop.com>
+*  @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
+*/
+				    	
+header("Expires: Mon, 26 Jul 1997 05:00:00 GMT");
+header("Last-Modified: ".gmdate("D, d M Y H:i:s")." GMT");
+						
+header("Cache-Control: no-store, no-cache, must-revalidate");
+header("Cache-Control: post-check=0, pre-check=0", false);
+header("Pragma: no-cache");
+						
+header("Location: ../");
+exit;