/classes/Link.php
PHP | 570 lines | 336 code | 80 blank | 154 comment | 106 complexity | c115f866f5d7c653869a3df8f11ffd15 MD5 | raw file
Possible License(s): LGPL-2.1, LGPL-3.0
- <?php
- /*
- * 2007-2012 PrestaShop
- *
- * 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.txt.
- * It is also available through the world-wide-web at this URL:
- * http://opensource.org/licenses/osl-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-2012 PrestaShop SA
- * @version Release: $Revision: 7465 $
- * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
- * International Registered Trademark & Property of PrestaShop SA
- */
- class LinkCore
- {
- /** @var boolean Rewriting activation */
- protected $allow;
- protected $url;
- public static $cache = array('page' => array());
- public $protocol_link;
- public $protocol_content;
- protected $ssl_enable;
- /**
- * Constructor (initialization only)
- */
- public function __construct($protocol_link = null, $protocol_content = null)
- {
- $this->allow = (int)Configuration::get('PS_REWRITING_SETTINGS');
- $this->url = $_SERVER['SCRIPT_NAME'];
- $this->protocol_link = $protocol_link;
- $this->protocol_content = $protocol_content;
- if (!defined('_PS_BASE_URL_'))
- define('_PS_BASE_URL_', Tools::getShopDomain(true));
- if (!defined('_PS_BASE_URL_SSL_'))
- define('_PS_BASE_URL_SSL_', Tools::getShopDomainSsl(true));
- $this->ssl_enable = Configuration::get('PS_SSL_ENABLED');
- }
- /**
- * Create a link to delete a product
- *
- * @param mixed $product ID of the product OR a Product object
- * @param int $id_picture ID of the picture to delete
- * @return string
- */
- public function getProductDeletePictureLink($product, $id_picture)
- {
- $url = $this->getProductLink($product);
- return $url.((strpos($url, '?')) ? '&' : '?').'&deletePicture='.$id_picture;
- }
- /**
- * Create a link to a product
- *
- * @param mixed $product Product object (can be an ID product, but deprecated)
- * @param string $alias
- * @param string $category
- * @param string $ean13
- * @param int $id_lang
- * @param int $id_shop (since 1.5.0) ID shop need to be used when we generate a product link for a product in a cart
- * @param int $ipa ID product attribute
- * @return string
- */
- public function getProductLink($product, $alias = null, $category = null, $ean13 = null, $id_lang = null, $id_shop = null, $ipa = 0, $force_routes = false)
- {
- $dispatcher = Dispatcher::getInstance();
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- if (!$id_shop)
- $shop = Context::getContext()->shop;
- else
- $shop = new Shop($id_shop);
-
- $url = 'http://'.$shop->domain.$shop->getBaseURI().$this->getLangLink($id_lang);
- if (!is_object($product))
- {
- if (is_array($product) && isset($product['id_product']))
- $product = new Product($product['id_product'], false, $id_lang);
- else if (is_numeric($product) || !$product)
- $product = new Product($product, false, $id_lang);
- else
- throw new PrestaShopException('Invalid product vars');
- }
- // Set available keywords
- $params = array();
- $params['id'] = $product->id;
- $params['rewrite'] = (!$alias) ? $product->getFieldByLang('link_rewrite') : $alias;
- $params['ean13'] = (!$ean13) ? $product->ean13 : $ean13;
- $params['meta_keywords'] = Tools::str2url($product->getFieldByLang('meta_keywords'));
- $params['meta_title'] = Tools::str2url($product->getFieldByLang('meta_title'));
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'manufacturer'))
- $params['manufacturer'] = Tools::str2url($product->isFullyLoaded ? $product->manufacturer_name : Manufacturer::getNameById($product->id_manufacturer));
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'supplier'))
- $params['supplier'] = Tools::str2url($product->isFullyLoaded ? $product->supplier_name : Supplier::getNameById($product->id_supplier));
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'price'))
- $params['price'] = $product->isFullyLoaded ? $product->price : Product::getPriceStatic($product->id, false, null, 6, null, false, true, 1, false, null, null, null, $product->specificPrice);
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'tags'))
- $params['tags'] = Tools::str2url($product->getTags($id_lang));
-
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'reference'))
- $params['reference'] = Tools::str2url($product->reference);
- if ($dispatcher->hasKeyword('product_rule', $id_lang, 'categories'))
- {
- $params['category'] = (!$category) ? $product->category : $category;
- $cats = array();
- foreach ($product->getParentCategories() as $cat)
- if (!in_array($cat['id_category'], array(1, 2)))//remove root and home category from the URL
- $cats[] = $cat['link_rewrite'];
- $params['categories'] = implode('/', $cats);
- }
- $anchor = $ipa ? $product->getAnchor($ipa) : '';
- return $url.$dispatcher->createUrl('product_rule', $id_lang, $params, $force_routes, $anchor);
- }
- /**
- * Create a link to a category
- *
- * @param mixed $category Category object (can be an ID category, but deprecated)
- * @param string $alias
- * @param int $id_lang
- * @param string $selected_filters Url parameter to autocheck filters of the module blocklayered
- * @return string
- */
- public function getCategoryLink($category, $alias = null, $id_lang = null, $selected_filters = null)
- {
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = _PS_BASE_URL_.__PS_BASE_URI__.$this->getLangLink($id_lang);
- if (!is_object($category))
- $category = new Category($category, $id_lang);
- // Set available keywords
- $params = array();
- $params['id'] = $category->id;
- $params['rewrite'] = (!$alias) ? $category->link_rewrite : $alias;
- $params['meta_keywords'] = Tools::str2url($category->meta_keywords);
- $params['meta_title'] = Tools::str2url($category->meta_title);
- // Selected filters is used by the module blocklayered
- $selected_filters = is_null($selected_filters) ? Tools::getValue('selected_filters') : $selected_filters;
- if (empty($selected_filters))
- $rule = 'category_rule';
- else
- {
- $rule = 'layered_rule';
- $params['selected_filters'] = $selected_filters;
- }
- return $url.Dispatcher::getInstance()->createUrl($rule, $id_lang, $params, $this->allow);
- }
- /**
- * Create a link to a CMS category
- *
- * @param mixed $category CMSCategory object (can be an ID category, but deprecated)
- * @param string $alias
- * @param int $id_lang
- * @return string
- */
- public function getCMSCategoryLink($category, $alias = null, $id_lang = null)
- {
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = _PS_BASE_URL_.__PS_BASE_URI__.$this->getLangLink($id_lang);
- if (!is_object($category))
- $category = new CMSCategory($category, $id_lang);
- // Set available keywords
- $params = array();
- $params['id'] = $category->id;
- $params['rewrite'] = (!$alias) ? $category->link_rewrite : $alias;
- $params['meta_keywords'] = Tools::str2url($category->meta_keywords);
- $params['meta_title'] = Tools::str2url($category->meta_title);
- return $url.Dispatcher::getInstance()->createUrl('cms_category_rule', $id_lang, $params, $this->allow);
- }
- /**
- * Create a link to a CMS page
- *
- * @param mixed $cms CMS object (can be an ID CMS, but deprecated)
- * @param string $alias
- * @param bool $ssl
- * @param int $id_lang
- * @return string
- */
- public function getCMSLink($cms, $alias = null, $ssl = false, $id_lang = null)
- {
- $base = (($ssl && $this->ssl_enable) ? _PS_BASE_URL_SSL_ : _PS_BASE_URL_);
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = $base.__PS_BASE_URI__.$this->getLangLink($id_lang);
- if (!is_object($cms))
- $cms = new CMS($cms, $id_lang);
- // Set available keywords
- $params = array();
- $params['id'] = $cms->id;
- $params['rewrite'] = (!$alias) ? (is_array($cms->link_rewrite) ? $cms->link_rewrite[(int)$id_lang] : $cms->link_rewrite) : $alias;
- if (isset($cms->meta_keywords) && !empty($cms->meta_keywords))
- $params['meta_keywords'] = is_array($cms->meta_keywords) ? Tools::str2url($cms->meta_keywords[(int)$id_lang]) : Tools::str2url($cms->meta_keywords);
- else
- $params['meta_keywords'] = '';
- if (isset($cms->meta_title) && !empty($cms->meta_title))
- $params['meta_title'] = is_array($cms->meta_title) ? Tools::str2url($cms->meta_title[(int)$id_lang]) : Tools::str2url($cms->meta_title);
- else
- $params['meta_title'] = '';
- return $url.Dispatcher::getInstance()->createUrl('cms_rule', $id_lang, $params, $this->allow);
- }
- /**
- * Create a link to a supplier
- *
- * @param mixed $supplier Supplier object (can be an ID supplier, but deprecated)
- * @param string $alias
- * @param int $id_lang
- * @return string
- */
- public function getSupplierLink($supplier, $alias = null, $id_lang = null)
- {
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = _PS_BASE_URL_.__PS_BASE_URI__.$this->getLangLink($id_lang);
- if (!is_object($supplier))
- $supplier = new Supplier($supplier, $id_lang);
- // Set available keywords
- $params = array();
- $params['id'] = $supplier->id;
- $params['rewrite'] = (!$alias) ? $supplier->link_rewrite : $alias;
- $params['meta_keywords'] = Tools::str2url($supplier->meta_keywords);
- $params['meta_title'] = Tools::str2url($supplier->meta_title);
- return $url.Dispatcher::getInstance()->createUrl('supplier_rule', $id_lang, $params, $this->allow);
- }
- /**
- * Create a link to a manufacturer
- *
- * @param mixed $manufacturer Manufacturer object (can be an ID supplier, but deprecated)
- * @param string $alias
- * @param int $id_lang
- * @return string
- */
- public function getManufacturerLink($manufacturer, $alias = null, $id_lang = null)
- {
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = _PS_BASE_URL_.__PS_BASE_URI__.$this->getLangLink($id_lang);
- if (!is_object($manufacturer))
- $manufacturer = new Manufacturer($manufacturer, $id_lang);
- // Set available keywords
- $params = array();
- $params['id'] = $manufacturer->id;
- $params['rewrite'] = (!$alias) ? $manufacturer->link_rewrite : $alias;
- $params['meta_keywords'] = Tools::str2url($manufacturer->meta_keywords);
- $params['meta_title'] = Tools::str2url($manufacturer->meta_title);
- return $url.Dispatcher::getInstance()->createUrl('manufacturer_rule', $id_lang, $params, $this->allow);
- }
- /**
- * Create a link to a module
- *
- * @since 1.5.0
- * @param string $module Module name
- * @param string $process Action name
- * @param int $id_lang
- * @return string
- */
- public function getModuleLink($module, $controller = 'default', array $params = array(), $ssl = false, $id_lang = null)
- {
- $base = (($ssl && $this->ssl_enable) ? _PS_BASE_URL_SSL_ : _PS_BASE_URL_);
- if (!$id_lang)
- $id_lang = Context::getContext()->language->id;
- $url = $base.__PS_BASE_URI__.$this->getLangLink($id_lang);
- // Set available keywords
- $params['module'] = $module;
- $params['controller'] = $controller ? $controller : 'default';
- // If the module has its own route ... just use it !
- if (Dispatcher::getInstance()->hasRoute('module-'.$module.'-'.$controller, $id_lang))
- {
- unset($params['module']);
- return $this->getPageLink('module-'.$module.'-'.$controller, $ssl, $id_lang, $params);
- }
- else
- return $url.Dispatcher::getInstance()->createUrl('module', $id_lang, $params, $this->allow);
- }
- /**
- * Use controller name to create a link
- *
- * @param string $controller
- * @param boolean $with_token include or not the token in the url
- * @return controller url
- */
- public function getAdminLink($controller, $with_token = true)
- {
- $id_lang = Context::getContext()->language->id;
-
- $params = $with_token ? array('token' => Tools::getAdminTokenLite($controller)) : array();
- return Dispatcher::getInstance()->createUrl($controller, $id_lang, $params, false);
- }
- /**
- * Returns a link to a product image for display
- * Note: the new image filesystem stores product images in subdirectories of img/p/
- *
- * @param string $name rewrite link of the image
- * @param string $ids id part of the image filename - can be "id_product-id_image" (legacy support, recommended) or "id_image" (new)
- * @param string $type
- */
- public function getImageLink($name, $ids, $type = null)
- {
- $not_default = false;
- // legacy mode or default image
- $theme = ((Shop::isFeatureActive() && file_exists(_PS_PROD_IMG_DIR_.$ids.($type ? '-'.$type : '').'-'.(int)Context::getContext()->shop->id_theme.'.jpg')) ? '-'.Context::getContext()->shop->id_theme : '');
- if ((Configuration::get('PS_LEGACY_IMAGES')
- && (file_exists(_PS_PROD_IMG_DIR_.$ids.($type ? '-'.$type : '').$theme.'.jpg')))
- || ($not_default = strpos($ids, 'default') !== false))
- {
- if ($this->allow == 1 && !$not_default)
- $uri_path = __PS_BASE_URI__.$ids.($type ? '-'.$type : '').$theme.'/'.$name.'.jpg';
- else
- $uri_path = _THEME_PROD_DIR_.$ids.($type ? '-'.$type : '').$theme.'.jpg';
- }
- else
- {
- // if ids if of the form id_product-id_image, we want to extract the id_image part
- $split_ids = explode('-', $ids);
- $id_image = (isset($split_ids[1]) ? $split_ids[1] : $split_ids[0]);
- $theme = ((Shop::isFeatureActive() && file_exists(_PS_PROD_IMG_DIR_.Image::getImgFolderStatic($id_image).$id_image.($type ? '-'.$type : '').'-'.(int)Context::getContext()->shop->id_theme.'.jpg')) ? '-'.Context::getContext()->shop->id_theme : '');
- if ($this->allow == 1)
- $uri_path = __PS_BASE_URI__.$id_image.($type ? '-'.$type : '').$theme.'/'.$name.'.jpg';
- else
- $uri_path = _THEME_PROD_DIR_.Image::getImgFolderStatic($id_image).$id_image.($type ? '-'.$type : '').$theme.'.jpg';
- }
- return $this->protocol_content.Tools::getMediaServer($uri_path).$uri_path;
- }
- public function getMediaLink($filepath)
- {
- return Tools::getProtocol().Tools::getMediaServer($filepath).$filepath;
- }
- /**
- * Create a simple link
- *
- * @param string $controller
- * @param bool $ssl
- * @param int $id_lang
- * @param string|array $request
- * @param bool $request_url_encode Use URL encode
- *
- * @return string Page link
- */
- public function getPageLink($controller, $ssl = false, $id_lang = null, $request = null, $request_url_encode = false)
- {
- $controller = Tools::strReplaceFirst('.php', '', $controller);
- if (!$id_lang)
- $id_lang = (int)Context::getContext()->language->id;
- if (!is_array($request))
- {
- // @FIXME html_entity_decode has been added due to '&' => '%3B' ...
- $request = html_entity_decode($request);
- if ($request_url_encode)
- $request = urlencode($request);
- parse_str($request, $request);
- }
- unset($request['controller']);
- $uri_path = Dispatcher::getInstance()->createUrl($controller, $id_lang, $request);
- $url = ($ssl && $this->ssl_enable) ? Tools::getShopDomainSsl(true) : Tools::getShopDomain(true);
- $url .= __PS_BASE_URI__.$this->getLangLink($id_lang).ltrim($uri_path, '/');
- return $url;
- }
- public function getCatImageLink($name, $id_category, $type = null)
- {
- $uri_path = ($this->allow == 1) ? (__PS_BASE_URI__.'c/'.$id_category.($type ? '-'.$type : '').'/'.$name.'.jpg') : (_THEME_CAT_DIR_.$id_category.($type ? '-'.$type : '').'.jpg');
- return $this->protocol_content.Tools::getMediaServer($uri_path).$uri_path;
- }
- /**
- * Create link after language change, for the change language block
- *
- * @param integer $id_lang Language ID
- * @return string link
- */
- public function getLanguageLink($id_lang, Context $context = null)
- {
- if (!$context)
- $context = Context::getContext();
- $params = $_GET;
- unset($params['isolang'], $params['controller']);
- if (!$this->allow)
- $params['id_lang'] = $id_lang;
- else
- unset($params['id_lang']);
- $controller = Dispatcher::getInstance()->getController();
- if (!empty(Context::getContext()->controller->php_self))
- $controller = Context::getContext()->controller->php_self;
- if ($controller == 'product' && isset($params['id_product']))
- return $this->getProductLink((int)$params['id_product'], null, null, null, (int)$id_lang);
- elseif ($controller == 'category' && isset($params['id_category']))
- return $this->getCategoryLink((int)$params['id_category'], null, (int)$id_lang);
- elseif ($controller == 'supplier' && isset($params['id_supplier']))
- return $this->getSupplierLink((int)$params['id_supplier'], null, (int)$id_lang);
- elseif ($controller == 'manufacturer' && isset($params['id_manufacturer']))
- return $this->getManufacturerLink((int)$params['id_manufacturer'], null, (int)$id_lang);
- elseif ($controller == 'cms' && isset($params['id_cms']))
- return $this->getCMSLink((int)$params['id_cms'], null, false, (int)$id_lang);
- elseif ($controller == 'cms' && isset($params['id_cms_category']))
- return $this->getCMSCategoryLink((int)$params['id_cms_category'], null, (int)$id_lang);
- return $this->getPageLink($controller, false, $id_lang, $params);
- }
- public function goPage($url, $p)
- {
- return $url.($p == 1 ? '' : (!strstr($url, '?') ? '?' : '&').'p='.(int)$p);
- }
- /**
- * Get pagination link
- *
- * @param string $type Controller name
- * @param int $id_object
- * @param boolean $nb Show nb element per page attribute
- * @param boolean $sort Show sort attribute
- * @param boolean $pagination Show page number attribute
- * @param boolean $array If false return an url, if true return an array
- */
- public function getPaginationLink($type, $id_object, $nb = false, $sort = false, $pagination = false, $array = false)
- {
- // If no parameter $type, try to get it by using the controller name
- if (!$type && !$id_object)
- {
- $method_name = 'get'.Dispatcher::getInstance()->getController().'Link';
- if (method_exists($this, $method_name) && isset($_GET['id_'.Dispatcher::getInstance()->getController()]))
- {
- $type = Dispatcher::getInstance()->getController();
- $id_object = $_GET['id_'.$type];
- }
- }
- if ($type && $id_object)
- $url = $this->{'get'.$type.'Link'}($id_object, null);
- else
- {
- if (isset(Context::getContext()->controller->php_self))
- $name = Context::getContext()->controller->php_self;
- else
- $name = Dispatcher::getInstance()->getController();
- $url = $this->getPageLink($name);
- }
- $vars = array();
- $vars_nb = array('n', 'search_query');
- $vars_sort = array('orderby', 'orderway');
- $vars_pagination = array('p');
- foreach ($_GET as $k => $value)
- {
- if ($k != 'id_'.$type && $k != 'controller')
- {
- if (Configuration::get('PS_REWRITING_SETTINGS') && ($k == 'isolang' || $k == 'id_lang'))
- continue;
- $if_nb = (!$nb || ($nb && !in_array($k, $vars_nb)));
- $if_sort = (!$sort || ($sort && !in_array($k, $vars_sort)));
- $if_pagination = (!$pagination || ($pagination && !in_array($k, $vars_pagination)));
- if ($if_nb && $if_sort && $if_pagination)
- {
- if (!is_array($value))
- $vars[urlencode($k)] = $value;
- else
- {
- foreach (explode('&', http_build_query(array($k => $value), '', '&')) as $key => $val)
- {
- $data = explode('=', $val);
- $vars[urldecode($data[0])] = $data[1];
- }
- }
- }
- }
- }
- if (!$array)
- return $url.(($this->allow == 1 || $url == $this->url) ? '?' : '&').http_build_query($vars, '', '&');
- $vars['requestUrl'] = $url;
- if ($type && $id_object)
- $vars['id_'.$type] = (is_object($id_object) ? (int)$id_object->id : (int)$id_object);
-
- if (!$this->allow == 1)
- $vars['controller'] = Dispatcher::getInstance()->getController();
- return $vars;
- }
- public function addSortDetails($url, $orderby, $orderway)
- {
- return $url.(!strstr($url, '?') ? '?' : '&').'orderby='.urlencode($orderby).'&orderway='.urlencode($orderway);
- }
- protected function getLangLink($id_lang = null, Context $context = null)
- {
- if (!$context)
- $context = Context::getContext();
- if (!$this->allow || !Language::isMultiLanguageActivated())
- return '';
- if (!$id_lang)
- $id_lang = $context->language->id;
- return Language::getIsoById($id_lang).'/';
- }
- }