/home/sharedstore/public_html/prestashop.sharedstore.ma/classes
Edit: /home/sharedstore/public_html/prestashop.sharedstore.ma/classes/Meta.php (18577B)
* @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($selection)
{
if (!is_array($selection)) {
die(Tools::displayError('Parameter "selection" must be an array.'));
}
$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') || Tools::isAllowedToBypassMaintenance()) {
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);
}
}