UrlGenerator.php 13.2 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
Crell's avatar
Crell committed
5
 * Contains Drupal\Core\Routing\UrlGenerator.
6 7 8 9
 */

namespace Drupal\Core\Routing;

10
use Psr\Log\LoggerInterface;
11
use Symfony\Component\HttpFoundation\Request;
12

13 14 15
use Symfony\Component\Routing\Route as SymfonyRoute;
use Symfony\Component\Routing\Exception\RouteNotFoundException;

16 17
use Symfony\Cmf\Component\Routing\ProviderBasedGenerator;

18
use Drupal\Component\Utility\UrlHelper;
19
use Drupal\Core\Config\ConfigFactoryInterface;
20
use Drupal\Core\PathProcessor\OutboundPathProcessorInterface;
21
use Drupal\Core\RouteProcessor\OutboundRouteProcessorInterface;
22
use Drupal\Core\Site\Settings;
23 24

/**
25
 * Generates URLs from route names and parameters.
26
 */
27
class UrlGenerator extends ProviderBasedGenerator implements UrlGeneratorInterface {
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

  /**
   * A request object.
   *
   * @var \Symfony\Component\HttpFoundation\Request
   */
  protected $request;

  /**
   * The path processor to convert the system path to one suitable for urls.
   *
   * @var \Drupal\Core\PathProcessor\OutboundPathProcessorInterface
   */
  protected $pathProcessor;

43 44 45
  /**
   * The route processor.
   *
46
   * @var \Drupal\Core\RouteProcessor\OutboundRouteProcessorInterface
47 48 49
   */
  protected $routeProcessor;

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  /**
   * The base path to use for urls.
   *
   * @var string
   */
  protected $basePath;

  /**
   * The base url to use for urls.
   *
   * @var string
   */
  protected $baseUrl;

  /**
   * The script path to use for urls.
   *
   * @var string
   */
  protected $scriptPath;
70 71

  /**
72
   * Whether both secure and insecure session cookies can be used simultaneously.
73
   *
74
   * @var bool
75
   */
76
  protected $mixedModeSessions;
77

78 79 80
  /**
   *  Constructs a new generator object.
   *
81
   * @param \Drupal\Core\Routing\RouteProviderInterface $provider
82
   *   The route provider to be searched for routes.
83 84 85 86 87 88
   * @param \Drupal\Core\PathProcessor\OutboundPathProcessorInterface $path_processor
   *   The path processor to convert the system path to one suitable for urls.
   * @param \Drupal\Core\RouteProcessor\OutboundRouteProcessorInterface $route_processor
   *   The route processor.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *    The config factory.
89
   * @param \Drupal\Core\Site\Settings $settings
90
   *    The read only settings.
91
   * @param \Psr\Log\LoggerInterface $logger
92 93
   *   An optional logger for recording errors.
   */
94
  public function __construct(RouteProviderInterface $provider, OutboundPathProcessorInterface $path_processor, OutboundRouteProcessorInterface $route_processor, ConfigFactoryInterface $config, Settings $settings, LoggerInterface $logger = NULL) {
95 96
    parent::__construct($provider, $logger);

97
    $this->pathProcessor = $path_processor;
98
    $this->routeProcessor = $route_processor;
99 100
    $this->mixedModeSessions = $settings->get('mixed_mode_sessions', FALSE);
    $allowed_protocols = $config->get('system.filter')->get('protocols') ?: array('http', 'https');
101
    UrlHelper::setAllowedProtocols($allowed_protocols);
102 103 104
  }

  /**
105
   * {@inheritdoc}
106 107 108 109 110 111 112 113 114 115 116 117 118 119
   */
  public function setRequest(Request $request) {
    $this->request = $request;
    // Set some properties, based on the request, that are used during path-based
    // url generation.
    $this->basePath = $request->getBasePath() . '/';
    $this->baseUrl = $request->getSchemeAndHttpHost() . $this->basePath;
    $this->scriptPath = '';
    $base_path_with_script = $request->getBaseUrl();
    $script_name = $request->getScriptName();
    if (!empty($base_path_with_script) && strpos($base_path_with_script, $script_name) !== FALSE) {
      $length = strlen($this->basePath);
      $this->scriptPath = ltrim(substr($script_name, $length), '/') . '/';
    }
120 121
  }

122
  /**
123
   * {@inheritdoc}
124
   */
125
  public function getPathFromRoute($name, $parameters = array()) {
126
    $route = $this->getRoute($name);
127 128 129 130 131 132 133
    $path = $this->getInternalPathFromRoute($route, $parameters);
    // Router-based paths may have a querystring on them but Drupal paths may
    // not have one, so remove any ? and anything after it. For generate() this
    // is handled in processPath().
    $path = preg_replace('/\?.*/', '', $path);
    return trim($path, '/');
  }
134

135 136 137 138 139 140 141 142 143 144 145 146 147
  /**
   * Gets the path of a route.
   *
   * @param \Symfony\Component\Routing\Route $route
   *  The route object.
   * @param array $parameters
   *  An array of parameters as passed to
   *  \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().
   *
   * @return string
   *  The url path corresponding to the route, without the base path.
   */
  protected function getInternalPathFromRoute(SymfonyRoute $route, $parameters = array()) {
148 149 150 151 152 153 154 155 156 157 158
    // The Route has a cache of its own and is not recompiled as long as it does
    // not get modified.
    $compiledRoute = $route->compile();
    $hostTokens = $compiledRoute->getHostTokens();

    $route_requirements = $route->getRequirements();
    // We need to bypass the doGenerate() method's handling of absolute URLs as
    // we handle that ourselves after processing the path.
    if (isset($route_requirements['_scheme'])) {
      unset($route_requirements['_scheme']);
    }
159
    $path = $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route_requirements, $compiledRoute->getTokens(), $parameters, $route->getPath(), FALSE, $hostTokens);
160 161 162 163 164 165 166 167

