Merge pull request #526 from MauricioFauth/Token-construct

Add native parameter types to Token constructor
phpmyadmin · Jan 16, 2024 · 3b7191a · 3b7191a
2 parents 94f2db2 + 16389b2
commit 3b7191a
Show file tree

Hide file tree

Showing 449 changed files with 3,589 additions and 3,607 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -385,16 +385,6 @@ parameters:
 			count: 3
 			path: src/Lexer.php
 
-		-
-			message: "#^Parameter \\#1 \\$token of class PhpMyAdmin\\\\SqlParser\\\\Token constructor expects string, null given\\.$#"
-			count: 1
-			path: src/Lexer.php
-
-		-
-			message: "#^Parameter \\#3 \\$flags of class PhpMyAdmin\\\\SqlParser\\\\Token constructor expects int, int\\|null given\\.$#"
-			count: 1
-			path: src/Lexer.php
-
 		-
 			message: "#^Property PhpMyAdmin\\\\SqlParser\\\\Lexer\\:\\:\\$delimiter \\(string\\) does not accept null\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -577,11 +577,7 @@
       <code><![CDATA[$this->str[$this->last]]]></code>
       <code><![CDATA[$token->value]]></code>
     </MixedOperand>
-    <NullArgument>
-      <code>null</code>
-    </NullArgument>
     <PossiblyNullArgument>
-      <code>$flags</code>
       <code><![CDATA[$this->str[$this->last + 1]]]></code>
       <code><![CDATA[$this->str[$this->last]]]></code>
       <code><![CDATA[$this->str[$this->last]]]></code>

diff --git a/src/Lexer.php b/src/Lexer.php
@@ -282,7 +282,7 @@ public function lex(): void
         }
 
         // Adding a final delimiter to mark the ending.
-        $list->tokens[$list->count++] = new Token(null, TokenType::Delimiter);
+        $list->tokens[$list->count++] = new Token('', TokenType::Delimiter);
 
         // Saving the tokens list.
         $this->list = $list;
@@ -360,7 +360,7 @@ private function solveAmbiguityOnFunctionKeywords(): void
                 && ($next->type !== TokenType::Operator
                     || ! in_array($next->value, self::OPERATOR_NAME_INDICATORS, true)
                 )
-                && ($next->value !== null)
+                && ($next->value !== '')
             ) {
                 continue;
             }
@@ -915,7 +915,7 @@ public function parseString(string $quote = ''): Token|null
             $token .= $this->str[$this->last];
         }
 
-        return new Token($token, TokenType::String, $flags);
+        return new Token($token, TokenType::String, $flags ?? Token::FLAG_NONE);
     }
 
     /**

diff --git a/src/Token.php b/src/Token.php
@@ -64,10 +64,8 @@ class Token
 
     /**
      * The token it its raw string representation.
-     *
-     * @var string
      */
-    public $token;
+    public string $token;
 
     /**
      * The value this token contains (i.e. token after some evaluation).
@@ -90,10 +88,8 @@ class Token
 
     /**
      * The flags of this token.
-     *
-     * @var int
      */
-    public $flags;
+    public int $flags;
 
     /**
      * The position in the initial string where this token started.
@@ -110,7 +106,7 @@ class Token
      * @param TokenType $type  the type of the token
      * @param int       $flags the flags of the token
      */
