Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixed routing issues with multisite and multilanguage (Grav 1.5 edition) #2046

Merged
merged 9 commits into from
Jun 12, 2018
Merged

Fixed routing issues with multisite and multilanguage (Grav 1.5 edition) #2046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9fcfb80
Fixed routing issues with multisite and multilanguage (#1501)
mahagr Jun 2, 2017
ad498b5
Fix unit tests (#1501)
mahagr Jun 5, 2017
8f90951
Merge branch 'develop' of https://github.com/getgrav/grav into featur…
mahagr Mar 20, 2018
23cf909
Merge branch 'develop' of https://github.com/getgrav/grav into featur…
mahagr May 17, 2018
65ead88
Merge branch 'feature/multisite-route' into feature/multisite-15
mahagr May 17, 2018
3630402
Merge branch '1.5' of https://github.com/getgrav/grav into feature/mu…
mahagr Jun 1, 2018
5d000f1
Code cleanup
mahagr Jun 1, 2018
2eac670
Remove some duplicated code
mahagr Jun 1, 2018
51c1917
Merge branch '1.5' of https://github.com/getgrav/grav into feature/mu…
mahagr Jun 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions system/src/Grav/Common/Grav.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
namespace Grav\Common;

use Grav\Common\Config\Config;
use Grav\Common\Language\Language;
use Grav\Common\Page\Medium\ImageMedium;
use Grav\Common\Page\Medium\Medium;
use Grav\Common\Page\Page;
Expand Down Expand Up @@ -205,11 +204,8 @@ public function redirect($route, $code = null)
*/
public function redirectLangSafe($route, $code = null)
{
/** @var Language $language */
$language = $this['language'];

if (!$this['uri']->isExternal($route) && $language->enabled() && $language->isIncludeDefaultLanguage()) {
$this->redirect($language->getLanguage() . $route, $code);
if (!$this['uri']->isExternal($route)) {
$this->redirect($this['pages']->route($route), $code);
} else {
$this->redirect($route, $code);
}
Expand Down
45 changes: 17 additions & 28 deletions system/src/Grav/Common/Page/Page.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1647,14 +1647,19 @@ public function canonical($include_lang = true)
* Gets the url for the Page.
*
* @param bool $include_host Defaults false, but true would include http://yourhost.com
* @param bool $canonical true to return the canonical URL
* @param bool $include_lang
* @param bool $canonical True to return the canonical URL
* @param bool $include_base Include base url on multisite as well as language code
* @param bool $raw_route
*
* @return string The url.
*/
public function url($include_host = false, $canonical = false, $include_lang = true, $raw_route = false)
public function url($include_host = false, $canonical = false, $include_base = true, $raw_route = false)
{
// Override any URL when external_url is set
if (isset($this->external_url)) {
return $this->external_url;
}

$grav = Grav::instance();

/** @var Pages $pages */
Expand All @@ -1663,41 +1668,25 @@ public function url($include_host = false, $canonical = false, $include_lang = t
/** @var Config $config */
$config = $grav['config'];

/** @var Language $language */
$language = $grav['language'];

/** @var Uri $uri */
$uri = $grav['uri'];

// Override any URL when external_url is set
if (isset($this->external_url)) {
return $this->external_url;
}

// get pre-route
if ($include_lang && $language->enabled()) {
$pre_route = $language->getLanguageURLPrefix();
} else {
$pre_route = '';
}
// get base route (multisite base and language)
$route = $include_base ? $pages->baseRoute() : '';

// add full route if configured to do so
if ($config->get('system.absolute_urls', false)) {
if (!$include_host && $config->get('system.absolute_urls', false)) {
$include_host = true;
}

// get canonical route if requested
if ($canonical) {
$route = $pre_route . $this->routeCanonical();
$route .= $this->routeCanonical();
} elseif ($raw_route) {
$route = $pre_route . $this->rawRoute();
$route .= $this->rawRoute();
} else {
$route = $pre_route . $this->route();
$route .= $this->route();
}

$rootUrl = $uri->rootUrl($include_host) . $pages->base();

$url = $rootUrl . '/' . trim($route, '/') . $this->urlExtension();
/** @var Uri $uri */
$uri = $grav['uri'];
$url = $uri->rootUrl($include_host) . '/' . trim($route, '/') . $this->urlExtension();

// trim trailing / if not root
if ($url !== '/') {
Expand Down
70 changes: 46 additions & 24 deletions system/src/Grav/Common/Page/Pages.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class Pages
/**
* @var array|string[]
*/
protected $baseUrl = [];
protected $baseRoute = [];

/**
* @var array|string[]
Expand Down Expand Up @@ -120,47 +120,69 @@ public function base($path = null)
if ($path !== null) {
$path = trim($path, '/');
$this->base = $path ? '/' . $path : null;
$this->baseUrl = [];
$this->baseRoute = [];
}

return $this->base;
}

/**
*
* Get base URL for Grav pages.
* Get base route for Grav pages.
*
* @param string $lang Optional language code for multilingual links.
* @param bool $absolute If true, return absolute url, if false, return relative url. Otherwise return default.
* @param string $lang Optional language code for multilingual routes.
*
* @return string
*/
public function baseUrl($lang = null, $absolute = null)
public function baseRoute($lang = null)
{
$lang = (string) $lang;
$type = $absolute === null ? 'base_url' : ($absolute ? 'base_url_absolute' : 'base_url_relative');
$key = "{$lang} {$type}";

if (!isset($this->baseUrl[$key])) {
/** @var Config $config */
$config = $this->grav['config'];
$key = $lang ?: 'default';

if (!isset($this->baseRoute[$key])) {
/** @var Language $language */
$language = $this->grav['language'];

if (!$lang) {
$lang = $language->getActive();
}
$path_base = rtrim($this->base(), '/');
$path_lang = $language->enabled() ? $language->getLanguageURLPrefix($lang) : '';

$path_append = rtrim($this->grav['pages']->base(), '/');
if ($language->getDefault() !== $lang || $config->get('system.languages.include_default_lang') === true) {
$path_append .= $lang ? '/' . $lang : '';
}
$this->baseRoute[$key] = $path_base . $path_lang;
}

return $this->baseRoute[$key];
}

$this->baseUrl[$key] = $this->grav[$type] . $path_append;
/**
*
* Get route for Grav site.
*
* @param string $route Optional route to the page.
* @param string $lang Optional language code for multilingual links.
*
* @return string
*/
public function route($route = '/', $lang = null)
{
if (!$route || $route === '/') {
return $this->baseRoute($lang) ?: '/';
}

return $this->baseUrl[$key];
return $this->baseRoute($lang) . $route;
}

/**
*
* Get base URL for Grav pages.
*
* @param string $lang Optional language code for multilingual links.
* @param bool|null $absolute If true, return absolute url, if false, return relative url. Otherwise return default.
*
* @return string
*/
public function baseUrl($lang = null, $absolute = null)
{
$type = $absolute === null ? 'base_url' : ($absolute ? 'base_url_absolute' : 'base_url_relative');

return $this->grav[$type] . $this->baseRoute($lang);
}

/**
Expand All @@ -179,7 +201,7 @@ public function homeUrl($lang = null, $absolute = null)

/**
*
* Get home URL for Grav site.
* Get URL for Grav site.
*
* @param string $route Optional route to the page.
* @param string $lang Optional language code for multilingual links.
Expand All @@ -189,7 +211,7 @@ public function homeUrl($lang = null, $absolute = null)
*/
public function url($route = '/', $lang = null, $absolute = null)
{
if ($route === '/') {
if (!$route || $route === '/') {
return $this->homeUrl($lang, $absolute);
}

Expand Down
29 changes: 20 additions & 9 deletions system/src/Grav/Common/Processors/InitializeProcessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,47 @@

namespace Grav\Common\Processors;

use Grav\Common\Config\Config;
use Grav\Common\Uri;
use Grav\Common\Utils;

class InitializeProcessor extends ProcessorBase implements ProcessorInterface
{
public $id = 'init';
public $title = 'Initialize';

public function process()
{
$this->container['config']->debug();
/** @var Config $config */
$config = $this->container['config'];
$config->debug();

// Use output buffering to prevent headers from being sent too early.
ob_start();
if ($this->container['config']->get('system.cache.gzip')) {
if ($config->get('system.cache.gzip') && !@ob_start('ob_gzhandler')) {
// Enable zip/deflate with a fallback in case of if browser does not support compressing.
if (!@ob_start("ob_gzhandler")) {
ob_start();
}
ob_start();
}

// Initialize the timezone.
if ($this->container['config']->get('system.timezone')) {
if ($config->get('system.timezone')) {
date_default_timezone_set($this->container['config']->get('system.timezone'));
}

// FIXME: Initialize session should happen later after plugins have been loaded. This is a workaround to fix session issues in AWS.
if ($this->container['config']->get('system.session.initialize', 1) && isset($this->container['session'])) {
if (isset($this->container['session']) && $config->get('system.session.initialize', true)) {
$this->container['session']->init();
}

// Initialize uri.
$this->container['uri']->init();
/** @var Uri $uri */
$uri = $this->container['uri'];
$uri->init();

// Redirect pages with trailing slash if configured to do so.
$path = $uri->path() ?: '/';
if ($path !== '/' && $config->get('system.pages.redirect_trailing_slash', false) && Utils::endsWith($path, '/')) {
$this->container->redirect(rtrim($path, '/'), 302);
}

$this->container->setLocale();
}
Expand Down
37 changes: 17 additions & 20 deletions system/src/Grav/Common/Service/PageServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

namespace Grav\Common\Service;

use Grav\Common\Config\Config;
use Grav\Common\Grav;
use Grav\Common\Language\Language;
use Grav\Common\Page\Page;
Expand All @@ -26,35 +27,33 @@ public function register(Container $container)
/** @var Pages $pages */
$pages = $c['pages'];

/** @var Config $config */
$config = $c['config'];

/** @var Uri $uri */
$uri = $c['uri'];

$path = $uri->path(); // Don't trim to support trailing slash default routes
$path = $path ?: '/';

$path = $uri->path() ?: '/'; // Don't trim to support trailing slash default routes
$page = $pages->dispatch($path);

// Redirection tests
if ($page) {
/** @var Language $language */
$language = $c['language'];

// some debugger override logic
if ($page->debugger() === false) {
$c['debugger']->enabled(false);
}

if ($c['config']->get('system.force_ssl')) {
if (!isset($_SERVER['HTTPS']) || $_SERVER["HTTPS"] != "on") {
$url = "https://" . $_SERVER["HTTP_HOST"] . $_SERVER["REQUEST_URI"];
if ($config->get('system.force_ssl')) {
if (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] !== 'on') {
$url = 'https://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
$c->redirect($url);
}
}

$url = $page->route();
$url = $pages->route($page->route());

if ($uri->params()) {
if ($url == '/') { //Avoid double slash
if ($url === '/') { //Avoid double slash
$url = $uri->params();
} else {
$url .= $uri->params();
Expand All @@ -67,18 +66,16 @@ public function register(Container $container)
$url .= '#' . $uri->fragment();
}

/** @var Language $language */
$language = $c['language'];

// Language-specific redirection scenarios
if ($language->enabled()) {
if ($language->isLanguageInUrl() && !$language->isIncludeDefaultLanguage()) {
$c->redirect($url);
}
if (!$language->isLanguageInUrl() && $language->isIncludeDefaultLanguage()) {
$c->redirectLangSafe($url);
}
if ($language->enabled() && ($language->isLanguageInUrl() xor $language->isIncludeDefaultLanguage())) {
$c->redirect($url);
}
// Default route test and redirect
if ($c['config']->get('system.pages.redirect_default_route') && $page->route() != $path) {
$c->redirectLangSafe($url);
if ($config->get('system.pages.redirect_default_route') && $page->route() !== $path) {
$c->redirect($url);
}
}

Expand Down
4 changes: 2 additions & 2 deletions system/src/Grav/Common/Twig/TwigExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ public function dump(\Twig_Environment $env, $context)
* Output a Gist
*
* @param string $id
* @param string $file
* @param string|bool $file
*
* @return string
*/
Expand Down Expand Up @@ -976,7 +976,7 @@ public function regexFilter($array, $regex, $flags = 0) {
public function redirectFunc($url, $statusCode = 303)
{
header('Location: ' . $url, true, $statusCode);
die();
exit();
}

/**
Expand Down
Loading