forked from PrestaShop/PrestaShop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMeta.php
556 lines (500 loc) · 18.1 KB
/
Meta.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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
<?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 Open Software License (OSL 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/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 [email protected] 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://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <[email protected]>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
*/
use PrestaShop\PrestaShop\Adapter\Presenter\Object\ObjectPresenter;
use Symfony\Component\HttpFoundation\IpUtils;
/**
* Class MetaCore.
*/
class MetaCore extends ObjectModel
{
public $page;
public $configurable = 1;
public $title;
public $description;
public $keywords;
public $url_rewrite;
/**
* @see ObjectModel::$definition
*/
public static $definition = [
'table' => 'meta',
'primary' => 'id_meta',
'multilang' => true,
'multilang_shop' => true,
'fields' => [
'page' => ['type' => self::TYPE_STRING, 'validate' => 'isFileName', 'required' => true, 'size' => 64],
'configurable' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedInt'],
/* Lang fields */
'title' => ['type' => self::TYPE_STRING, 'lang' => true, 'validate' => 'isGenericName', 'size' => 128],
'description' => ['type' => self::TYPE_STRING, 'lang' => true, 'validate' => 'isGenericName', 'size' => 255],
'keywords' => ['type' => self::TYPE_STRING, 'lang' => true, 'validate' => 'isGenericName', 'size' => 255],
'url_rewrite' => ['type' => self::TYPE_STRING, 'lang' => true, 'validate' => 'isLinkRewrite', 'size' => 255],
],
];
/**
* Get pages.
*
* @param bool $excludeFilled
* @param bool|string $addPage
*
* @return array
*/
public static function getPages($excludeFilled = false, $addPage = false)
{
$selectedPages = [];
if (!$files = Tools::scandir(_PS_CORE_DIR_ . DIRECTORY_SEPARATOR . 'controllers' . DIRECTORY_SEPARATOR . 'front' . DIRECTORY_SEPARATOR, 'php', '', true)) {
die(Tools::displayError(Context::getContext()->getTranslator()->trans('Cannot scan root directory', [], 'Admin.Notifications.Error')));
}
$overrideDir = _PS_CORE_DIR_ . DIRECTORY_SEPARATOR . 'override' . DIRECTORY_SEPARATOR . 'controllers' . DIRECTORY_SEPARATOR . 'front' . DIRECTORY_SEPARATOR;
if (!is_dir($overrideDir)) {
$overrideFiles = [];
} elseif (!$overrideFiles = Tools::scandir($overrideDir, 'php', '', true)) {
die(Tools::displayError(Context::getContext()->getTranslator()->trans('Cannot scan "override" directory', [], 'Admin.Notifications.Error')));
}
$files = array_values(array_unique(array_merge($files, $overrideFiles)));
// Exclude pages forbidden
$exludePages = [
'category',
'changecurrency',
'cms',
'footer',
'header',
'pagination',
'product',
'product-sort',
'statistics',
];
foreach ($files as $file) {
if ($file != 'index.php' && !in_array(strtolower(str_replace('Controller.php', '', $file)), $exludePages)) {
$className = str_replace('.php', '', $file);
$reflection = class_exists($className) ? new ReflectionClass(str_replace('.php', '', $file)) : false;
$properties = $reflection ? $reflection->getDefaultProperties() : [];
if (isset($properties['php_self'])) {
$selectedPages[$properties['php_self']] = $properties['php_self'];
} elseif (preg_match('/^[a-z0-9_.-]*\.php$/i', $file)) {
$selectedPages[strtolower(str_replace('Controller.php', '', $file))] = strtolower(str_replace('Controller.php', '', $file));
} elseif (preg_match('/^([a-z0-9_.-]*\/)?[a-z0-9_.-]*\.php$/i', $file)) {
$selectedPages[strtolower(Context::getContext()->getTranslator()->trans('File %2$s (in directory %1$s)', [dirname($file), str_replace('Controller.php', '', basename($file))], 'Admin.Notifications.Error'))] = strtolower(str_replace('Controller.php', '', basename($file)));
}
}
}
// Add modules controllers to list (this function is cool !)
foreach (glob(_PS_MODULE_DIR_ . '*/controllers/front/*.php') as $file) {
$filename = Tools::strtolower(basename($file, '.php'));
if ($filename == 'index') {
continue;
}
$module = Tools::strtolower(basename(dirname(dirname(dirname($file)))));
$selectedPages[$module . ' - ' . $filename] = 'module-' . $module . '-' . $filename;
}
// Exclude page already filled
if ($excludeFilled) {
$metas = Meta::getMetas();
foreach ($metas as $meta) {
if (in_array($meta['page'], $selectedPages)) {
unset($selectedPages[array_search($meta['page'], $selectedPages)]);
}
}
}
// Add selected page
if ($addPage) {
$name = $addPage;
if (preg_match('#module-([a-z0-9_-]+)-([a-z0-9]+)$#i', $addPage, $m)) {
$addPage = $m[1] . ' - ' . $m[2];
}
$selectedPages[$addPage] = $name;
asort($selectedPages);
}
return $selectedPages;
}
/**
* Get all Metas.
*
* @return array|false|mysqli_result|PDOStatement|resource|null
*/
public static function getMetas()
{
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('SELECT * FROM ' . _DB_PREFIX_ . 'meta ORDER BY page ASC');
}
/**
* Get all metas, but filter by Language.
*
* @param int $idLang Language ID
*
* @return array|false|mysqli_result|PDOStatement|resource|null
*/
public static function getMetasByIdLang($idLang)
{
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
SELECT *
FROM `' . _DB_PREFIX_ . 'meta` m
LEFT JOIN `' . _DB_PREFIX_ . 'meta_lang` ml ON m.`id_meta` = ml.`id_meta`
WHERE ml.`id_lang` = ' . (int) $idLang
. Shop::addSqlRestrictionOnLang('ml') .
'ORDER BY page ASC');
}
/**
* Get metas by page.
*
* @param string $page
* @param int $idLang Language ID
*
* @return array|bool|object|null
*/
public static function getMetaByPage($page, $idLang)
{
return Db::getInstance(_PS_USE_SQL_SLAVE_)->getRow('
SELECT *
FROM ' . _DB_PREFIX_ . 'meta m
LEFT JOIN ' . _DB_PREFIX_ . 'meta_lang ml ON m.id_meta = ml.id_meta
WHERE (
m.page = "' . pSQL($page) . '"
OR m.page = "' . pSQL(str_replace('-', '', strtolower($page))) . '"
)
AND ml.id_lang = ' . (int) $idLang . '
' . Shop::addSqlRestrictionOnLang('ml'));
}
/**
* Get all metas.
*
* @param int $idLang
*
* @return array|false|mysqli_result|PDOStatement|resource|null
*/
public static function getAllMeta($idLang)
{
return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
SELECT *
FROM ' . _DB_PREFIX_ . 'meta m
LEFT JOIN ' . _DB_PREFIX_ . 'meta_lang ml ON m.id_meta = ml.id_meta
AND ml.id_lang = ' . (int) $idLang . '
' . Shop::addSqlRestrictionOnLang('ml'));
}
/**
* Updates the current Meta in the database.
*
* @param bool $nullValues Whether we want to use NULL values instead of empty quotes values
*
* @return bool Indicates whether the Meta has been successfully updated
*
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
*/
public function update($nullValues = false)
{
if (!parent::update($nullValues)) {
return false;
}
return Tools::generateHtaccess();
}
/**
* Deletes current Meta from the database.
*
* @return bool `true` if delete was successful
*
* @throws PrestaShopException
*/
public function delete()
{
if (!parent::delete()) {
return false;
}
return Tools::generateHtaccess();
}
/**
* Delete selection.
*
* @param array $selection
*
* @return bool
*/
public function deleteSelection(array $selection)
{
$result = true;
foreach ($selection as $id) {
$this->id = (int) $id;
$result = $result && $this->delete();
}
return $result && Tools::generateHtaccess();
}
/**
* Get equivalent URL rewrite.
*
* @param int $newIdLang
* @param int $idLang
* @param string $urlRewrite
*
* @return false|string|null
*/
public static function getEquivalentUrlRewrite($newIdLang, $idLang, $urlRewrite)
{
return Db::getInstance()->getValue('
SELECT url_rewrite
FROM `' . _DB_PREFIX_ . 'meta_lang`
WHERE id_meta = (
SELECT id_meta
FROM `' . _DB_PREFIX_ . 'meta_lang`
WHERE url_rewrite = \'' . pSQL($urlRewrite) . '\' AND id_lang = ' . (int) $idLang . '
AND id_shop = ' . Context::getContext()->shop->id . '
)
AND id_lang = ' . (int) $newIdLang . '
AND id_shop = ' . Context::getContext()->shop->id);
}
/**
* Get meta tags.
*
* @since 1.5.0
*/
public static function getMetaTags($idLang, $pageName, $title = '')
{
if (Configuration::get('PS_SHOP_ENABLE')
|| IpUtils::checkIp(Tools::getRemoteAddr(), explode(',', Configuration::get('PS_MAINTENANCE_IP')))) {
if ($pageName == 'product' && ($idProduct = Tools::getValue('id_product'))) {
return Meta::getProductMetas($idProduct, $idLang, $pageName);
} elseif ($pageName == 'category' && ($idCategory = Tools::getValue('id_category'))) {
return Meta::getCategoryMetas($idCategory, $idLang, $pageName, $title);
} elseif ($pageName == 'manufacturer' && ($idManufacturer = Tools::getValue('id_manufacturer'))) {
return Meta::getManufacturerMetas($idManufacturer, $idLang, $pageName);
} elseif ($pageName == 'supplier' && ($idSupplier = Tools::getValue('id_supplier'))) {
return Meta::getSupplierMetas($idSupplier, $idLang, $pageName);
} elseif ($pageName == 'cms' && ($idCms = Tools::getValue('id_cms'))) {
return Meta::getCmsMetas($idCms, $idLang, $pageName);
} elseif ($pageName == 'cms' && ($idCmsCategory = Tools::getValue('id_cms_category'))) {
return Meta::getCmsCategoryMetas($idCmsCategory, $idLang, $pageName);
}
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* Get meta tags for a given page.
*
* @param int $idLang Language ID
* @param string $pageName Page name
*
* @return array Meta tags
*
* @since 1.5.0
*/
public static function getHomeMetas($idLang, $pageName)
{
$metas = Meta::getMetaByPage($pageName, $idLang);
$ret['meta_title'] = (isset($metas['title']) && $metas['title']) ? $metas['title'] : Configuration::get('PS_SHOP_NAME');
$ret['meta_description'] = (isset($metas['description']) && $metas['description']) ? $metas['description'] : '';
$ret['meta_keywords'] = (isset($metas['keywords']) && $metas['keywords']) ? $metas['keywords'] : '';
$ret = Meta::completeMetaTags($ret, $ret['meta_title']);
return $ret;
}
/**
* Get product meta tags.
*
* @param int $idProduct
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getProductMetas($idProduct, $idLang, $pageName)
{
$product = new Product($idProduct, false, $idLang);
if (Validate::isLoadedObject($product) && $product->active) {
$row = Meta::getPresentedObject($product);
if (empty($row['meta_description'])) {
$row['meta_description'] = strip_tags($row['description_short']);
}
return Meta::completeMetaTags($row, $row['name']);
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* Get category meta tags.
*
* @param int $idCategory
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getCategoryMetas($idCategory, $idLang, $pageName, $title = '')
{
$category = new Category($idCategory, $idLang);
$cacheId = 'Meta::getCategoryMetas' . (int) $idCategory . '-' . (int) $idLang;
if (!Cache::isStored($cacheId)) {
if (Validate::isLoadedObject($category)) {
$row = Meta::getPresentedObject($category);
if (empty($row['meta_description'])) {
$row['meta_description'] = strip_tags($row['description']);
}
if (is_string($title) && $title !== '') {
$row['meta_title'] = $title;
} else {
$row['meta_title'] = $row['meta_title'] ?: $row['name'];
}
$result = Meta::completeMetaTags($row, $row['name']);
} else {
$result = Meta::getHomeMetas($idLang, $pageName);
}
Cache::store($cacheId, $result);
return $result;
}
return Cache::retrieve($cacheId);
}
/**
* Get manufacturer meta tags.
*
* @param int $idManufacturer
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getManufacturerMetas($idManufacturer, $idLang, $pageName)
{
$manufacturer = new Manufacturer($idManufacturer, $idLang);
if (Validate::isLoadedObject($manufacturer)) {
$row = Meta::getPresentedObject($manufacturer);
if (!empty($row['meta_description'])) {
$row['meta_description'] = strip_tags($row['meta_description']);
}
$row['meta_title'] = $row['meta_title'] ?: $row['name'];
return Meta::completeMetaTags($row, $row['meta_title']);
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* Get supplier meta tags.
*
* @param int $idSupplier
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getSupplierMetas($idSupplier, $idLang, $pageName)
{
$supplier = new Supplier($idSupplier, $idLang);
if (Validate::isLoadedObject($supplier)) {
$row = Meta::getPresentedObject($supplier);
if (!empty($row['meta_description'])) {
$row['meta_description'] = strip_tags($row['meta_description']);
}
return Meta::completeMetaTags($row, $row['name']);
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* Get CMS meta tags.
*
* @param int $idCms
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getCmsMetas($idCms, $idLang, $pageName)
{
$cms = new CMS($idCms, $idLang);
if (Validate::isLoadedObject($cms)) {
$row = Meta::getPresentedObject($cms);
$row['meta_title'] = !empty($row['head_seo_title']) ? $row['head_seo_title'] : $row['meta_title'];
return Meta::completeMetaTags($row, $row['meta_title']);
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* Get CMS category meta tags.
*
* @param int $idCmsCategory
* @param int $idLang
* @param string $pageName
*
* @return array
*
* @since 1.5.0
*/
public static function getCmsCategoryMetas($idCmsCategory, $idLang, $pageName)
{
$cmsCategory = new CMSCategory($idCmsCategory, $idLang);
if (Validate::isLoadedObject($cmsCategory)) {
$row = Meta::getPresentedObject($cmsCategory);
$row['meta_title'] = empty($row['meta_title']) ? $row['name'] : $row['meta_title'];
return Meta::completeMetaTags($row, $row['meta_title']);
}
return Meta::getHomeMetas($idLang, $pageName);
}
/**
* @since 1.5.0
*/
public static function completeMetaTags($metaTags, $defaultValue, ?Context $context = null)
{
if (!$context) {
$context = Context::getContext();
}
if (empty($metaTags['meta_title'])) {
$metaTags['meta_title'] = $defaultValue;
}
if (!empty($context->controller) && method_exists($context->controller, 'getTemplateVarPagination')) {
$metaTags['meta_title'] = Meta::paginateTitle($metaTags['meta_title']);
}
return $metaTags;
}
/**
* Add page number to title
*
* @param string $title
*
* @return string
*/
public static function paginateTitle(string $title): string
{
$page_num = (int) Tools::getValue('page');
if ($page_num > 1) {
$title .= ' (' . $page_num . ')';
}
return $title;
}
/**
* Get presented version of an object.
*
* @param ObjectModel $object
*
* @return array
*/
protected static function getPresentedObject($object)
{
$objectPresenter = new ObjectPresenter();
return $objectPresenter->present($object);
}
}