Skip to content

Commit

Permalink
link generation moved to a new class LinkGenerator
Browse files Browse the repository at this point in the history
  • Loading branch information
@dg
dg committed Apr 20, 2024
1 parent bb652c1 commit 850ab85
Show file tree
Hide file tree
Showing 7 changed files with 273 additions and 247 deletions.
228 changes: 228 additions & 0 deletions src/Application/LinkGenerator.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
*/
final class LinkGenerator
{
/** @internal */
public ?Request $lastRequest = null;


public function __construct(
private readonly Router $router,
private readonly UrlScript $refUrl,
Expand Down Expand Up @@ -78,6 +82,230 @@ public function link(string $dest, array $params = []): string
}


/**
* @param string $destination in format "[[[module:]presenter:]action | signal! | this]"
* @param string $mode forward|redirect|link
* @throws UI\InvalidLinkException
* @internal
*/
public function createRequest(
UI\Component $component,
string $destination,
array $args,
string $mode,
): ?string
{
// note: createRequest supposes that saveState(), run() & tryCall() behaviour is final

$this->lastRequest = null;
$refPresenter = $component->getPresenter();

$parts = static::parseDestination($destination);
$path = $parts['path'];
$args = $parts['args'] ?? $args;

if (!$component instanceof UI\Presenter || $parts['signal']) {
[$cname, $signal] = Helpers::splitName($path);
if ($cname !== '') {
$component = $component->getComponent(strtr($cname, ':', '-'));
}

if ($signal === '') {
throw new UI\InvalidLinkException('Signal must be non-empty string.');
}

$path = 'this';
}

$current = false;
[$presenter, $action] = Helpers::splitName($path);
if ($presenter === '') {
$action = $path === 'this' ? $refPresenter->getAction() : $action;
$presenter = $refPresenter->getName();
$presenterClass = $refPresenter::class;

} else {
if ($presenter[0] === ':') { // absolute
$presenter = substr($presenter, 1);
if (!$presenter) {
throw new UI\InvalidLinkException("Missing presenter name in '$destination'.");
}
} else { // relative
[$module, , $sep] = Helpers::splitName($refPresenter->getName());
$presenter = $module . $sep . $presenter;
}

try {
$presenterClass = $this->presenterFactory->getPresenterClass($presenter);
} catch (InvalidPresenterException $e) {
throw new UI\InvalidLinkException($e->getMessage(), 0, $e);
}
}

// PROCESS SIGNAL ARGUMENTS
if (isset($signal)) { // $component must be StatePersistent
$reflection = new UI\ComponentReflection($component::class);
if ($signal === 'this') { // means "no signal"
$signal = '';
if (array_key_exists(0, $args)) {
throw new UI\InvalidLinkException("Unable to pass parameters to 'this!' signal.");
}
} elseif (!str_contains($signal, UI\Component::NameSeparator)) {
// counterpart of signalReceived() & tryCall()

$method = $reflection->getSignalMethod($signal);
if (!$method) {
throw new UI\InvalidLinkException("Unknown signal '$signal', missing handler {$reflection->getName()}::{$component::formatSignalMethod($signal)}()");
} elseif (
$refPresenter->invalidLinkMode
&& UI\ComponentReflection::parseAnnotation($method, 'deprecated')
) {
trigger_error("Link to deprecated signal '$signal'" . ($component === $refPresenter ? '' : ' in ' . $component::class) . " from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
}

// convert indexed parameters to named
UI\ParameterConverter::toParameters($component::class, $method->getName(), $args, [], $missing);
}

// counterpart of StatePersistent
if ($args && array_intersect_key($args, $reflection->getPersistentParams())) {
$component->saveState($args);
}

if ($args && $component !== $refPresenter) {
$prefix = $component->getUniqueId() . UI\Component::NameSeparator;
foreach ($args as $key => $val) {
unset($args[$key]);
$args[$prefix . $key] = $val;
}
}
}

// PROCESS ARGUMENTS
if (is_subclass_of($presenterClass, UI\Presenter::class)) {
if ($action === '') {
$action = UI\Presenter::DefaultAction;
}

$current = ($action === '*' || strcasecmp($action, $refPresenter->getAction()) === 0) && $presenterClass === $refPresenter::class;

$reflection = new UI\ComponentReflection($presenterClass);
if ($refPresenter->invalidLinkMode && UI\ComponentReflection::parseAnnotation($reflection, 'deprecated')) {
trigger_error("Link to deprecated presenter '$presenter' from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
}

// counterpart of run() & tryCall()
if ($method = $reflection->getActionRenderMethod($action)) {
if ($refPresenter->invalidLinkMode && UI\ComponentReflection::parseAnnotation($method, 'deprecated')) {
trigger_error("Link to deprecated action '$presenter:$action' from '{$refPresenter->getName()}:{$refPresenter->getAction()}'.", E_USER_DEPRECATED);
}

UI\ParameterConverter::toParameters($presenterClass, $method->getName(), $args, $path === 'this' ? $refPresenter->getParameters() : [], $missing);

} elseif (array_key_exists(0, $args)) {
throw new UI\InvalidLinkException("Unable to pass parameters to action '$presenter:$action', missing corresponding method.");
}

// counterpart of StatePersistent
if (empty($signal) && $args && array_intersect_key($args, $reflection->getPersistentParams())) {
$refPresenter->saveStatePartial($args, $reflection);
}

$globalState = $refPresenter->getGlobalState($path === 'this' ? null : $presenterClass);
if ($current && $args) {
$tmp = $globalState + $refPresenter->getParameters();
foreach ($args as $key => $val) {
if (http_build_query([$val]) !== (isset($tmp[$key]) ? http_build_query([$tmp[$key]]) : '')) {
$current = false;
break;
}
}
}

$args += $globalState;
}

if ($mode !== 'test' && !empty($missing)) {
foreach ($missing as $rp) {
if (!array_key_exists($rp->getName(), $args)) {
throw new UI\InvalidLinkException("Missing parameter \${$rp->getName()} required by {$rp->getDeclaringClass()->getName()}::{$rp->getDeclaringFunction()->getName()}()");
}
}
}

// ADD ACTION & SIGNAL & FLASH
if ($action) {
$args[UI\Presenter::ActionKey] = $action;
}

if (!empty($signal)) {
$args[UI\Presenter::SignalKey] = $component->getParameterId($signal);
$current = $current && $args[UI\Presenter::SignalKey] === $refPresenter->getParameter(UI\Presenter::SignalKey);
}

if (($mode === 'redirect' || $mode === 'forward') && $refPresenter->hasFlashSession()) {
$flashKey = $refPresenter->getParameter(UI\Presenter::FlashKey);
$args[UI\Presenter::FlashKey] = is_string($flashKey) && $flashKey !== '' ? $flashKey : null;
}

$this->lastRequest = new Request($presenter, Request::FORWARD, $args, flags: ['current' => $current]);

return $mode === 'forward' || $mode === 'test'
? null
: $this->requestToUrl($this->lastRequest, $mode === 'link' && !$parts['absolute'] && !$refPresenter->absoluteUrls) . $parts['fragment'];
}


/**
* Parse destination in format "[//] [[[module:]presenter:]action | signal! | this] [?query] [#fragment]"
* @throws UI\InvalidLinkException
* @return array{absolute: bool, path: string, signal: bool, args: ?array, fragment: string}
* @internal
*/
public static function parseDestination(string $destination): array
{
if (!preg_match('~^ (?<absolute>//)?+ (?<path>[^!?#]++) (?<signal>!)?+ (?<query>\?[^#]*)?+ (?<fragment>\#.*)?+ $~x', $destination, $matches)) {
throw new UI\InvalidLinkException("Invalid destination '$destination'.");
}

if (!empty($matches['query'])) {
parse_str(substr($matches['query'], 1), $args);
}

return [
'absolute' => (bool) $matches['absolute'],
'path' => $matches['path'],
'signal' => !empty($matches['signal']),
'args' => $args ?? null,
'fragment' => $matches['fragment'] ?? '',
];
}


/**
* Converts Request to URL.
*/
public function requestToUrl(Request $request, ?bool $relative = false): string
{
$url = $this->router->constructUrl($request->toArray(), $this->refUrl);
if ($url === null) {
$params = $request->getParameters();
unset($params[UI\Presenter::ActionKey], $params[UI\Presenter::PresenterKey]);
$params = urldecode(http_build_query($params, '', ', '));
throw new UI\InvalidLinkException("No route for {$request->getPresenterName()}:{$request->getParameter('action')}($params)");
}

if ($relative) {
$hostUrl = $this->refUrl->getHostUrl() . '/';
if (strncmp($url, $hostUrl, strlen($hostUrl)) === 0) {
$url = substr($url, strlen($hostUrl) - 1);
}
}

return $url;
}


public function withReferenceUrl(string $url): static
{
return new self(
Expand Down
8 changes: 4 additions & 4 deletions src/Application/UI/Component.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ public function link(string $destination, $args = []): string
$args = func_num_args() < 3 && is_array($args)
? $args
: array_slice(func_get_args(), 1);
return $this->getPresenter()->createRequest($this, $destination, $args, 'link');
return $this->getPresenter()->getLinkGenerator()->createRequest($this, $destination, $args, 'link');

} catch (InvalidLinkException $e) {
return $this->getPresenter()->handleInvalidLink($e);
Expand Down Expand Up @@ -324,7 +324,7 @@ public function isLinkCurrent(?string $destination = null, $args = []): bool
$args = func_num_args() < 3 && is_array($args)
? $args
: array_slice(func_get_args(), 1);
$this->getPresenter()->createRequest($this, $destination, $args, 'test');
$this->getPresenter()->getLinkGenerator()->createRequest($this, $destination, $args, 'test');
}

return $this->getPresenter()->getLastCreatedRequestFlag('current');
Expand All @@ -345,7 +345,7 @@ public function redirect(string $destination, $args = []): void
: array_slice(func_get_args(), 1);
$presenter = $this->getPresenter();
$presenter->saveGlobalState();
$presenter->redirectUrl($presenter->createRequest($this, $destination, $args, 'redirect'));
$presenter->redirectUrl($presenter->getLinkGenerator()->createRequest($this, $destination, $args, 'redirect'));
}


Expand All @@ -363,7 +363,7 @@ public function redirectPermanent(string $destination, $args = []): void
: array_slice(func_get_args(), 1);
$presenter = $this->getPresenter();
$presenter->redirectUrl(
$presenter->createRequest($this, $destination, $args, 'redirect'),
$presenter->getLinkGenerator()->createRequest($this, $destination, $args, 'redirect'),
Nette\Http\IResponse::S301_MovedPermanently,
);
}
Expand Down
Loading

0 comments on commit 850ab85

Please sign in to comment.