356 lines
12 KiB
PHP
356 lines
12 KiB
PHP
<?php
|
|
/*************************************************************************************/
|
|
/* This file is part of the Thelia package. */
|
|
/* */
|
|
/* Copyright (c) OpenStudio */
|
|
/* email : dev@thelia.net */
|
|
/* web : http://www.thelia.net */
|
|
/* */
|
|
/* For the full copyright and license information, please view the LICENSE.txt */
|
|
/* file that was distributed with this source code. */
|
|
/*************************************************************************************/
|
|
|
|
namespace Thelia\Tools;
|
|
|
|
use Symfony\Component\Routing\RequestContext;
|
|
use Symfony\Component\Validator\Constraints\UrlValidator;
|
|
use Thelia\Model\ConfigQuery;
|
|
use Thelia\Model\LangQuery;
|
|
use Thelia\Rewriting\RewritingResolver;
|
|
use Thelia\Rewriting\RewritingRetriever;
|
|
use Thelia\Core\HttpFoundation\Request;
|
|
use Symfony\Component\DependencyInjection\ContainerInterface;
|
|
|
|
class URL
|
|
{
|
|
/** @var RewritingResolver $resolver */
|
|
protected $resolver = null;
|
|
|
|
/** @var RewritingRetriever $retriever */
|
|
protected $retriever = null;
|
|
|
|
/** @var RequestContext $requestContext */
|
|
protected $requestContext;
|
|
|
|
const PATH_TO_FILE = true;
|
|
const WITH_INDEX_PAGE = false;
|
|
|
|
protected static $instance = null;
|
|
|
|
/** @var string $baseUrlScheme a cache for the base URL scheme */
|
|
private $baseUrlScheme = null;
|
|
|
|
public function __construct(ContainerInterface $container = null)
|
|
{
|
|
// Allow singleton style calls once instantiated.
|
|
// For this to work, the URL service has to be instantiated very early. This is done manually
|
|
// in TheliaHttpKernel, by calling $this->container->get('thelia.url.manager');
|
|
self::$instance = $this;
|
|
|
|
if ($container !== null) {
|
|
$this->requestContext = $container->get('router.admin')->getContext();
|
|
}
|
|
|
|
$this->retriever = new RewritingRetriever();
|
|
$this->resolver = new RewritingResolver();
|
|
}
|
|
|
|
/**
|
|
* @param RequestContext $requestContext
|
|
* @since Version 2.2
|
|
*/
|
|
public function setRequestContext(RequestContext $requestContext)
|
|
{
|
|
$this->requestContext = $requestContext;
|
|
}
|
|
|
|
/**
|
|
* Return this class instance, only once instanciated.
|
|
*
|
|
* @throws \RuntimeException if the class has not been instanciated.
|
|
* @return \Thelia\Tools\URL the instance.
|
|
*/
|
|
public static function getInstance()
|
|
{
|
|
if (self::$instance == null) {
|
|
throw new \RuntimeException("URL instance is not initialized.");
|
|
}
|
|
return self::$instance;
|
|
}
|
|
|
|
/**
|
|
* Return the base URL, either the base_url defined in Config, or the URL
|
|
* of the current language, if 'one_domain_foreach_lang' is enabled.
|
|
*
|
|
* @param bool $scheme_only if true, only the scheme will be returned. If false, the complete base URL, including path, is returned.
|
|
*
|
|
* @return string the base URL, with a trailing '/'
|
|
*/
|
|
public function getBaseUrl($scheme_only = false)
|
|
{
|
|
if (null === $this->baseUrlScheme) {
|
|
$scheme = "http";
|
|
$port = 80;
|
|
|
|
if ($host = $this->requestContext->getHost()) {
|
|
$scheme = $this->requestContext->getScheme();
|
|
|
|
$port = '';
|
|
|
|
if ('http' === $scheme && 80 != $this->requestContext->getHttpPort()) {
|
|
$port = ':'.$this->requestContext->getHttpPort();
|
|
} elseif ('https' === $scheme && 443 != $this->requestContext->getHttpsPort()) {
|
|
$port = ':'.$this->requestContext->getHttpsPort();
|
|
}
|
|
}
|
|
|
|
$this->baseUrlScheme = "$scheme://$host"."$port";
|
|
}
|
|
|
|
return $scheme_only ? $this->baseUrlScheme : $this->baseUrlScheme . $this->requestContext->getBaseUrl();
|
|
}
|
|
|
|
/**
|
|
* @return string the index page, which is in fact the base URL.
|
|
*/
|
|
public function getIndexPage()
|
|
{
|
|
// The index page is the base URL :)
|
|
return $this->getBaseUrl();
|
|
}
|
|
|
|
/**
|
|
* Returns the Absolute URL for a given path relative to web root. By default,
|
|
* the script name (index_dev.php) is added to the URL in dev_environment, use
|
|
* $path_only = true to get a path without the index script.
|
|
*
|
|
* @param string $path the relative path
|
|
* @param array $parameters An array of parameters
|
|
* @param boolean $path_only if true (PATH_TO_FILE), getIndexPage() will not be added
|
|
*
|
|
* @return string The generated URL
|
|
*/
|
|
public function absoluteUrl($path, array $parameters = null, $path_only = self::WITH_INDEX_PAGE)
|
|
{
|
|
// Already absolute ?
|
|
if (substr($path, 0, 4) != 'http') {
|
|
// Prevent duplication of the subdirectory name when Thelia is installed in a subdirectory.
|
|
// This happens when $path was calculated with Router::generate(), which returns an absolute URL,
|
|
// starting at web server root. For example, if Thelia is installed in /thelia2, we got something like /thelia2/my/path
|
|
// As base URL also contains /thelia2 (e.g. http://some.server.com/thelia2), we end up with
|
|
// http://some.server.com/thelia2/thelia2/my/path, instead of http://some.server.com/thelia2/my/path
|
|
// We have to compensate for this.
|
|
$rcbu = $this->requestContext->getBaseUrl();
|
|
|
|
$hasSubdirectory = ! empty($rcbu) && (0 === strpos($path, $rcbu));
|
|
|
|
$base_url = $this->getBaseUrl($hasSubdirectory);
|
|
|
|
/* Seems no longer required
|
|
// TODO fix this ugly patch
|
|
if (strpos($path, "index_dev.php")) {
|
|
$path = str_replace('index_dev.php', '', $path);
|
|
}
|
|
*/
|
|
|
|
// If only a path is requested, be sure to remove the script name (index.php or index_dev.php), if any.
|
|
if ($path_only == self::PATH_TO_FILE) {
|
|
if (substr($base_url, -3) == 'php') {
|
|
$base_url = dirname($base_url);
|
|
}
|
|
}
|
|
|
|
// Normalize the given path
|
|
$base = rtrim($base_url, '/') . '/' . ltrim($path, '/');
|
|
} else {
|
|
$base = $path;
|
|
}
|
|
|
|
$base = str_replace('&', '&', $base);
|
|
|
|
$queryString = '';
|
|
$anchor = '';
|
|
|
|
if (! is_null($parameters)) {
|
|
foreach ($parameters as $name => $value) {
|
|
// Remove this parameter from base URL to prevent duplicate parameters
|
|
$base = preg_replace('`([?&])'.preg_quote($name, '`').'=(?:[^&]*)(?:&|$)`', '$1', $base);
|
|
|
|
$queryString .= sprintf("%s=%s&", urlencode($name), urlencode($value));
|
|
}
|
|
}
|
|
|
|
if ('' !== $queryString = rtrim($queryString, "&")) {
|
|
// url could contain anchor
|
|
$pos = strrpos($base, '#');
|
|
if ($pos !== false) {
|
|
$anchor = substr($base, $pos);
|
|
$base = substr($base, 0, $pos);
|
|
}
|
|
|
|
$base = rtrim($base, "?&");
|
|
|
|
$sepChar = strstr($base, '?') === false ? '?' : '&';
|
|
|
|
$queryString = $sepChar . $queryString;
|
|
}
|
|
|
|
return $base . $queryString . $anchor;
|
|
}
|
|
|
|
/**
|
|
* Returns the Absolute URL to a administration view
|
|
*
|
|
* @param string $viewName the view name (e.g. login for login.html)
|
|
* @param mixed $parameters An array of parameters
|
|
*
|
|
* @return string The generated URL
|
|
*/
|
|
public function adminViewUrl($viewName, array $parameters = array())
|
|
{
|
|
$path = sprintf("%s/admin/%s", $this->getIndexPage(), $viewName);
|
|
|
|
return $this->absoluteUrl($path, $parameters);
|
|
}
|
|
|
|
/**
|
|
* Returns the Absolute URL to a view
|
|
*
|
|
* @param string $viewName the view name (e.g. login for login.html)
|
|
* @param mixed $parameters An array of parameters
|
|
*
|
|
* @return string The generated URL
|
|
*/
|
|
public function viewUrl($viewName, array $parameters = array())
|
|
{
|
|
$path = sprintf("?view=%s", $viewName);
|
|
|
|
return $this->absoluteUrl($path, $parameters);
|
|
}
|
|
|
|
/**
|
|
* Retrieve a rewritten URL from a view, a view id and a locale
|
|
*
|
|
* @param $view
|
|
* @param $viewId
|
|
* @param $viewLocale
|
|
*
|
|
* @return RewritingRetriever You can access $url and $rewrittenUrl properties
|
|
*/
|
|
public function retrieve($view, $viewId, $viewLocale)
|
|
{
|
|
if (ConfigQuery::isRewritingEnable()) {
|
|
$this->retriever->loadViewUrl($view, $viewLocale, $viewId);
|
|
} else {
|
|
$allParametersWithoutView = array();
|
|
$allParametersWithoutView['lang'] = $viewLocale;
|
|
if (null !== $viewId) {
|
|
$allParametersWithoutView[$view . '_id'] = $viewId;
|
|
}
|
|
$this->retriever->rewrittenUrl = null;
|
|
$this->retriever->url = URL::getInstance()->viewUrl($view, $allParametersWithoutView);
|
|
}
|
|
|
|
return $this->retriever;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a rewritten URL from the current GET parameters
|
|
*
|
|
* @param Request $request
|
|
*
|
|
* @return RewritingRetriever You can access $url and $rewrittenUrl properties or use toString method
|
|
*/
|
|
public function retrieveCurrent(Request $request)
|
|
{
|
|
if (ConfigQuery::isRewritingEnable()) {
|
|
$view = $request->attributes->get('_view', null);
|
|
|
|
$viewLocale = $this->getViewLocale($request);
|
|
|
|
$viewId = $view === null ? null : $request->query->get($view . '_id', null);
|
|
|
|
$allOtherParameters = $request->query->all();
|
|
if ($view !== null) {
|
|
unset($allOtherParameters['view']);
|
|
if ($viewId !== null) {
|
|
unset($allOtherParameters[$view . '_id']);
|
|
}
|
|
}
|
|
if ($viewLocale !== null) {
|
|
unset($allOtherParameters['lang']);
|
|
unset($allOtherParameters['locale']);
|
|
}
|
|
|
|
$this->retriever->loadSpecificUrl($view, $viewLocale, $viewId, $allOtherParameters);
|
|
} else {
|
|
$allParametersWithoutView = $request->query->all();
|
|
$view = $request->attributes->get('_view');
|
|
if (isset($allOtherParameters['view'])) {
|
|
unset($allOtherParameters['view']);
|
|
}
|
|
$this->retriever->rewrittenUrl = null;
|
|
$this->retriever->url = URL::getInstance()->viewUrl($view, $allParametersWithoutView);
|
|
}
|
|
|
|
return $this->retriever;
|
|
}
|
|
|
|
/**
|
|
* Retrieve a rewritten URL from the current GET parameters or use toString method
|
|
*
|
|
* @param $url
|
|
*
|
|
* @return RewritingResolver
|
|
*/
|
|
public function resolve($url)
|
|
{
|
|
$this->resolver->load($url);
|
|
|
|
return $this->resolver;
|
|
}
|
|
|
|
protected function sanitize($string, $force_lowercase = true, $alphabetic_only = false)
|
|
{
|
|
static $strip = array("~", "`", "!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "_", "=", "+", "[", "{", "]",
|
|
"}", "\\", "|", ";", ":", "\"", "'", "‘", "’", "“", "”", "–", "—",
|
|
"—", "–", ",", "<", ".", ">", "/", "?");
|
|
|
|
$clean = trim(str_replace($strip, "", strip_tags($string)));
|
|
|
|
$clean = preg_replace('/\s+/', "-", $clean);
|
|
|
|
$clean = ($alphabetic_only) ? preg_replace("/[^a-zA-Z0-9]/", "", $clean) : $clean ;
|
|
|
|
return ($force_lowercase) ?
|
|
(function_exists('mb_strtolower')) ?
|
|
mb_strtolower($clean, 'UTF-8') :
|
|
strtolower($clean) :
|
|
$clean;
|
|
}
|
|
|
|
public static function checkUrl($url, array $protocols = ["http", "https"])
|
|
{
|
|
$pattern = sprintf(UrlValidator::PATTERN, implode('|', $protocols));
|
|
|
|
return (bool) preg_match($pattern, $url);
|
|
}
|
|
|
|
/**
|
|
* Get the locale code from the lang attribute in URL.
|
|
*
|
|
* @param Request $request
|
|
* @return null|string
|
|
*/
|
|
private function getViewLocale(Request $request)
|
|
{
|
|
$viewLocale = $request->query->get('lang', null);
|
|
if (null === $viewLocale) {
|
|
// fallback for old parameter
|
|
$viewLocale = $request->query->get('locale', null);
|
|
}
|
|
|
|
return $viewLocale;
|
|
}
|
|
}
|