Restore stream offsets with subsequent execute

mcurland · mcurland · commit 11eefe126611 · 2025-02-26T10:21:18.000-07:00
Driver statement instances needs to maintain resources offsets for
streams passed to bindValue after the first call to execute.

Modified array compare in testBindValueResetsStream to explicitly
read the stream and read remaining stream content instead of checking
current pointer to conclude the test.

Fixed for PDO, SQLite3, SQLSrv, OCI8
diff --git a/src/Driver/OCI8/Statement.php b/src/Driver/OCI8/Statement.php
@@ -74,7 +74,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool
         }
 
         if ($type === ParameterType::BINARY || $type === ParameterType::LARGE_OBJECT) {
-            $this->trackParamResource($value);
+            $this->trackParamResource($param, $value);
         }
 
         return $this->bindParam($param, $value, $type);
@@ -195,16 +195,17 @@ public function execute($params = null): ResultInterface
      * Track a binary parameter reference at binding time. These
      * are cached for later analysis by the getResourceOffsets.
      *
-     * @param mixed $resource
+     * @param int|string $param
+     * @param mixed      $resource
      */
-    private function trackParamResource($resource): void
+    private function trackParamResource($param, $resource): void
     {
         if (! is_resource($resource)) {
             return;
         }
 
-        $this->paramResources ??= [];
-        $this->paramResources[] = $resource;
+        $this->paramResources       ??= [];
+        $this->paramResources[$param] = $resource;
     }
 
     /**
@@ -256,7 +257,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void
         foreach ($resourceOffsets as $index => $offset) {
             fseek($this->paramResources[$index], $offset, SEEK_SET);
         }
-
-        $this->paramResources = null;
     }
 }
diff --git a/src/Driver/PDO/SQLSrv/Statement.php b/src/Driver/PDO/SQLSrv/Statement.php
@@ -115,7 +115,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool
         }
 
         if ($type === ParameterType::LARGE_OBJECT || $type === ParameterType::BINARY) {
-            $this->trackParamResource($value);
+            $this->trackParamResource($param, $value);
         }
 
         return $this->bindParam($param, $value, $type);
@@ -140,16 +140,17 @@ public function execute($params = null): Result
      * Track a binary parameter reference at binding time. These
      * are cached for later analysis by the getResourceOffsets.
      *
-     * @param mixed $resource
+     * @param int|string $param
+     * @param mixed      $resource
      */
-    private function trackParamResource($resource): void
+    private function trackParamResource($param, $resource): void
     {
         if (! is_resource($resource)) {
             return;
         }
 
-        $this->paramResources ??= [];
-        $this->paramResources[] = $resource;
+        $this->paramResources       ??= [];
+        $this->paramResources[$param] = $resource;
     }
 
     /**
@@ -201,7 +202,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void
         foreach ($resourceOffsets as $index => $offset) {
             fseek($this->paramResources[$index], $offset, SEEK_SET);
         }
-
-        $this->paramResources = null;
     }
 }
diff --git a/src/Driver/PDO/Statement.php b/src/Driver/PDO/Statement.php
@@ -54,7 +54,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING)
 
         $pdoType = ParameterTypeMap::convertParamType($type);
         if ($pdoType === PDO::PARAM_LOB) {
-            $this->trackParamResource($value);
+            $this->trackParamResource($param, $value);
         }
 
         try {
@@ -157,16 +157,17 @@ public function execute($params = null): ResultInterface
      * Track a binary parameter reference at binding time. These
      * are cached for later analysis by the getResourceOffsets.
      *
-     * @param mixed $resource
+     * @param int|string $param
+     * @param mixed      $resource
      */
-    private function trackParamResource($resource): void
+    private function trackParamResource($param, $resource): void
     {
         if (! is_resource($resource)) {
             return;
         }
 
-        $this->paramResources ??= [];
-        $this->paramResources[] = $resource;
+        $this->paramResources       ??= [];
+        $this->paramResources[$param] = $resource;
     }
 
     /**
@@ -218,7 +219,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void
         foreach ($resourceOffsets as $index => $offset) {
             fseek($this->paramResources[$index], $offset, SEEK_SET);
         }
-
-        $this->paramResources = null;
     }
 }
diff --git a/src/Driver/SQLSrv/Statement.php b/src/Driver/SQLSrv/Statement.php
@@ -110,7 +110,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool
         }
 
         if ($type === ParameterType::LARGE_OBJECT || $type === ParameterType::BINARY) {
-            $this->trackParamResource($value);
+            $this->trackParamResource($param, $value);
         }
 
         $this->variables[$param] = $value;
@@ -248,16 +248,17 @@ private function prepare()
      * Track a binary parameter reference at binding time. These
      * are cached for later analysis by the getResourceOffsets.
      *
-     * @param mixed $resource
+     * @param int|string $param
+     * @param mixed      $resource
      */