    // The URL returned from doGenerate() will include the base path if there is
    // one (i.e., if running in a subdirectory) so we need to strip that off
    // before processing the path.
    $base_url = $this->context->getBaseUrl();
    if (!empty($base_url) && strpos($path, $base_url) === 0) {
      $path = substr($path, strlen($base_url));
    }
168 169
    return $path;
  }
170

171 172 173 174
  /**
   * {@inheritdoc}
   */
  public function generate($name, $parameters = array(), $absolute = FALSE) {
175 176 177
    $options['absolute'] = $absolute;
    return $this->generateFromRoute($name, $parameters, $options);
  }
webchick's avatar
webchick committed
178

179 180 181 182 183 184
  /**
   * {@inheritdoc}
   */
  public function generateFromRoute($name, $parameters = array(), $options = array()) {
    $absolute = !empty($options['absolute']);
    $route = $this->getRoute($name);
185 186
    $this->processRoute($route, $parameters);

187 188 189 190
    // Symfony adds any parameters that are not path slugs as query strings.
    if (isset($options['query']) && is_array($options['query'])) {
      $parameters = (array) $parameters + $options['query'];
    }
191

192 193 194 195 196 197 198 199
    $path = $this->getInternalPathFromRoute($route, $parameters);
    $path = $this->processPath($path, $options);
    $fragment = '';
    if (isset($options['fragment'])) {
      if (($fragment = trim($options['fragment'])) != '') {
        $fragment = '#' . $fragment;
      }
    }
200

201
    $base_url = $this->context->getBaseUrl();
202
    if (!$absolute || !$host = $this->context->getHost()) {
203
      return $base_url . $path . $fragment;
204 205 206 207
    }

    // Prepare an absolute URL by getting the correct scheme, host and port from
    // the request context.
208 209 210 211 212 213
    if (isset($options['https']) && $this->mixedModeSessions) {
      $scheme = $options['https'] ? 'https' : 'http';
    }
    else {
      $scheme = $this->context->getScheme();
    }
214
    $scheme_req = $route->getRequirement('_scheme');
215 216 217 218 219 220 221 222 223
    if (isset($scheme_req) && ($req = strtolower($scheme_req)) && $scheme !== $req) {
      $scheme = $req;
    }
    $port = '';
    if ('http' === $scheme && 80 != $this->context->getHttpPort()) {
      $port = ':' . $this->context->getHttpPort();
    } elseif ('https' === $scheme && 443 != $this->context->getHttpsPort()) {
      $port = ':' . $this->context->getHttpsPort();
    }
224
    return $scheme . '://' . $host . $port . $base_url . $path . $fragment;
225 226 227
  }

  /**
228
   * {@inheritdoc}
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
   */
  public function generateFromPath($path = NULL, $options = array()) {

    if (!$this->initialized()) {
      throw new GeneratorNotInitializedException();
    }

    // Merge in defaults.
    $options += array(
      'fragment' => '',
      'query' => array(),
      'absolute' => FALSE,
      'prefix' => '',
    );

    if (!isset($options['external'])) {
      // Return an external link if $path contains an allowed absolute URL. Only
246 247 248
      // call the slow
      // \Drupal\Component\Utility\UrlHelper::stripDangerousProtocols() if $path
      // contains a ':' before any / ? or #. Note: we could use
249 250 251
      // \Drupal\Component\Utility\UrlHelper::isExternal($path) here, but that
      // would require another function call, and performance inside url() is
      // critical.
252
      $colonpos = strpos($path, ':');
253
      $options['external'] = ($colonpos !== FALSE && !preg_match('![/?#]!', substr($path, 0, $colonpos)) && UrlHelper::stripDangerousProtocols($path) == $path);
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
    }

    if (isset($options['fragment']) && $options['fragment'] !== '') {
      $options['fragment'] = '#' . $options['fragment'];
    }

    if ($options['external']) {
      // Split off the fragment.
      if (strpos($path, '#') !== FALSE) {
        list($path, $old_fragment) = explode('#', $path, 2);
        // If $options contains no fragment, take it over from the path.
        if (isset($old_fragment) && !$options['fragment']) {
          $options['fragment'] = '#' . $old_fragment;
        }
      }
      // Append the query.
      if ($options['query']) {
271
        $path .= (strpos($path, '?') !== FALSE ? '&' : '?') . UrlHelper::buildQuery($options['query']);
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
      }
      if (isset($options['https']) && $this->mixedModeSessions) {
        if ($options['https'] === TRUE) {
          $path = str_replace('http://', 'https://', $path);
        }
        elseif ($options['https'] === FALSE) {
          $path = str_replace('https://', 'http://', $path);
        }
      }
      // Reassemble.
      return $path . $options['fragment'];
    }
    else {
      $path = ltrim($this->processPath($path, $options), '/');
    }

    if (!isset($options['script'])) {
      $options['script'] = $this->scriptPath;
    }
    // The base_url might be rewritten from the language rewrite in domain mode.
    if (!isset($options['base_url'])) {
      if (isset($options['https']) && $this->mixedModeSessions) {
        if ($options['https'] === TRUE) {
          $options['base_url'] = str_replace('http://', 'https://', $this->baseUrl);
          $options['absolute'] = TRUE;
        }
        elseif ($options['https'] === FALSE) {
          $options['base_url'] = str_replace('https://', 'http://', $this->baseUrl);
          $options['absolute'] = TRUE;
        }
      }
      else {
        $options['base_url'] = $this->baseUrl;
      }
    }
    elseif (rtrim($options['base_url'], '/') == $options['base_url']) {
      $options['base_url'] .= '/';
    }
    $base = $options['absolute'] ? $options['base_url'] : $this->basePath;
    $prefix = empty($path) ? rtrim($options['prefix'], '/') : $options['prefix'];

    $path = str_replace('%2F', '/', rawurlencode($prefix . $path));
314
    $query = $options['query'] ? ('?' . UrlHelper::buildQuery($options['query'])) : '';
315 316 317 318
    return $base . $options['script'] . $path . $query . $options['fragment'];
  }

  /**
319
   * {@inheritdoc}
320 321 322 323 324 325
   */
  public function setBaseUrl($url) {
    $this->baseUrl = $url;
  }

  /**
326
   * {@inheritdoc}
327 328 329 330 331 332
   */
  public function setBasePath($path) {
    $this->basePath = $path;
  }

  /**
333
   * {@inheritdoc}
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
   */
  public function setScriptPath($path) {
    $this->scriptPath = $path;
  }

  /**
   * Passes the path to a processor manager to allow alterations.
   */
  protected function processPath($path, &$options = array()) {
    // Router-based paths may have a querystring on them.
    if ($query_pos = strpos($path, '?')) {
      // We don't need to do a strict check here because position 0 would mean we
      // have no actual path to work with.
      $actual_path = substr($path, 0, $query_pos);
      $query_string = substr($path, $query_pos);
    }
    else {
      $actual_path = $path;
      $query_string = '';
    }
    $path = '/' . $this->pathProcessor->processOutbound(trim($actual_path, '/'), $options, $this->request);
    $path .= $query_string;
356 357 358
    return $path;
  }

