mirror of
https://github.com/phpbb/phpbb.git
synced 2025-05-06 23:55:26 +02:00
Merge pull request #2957 from Nicofuma/ticket/13063
[ticket/13063] Introduces a new \phpbb\routing\router class
This commit is contained in:
Nils Adermann
commit
6fa0ca1f96
build
phpBB
tests
controller
mock
pagination
@ -382,6 +382,12 @@
|
||||
<delete file="${dir}/vendor/twig/twig/CHANGELOG" />
|
||||
<delete file="${dir}/vendor/twig/twig/phpunit.xml.dist" />
|
||||
<delete file="${dir}/vendor/twig/twig/README.markdown" />
|
||||
|
||||
<delete dir="${dir}/vendor/symfony/twig-bridge/Symfony/Bridge/Twig/Tests" />
|
||||
<delete file="${dir}/vendor/symfony/twig-bridge/Symfony/Bridge/Twig/.gitignore" />
|
||||
<delete file="${dir}/vendor/symfony/twig-bridge/Symfony/Bridge/Twig/CHANGELOG.md" />
|
||||
<delete file="${dir}/vendor/symfony/twig-bridge/Symfony/Bridge/Twig/README.md" />
|
||||
<delete file="${dir}/vendor/symfony/twig-bridge/Symfony/Bridge/Twig/phpunit.xml.dist" />
|
||||
</target>
|
||||
|
||||
<target name="clean-diff-dir">
|
||||
|
||||
@ -34,6 +34,7 @@
|
||||
"symfony/event-dispatcher": "2.5.*",
|
||||
"symfony/http-kernel": "2.5.*",
|
||||
"symfony/routing": "2.5.*",
|
||||
"symfony/twig-bridge": "2.5.*",
|
||||
"symfony/yaml": "2.5.*",
|
||||
"twig/twig": "1.13.*"
|
||||
},
|
||||
|
||||
205
phpBB/composer.lock
generated
205
phpBB/composer.lock
generated
@ -3,7 +3,7 @@
|
||||
"This file locks the dependencies of your project to a known state",
|
||||
"Read more about it at http://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file"
|
||||
],
|
||||
"hash": "3c4d83fc3d00d6d76787dbb1d89ee405",
|
||||
"hash": "2faf4ba24774c0d51cff4b78d4a81a68",
|
||||
"packages": [
|
||||
{
|
||||
"name": "lusitanian/oauth",
|
||||
@ -673,6 +673,194 @@
|
||||
],
|
||||
"time": "2014-09-22 15:28:36"
|
||||
},
|
||||
{
|
||||
"name": "symfony/security-core",
|
||||
"version": "v2.5.6",
|
||||
"target-dir": "Symfony/Component/Security/Core",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/security-core.git",
|
||||
"reference": "fc79ba84f7db4a11d8313c87e8845096278d4144"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/security-core/zipball/fc79ba84f7db4a11d8313c87e8845096278d4144",
|
||||
"reference": "fc79ba84f7db4a11d8313c87e8845096278d4144",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.3"
|
||||
},
|
||||
"require-dev": {
|
||||
"ircmaxell/password-compat": "1.0.*",
|
||||
"psr/log": "~1.0",
|
||||
"symfony/event-dispatcher": "~2.1",
|
||||
"symfony/expression-language": "~2.4",
|
||||
"symfony/http-foundation": "~2.4",
|
||||
"symfony/validator": "~2.5"
|
||||
},
|
||||
"suggest": {
|
||||
"ircmaxell/password-compat": "For using the BCrypt password encoder in PHP <5.5",
|
||||
"symfony/event-dispatcher": "",
|
||||
"symfony/expression-language": "For using the expression voter",
|
||||
"symfony/http-foundation": "",
|
||||
"symfony/validator": "For using the user password constraint"
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.5-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Symfony\\Component\\Security\\Core\\": ""
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "http://symfony.com/contributors"
|
||||
},
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com"
|
||||
}
|
||||
],
|
||||
"description": "Symfony Security Component - Core Library",
|
||||
"homepage": "http://symfony.com",
|
||||
"time": "2014-09-28 15:22:14"
|
||||
},
|
||||
{
|
||||
"name": "symfony/security-csrf",
|
||||
"version": "v2.5.6",
|
||||
"target-dir": "Symfony/Component/Security/Csrf",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/security-csrf.git",
|
||||
"reference": "08711832eb9c7b08b513318357391693411e9478"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/security-csrf/zipball/08711832eb9c7b08b513318357391693411e9478",
|
||||
"reference": "08711832eb9c7b08b513318357391693411e9478",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.3",
|
||||
"symfony/security-core": "~2.4"
|
||||
},
|
||||
"require-dev": {
|
||||
"symfony/http-foundation": "~2.1"
|
||||
},
|
||||
"suggest": {
|
||||
"symfony/http-foundation": "For using the class SessionTokenStorage."
|
||||
},
|
||||
"type": "library",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.5-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Symfony\\Component\\Security\\Csrf\\": ""
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "http://symfony.com/contributors"
|
||||
},
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com"
|
||||
}
|
||||
],
|
||||
"description": "Symfony Security Component - CSRF Library",
|
||||
"homepage": "http://symfony.com",
|
||||
"time": "2014-05-12 09:28:39"
|
||||
},
|
||||
{
|
||||
"name": "symfony/twig-bridge",
|
||||
"version": "v2.5.6",
|
||||
"target-dir": "Symfony/Bridge/Twig",
|
||||
"source": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/symfony/TwigBridge.git",
|
||||
"reference": "8850738d9f51436494f87d1e4669f4e870a5fe83"
|
||||
},
|
||||
"dist": {
|
||||
"type": "zip",
|
||||
"url": "https://api.github.com/repos/symfony/TwigBridge/zipball/8850738d9f51436494f87d1e4669f4e870a5fe83",
|
||||
"reference": "8850738d9f51436494f87d1e4669f4e870a5fe83",
|
||||
"shasum": ""
|
||||
},
|
||||
"require": {
|
||||
"php": ">=5.3.3",
|
||||
"symfony/security-csrf": "~2.4",
|
||||
"twig/twig": "~1.12"
|
||||
},
|
||||
"require-dev": {
|
||||
"symfony/console": "~2.2",
|
||||
"symfony/expression-language": "~2.4",
|
||||
"symfony/form": "~2.5,<2.6.0",
|
||||
"symfony/http-kernel": "~2.2",
|
||||
"symfony/routing": "~2.2",
|
||||
"symfony/security": "~2.4",
|
||||
"symfony/stopwatch": "~2.2",
|
||||
"symfony/templating": "~2.1",
|
||||
"symfony/translation": "~2.2",
|
||||
"symfony/yaml": "~2.0"
|
||||
},
|
||||
"suggest": {
|
||||
"symfony/expression-language": "For using the ExpressionExtension",
|
||||
"symfony/form": "For using the FormExtension",
|
||||
"symfony/http-kernel": "For using the HttpKernelExtension",
|
||||
"symfony/routing": "For using the RoutingExtension",
|
||||
"symfony/security": "For using the SecurityExtension",
|
||||
"symfony/stopwatch": "For using the StopwatchExtension",
|
||||
"symfony/templating": "For using the TwigEngine",
|
||||
"symfony/translation": "For using the TranslationExtension",
|
||||
"symfony/yaml": "For using the YamlExtension"
|
||||
},
|
||||
"type": "symfony-bridge",
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.5-dev"
|
||||
}
|
||||
},
|
||||
"autoload": {
|
||||
"psr-0": {
|
||||
"Symfony\\Bridge\\Twig\\": ""
|
||||
}
|
||||
},
|
||||
"notification-url": "https://packagist.org/downloads/",
|
||||
"license": [
|
||||
"MIT"
|
||||
],
|
||||
"authors": [
|
||||
{
|
||||
"name": "Symfony Community",
|
||||
"homepage": "http://symfony.com/contributors"
|
||||
},
|
||||
{
|
||||
"name": "Fabien Potencier",
|
||||
"email": "fabien@symfony.com"
|
||||
}
|
||||
],
|
||||
"description": "Symfony Twig Bridge",
|
||||
"homepage": "http://symfony.com",
|
||||
"time": "2014-10-24 05:49:22"
|
||||
},
|
||||
{
|
||||
"name": "symfony/yaml",
|
||||
"version": "v2.5.5",
|
||||
@ -1159,7 +1347,8 @@
|
||||
"authors": [
|
||||
{
|
||||
"name": "Michiel Rook",
|
||||
"email": "mrook@php.net"
|
||||
"email": "mrook@php.net",
|
||||
"role": "Lead"
|
||||
},
|
||||
{
|
||||
"name": "Phing Community",
|
||||
@ -2309,17 +2498,11 @@
|
||||
"time": "2014-09-23 05:25:11"
|
||||
}
|
||||
],
|
||||
"aliases": [
|
||||
|
||||
],
|
||||
"aliases": [],
|
||||
"minimum-stability": "stable",
|
||||
"stability-flags": [
|
||||
|
||||
],
|
||||
"stability-flags": [],
|
||||
"platform": {
|
||||
"php": ">=5.3.3"
|
||||
},
|
||||
"platform-dev": [
|
||||
|
||||
]
|
||||
"platform-dev": []
|
||||
}
|
||||
|
||||
@ -11,15 +11,6 @@ services:
|
||||
- %core.php_ext%
|
||||
- @cache.driver
|
||||
|
||||
kernel_request_subscriber:
|
||||
class: phpbb\event\kernel_request_subscriber
|
||||
arguments:
|
||||
- @ext.manager
|
||||
- %core.root_path%
|
||||
- %core.php_ext%
|
||||
tags:
|
||||
- { name: kernel.event_subscriber }
|
||||
|
||||
kernel_exception_subscriber:
|
||||
class: phpbb\event\kernel_exception_subscriber
|
||||
arguments:
|
||||
|
||||
@ -73,8 +73,7 @@ services:
|
||||
- @template
|
||||
- @user
|
||||
- @config
|
||||
- @controller.provider
|
||||
- @ext.manager
|
||||
- @router
|
||||
- @symfony_request
|
||||
- @request
|
||||
- @filesystem
|
||||
@ -89,11 +88,6 @@ services:
|
||||
- %core.root_path%
|
||||
- @template
|
||||
|
||||
controller.provider:
|
||||
class: phpbb\controller\provider
|
||||
calls:
|
||||
- [find, [%core.root_path%]]
|
||||
|
||||
ext.manager:
|
||||
class: phpbb\extension\manager
|
||||
arguments:
|
||||
@ -157,6 +151,20 @@ services:
|
||||
- null
|
||||
- %core.disable_super_globals%
|
||||
|
||||
router:
|
||||
class: phpbb\routing\router
|
||||
arguments:
|
||||
- @ext.manager
|
||||
- %core.root_path%
|
||||
- %core.php_ext%
|
||||
|
||||
router.listener:
|
||||
class: Symfony\Component\HttpKernel\EventListener\RouterListener
|
||||
arguments:
|
||||
- @router
|
||||
tags:
|
||||
- { name: kernel.event_subscriber }
|
||||
|
||||
# WARNING: The Symfony request does not escape the input and should be used very carefully
|
||||
# prefer the phpbb request (service @request) as possible
|
||||
symfony_request:
|
||||
|
||||
@ -34,3 +34,10 @@ services:
|
||||
- @user
|
||||
tags:
|
||||
- { name: twig.extension }
|
||||
|
||||
template.twig.extensions.routing:
|
||||
class: Symfony\Bridge\Twig\Extension\RoutingExtension
|
||||
arguments:
|
||||
- @router
|
||||
tags:
|
||||
- { name: twig.extension }
|
||||
|
||||
1
phpBB/phpbb/cache/driver/base.php
vendored
1
phpBB/phpbb/cache/driver/base.php
vendored
@ -50,6 +50,7 @@ abstract class base implements \phpbb\cache\driver\driver_interface
|
||||
}
|
||||
else if (strpos($filename, 'container_') === 0 ||
|
||||
strpos($filename, 'url_matcher') === 0 ||
|
||||
strpos($filename, 'url_generator') === 0 ||
|
||||
strpos($filename, 'sql_') === 0 ||
|
||||
strpos($filename, 'data_') === 0)
|
||||
{
|
||||
|
||||
@ -14,7 +14,6 @@
|
||||
namespace phpbb\controller;
|
||||
|
||||
use Symfony\Component\HttpFoundation\Response;
|
||||
use Symfony\Component\Routing\Generator\UrlGenerator;
|
||||
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
|
||||
@ -41,6 +40,11 @@ class helper
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* @var \phpbb\routing\router phpBB router
|
||||
*/
|
||||
protected $router;
|
||||
|
||||
/* @var \phpbb\symfony_request */
|
||||
protected $symfony_request;
|
||||
|
||||
@ -70,26 +74,24 @@ class helper
|
||||
* @param \phpbb\template\template $template Template object
|
||||
* @param \phpbb\user $user User object
|
||||
* @param \phpbb\config\config $config Config object
|
||||
* @param \phpbb\controller\provider $provider Path provider
|
||||
* @param \phpbb\extension\manager $manager Extension manager object
|
||||
* @param \phpbb\routing\router $router phpBB router
|
||||
* @param \phpbb\symfony_request $symfony_request Symfony Request object
|
||||
* @param \phpbb\request\request_interface $request phpBB request object
|
||||
* @param \phpbb\filesystem $filesystem The filesystem object
|
||||
* @param string $phpbb_root_path phpBB root path
|
||||
* @param string $php_ext PHP file extension
|
||||
*/
|
||||
public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\controller\provider $provider, \phpbb\extension\manager $manager, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\filesystem $filesystem, $phpbb_root_path, $php_ext)
|
||||
public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\routing\router $router, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\filesystem $filesystem, $phpbb_root_path, $php_ext)
|
||||
{
|
||||
$this->template = $template;
|
||||
$this->user = $user;
|
||||
$this->config = $config;
|
||||
$this->router = $router;
|
||||
$this->symfony_request = $symfony_request;
|
||||
$this->request = $request;
|
||||
$this->filesystem = $filesystem;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$provider->find_routing_files($manager->get_finder());
|
||||
$this->route_collection = $provider->find($phpbb_root_path)->get_routes();
|
||||
}
|
||||
|
||||
/**
|
||||
@ -162,8 +164,8 @@ class helper
|
||||
|
||||
$context->setBaseUrl($base_url);
|
||||
|
||||
$url_generator = new UrlGenerator($this->route_collection, $context);
|
||||
$route_url = $url_generator->generate($route, $params, $reference_type);
|
||||
$this->router->setContext($context);
|
||||
$route_url = $this->router->generate($route, $params, $reference_type);
|
||||
|
||||
if ($is_amp)
|
||||
{
|
||||
|
||||
@ -1,92 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* This file is part of the phpBB Forum Software package.
|
||||
*
|
||||
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
||||
* @license GNU General Public License, version 2 (GPL-2.0)
|
||||
*
|
||||
* For full copyright and license information, please see
|
||||
* the docs/CREDITS.txt file.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace phpbb\controller;
|
||||
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
use Symfony\Component\Routing\Loader\YamlFileLoader;
|
||||
use Symfony\Component\Config\FileLocator;
|
||||
|
||||
/**
|
||||
* Controller interface
|
||||
*/
|
||||
class provider
|
||||
{
|
||||
/**
|
||||
* YAML file(s) containing route information
|
||||
* @var array
|
||||
*/
|
||||
protected $routing_files;
|
||||
|
||||
/**
|
||||
* Collection of the routes in phpBB and all found extensions
|
||||
* @var RouteCollection
|
||||
*/
|
||||
protected $routes;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param array $routing_files Array of strings containing paths
|
||||
* to YAML files holding route information
|
||||
*/
|
||||
public function __construct($routing_files = array())
|
||||
{
|
||||
$this->routing_files = $routing_files;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the list of routing files
|
||||
*
|
||||
* @param \phpbb\finder $finder
|
||||
* @return null
|
||||
*/
|
||||
public function find_routing_files(\phpbb\finder $finder)
|
||||
{
|
||||
// We hardcode the path to the core config directory
|
||||
// because the finder cannot find it
|
||||
$this->routing_files = array_merge($this->routing_files, array('config/routing.yml'), array_keys($finder
|
||||
->directory('/config')
|
||||
->suffix('routing.yml')
|
||||
->find()
|
||||
));
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a list of controllers
|
||||
*
|
||||
* @param string $base_path Base path to prepend to file paths
|
||||
* @return provider
|
||||
*/
|
||||
public function find($base_path = '')
|
||||
{
|
||||
$this->routes = new RouteCollection;
|
||||
foreach ($this->routing_files as $file_path)
|
||||
{
|
||||
$loader = new YamlFileLoader(new FileLocator(phpbb_realpath($base_path)));
|
||||
$this->routes->addCollection($loader->load($file_path));
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of routes
|
||||
*
|
||||
* @return RouteCollection Get the route collection
|
||||
*/
|
||||
public function get_routes()
|
||||
{
|
||||
return $this->routes;
|
||||
}
|
||||
}
|
||||
@ -1,82 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* This file is part of the phpBB Forum Software package.
|
||||
*
|
||||
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
||||
* @license GNU General Public License, version 2 (GPL-2.0)
|
||||
*
|
||||
* For full copyright and license information, please see
|
||||
* the docs/CREDITS.txt file.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace phpbb\event;
|
||||
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
use Symfony\Component\HttpKernel\KernelEvents;
|
||||
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
|
||||
use Symfony\Component\HttpKernel\EventListener\RouterListener;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
|
||||
class kernel_request_subscriber implements EventSubscriberInterface
|
||||
{
|
||||
/**
|
||||
* Extension manager object
|
||||
* @var \phpbb\extension\manager
|
||||
*/
|
||||
protected $manager;
|
||||
|
||||
/**
|
||||
* PHP file extension
|
||||
* @var string
|
||||
*/
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* Root path
|
||||
* @var string
|
||||
*/
|
||||
protected $root_path;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param \phpbb\extension\manager $manager Extension manager object
|
||||
* @param string $root_path Root path
|
||||
* @param string $php_ext PHP file extension
|
||||
*/
|
||||
public function __construct(\phpbb\extension\manager $manager, $root_path, $php_ext)
|
||||
{
|
||||
$this->root_path = $root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$this->manager = $manager;
|
||||
}
|
||||
|
||||
/**
|
||||
* This listener is run when the KernelEvents::REQUEST event is triggered
|
||||
*
|
||||
* This is responsible for setting up the routing information
|
||||
*
|
||||
* @param GetResponseEvent $event
|
||||
* @throws \BadMethodCallException
|
||||
* @return null
|
||||
*/
|
||||
public function on_kernel_request(GetResponseEvent $event)
|
||||
{
|
||||
$request = $event->getRequest();
|
||||
$context = new RequestContext();
|
||||
$context->fromRequest($request);
|
||||
|
||||
$matcher = phpbb_get_url_matcher($this->manager, $context, $this->root_path, $this->php_ext);
|
||||
$router_listener = new RouterListener($matcher, $context);
|
||||
$router_listener->onKernelRequest($event);
|
||||
}
|
||||
|
||||
public static function getSubscribedEvents()
|
||||
{
|
||||
return array(
|
||||
KernelEvents::REQUEST => 'on_kernel_request',
|
||||
);
|
||||
}
|
||||
}
|
||||
303
phpBB/phpbb/routing/router.php
Normal file
303
phpBB/phpbb/routing/router.php
Normal file
@ -0,0 +1,303 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* This file is part of the phpBB Forum Software package.
|
||||
*
|
||||
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
||||
* @license GNU General Public License, version 2 (GPL-2.0)
|
||||
*
|
||||
* For full copyright and license information, please see
|
||||
* the docs/CREDITS.txt file.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace phpbb\routing;
|
||||
|
||||
use Symfony\Component\Routing\Matcher\Dumper\PhpMatcherDumper;
|
||||
use Symfony\Component\Routing\Generator\Dumper\PhpGeneratorDumper;
|
||||
use Symfony\Component\Routing\Matcher\UrlMatcher;
|
||||
use Symfony\Component\Routing\Generator\UrlGenerator;
|
||||
use Symfony\Component\Routing\RequestContext;
|
||||
use Symfony\Component\Routing\RouteCollection;
|
||||
use Symfony\Component\Routing\RouterInterface;
|
||||
use Symfony\Component\Routing\Loader\YamlFileLoader;
|
||||
use Symfony\Component\Config\FileLocator;
|
||||
use phpbb\extension\manager;
|
||||
|
||||
/**
|
||||
* Integration of all pieces of the routing system for easier use.
|
||||
*/
|
||||
class router implements RouterInterface
|
||||
{
|
||||
/**
|
||||
* @var manager Extension manager
|
||||
*/
|
||||
protected $extension_manager;
|
||||
|
||||
/**
|
||||
* @var string phpBB root path
|
||||
*/
|
||||
protected $phpbb_root_path;
|
||||
|
||||
/**
|
||||
* @var string PHP file extensions
|
||||
*/
|
||||
protected $php_ext;
|
||||
|
||||
/**
|
||||
* @var array YAML file(s) containing route information
|
||||
*/
|
||||
protected $routing_files;
|
||||
|
||||
/**
|
||||
* @var \Symfony\Component\Routing\Matcher\UrlMatcherInterface|null
|
||||
*/
|
||||
protected $matcher;
|
||||
|
||||
/**
|
||||
* @var \Symfony\Component\Routing\Generator\UrlGeneratorInterface|null
|
||||
*/
|
||||
protected $generator;
|
||||
|
||||
/**
|
||||
* @var RequestContext
|
||||
*/
|
||||
protected $context;
|
||||
|
||||
/**
|
||||
* @var RouteCollection|null
|
||||
*/
|
||||
protected $route_collection;
|
||||
|
||||
/**
|
||||
* Construct method
|
||||
*
|
||||
* @param manager $extension_manager The extension manager
|
||||
* @param string $phpbb_root_path phpBB root path
|
||||
* @param string $php_ext PHP file extension
|
||||
* @param array $routing_files Array of strings containing paths to YAML files holding route information
|
||||
*/
|
||||
public function __construct(manager $extension_manager, $phpbb_root_path, $php_ext, $routing_files = array())
|
||||
{
|
||||
$this->extension_manager = $extension_manager;
|
||||
$this->routing_files = $routing_files;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$this->context = new RequestContext();
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the list of routing files
|
||||
*
|
||||
* @param \phpbb\finder $finder
|
||||
* @return router
|
||||
*/
|
||||
public function find_routing_files(\phpbb\finder $finder)
|
||||
{
|
||||
if ($this->routing_files === null || empty($this->routing_files))
|
||||
{
|
||||
// We hardcode the path to the core config directory
|
||||
// because the finder cannot find it
|
||||
$this->routing_files = array_merge($this->routing_files, array('config/routing.yml'), array_keys($finder
|
||||
->directory('/config')
|
||||
->suffix('routing.yml')
|
||||
->find()
|
||||
));
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find a list of controllers
|
||||
*
|
||||
* @param string $base_path Base path to prepend to file paths
|
||||
* @return router
|
||||
*/
|
||||
public function find($base_path = '')
|
||||
{
|
||||
if ($this->route_collection === null || $this->route_collection->count() === 0)
|
||||
{
|
||||
$this->route_collection = new RouteCollection;
|
||||
foreach ($this->routing_files as $file_path)
|
||||
{
|
||||
$loader = new YamlFileLoader(new FileLocator(phpbb_realpath($base_path)));
|
||||
$this->route_collection->addCollection($loader->load($file_path));
|
||||
}
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the list of routes
|
||||
*
|
||||
* @return RouteCollection Get the route collection
|
||||
*/
|
||||
public function get_routes()
|
||||
{
|
||||
if ($this->route_collection == null || empty($this->routing_files))
|
||||
{
|
||||
$this->find_routing_files($this->extension_manager->get_finder())
|
||||
->find($this->phpbb_root_path);
|
||||
}
|
||||
|
||||
return $this->route_collection;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getRouteCollection()
|
||||
{
|
||||
return $this->get_routes();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function setContext(RequestContext $context)
|
||||
{
|
||||
$this->context = $context;
|
||||
|
||||
if ($this->matcher !== null)
|
||||
{
|
||||
$this->get_matcher()->setContext($context);
|
||||
}
|
||||
if ($this->generator !== null)
|
||||
{
|
||||
$this->get_generator()->setContext($context);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function getContext()
|
||||
{
|
||||
return $this->context;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)
|
||||
{
|
||||
return $this->get_generator()->generate($name, $parameters, $referenceType);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
public function match($pathinfo)
|
||||
{
|
||||
return $this->get_matcher()->match($pathinfo);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the UrlMatcher instance associated with this Router.
|
||||
*
|
||||
* @return \Symfony\Component\Routing\Matcher\UrlMatcherInterface A UrlMatcherInterface instance
|
||||
*/
|
||||
public function get_matcher()
|
||||
{
|
||||
if ($this->matcher !== null)
|
||||
{
|
||||
return $this->matcher;
|
||||
}
|
||||
|
||||
if (defined('DEBUG'))
|
||||
{
|
||||
$this->create_new_url_matcher();
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->create_dumped_url_matcher();
|
||||
}
|
||||
|
||||
return $this->matcher;
|
||||
}
|
||||
/**
|
||||
* Creates a new dumped URL Matcher (dump it if necessary)
|
||||
*/
|
||||
protected function create_dumped_url_matcher()
|
||||
{
|
||||
if (!file_exists($this->phpbb_root_path . 'cache/url_matcher.' . $this->php_ext))
|
||||
{
|
||||
$dumper = new PhpMatcherDumper($this->get_routes());
|
||||
|
||||
$options = array(
|
||||
'class' => 'phpbb_url_matcher',
|
||||
);
|
||||
|
||||
$dump = $dumper->dump($options);
|
||||
file_put_contents($this->phpbb_root_path . 'cache/url_matcher.' . $this->php_ext, $dump);
|
||||
}
|
||||
|
||||
require_once($this->phpbb_root_path . 'cache/url_matcher.' . $this->php_ext);
|
||||
|
||||
$this->matcher = new phpbb_url_matcher($this->context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new URL Matcher
|
||||
*/
|
||||
protected function create_new_url_matcher()
|
||||
{
|
||||
$this->matcher = new UrlMatcher($this->get_routes(), $this->context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the UrlGenerator instance associated with this Router.
|
||||
*
|
||||
* @return \Symfony\Component\Routing\Generator\UrlGeneratorInterface A UrlGeneratorInterface instance
|
||||
*/
|
||||
public function get_generator()
|
||||
{
|
||||
if ($this->generator !== null)
|
||||
{
|
||||
return $this->generator;
|
||||
}
|
||||
|
||||
if (defined('DEBUG'))
|
||||
{
|
||||
$this->create_new_url_generator();
|
||||
}
|
||||
else
|
||||
{
|
||||
$this->create_dumped_url_generator();
|
||||
}
|
||||
|
||||
return $this->generator;
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new dumped URL Generator (dump it if necessary)
|
||||
*/
|
||||
protected function create_dumped_url_generator()
|
||||
{
|
||||
if (!file_exists($this->phpbb_root_path . 'cache/url_generator.' . $this->php_ext))
|
||||
{
|
||||
$dumper = new PhpGeneratorDumper($this->get_routes());
|
||||
|
||||
$options = array(
|
||||
'class' => 'phpbb_url_generator',
|
||||
);
|
||||
|
||||
$dump = $dumper->dump($options);
|
||||
file_put_contents($this->phpbb_root_path . 'cache/url_generator.' . $this->php_ext, $dump);
|
||||
}
|
||||
|
||||
require_once($this->phpbb_root_path . 'cache/url_generator.' . $this->php_ext);
|
||||
|
||||
$this->generator = new phpbb_url_generator($this->context);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new URL Generator
|
||||
*/
|
||||
protected function create_new_url_generator()
|
||||
{
|
||||
$this->generator = new UrlGenerator($this->get_routes(), $this->context);
|
||||
}
|
||||
}
|
||||
@ -119,9 +119,9 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
new phpbb_mock_cache()
|
||||
);
|
||||
$finder->set_extensions(array_keys($this->extension_manager->all_enabled()));
|
||||
$this->provider = new \phpbb\controller\provider();
|
||||
$this->provider->find_routing_files($finder);
|
||||
$this->provider->find(dirname(__FILE__) . '/');
|
||||
$this->router = new phpbb_mock_router($this->extension_manager, dirname(__FILE__) . '/', 'php');
|
||||
$this->router->find_routing_files($finder);
|
||||
$this->router->find(dirname(__FILE__) . '/');
|
||||
// Set correct current phpBB root path
|
||||
$this->root_path = $this->get_phpbb_root_path();
|
||||
}
|
||||
@ -161,8 +161,9 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
*/
|
||||
public function test_helper_url_no_rewrite($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id));
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '0'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_with_rewrite()
|
||||
@ -201,8 +202,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_with_rewrite($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '1'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_absolute()
|
||||
@ -241,8 +242,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_absolute($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '0'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::ABSOLUTE_URL));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::ABSOLUTE_URL), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_relative_path()
|
||||
@ -281,8 +282,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_relative_path($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '0'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::RELATIVE_PATH));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::RELATIVE_PATH), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_network()
|
||||
@ -321,8 +322,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_network($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '0'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::NETWORK_PATH));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::NETWORK_PATH), $description);
|
||||
}
|
||||
//TODO
|
||||
public function helper_url_data_absolute_with_rewrite()
|
||||
@ -361,8 +362,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_absolute_with_rewrite($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '1'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::ABSOLUTE_URL));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::ABSOLUTE_URL), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_relative_path_with_rewrite()
|
||||
@ -401,8 +402,8 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_relative_path_with_rewrite($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '1'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::RELATIVE_PATH));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::RELATIVE_PATH), $description);
|
||||
}
|
||||
|
||||
public function helper_url_data_network_with_rewrite()
|
||||
@ -441,7 +442,7 @@ abstract class phpbb_controller_common_helper_route extends phpbb_test_case
|
||||
public function test_helper_url_network_with_rewrite($route, $params, $is_amp, $session_id, $expected, $description)
|
||||
{
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '1'));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->provider, $this->extension_manager, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::NETWORK_PATH));
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $this->router, $this->symfony_request, $this->request, $this->filesystem, $this->root_path, 'php', dirname(__FILE__) . '/');
|
||||
$this->assertEquals($expected, $this->helper->route($route, $params, $is_amp, $session_id, UrlGeneratorInterface::NETWORK_PATH), $description);
|
||||
}
|
||||
}
|
||||
|
||||
@ -33,11 +33,11 @@ class phpbb_controller_controller_test extends phpbb_test_case
|
||||
));
|
||||
}
|
||||
|
||||
public function test_provider()
|
||||
public function test_router_find_files()
|
||||
{
|
||||
$provider = new \phpbb\controller\provider();
|
||||
$provider->find_routing_files($this->extension_manager->get_finder());
|
||||
$routes = $provider->find(__DIR__)->get_routes();
|
||||
$router = new \phpbb\routing\router($this->extension_manager, dirname(__FILE__) . '/', 'php');
|
||||
$router->find_routing_files($this->extension_manager->get_finder());
|
||||
$routes = $router->find(__DIR__)->get_routes();
|
||||
|
||||
// This will need to be updated if any new routes are defined
|
||||
$this->assertInstanceOf('Symfony\Component\Routing\Route', $routes->get('core_controller'));
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
|
||||
class phpbb_mock_controller_helper extends \phpbb\controller\helper
|
||||
{
|
||||
public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\controller\provider $provider, \phpbb\extension\manager $manager, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\filesystem $filesystem, $phpbb_root_path, $php_ext, $phpbb_root_path_ext)
|
||||
public function __construct(\phpbb\template\template $template, \phpbb\user $user, \phpbb\config\config $config, \phpbb\routing\router $router, \phpbb\symfony_request $symfony_request, \phpbb\request\request_interface $request, \phpbb\filesystem $filesystem, $phpbb_root_path, $php_ext, $phpbb_root_path_ext)
|
||||
{
|
||||
$this->template = $template;
|
||||
$this->user = $user;
|
||||
@ -23,8 +23,7 @@ class phpbb_mock_controller_helper extends \phpbb\controller\helper
|
||||
$this->filesystem = $filesystem;
|
||||
$this->phpbb_root_path = $phpbb_root_path;
|
||||
$this->php_ext = $php_ext;
|
||||
$provider->find_routing_files($manager->get_finder());
|
||||
$this->route_collection = $provider->find($phpbb_root_path_ext)->get_routes();
|
||||
$this->router = $router;
|
||||
}
|
||||
|
||||
public function get_current_url()
|
||||
|
||||
27
tests/mock/router.php
Normal file
27
tests/mock/router.php
Normal file
@ -0,0 +1,27 @@
|
||||
<?php
|
||||
/**
|
||||
*
|
||||
* This file is part of the phpBB Forum Software package.
|
||||
*
|
||||
* @copyright (c) phpBB Limited <https://www.phpbb.com>
|
||||
* @license GNU General Public License, version 2 (GPL-2.0)
|
||||
*
|
||||
* For full copyright and license information, please see
|
||||
* the docs/CREDITS.txt file.
|
||||
*
|
||||
*/
|
||||
|
||||
class phpbb_mock_router extends \phpbb\routing\router
|
||||
{
|
||||
public function get_matcher()
|
||||
{
|
||||
$this->create_new_url_matcher();
|
||||
return parent::get_matcher();
|
||||
}
|
||||
|
||||
public function get_generator()
|
||||
{
|
||||
$this->create_new_url_generator();
|
||||
return parent::get_generator();
|
||||
}
|
||||
}
|
||||
@ -44,9 +44,9 @@ class phpbb_pagination_pagination_test extends phpbb_template_template_test_case
|
||||
$finder->set_extensions(array_keys($manager->all_enabled()));
|
||||
|
||||
$this->config = new \phpbb\config\config(array('enable_mod_rewrite' => '1'));
|
||||
$provider = new \phpbb\controller\provider();
|
||||
$provider->find_routing_files($finder);
|
||||
$provider->find(dirname(__FILE__) . '/');
|
||||
$router = new phpbb_mock_router($manager, dirname(__FILE__) . '/', 'php');
|
||||
$router->find_routing_files($finder);
|
||||
$router->find(dirname(__FILE__) . '/');
|
||||
|
||||
$request = new phpbb_mock_request();
|
||||
$request->overwrite('SCRIPT_NAME', '/app.php', \phpbb\request\request_interface::SERVER);
|
||||
@ -57,7 +57,7 @@ class phpbb_pagination_pagination_test extends phpbb_template_template_test_case
|
||||
$request
|
||||
);
|
||||
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $provider, $manager, $symfony_request, $request, $filesystem, '', 'php', dirname(__FILE__) . '/');
|
||||
$this->helper = new phpbb_mock_controller_helper($this->template, $this->user, $this->config, $router, $symfony_request, $request, $filesystem, '', 'php', dirname(__FILE__) . '/');
|
||||
$this->pagination = new \phpbb\pagination($this->template, $this->user, $this->helper, $phpbb_dispatcher);
|
||||
}
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user