-    public function __construct($token, TokenType $type = TokenType::None, $flags = 0)
+    public function __construct(string $token, TokenType $type = TokenType::None, int $flags = self::FLAG_NONE)
     {
         $this->token = $token;
         $this->type = $type;

diff --git a/tests/Utils/CLITest.php b/tests/Utils/CLITest.php
@@ -329,7 +329,7 @@ public static function tokenizeParamsProvider(): array
         $result = "[TOKEN 0]\nType = 1\nFlags = 3\nValue = 'SELECT'\nToken = 'SELECT'\n\n"
             . "[TOKEN 1]\nType = 3\nFlags = 0\nValue = ' '\nToken = ' '\n\n"
             . "[TOKEN 2]\nType = 6\nFlags = 0\nValue = 1\nToken = '1'\n\n"
-            . "[TOKEN 3]\nType = 9\nFlags = 0\nValue = NULL\nToken = NULL\n\n";
+            . "[TOKEN 3]\nType = 9\nFlags = 0\nValue = ''\nToken = ''\n\n";
 
         return [
             [
@@ -381,7 +381,7 @@ public static function tokenizeParamsStdInProvider(): array
         $result = "[TOKEN 0]\nType = 1\nFlags = 3\nValue = 'SELECT'\nToken = 'SELECT'\n\n"
             . "[TOKEN 1]\nType = 3\nFlags = 0\nValue = ' '\nToken = ' '\n\n"
             . "[TOKEN 2]\nType = 6\nFlags = 0\nValue = 1\nToken = '1'\n\n"
-            . "[TOKEN 3]\nType = 9\nFlags = 0\nValue = NULL\nToken = NULL\n\n";
+            . "[TOKEN 3]\nType = 9\nFlags = 0\nValue = ''\nToken = ''\n\n";
 
         return [
             [

diff --git a/tests/data/bugs/fuzz1.out b/tests/data/bugs/fuzz1.out
@@ -2,6 +2,8 @@
     "query": "ALTER..2",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "ALTER..2",
         "len": 8,
         "last": 8,
@@ -51,8 +53,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -65,12 +67,12 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
@@ -84,9 +86,7 @@
                 "last": 0
             }
         ],
-        "brackets": 0,
-        "strict": false,
-        "errors": []
+        "brackets": 0
     },
     "errors": {
         "lexer": [],

diff --git a/tests/data/bugs/fuzz2.out b/tests/data/bugs/fuzz2.out
@@ -2,6 +2,8 @@
     "query": "WITH](",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "WITH](",
         "len": 6,
         "last": 6,
@@ -51,8 +53,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -65,12 +67,12 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
@@ -87,9 +89,7 @@
                 "last": 0
             }
         ],
-        "brackets": 1,
-        "strict": false,
-        "errors": []
+        "brackets": 1
     },
     "errors": {
         "lexer": [

diff --git a/tests/data/bugs/fuzz3.out b/tests/data/bugs/fuzz3.out
@@ -2,6 +2,8 @@
     "query": "WITH*/A(",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "WITH*/A(",
         "len": 8,
         "last": 8,
@@ -64,8 +66,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -78,12 +80,12 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
@@ -107,9 +109,7 @@
                 "last": 3
             }
         ],
-        "brackets": 0,
-        "strict": false,
-        "errors": []
+        "brackets": 0
     },
     "errors": {
         "lexer": [],

diff --git a/tests/data/bugs/fuzz4.out b/tests/data/bugs/fuzz4.out
@@ -2,6 +2,8 @@
     "query": "ALTeR=SET",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "ALTeR=SET",
         "len": 9,
         "last": 9,
@@ -49,8 +51,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -63,12 +65,12 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
@@ -93,9 +95,7 @@
                 "last": 2
             }
         ],
-        "brackets": 0,
-        "strict": false,
-        "errors": []
+        "brackets": 0
     },
     "errors": {
         "lexer": [],

diff --git a/tests/data/bugs/fuzz5.out b/tests/data/bugs/fuzz5.out
@@ -2,6 +2,8 @@
     "query": "+0xO",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "+0xO",
         "len": 4,
         "last": 4,
@@ -38,8 +40,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -52,19 +54,17 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
         "statements": [],
-        "brackets": 0,
-        "strict": false,
-        "errors": []
+        "brackets": 0
     },
     "errors": {
         "lexer": [],

diff --git a/tests/data/bugs/fuzz6.out b/tests/data/bugs/fuzz6.out
@@ -2,6 +2,8 @@
     "query": "-+0x!",
     "lexer": {
         "@type": "PhpMyAdmin\\SqlParser\\Lexer",
+        "strict": false,
+        "errors": [],
         "str": "-+0x!",
         "len": 5,
         "last": 5,
@@ -38,8 +40,8 @@
                 },
                 {
                     "@type": "PhpMyAdmin\\SqlParser\\Token",
-                    "token": null,
-                    "value": null,
+                    "token": "",
+                    "value": "",
                     "keyword": null,
                     "type": {
                         "@type": "PhpMyAdmin\\SqlParser\\TokenType",
@@ -52,19 +54,17 @@
             ]
         },
         "delimiter": ";",
-        "delimiterLen": 1,
-        "strict": false,
-        "errors": []
+        "delimiterLen": 1
     },
     "parser": {
         "@type": "PhpMyAdmin\\SqlParser\\Parser",
+        "strict": false,
+        "errors": [],
         "list": {
             "@type": "@1"
         },
         "statements": [],
-        "brackets": 0,
-        "strict": false,
-        "errors": []
+        "brackets": 0
     },
     "errors": {
         "lexer": [],