use router interface more strictly

This commit is contained in:
Dennis Eichhorn 2022-12-24 23:56:56 +01:00
parent 8d4736256f
commit a27b433ef4
4 changed files with 65 additions and 50 deletions

View File

@ -77,7 +77,7 @@ class PacketManager
$response = new SocketResponse(); $response = new SocketResponse();
$this->dispatcher->dispatch( $this->dispatcher->dispatch(
$this->router->route($data, RouteVerb::ANY, 'Socket', 1, $client->getAccount()), $this->router->route($data, null, RouteVerb::ANY, 'Socket', 1, $client->getAccount()),
$request, $request,
$response $response
); );

View File

@ -14,6 +14,8 @@ declare(strict_types=1);
namespace phpOMS\Router; namespace phpOMS\Router;
use phpOMS\Account\Account;
/** /**
* Router interface. * Router interface.
* *
@ -42,4 +44,52 @@ interface RouterInterface
* @since 1.0.0 * @since 1.0.0
*/ */
public function clear() : void; public function clear() : void;
/**
* Add route.
*
* @param string $route Route regex
* @param mixed $destination Destination e.g. Module:function string or callback
* @param int $verb Request verb
* @param bool $csrf Is CSRF token required
* @param array $validation Validation patterns
* @param string $dataPattern Data patterns
*
* @return void
*
* @since 1.0.0
*/
public function add(
string $route,
mixed $destination,
int $verb = RouteVerb::GET,
bool $csrf = false,
array $validation = [],
string $dataPattern = ''
) : void;
/**
* Route request.
*
* @param string $uri Route
* @param string $csrf CSRF token
* @param int $verb Route verb
* @param string $app Application name
* @param int $orgId Organization id
* @param Account $account Account
* @param array $data Data
*
* @return array
*
* @since 1.0.0
*/
public function route(
string $uri,
string $csrf = null,
int $verb = RouteVerb::GET,
string $app = null,
int $orgId = null,
Account $account = null,
array $data = null
) : array;
} }

View File

@ -82,22 +82,13 @@ final class SocketRouter implements RouterInterface
} }
/** /**
* Add route. * {@inheritdoc}
*
* @param string $route Route regex
* @param mixed $destination Destination e.g. Module:function string or callback
* @param int $verb Request verb
* @param array $validation Validation patterns
* @param string $dataPattern Data patterns
*
* @return void
*
* @since 1.0.0
*/ */
public function add( public function add(
string $route, string $route,
mixed $destination, mixed $destination,
int $verb = RouteVerb::GET, int $verb = RouteVerb::GET,
bool $csrf = false,
array $validation = [], array $validation = [],
string $dataPattern = '' string $dataPattern = ''
) : void ) : void
@ -109,27 +100,18 @@ final class SocketRouter implements RouterInterface
$this->routes[$route][] = [ $this->routes[$route][] = [
'dest' => $destination, 'dest' => $destination,
'verb' => $verb, 'verb' => $verb,
'csrf' => $csrf,
'validation' => empty($validation) ? null : $validation, 'validation' => empty($validation) ? null : $validation,
'pattern' => empty($dataPattern) ? null : $dataPattern, 'pattern' => empty($dataPattern) ? null : $dataPattern,
]; ];
} }
/** /**
* Route request. * {@inheritdoc}
*
* @param string $uri Route
* @param int $verb Route verb
* @param string $app Application name
* @param int $orgId Organization id
* @param Account $account Account
* @param array $data Data
*
* @return array
*
* @since 1.0.0
*/ */
public function route( public function route(
string $uri, string $uri,
string $csrf = null,
int $verb = RouteVerb::GET, int $verb = RouteVerb::GET,
string $app = null, string $app = null,
int $orgId = null, int $orgId = null,
@ -148,6 +130,11 @@ final class SocketRouter implements RouterInterface
|| $verb === RouteVerb::ANY || $verb === RouteVerb::ANY
|| ($verb & $d['verb']) === $verb || ($verb & $d['verb']) === $verb
) { ) {
// if csrf is required but not set
if (isset($d['csrf']) && $d['csrf'] && $csrf === null) {
return ['dest' => RouteStatus::INVALID_CSRF];
}
// if permission check is invalid // if permission check is invalid
if (isset($d['permission']) && !empty($d['permission']) if (isset($d['permission']) && !empty($d['permission'])
&& ($account === null || $account instanceof NullAccount) && ($account === null || $account instanceof NullAccount)

View File

@ -84,24 +84,14 @@ final class WebRouter implements RouterInterface
} }
/** /**
* Add route. * {@inheritdoc}
*
* @param string $route Route regex
* @param mixed $destination Destination e.g. Module:function string or callback
* @param int $verb Request verb
* @param bool $csrf Is CSRF token required
* @param array $validation Validation patterns
* @param string $dataPattern Data patterns
*
* @return void
*
* @since 1.0.0
*/ */
public function add( public function add(
string $route, string $route,
mixed $destination, mixed $destination,
int $verb = RouteVerb::GET, int $verb = RouteVerb::GET,
bool $csrf = false, array $validation = [], bool $csrf = false,
array $validation = [],
string $dataPattern = '' string $dataPattern = ''
) : void ) : void
{ {
@ -119,19 +109,7 @@ final class WebRouter implements RouterInterface
} }
/** /**
* Route request. * {@inheritdoc}
*
* @param string $uri Route
* @param string $csrf CSRF token
* @param int $verb Route verb
* @param string $app Application name
* @param int $orgId Organization id
* @param Account $account Account
* @param array $data Validation
*
* @return array
*
* @since 1.0.0
*/ */
public function route( public function route(
string $uri, string $uri,