-    private function trackParamResource($resource): void
+    private function trackParamResource($param, $resource): void
     {
         if (! is_resource($resource)) {
             return;
         }
 
-        $this->paramResources ??= [];
-        $this->paramResources[] = $resource;
+        $this->paramResources       ??= [];
+        $this->paramResources[$param] = $resource;
     }
 
     /**
@@ -309,7 +310,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void
         foreach ($resourceOffsets as $index => $offset) {
             fseek($this->paramResources[$index], $offset, SEEK_SET);
         }
-
-        $this->paramResources = null;
     }
 }
diff --git a/src/Driver/SQLite3/Statement.php b/src/Driver/SQLite3/Statement.php
@@ -68,7 +68,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool
 
         $sqliteType = $this->convertParamType($type);
         if ($sqliteType === SQLITE3_BLOB) {
-            $this->trackParamResource($value);
+            $this->trackParamResource($param, $value);
         }
 
         return $this->statement->bindValue($param, $value, $sqliteType);
@@ -156,16 +156,17 @@ private function convertParamType(int $type): int
      * Track a binary parameter reference at binding time. These
      * are cached for later analysis by the getResourceOffsets.
      *
-     * @param mixed $resource
+     * @param int|string $param
+     * @param mixed      $resource
      */
-    private function trackParamResource($resource): void
+    private function trackParamResource($param, $resource): void
     {
         if (! is_resource($resource)) {
             return;
         }
 
-        $this->paramResources ??= [];
-        $this->paramResources[] = $resource;
+        $this->paramResources       ??= [];
+        $this->paramResources[$param] = $resource;
     }
 
     /**
@@ -217,7 +218,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void
         foreach ($resourceOffsets as $index => $offset) {
             fseek($this->paramResources[$index], $offset, SEEK_SET);
         }
-
-        $this->paramResources = null;
     }
 }
diff --git a/tests/Functional/BlobTest.php b/tests/Functional/BlobTest.php
@@ -13,7 +13,6 @@
 use function assert;
 use function fopen;
 use function fseek;
-use function ftell;
 use function fwrite;
 use function str_repeat;
 use function stream_get_contents;
@@ -229,10 +228,12 @@ public function testBindValueResetsStream(): void
         $stmt->bindValue(1, 3, ParameterType::INTEGER);
         $stmt->executeStatement();
 
-        $rows = array_map(
-            function (array $row): array {
+        $blobType = Type::getType(Types::BLOB);
+        $platform = $this->connection->getDatabasePlatform();
+        $rows     = array_map(
+            function (array $row) use ($blobType, $platform): array {
                 $row[0] = $this->connection->convertToPHPValue($row[0], Types::INTEGER);
-                $row[1] = $this->connection->convertToPHPValue($row[1], Types::STRING);
+                $row[1] = stream_get_contents($blobType->convertToPHPValue($row[1], $platform));
 
                 return $row;
             },
@@ -246,9 +247,12 @@ function (array $row): array {
         // for this test is that reading the stream to extract the value moves the stream
         // pointer, so that using the stream with a new statement (and hence a new call
         // to bindValue and a new initial call to execute*) causes a different value to
-        // be read from the stream results. All that we have learned so far is that bindValue
-        // reuses the value obtained during the first execution of the statement.
-        self::assertEquals(2, ftell($stream), 'Resource parameter should be reset to position before execute.');
+        // be read from the stream results. Currently, we have verified one of two things:
+        // either the stream is reset with each execute, or that bindValue reuses the value
+        // obtained during the first execution of the statement. Which of these holds is not
+        // consistent across implementations. For example, the default pdo_sqlite test target
+        // does not reread the stream on subsequent executes, but pdo_pgsql does.
+        self::assertEquals('test', stream_get_contents($stream));
     }
 
     private function assertBlobContains(string $text): void

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`if ($type === ParameterType::BINARY \|\| $type === ParameterType::LARGE_OBJECT) {`
`77`		`- $this->trackParamResource($value);`
	`77`	`+ $this->trackParamResource($param, $value);`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`return $this->bindParam($param, $value, $type);`
`@@ -195,16 +195,17 @@ public function execute($params = null): ResultInterface`
`195`	`195`	`* Track a binary parameter reference at binding time. These`
`196`	`196`	`* are cached for later analysis by the getResourceOffsets.`
`197`	`197`	`*`
`198`		`- * @param mixed $resource`
	`198`	`+ * @param int\|string $param`
	`199`	`+ * @param mixed $resource`
`199`	`200`	`*/`
`200`		`- private function trackParamResource($resource): void`
	`201`	`+ private function trackParamResource($param, $resource): void`
`201`	`202`	`{`
`202`	`203`	`if (! is_resource($resource)) {`
`203`	`204`	`return;`
`204`	`205`	`}`
`205`	`206`
`206`		`- $this->paramResources ??= [];`
`207`		`- $this->paramResources[] = $resource;`
	`207`	`+ $this->paramResources ??= [];`
	`208`	`+ $this->paramResources[$param] = $resource;`
`208`	`209`	`}`
`209`	`210`
`210`	`211`	`/**`
`@@ -256,7 +257,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void`
`256`	`257`	`foreach ($resourceOffsets as $index => $offset) {`
`257`	`258`	`fseek($this->paramResources[$index], $offset, SEEK_SET);`
`258`	`259`	`}`
`259`		`-`
`260`		`- $this->paramResources = null;`
`261`	`260`	`}`
`262`	`261`	`}`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`if ($type === ParameterType::LARGE_OBJECT \|\| $type === ParameterType::BINARY) {`
`118`		`- $this->trackParamResource($value);`
	`118`	`+ $this->trackParamResource($param, $value);`
`119`	`119`	`}`
`120`	`120`
`121`	`121`	`return $this->bindParam($param, $value, $type);`
`@@ -140,16 +140,17 @@ public function execute($params = null): Result`
`140`	`140`	`* Track a binary parameter reference at binding time. These`
`141`	`141`	`* are cached for later analysis by the getResourceOffsets.`
`142`	`142`	`*`
`143`		`- * @param mixed $resource`
	`143`	`+ * @param int\|string $param`
	`144`	`+ * @param mixed $resource`
`144`	`145`	`*/`
`145`		`- private function trackParamResource($resource): void`
	`146`	`+ private function trackParamResource($param, $resource): void`
`146`	`147`	`{`
`147`	`148`	`if (! is_resource($resource)) {`
`148`	`149`	`return;`
`149`	`150`	`}`
`150`	`151`
`151`		`- $this->paramResources ??= [];`
`152`		`- $this->paramResources[] = $resource;`
	`152`	`+ $this->paramResources ??= [];`
	`153`	`+ $this->paramResources[$param] = $resource;`
`153`	`154`	`}`
`154`	`155`
`155`	`156`	`/**`
`@@ -201,7 +202,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void`
`201`	`202`	`foreach ($resourceOffsets as $index => $offset) {`
`202`	`203`	`fseek($this->paramResources[$index], $offset, SEEK_SET);`
`203`	`204`	`}`
`204`		`-`
`205`		`- $this->paramResources = null;`
`206`	`205`	`}`
`207`	`206`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING)`
`54`	`54`
`55`	`55`	`$pdoType = ParameterTypeMap::convertParamType($type);`
`56`	`56`	`if ($pdoType === PDO::PARAM_LOB) {`
`57`		`- $this->trackParamResource($value);`
	`57`	`+ $this->trackParamResource($param, $value);`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`try {`
`@@ -157,16 +157,17 @@ public function execute($params = null): ResultInterface`
`157`	`157`	`* Track a binary parameter reference at binding time. These`
`158`	`158`	`* are cached for later analysis by the getResourceOffsets.`
`159`	`159`	`*`
`160`		`- * @param mixed $resource`
	`160`	`+ * @param int\|string $param`
	`161`	`+ * @param mixed $resource`
`161`	`162`	`*/`
`162`		`- private function trackParamResource($resource): void`
	`163`	`+ private function trackParamResource($param, $resource): void`
`163`	`164`	`{`
`164`	`165`	`if (! is_resource($resource)) {`
`165`	`166`	`return;`
`166`	`167`	`}`
`167`	`168`
`168`		`- $this->paramResources ??= [];`
`169`		`- $this->paramResources[] = $resource;`
	`169`	`+ $this->paramResources ??= [];`
	`170`	`+ $this->paramResources[$param] = $resource;`
`170`	`171`	`}`
`171`	`172`
`172`	`173`	`/**`
`@@ -218,7 +219,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void`
`218`	`219`	`foreach ($resourceOffsets as $index => $offset) {`
`219`	`220`	`fseek($this->paramResources[$index], $offset, SEEK_SET);`
`220`	`221`	`}`
`221`		`-`
`222`		`- $this->paramResources = null;`
`223`	`222`	`}`
`224`	`223`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool`
`110`	`110`	`}`
`111`	`111`
`112`	`112`	`if ($type === ParameterType::LARGE_OBJECT \|\| $type === ParameterType::BINARY) {`
`113`		`- $this->trackParamResource($value);`
	`113`	`+ $this->trackParamResource($param, $value);`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`$this->variables[$param] = $value;`
`@@ -248,16 +248,17 @@ private function prepare()`
`248`	`248`	`* Track a binary parameter reference at binding time. These`
`249`	`249`	`* are cached for later analysis by the getResourceOffsets.`
`250`	`250`	`*`
`251`		`- * @param mixed $resource`
	`251`	`+ * @param int\|string $param`
	`252`	`+ * @param mixed $resource`
`252`	`253`	`*/`
`253`		`- private function trackParamResource($resource): void`
	`254`	`+ private function trackParamResource($param, $resource): void`
`254`	`255`	`{`
`255`	`256`	`if (! is_resource($resource)) {`
`256`	`257`	`return;`
`257`	`258`	`}`
`258`	`259`
`259`		`- $this->paramResources ??= [];`
`260`		`- $this->paramResources[] = $resource;`
	`260`	`+ $this->paramResources ??= [];`
	`261`	`+ $this->paramResources[$param] = $resource;`
`261`	`262`	`}`
`262`	`263`
`263`	`264`	`/**`
`@@ -309,7 +310,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void`
`309`	`310`	`foreach ($resourceOffsets as $index => $offset) {`
`310`	`311`	`fseek($this->paramResources[$index], $offset, SEEK_SET);`
`311`	`312`	`}`
`312`		`-`
`313`		`- $this->paramResources = null;`
`314`	`313`	`}`
`315`	`314`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public function bindValue($param, $value, $type = ParameterType::STRING): bool`
`68`	`68`
`69`	`69`	`$sqliteType = $this->convertParamType($type);`
`70`	`70`	`if ($sqliteType === SQLITE3_BLOB) {`
`71`		`- $this->trackParamResource($value);`
	`71`	`+ $this->trackParamResource($param, $value);`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`return $this->statement->bindValue($param, $value, $sqliteType);`
`@@ -156,16 +156,17 @@ private function convertParamType(int $type): int`
`156`	`156`	`* Track a binary parameter reference at binding time. These`
`157`	`157`	`* are cached for later analysis by the getResourceOffsets.`
`158`	`158`	`*`
`159`		`- * @param mixed $resource`
	`159`	`+ * @param int\|string $param`
	`160`	`+ * @param mixed $resource`
`160`	`161`	`*/`
`161`		`- private function trackParamResource($resource): void`
	`162`	`+ private function trackParamResource($param, $resource): void`
`162`	`163`	`{`
`163`	`164`	`if (! is_resource($resource)) {`
`164`	`165`	`return;`
`165`	`166`	`}`
`166`	`167`
`167`		`- $this->paramResources ??= [];`
`168`		`- $this->paramResources[] = $resource;`
	`168`	`+ $this->paramResources ??= [];`
	`169`	`+ $this->paramResources[$param] = $resource;`
`169`	`170`	`}`
`170`	`171`
`171`	`172`	`/**`
`@@ -217,7 +218,5 @@ private function restoreResourceOffsets(?array $resourceOffsets): void`
`217`	`218`	`foreach ($resourceOffsets as $index => $offset) {`
`218`	`219`	`fseek($this->paramResources[$index], $offset, SEEK_SET);`
`219`	`220`	`}`
`220`		`-`
`221`		`- $this->paramResources = null;`
`222`	`221`	`}`
`223`	`222`	`}`