359 360 361 362 363 364 365 366 367 368 369 370 371
  /**
   * Passes the route to the processor manager for altering before complation.
   *
   * @param \Symfony\Component\Routing\Route $route
   *   The route object to process.
   *
   * @param array $parameters
   *   An array of parameters to be passed to the route compiler.
   */
  protected function processRoute(SymfonyRoute $route, array &$parameters) {
    $this->routeProcessor->processOutbound($route, $parameters);
  }

372 373 374 375 376 377 378 379 380 381 382
  /**
   * Returns whether or not the url generator has been initialized.
   *
   * @return bool
   *   Returns TRUE if the basePath, baseUrl and scriptPath properties have been
   *   set, FALSE otherwise.
   */
  protected function initialized() {
    return isset($this->basePath) && isset($this->baseUrl) && isset($this->scriptPath);
  }

383
  /**
384
   * Find the route using the provided route name.
385 386 387 388 389 390 391 392 393 394 395 396
   *
   * @param string $name
   *   The route name to fetch
   *
   * @return \Symfony\Component\Routing\Route
   *   The found route.
   *
   * @throws \Symfony\Component\Routing\Exception\RouteNotFoundException
   *   Thrown if there is no route with that name in this repository.
   *
   * @see \Drupal\Core\Routing\RouteProviderInterface
   */
397
  protected function getRoute($name) {
398 399 400
    if ($name instanceof SymfonyRoute) {
      $route = $name;
    }
401
    elseif (NULL === $route = $this->provider->getRouteByName($name)) {
402 403 404 405 406
      throw new RouteNotFoundException(sprintf('Route "%s" does not exist.', $name));
    }
    return $route;
  }

407
}