minor symfony#58089 [Uid] Rework internal format conversion (alexandre-daubois)

nicolas-grekas · nicolas-grekas · commit f892c58ad824 · 2024-08-27T16:36:21.000+02:00
This PR was merged into the 7.2 branch. Discussion ---------- [Uid] Rework internal format conversion | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT On a second look, the control flow is a bit confusing so I propose this refactor to clear things up. Commits ------- 736c5a6 [Uid] Rework internal format conversion
diff --git a/src/Symfony/Component/Uid/Uuid.php b/src/Symfony/Component/Uid/Uuid.php
@@ -124,15 +124,17 @@ final public static function v8(string $uuid): UuidV8
     /**
      * @param int-mask-of<Uuid::FORMAT_*> $format
      */
-    public static function isValid(string $uuid /*, int $format = self::FORMAT_RFC_4122 */): bool
+    public static function isValid(string $uuid /* , int $format = self::FORMAT_RFC_4122 */): bool
     {
         $format = 1 < \func_num_args() ? func_get_arg(1) : self::FORMAT_RFC_4122;
 
         if (36 === \strlen($uuid) && !($format & self::FORMAT_RFC_4122)) {
             return false;
         }
 
-        $uuid = self::transformToRfc4122($uuid, $format);
+        if (false === $uuid = self::transformToRfc4122($uuid, $format)) {
+            return false;
+        }
 
         if (self::NIL === $uuid && \in_array(static::class, [__CLASS__, NilUuid::class], true)) {
             return true;
@@ -190,10 +192,11 @@ private static function format(string $uuid, string $version): string
      *
      * @param int-mask-of<Uuid::FORMAT_*> $format
      *
-     * @return non-empty-string
+     * @return string|false The RFC4122 string or false if the format doesn't match the input
      */
-    private static function transformToRfc4122(string $uuid, int $format): string
+    private static function transformToRfc4122(string $uuid, int $format): string|false
     {
+        $inputUuid = $uuid;
         $fromBase58 = false;
         if (22 === \strlen($uuid) && 22 === strspn($uuid, BinaryUtil::BASE58['']) && $format & self::FORMAT_BASE_58) {
             $uuid = str_pad(BinaryUtil::fromBase($uuid, BinaryUtil::BASE58), 16, "\0", \STR_PAD_LEFT);
@@ -214,6 +217,11 @@ private static function transformToRfc4122(string $uuid, int $format): string
             $uuid = $ulid->toRfc4122();
         }
 
+        if ($inputUuid === $uuid && !($format & self::FORMAT_RFC_4122)) {
+            // input format doesn't match the input string
+            return false;
+        }
+
         return $uuid;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -124,15 +124,17 @@ final public static function v8(string $uuid): UuidV8`
`124`	`124`	`/**`
`125`	`125`	`* @param int-mask-of<Uuid::FORMAT_*> $format`
`126`	`126`	`*/`
`127`		`- public static function isValid(string $uuid /, int $format = self::FORMAT_RFC_4122 /): bool`
	`127`	`+ public static function isValid(string $uuid /* , int $format = self::FORMAT_RFC_4122 */): bool`
`128`	`128`	`{`
`129`	`129`	`$format = 1 < \func_num_args() ? func_get_arg(1) : self::FORMAT_RFC_4122;`
`130`	`130`
`131`	`131`	`if (36 === \strlen($uuid) && !($format & self::FORMAT_RFC_4122)) {`
`132`	`132`	`return false;`
`133`	`133`	`}`
`134`	`134`
`135`		`- $uuid = self::transformToRfc4122($uuid, $format);`
	`135`	`+ if (false === $uuid = self::transformToRfc4122($uuid, $format)) {`
	`136`	`+ return false;`
	8000 `137`	`+ }`
`136`	`138`
`137`	`139`	`if (self::NIL === $uuid && \in_array(static::class, [__CLASS__, NilUuid::class], true)) {`
`138`	`140`	`return true;`
`@@ -190,10 +192,11 @@ private static function format(string $uuid, string $version): string`
`190`	`192`	`*`
`191`	`193`	`* @param int-mask-of<Uuid::FORMAT_*> $format`
`192`	`194`	`*`
`193`		`- * @return non-empty-string`
	`195`	`+ * @return string\|false The RFC4122 string or false if the format doesn't match the input`
`194`	`196`	`*/`
`195`		`- private static function transformToRfc4122(string $uuid, int $format): string`
	`197`	`+ private static function transformToRfc4122(string $uuid, int $format): string\|false`
`196`	`198`	`{`
	`199`	`+ $inputUuid = $uuid;`
`197`	`200`	`$fromBase58 = false;`
`198`	`201`	`if (22 === \strlen($uuid) && 22 === strspn($uuid, BinaryUtil::BASE58['']) && $format & self::FORMAT_BASE_58) {`
`199`	`202`	`$uuid = str_pad(BinaryUtil::fromBase($uuid, BinaryUtil::BASE58), 16, "\0", \STR_PAD_LEFT);`
`@@ -214,6 +217,11 @@ private static function transformToRfc4122(string $uuid, int $format): string`
`214`	`217`	`$uuid = $ulid->toRfc4122();`
`215`	`218`	`}`
`216`	`219`
	`220`	`+ if ($inputUuid === $uuid && !($format & self::FORMAT_RFC_4122)) {`
	`221`	`+ // input format doesn't match the input string`
	`222`	`+ return false;`
	`223`	`+ }`
	`224`	`+`
`217`	`225`	`return $uuid;`
`218`	`226`	`}`
`219`	`227`	`}`