feature #51804 [Security] Make impersonation_path() argument mandatory and add impersonation_url() (alexandre-daubois)

fabpot · fabpot · commit e11ae31aea07 · 2023-10-02T13:28:24.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [Security] Make `impersonation_path()` argument mandatory and add `impersonation_url()` | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | yes | Deprecations? | no | Tickets | - | License | MIT Follow-up of #50030 When documenting this function, I found out that the`identifier` argument was optional, which seemed weird to me given the function purpose. I then had a look at the implementation, and I saw that `ImpersonateUrlGenerator::generateImpersonationPath()` accepts a nullable string. However, the underlying call to `ImpersonateUrlGenerator::buildPath()` doesn't accept a nullable string. I propose to make the `identifier` argument mandatory, which makes more sense here. I also added the missing Changelog line and `impersonation_url()` Commits ------- 5d71d95 [Security] Make `impersonation_path()` argument mandatory and add `impersonation_url()`
diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Allow an array to be passed as the first argument to the `importmap()` Twig function
  * Add `TemplatedEmail::locale()` to set the locale for the email rendering
  * Add `AppVariable::getEnabledLocales()` to retrieve the enabled locales
+ * Add `impersonation_path()` and `impersonation_url()` Twig functions
 
 6.3
 ---
diff --git a/src/Symfony/Bridge/Twig/Extension/SecurityExtension.php b/src/Symfony/Bridge/Twig/Extension/SecurityExtension.php
@@ -69,7 +69,16 @@ public function getImpersonateExitPath(string $exitTo = null): string
         return $this->impersonateUrlGenerator->generateExitPath($exitTo);
     }
 
-    public function getImpersonatePath(string $identifier = null): string
+    public function getImpersonateUrl(string $identifier): string
+    {
+        if (null === $this->impersonateUrlGenerator) {
+            return '';
+        }
+
+        return $this->impersonateUrlGenerator->generateImpersonationUrl($identifier);
+    }
+
+    public function getImpersonatePath(string $identifier): string
     {
         if (null === $this->impersonateUrlGenerator) {
             return '';
@@ -84,6 +93,7 @@ public function getFunctions(): array
             new TwigFunction('is_granted', $this->isGranted(...)),
             new TwigFunction('impersonation_exit_url', $this->getImpersonateExitUrl(...)),
             new TwigFunction('impersonation_exit_path', $this->getImpersonateExitPath(...)),
+            new TwigFunction('impersonation_url', $this->getImpersonateUrl(...)),
             new TwigFunction('impersonation_path', $this->getImpersonatePath(...)),
         ];
     }
diff --git a/src/Symfony/Component/Security/Http/Impersonate/ImpersonateUrlGenerator.php b/src/Symfony/Component/Security/Http/Impersonate/ImpersonateUrlGenerator.php
@@ -36,11 +36,20 @@ public function __construct(RequestStack $requestStack, FirewallMap $firewallMap
         $this->firewallMap = $firewallMap;
     }
 
-    public function generateImpersonationPath(string $identifier = null): string
+    public function generateImpersonationPath(string $identifier): string
     {
         return $this->buildPath(null, $identifier);
     }
 
+    public function generateImpersonationUrl(string $identifier): string
+    {
+        if (null === $request = $this->requestStack->getCurrentRequest()) {
+            return '';
+        }
+
+        return $request->getUriForPath($this->buildPath(null, $identifier));
+    }
+
     public function generateExitPath(string $targetUri = null): string
     {
         return $this->buildPath($targetUri);

Original file line number	Diff line number	Diff line change
`@@ -36,11 +36,20 @@ public function __construct(RequestStack $requestStack, FirewallMap $firewallMap`
`36`	`36`	`$this->firewallMap = $firewallMap;`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function generateImpersonationPath(string $identifier = null): string`
	`39`	`+ public function generateImpersonationPath(string $identifier): string`
`40`	`40`	`{`
`41`	`41`	`return $this->buildPath(null, $identifier);`
`42`	`42`	`}`
`43`	`43`
	`44`	`+ public function generateImpersonationUrl(string $identifier): string`
	`45`	`+ {`
	`46`	`+ if (null === $request = $this->requestStack->getCurrentRequest()) {`
	`47`	`+ return '';`
	`48`	`+ }`
	`49`	`+`
	`50`	`+ return $request->getUriForPath($this->buildPath(null, $identifier));`
	`51`	`+ }`
	`52`	`+`
`44`	`53`	`public function generateExitPath(string $targetUri = null): string`
`45`	`54`	`{`
`46`	`55`	`return $this->buildPath($targetUri);`