[CORE][ROUTES] Implemented custom router, with an interface similar to the old one, which allows routes to be seperated into files

This commit is contained in:
Hugo Sales 2020-03-21 18:53:25 +00:00 committed by Hugo Sales
parent e92a0227a1
commit 5d1685b142
Signed by: someonewithpc
GPG Key ID: 7D0C7EAFC9D835A0
4 changed files with 136 additions and 7 deletions

View File

@ -1,10 +1,7 @@
<?php <?php
use App\Controller\NetworkPublic;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator; use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
return function (RoutingConfigurator $routes) { return function (RoutingConfigurator $routes) {
$routes->add('network.public', '/main/all') $routes->import('.', 'GNUsocial');
->controller(NetworkPublic::class);
}; };

View File

@ -15,7 +15,7 @@ services:
# this creates a service per class whose id is the fully-qualified class name # this creates a service per class whose id is the fully-qualified class name
App\: App\:
resource: '../src/*' resource: '../src/*'
exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}' exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php,Routes}'
# controllers are imported separately to make sure services can be injected # controllers are imported separately to make sure services can be injected
# as action arguments even if you don't extend any base controller class # as action arguments even if you don't extend any base controller class
@ -23,8 +23,9 @@ services:
resource: '../src/Controller' resource: '../src/Controller'
tags: ['controller.service_arguments'] tags: ['controller.service_arguments']
# add more service definitions when explicit configuration is needed App\Util\RouteLoader:
# please note that last definitions always *replace* previous ones tags: ['routing.loader']
# Wrapper arround Doctrine's StaticPHP metadata driver # Wrapper arround Doctrine's StaticPHP metadata driver
app.util.schemadef_driver: app.util.schemadef_driver:

13
src/Routes/Main.php Normal file
View File

@ -0,0 +1,13 @@
<?php
namespace App\Routes;
use App\Util\RouteLoader;
abstract class Main
{
public static function load(RouteLoader $r): void
{
$r->connect('main_all', '/main/all', \App\Controller\NetworkPublic::class);
}
}

118
src/Util/RouteLoader.php Normal file
View File

@ -0,0 +1,118 @@
<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// GNU social is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with GNU social. If not, see <http://www.gnu.org/licenses/>.
/**
* Old URLMapper interface atop Symfony's router
*
* Converts a path into a set of parameters, and vice versa
*
* @package GNUsocial
* @category URL
*
* @author Hugo Sales <hugo@fc.up.pt>
* @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
namespace App\Util;
use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;
class RouteLoader extends Loader
{
private RouteCollection $rc;
/**
* Route loading entry point, called from `config/routes.php`
*
* Must comform to symfony's interface, but the $resource is unused
* and $type must not be null
*
* @param mixed $resource
*/
public function load($resource, string $type = null): RouteCollection
{
$this->rc = new RouteCollection();
$route_files = glob(INSTALLDIR . '/src/Routes/*.php');
foreach ($route_files as $file) {
require_once $file;
$ns = '\\App\\Routes\\' . basename($file, '.php');
$ns::load($this);
}
return $this->rc;
}
/**
* Connect a route to a controller
*
* @param mixed $target Some kind of callable, typically [object, method]
* @param ?array $options Possible keys are ['condition', 'defaults', 'format',
* 'fragment', 'http-methods', 'locale', 'methods', 'schemes']
* 'http-methods' and 'methods' are aliases
*/
public function connect(string $id, string $uri_path, $target, ?array $param_reqs = [], ?array $options = [])
{
$this->rc->add($id,
new Route(
// path -- URI path
$uri_path,
// defaults = [] -- param default values,
// and special configuration options
array_merge(
[
'_controller' => is_array($target) ? $target : [$target, '__invoke'],
'_format' => $options['format'] ?? 'html',
'_fragment' => $options['fragment'] ?? '',
'_locale' => $options['locale'] ?? '',
],
$options['defaults'] ?? []),
// requirements = [] -- param => regex
$param_reqs,
// options = [] -- possible keys: compiler_class:, utf8
// No need for a special compiler class for now,
// Enforce UTF8
['utf8' => true],
// host = '' -- hostname (subdomain, for instance) to match,
// we don't want this
'',
// schemes = [] -- URI schemes (https, ftp and such)
$options['schemes'] ?? [],
// methods = [] -- HTTP methods
$options['http-methods'] ?? $options['methods'] ?? [],
// condition = '' -- Symfony condition expression,
// see https://symfony.com/doc/current/routing.html#matching-expressions
$options['condition'] ?? ''
)
);
}
/**
* Whether this loader supports loading this route type
* Passed the arguments from the `RoutingConfigurator::import` call from
* `config/routes.php`
*
* @param mixed $resource Unused
*/
public function supports($resource, string $type = null)
{
return 'GNUsocial' === $type;
}
}