forked from faktiva/prestashop-seo-tk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
faktiva_seotk.php
496 lines (440 loc) · 17.3 KB
/
faktiva_seotk.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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
<?php
/*
* This file is part of the "Prestashop SEO ToolKit" module.
*
* @author Emiliano 'AlberT' Gabrielli <albert@faktiva.com>
* @source https://github.com/faktiva/prestashop-seo-tk
* @license MIT
*
*
* The MIT License (MIT)
*
* Copyright (c) 2015-2017 Emiliano Gabrielli
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
if (!defined('_PS_VERSION_')) {
return;
}
if (version_compare(PHP_VERSION, '5.3.0', '>=')) { // Namespaces support is required
include_once __DIR__ . '/tools/debug.php';
}
/**
* Class Faktiva_Seotk
*/
class Faktiva_Seotk extends Module
{
private $_controller;
/**
* @var string[]
*/
private static $_paginating_controllers = array(
'best-sales',
'category',
'manufacturer',
'manufacturer-list',
'new-products',
'prices-drop',
'search',
'supplier',
'supplier-list',
);
/**
* @var string[]
*/
private static $_nobots_controllers = array(
'404',
'address',
'addresses',
'attachment',
'authentication',
'cart',
'discount',
'footer',
'get-file',
'guest-tracking',
'header',
'history',
'identity',
'images.inc',
'init',
'my-account',
'order',
'order-opc',
'order-slip',
'order-detail',
'order-follow',
'order-return',
'order-confirmation',
'pagenotfound',
'pagination',
'password',
'pdf-invoice',
'pdf-order-return',
'pdf-order-slip',
'product-sort',
'search',
'statistics',
);
/**
* Faktiva_Seotk constructor.
*/
public function __construct()
{
$this->name = 'faktiva_seotk';
$this->author = 'Faktiva';
$this->tab = 'seo';
$this->version = '1.4.4';
$this->need_instance = 0;
$this->bootstrap = true;
$this->ps_versions_compliancy = array('min' => '1.5.0.1', 'max' => _PS_VERSION_);
parent::__construct();
$this->displayName = $this->l('Faktiva SEO ToolKit');
$this->description = $this->l('Handles a few SEO related improvements, such as \'hreflang\', \'canonical\' and \'noindex\'.');
$this->confirmUninstall = $this->l('Are you sure you want to uninstall "Faktiva SEO ToolKit"?');
}
/**
* @return bool
*/
public function install()
{
if (Shop::isFeatureActive()) {
Shop::setContext(Shop::CONTEXT_ALL);
}
return parent::install()
&& $this->registerHook('header')
&& Configuration::updateValue('FKVSEOTK_HREFLANG_ENABLED', false)
&& Configuration::updateValue('FKVSEOTK_CANONICAL_ENABLED', false)
&& Configuration::updateValue('FKVSEOTK_NOBOTS_ENABLED', false)
;
}
/**
* @return bool
*/
public function uninstall()
{
return parent::uninstall()
&& Configuration::deleteByName('FKVSEOTK_HREFLANG_ENABLED')
&& Configuration::deleteByName('FKVSEOTK_CANONICAL_ENABLED')
&& Configuration::deleteByName('FKVSEOTK_NOBOTS_ENABLED')
;
}
/**
* @param $template
* @param null $cache_id
* @param null $compile_id
*
* FIXME
*/
public function _clearCache($template, $cache_id = null, $compile_id = null)
{
parent::_clearCache('meta-hreflang.tpl', $this->getCacheId($cache_id));
parent::_clearCache('meta-canonical.tpl', $this->getCacheId($cache_id));
}
/**
* @return string
*/
public function getContent()
{
$_html = '<div id="'.$this->name.'_config_intro" class="alert alert-info">'.
' <span class="module_name">'.$this->displayName.'</span>'.
' <div class="module_description">'.$this->description.'</div>'.
'</div>';
if (Tools::isSubmit('submitOptionsconfiguration')) {
if (null!==Tools::getValue('FKVSEOTK_HREFLANG_ENABLED')) {
Configuration::updateValue('FKVSEOTK_HREFLANG_ENABLED', (bool)Tools::getValue('FKVSEOTK_HREFLANG_ENABLED'));
}
if (null!==Tools::getValue('FKVSEOTK_CANONICAL_ENABLED')) {
Configuration::updateValue('FKVSEOTK_CANONICAL_ENABLED', (bool)Tools::getValue('FKVSEOTK_CANONICAL_ENABLED'));
}
if (null!==Tools::getValue('FKVSEOTK_NOBOTS_ENABLED')) {
Configuration::updateValue('FKVSEOTK_NOBOTS_ENABLED', (bool)Tools::getValue('FKVSEOTK_NOBOTS_ENABLED'));
}
}
$_html .= $this->renderForm();
return $_html;
}
/**
* @return mixed
*/
public function renderForm()
{
$this->fields_option = array(
'hreflang' => array(
'title' => $this->l('Internationalization'),
'icon' => 'icon-flag',
'fields' => array(
'FKVSEOTK_HREFLANG_ENABLED' => array(
'title' => $this->l('Enable "hreflang" meta tag'),
'hint' => $this->l('Set "hreflang" meta tag into the html head to handle the same content in different languages.'),
'validation' => 'isBool',
'cast' => 'boolval',
'type' => 'bool',
),
),
'submit' => array(
'title' => $this->l('Save'),
),
),
'canonical' => array(
'title' => $this->l('Canonical URL'),
'icon' => 'icon-link',
'fields' => array(
'FKVSEOTK_CANONICAL_ENABLED' => array(
'title' => $this->l('Enable "canonical" meta tag'),
'hint' => $this->l('Set "canonical"meta tag into the html head to avoid content duplication issues in SEO.'),
'validation' => 'isBool',
'cast' => 'boolval',
'type' => 'bool',
),
),
'submit' => array(
'title' => $this->l('Save'),
),
),
'nobots' => array(
'title' => $this->l('"nobots"'),
'icon' => 'icon-sitemap',
'fields' => array(
'FKVSEOTK_NOBOTS_ENABLED' => array(
'title' => $this->l('Enable "noindex" meta tag'),
'hint' => $this->l('Set "noindex" meta tag into the html head to avoid search engine indicization of "private" pages. Public pages are not affected of course.'),
'validation' => 'isBool',
'cast' => 'boolval',
'type' => 'bool',
),
),
'submit' => array(
'title' => $this->l('Save'),
),
),
);
$helper = new HelperOptions($this);
$helper->id = $this->id;
$helper->module = $this;
$helper->currentIndex = AdminController::$currentIndex.'&configure='.$this->name;
$helper->token = Tools::getAdminTokenLite('AdminModules');
$helper->title = $this->displayName;
return $helper->generateOptions($this->fields_option);
}
/**
* @return string
*/
public function hookHeader()
{
$this->_controller = Dispatcher::getInstance()->getController();
if (!empty($this->context->controller->php_self)) {
$this->_controller = $this->context->controller->php_self;
}
if ($this->_handleNobots()) {
// no need to add anything else as robots should ignore this page
return '';
}
$out = "\n"
.$this->_displayHreflang()
.$this->_displayCanonical()
;
return $out;
}
/**
* @return bool
*/
private function _handleNobots()
{
if (Configuration::get('FKVSEOTK_NOBOTS_ENABLED')) {
if (in_array($this->_controller, self::$_nobots_controllers, true)
|| Tools::getValue('selected_filters')
) {
$this->context->smarty->assign('nobots', true);
return true;
}
}
return false;
}
/**
* @return string
*/
private function _displayHreflang()
{
if (!Configuration::get('FKVSEOTK_HREFLANG_ENABLED')) {
return '';
}
$shop = $this->context->shop;
if (version_compare(_PS_VERSION_, '1.6.1.0', '>=')) {
$requested_URL = $shop->getBaseURL(true /* $auto_secure_mode */, false /* $add_base_uri */) . $_SERVER['REQUEST_URI'];
} else {
$proto = (Configuration::get('PS_SSL_ENABLED') && Configuration::get('PS_SSL_ENABLED_EVERYWHERE')) ? 'https://' : 'http://';
$domain = (Configuration::get('PS_SSL_ENABLED') && Configuration::get('PS_SSL_ENABLED_EVERYWHERE')) ? $shop->domain_ssl : $shop->domain;
$requested_URL = $proto . $domain . $_SERVER['REQUEST_URI'];
}
if (Configuration::get('FKVSEOTK_CANONICAL_ENABLED') && !$this->_isCanonicalRequest($requested_URL)) {
return ''; // skip if actual page is not the canonical page
}
foreach (Shop::getShops(true /* $active */, null /* $id_shop_group */, true /* $get_as_list_id */) as $shop_id) {
foreach (Language::getLanguages(true /* $active */, $shop_id) as $language) {
$url = $this->_getCanonical($language['id_lang'], $shop_id, true /* $has_qs */);
$shops_data[$shop_id][] = array(
'url' => $url,
'language' => array(
'id' => $language['id_lang'],
'code' => $language['language_code'],
),
);
}
}
$this->context->smarty->assign(array(
'shops_data' => $shops_data,
'default_lang_id' => (int)Configuration::get('PS_LANG_DEFAULT'),
'default_shop_id' => (int)Configuration::get('PS_SHOP_DEFAULT'),
));
return $this->display(__FILE__, 'meta-hreflang.tpl');
}
/**
* @return string
*/
private function _displayCanonical()
{
if (!Configuration::get('FKVSEOTK_CANONICAL_ENABLED')) {
return '';
}
$canonical = $this->_getCanonical();
if (!$this->isCached('meta-canonical.tpl', $this->getCacheId($canonical))) {
$this->context->smarty->assign(array(
'canonical_url' => $canonical,
));
}
return $this->display(__FILE__, 'meta-canonical.tpl', $this->getCacheId($canonical));
}
/**
* @param array $params
* @param null $id_lang
* @param null $id_shop
*
* @return string
*/
private function _getCanonicalByLink(array &$params, $id_lang = null, $id_shop = null)
{
$link = $this->context->link;
$controller = $this->_controller;
$module = Tools::getValue('module');
$id = (int)Tools::getValue('id_'.$controller);
$getLinkFunc = 'get'.ucfirst($controller).'Link';
if (!$link || !$controller) {
return '';
}
switch ($controller.$module) {
case 'product':
// getProductLink($product, $alias = null, $category = null, $ean13 = null, $id_lang = null, $id_shop = null, $ipa = 0, $force_routes = false, $relative_protocol = false)
$canonical = $link->getProductLink($id, null, null, null, $id_lang, $id_shop);
break;
case 'category':
// getCategoryLink($category, $alias = null, $id_lang = null, $selected_filters = null, $id_shop = null, $relative_protocol = false)
$canonical = $link->getCategoryLink($id, null, $id_lang, Tools::getValue('selected_filters', null), $id_shop);
break;
case 'cms':
if ($cat_id = (int)Tools::getValue('id_cms_category')) {
// getCMSCategoryLink($cms_category, $alias = null, $id_lang = null, $id_shop = null, $relative_protocol = false)
$canonical = $link->getCMSCategoryLink($cat_id, null, $id_lang, $id_shop);
} else {
// getCMSLink($cms, $alias = null, $ssl = null, $id_lang = null, $id_shop = null, $relative_protocol = false)
$canonical = $link->getCmsLink($id, null, null, $id_lang, $id_shop);
}
break;
case 'supplier':
// getSupplierLink ($supplier, $alias = null, $id_lang = null, $id_shop = null, $relative_protocol = false)
case 'manufacturer':
// getManufacturerLink($manufacturer, $alias = null, $id_lang = null, $id_shop = null, $relative_protocol = false)
$canonical = $id
? $link->{$getLinkFunc}($id, null, $id_lang, $id_shop)
: $link->getPageLink($controller, null, $id_lang, null, false, $id_shop);
break;
case 'search':
if ($tag = Tools::getValue('tag')) {
$params['tag'] = $tag;
}
if ($sq = Tools::getValue('search_query')) {
$params['search_query'] = $sq;
}
case 'products-comparison':
if ($ids_str = Tools::getValue('compare_product_list')) {
// use an ordered products' list as canonical param
$ids = explode('|', $ids_str);
sort($ids, SORT_NUMERIC);
$params['compare_product_list'] = implode('|', $ids);
}
default:
if (Validate::isModuleName($module)) {
$_params = $_GET;
unset($_params['fc']);
// getModuleLink($module, $controller = 'default', array $params = array(), $ssl = null, $id_lang = null, $id_shop = null, $relative_protocol = false)
$canonical = $link->getModuleLink($module, $controller, $_params, null, $id_lang, $id_shop);
} else {
// getPageLink($controller, $ssl = null, $id_lang = null, $request = null, $request_url_encode = false, $id_shop = null, $relative_protocol = false)
$canonical = $link->getPageLink($controller, null, $id_lang, null, false, $id_shop);
}
}
return $canonical;
}
/**
* @param int|null $id_lang
* @param int|null $id_shop
* @param bool $add_qs
*
* @return mixed
*/
private function _getCanonical($id_lang = null, $id_shop = null, $add_qs = true)
{
$controller = $this->_controller;
$params = array();
$canonical = $this->_getCanonicalByLink($params, $id_lang, $id_shop);
if ('index' === $controller && '/' === strtok($_SERVER['REQUEST_URI'], '?')) {
$canonical = rtrim($canonical, '/');
}
// retain pagination for controllers supporting it, remove p=1
if (($p = Tools::getValue('p')) && $p > 1
&& (in_array($controller, self::$_paginating_controllers, true) || Tools::getValue('module'))
) {
$params['p'] = $p;
}
// remove "dirty" QS
$canonical = strtok($canonical, '?');
// add "canonical" QS if enabled
if ($add_qs && !empty($params)) {
$canonical .= '?'.http_build_query($params, '', '&');
}
// HACK: Link class should return the right protocol for a given shop but it doesn't
$protocol = Configuration::get('PS_SSL_ENABLED', null, null, $id_shop) && Configuration::get('PS_SSL_ENABLED_EVERYWHERE', null, null, $id_shop) ? 'https' : 'http' ;
return preg_replace('/^https?/i', $protocol, $canonical);
}
/**
* @param string $url
*
* @return bool
*/
private function _isCanonicalRequest($url)
{
$canonical = $this->_getCanonical(null, null, false /* $has_qs */);
$request = strtok($url, '?');
if ('index' === $this->_controller) {
$request = rtrim($request, '/');
$canonical = rtrim($canonical, '/');
}
return ($request === $canonical);
}
}