-
Notifications
You must be signed in to change notification settings - Fork 12
/
pagesnotfound.php
233 lines (207 loc) · 10.2 KB
/
pagesnotfound.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License version 3.0
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/AFL-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 [email protected] so we can send you a copy immediately.
*
* @author PrestaShop SA and Contributors <[email protected]>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
*/
if (!defined('_PS_VERSION_')) {
exit;
}
class PagesNotFound extends Module
{
private $html = '';
public function __construct()
{
$this->name = 'pagesnotfound';
$this->tab = 'administration';
$this->version = '3.0.0';
$this->author = 'PrestaShop';
$this->need_instance = 0;
parent::__construct();
$this->displayName = $this->trans('Pages not found', [], 'Modules.Pagesnotfound.Admin');
$this->description = $this->trans('Enrich your stats, display the pages requested by your visitors that could not be found.', [], 'Modules.Pagesnotfound.Admin');
$this->ps_versions_compliancy = ['min' => '1.7.7', 'max' => _PS_VERSION_];
}
public function install()
{
if (!parent::install()
|| !$this->registerHook('displayTop')
|| !$this->registerHook('displayAdminStatsModules')
) {
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((bool) _PS_USE_SQL_SLAVE_)->executeS($sql);
$pages = [];
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']] = ['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 hookDisplayAdminStatsModules()
{
$this->context->controller->addCSS($this->_path . 'views/css/stacking_responsive.css');
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.', [], 'Modules.Pagesnotfound.Admin') . '</div>';
} elseif (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.', [], 'Modules.Pagesnotfound.Admin') . '</div>';
}
$this->html .= '
<div class="panel-heading">
' . $this->displayName . '
</div>
<h4>' . $this->trans('Guide', [], 'Modules.Pagesnotfound.Admin') . '</h4>
<div class="alert alert-warning">
<h4>' . $this->trans('404 errors', [], '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.', [], 'Modules.Pagesnotfound.Admin') . '
</p>
<p> </p>
<h4>' . $this->trans('How to catch these errors?', [], '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".', [], '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.', [], '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.', [], 'Modules.Pagesnotfound.Admin') . '</div>';
}
$pages = $this->getPages();
if (count($pages)) {
$titlePage = $this->trans('Page', [], 'Modules.Pagesnotfound.Admin');
$titleReferer = $this->trans('Referrer', [], 'Modules.Pagesnotfound.Admin');
$titleCounter = $this->trans('Counter', [], 'Modules.Pagesnotfound.Admin');
$this->html .= '
<div class="stacking__wrapper">
<table class="table">
<thead>
<tr>
<th scope="row"></th>
<th scope="col"><span class="title_box active">' . $titlePage . '</span></th>
<th scope="col"><span class="title_box active">' . $titleReferer . '</span></th>
<th scope="col"><span class="title_box active">' . $titleCounter . '</span></th>
</tr>
</thead>
<tbody>';
foreach ($pages as $ru => $hrs) {
foreach ($hrs as $hr => $counter) {
if ($hr != 'nb') {
$this->html .= '
<tr>
<th scope="row"></th>
<td data-header="' . $titlePage . '"><a href="' . $ru . '-admin404">' . wordwrap($ru, 30, '<br />', true) . '</a></td>
<td data-header="' . $titleReferer . '"><a href="' . Tools::getProtocol() . $hr . '">' . wordwrap($hr, 40, '<br />', true) . '</a></td>
<td data-header="' . $titleCounter . '"><span>' . $counter . '</span></td>
</tr>';
}
}
}
$this->html .= '
</tbody>
</table>
</div>';
} else {
$this->html .= '<div class="alert alert-warning"> ' . $this->trans('No "page not found" issue registered for now.', [], 'Modules.Pagesnotfound.Admin') . '</div>';
}
if (count($pages)) {
$this->html .= '
<h4>' . $this->trans('Empty database', [], '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', [], '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', [], 'Modules.Pagesnotfound.Admin') . '
</button>
</form>';
}
return $this->html;
}
public function hookDisplayTop($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, ['/', '\\'])) {
$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;
}