|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace Utopia\Database; |
| 4 | + |
| 5 | +use Utopia\Console; |
| 6 | + |
| 7 | +/** |
| 8 | + * Wraps a \PDOStatement so a connection lost during execution is recovered |
| 9 | + * transparently: the owning PDO reconnects, the statement is re-prepared |
| 10 | + * against the fresh connection, previously bound parameters/columns/attributes |
| 11 | + * are replayed, and the failed execute() is retried. |
| 12 | + * |
| 13 | + * Recovery is attempted only for execute(), and only outside a transaction: |
| 14 | + * re-running any other method (fetch, rowCount, ...) without a fresh execute |
| 15 | + * would return data from an unexecuted statement, and a connection cannot be |
| 16 | + * healed in place mid-transaction (the uncommitted state is gone, so the call |
| 17 | + * is rethrown for Adapter::withTransaction to roll back and replay). |
| 18 | + * |
| 19 | + * @mixin \PDOStatement |
| 20 | + * @implements \IteratorAggregate<int, mixed> |
| 21 | + */ |
| 22 | +class PDOStatement implements \IteratorAggregate |
| 23 | +{ |
| 24 | + /** |
| 25 | + * @var array<int|string, array{mixed, int}> |
| 26 | + */ |
| 27 | + private array $values = []; |
| 28 | + |
| 29 | + /** |
| 30 | + * @var array<int|string, array{mixed, int, int, mixed}> |
| 31 | + */ |
| 32 | + private array $params = []; |
| 33 | + |
| 34 | + /** |
| 35 | + * @var array<int|string, array{mixed, int, ?int, ?int, mixed}> |
| 36 | + */ |
| 37 | + private array $columns = []; |
| 38 | + |
| 39 | + /** |
| 40 | + * @var array<int, mixed> |
| 41 | + */ |
| 42 | + private array $attributes = []; |
| 43 | + |
| 44 | + /** |
| 45 | + * @var array<int|string, mixed>|null |
| 46 | + */ |
| 47 | + private ?array $fetchMode = null; |
| 48 | + |
| 49 | + /** |
| 50 | + * @param array<mixed> $options |
| 51 | + */ |
| 52 | + public function __construct( |
| 53 | + private readonly PDO $pdo, |
| 54 | + private \PDOStatement $statement, |
| 55 | + private readonly string $query, |
| 56 | + private readonly array $options = [], |
| 57 | + ) { |
| 58 | + } |
| 59 | + |
| 60 | + public function __get(string $name): mixed |
| 61 | + { |
| 62 | + return $this->statement->{$name}; |
| 63 | + } |
| 64 | + |
| 65 | + public function __set(string $name, mixed $value): void |
| 66 | + { |
| 67 | + $this->statement->{$name} = $value; |
| 68 | + } |
| 69 | + |
| 70 | + public function __isset(string $name): bool |
| 71 | + { |
| 72 | + return isset($this->statement->{$name}); |
| 73 | + } |
| 74 | + |
| 75 | + public function __unset(string $name): void |
| 76 | + { |
| 77 | + unset($this->statement->{$name}); |
| 78 | + } |
| 79 | + |
| 80 | + public function __clone(): void |
| 81 | + { |
| 82 | + throw new \Error('Trying to clone an uncloneable PDOStatement'); |
| 83 | + } |
| 84 | + |
| 85 | + /** |
| 86 | + * Preserve \PDOStatement's native iterability (foreach over rows), which |
| 87 | + * does not route through __call(). |
| 88 | + */ |
| 89 | + public function getIterator(): \Traversable |
| 90 | + { |
| 91 | + return $this->statement; |
| 92 | + } |
| 93 | + |
| 94 | + /** |
| 95 | + * @param array<mixed> $args |
| 96 | + * @throws \Throwable |
| 97 | + */ |
| 98 | + public function __call(string $method, array $args): mixed |
| 99 | + { |
| 100 | + try { |
| 101 | + return $this->statement->{$method}(...$args); |
| 102 | + } catch (\Throwable $e) { |
| 103 | + if ( |
| 104 | + \strcasecmp($method, 'execute') !== 0 |
| 105 | + || $this->pdo->inTransaction() |
| 106 | + || !Connection::hasError($e) |
| 107 | + ) { |
| 108 | + throw $e; |
| 109 | + } |
| 110 | + |
| 111 | + Console::warning('[Database] ' . $e->getMessage()); |
| 112 | + Console::warning('[Database] Lost connection detected. Re-preparing statement...'); |
| 113 | + |
| 114 | + $this->reprepare(); |
| 115 | + |
| 116 | + return $this->statement->{$method}(...$args); |
| 117 | + } |
| 118 | + } |
| 119 | + |
| 120 | + public function getStatement(): \PDOStatement |
| 121 | + { |
| 122 | + return $this->statement; |
| 123 | + } |
| 124 | + |
| 125 | + public function setAttribute(int $attribute, mixed $value): bool |
| 126 | + { |
| 127 | + $this->attributes[$attribute] = $value; |
| 128 | + |
| 129 | + return $this->statement->setAttribute($attribute, $value); |
| 130 | + } |
| 131 | + |
| 132 | + public function setFetchMode(int $mode, mixed ...$args): bool |
| 133 | + { |
| 134 | + $this->fetchMode = [$mode, ...$args]; |
| 135 | + |
| 136 | + return $this->statement->setFetchMode($mode, ...$args); |
| 137 | + } |
| 138 | + |
| 139 | + public function bindValue(int|string $param, mixed $value, int $type = \PDO::PARAM_STR): bool |
| 140 | + { |
| 141 | + $this->values[$param] = [$value, $type]; |
| 142 | + |
| 143 | + return $this->statement->bindValue($param, $value, $type); |
| 144 | + } |
| 145 | + |
| 146 | + public function bindParam(int|string $param, mixed &$variable, int $type = \PDO::PARAM_STR, int $maxLength = 0, mixed $driverOptions = null): bool |
| 147 | + { |
| 148 | + // Store the variable by reference so a value changed between bind and |
| 149 | + // execute is the value replayed after a reconnect (PDO binds late). |
| 150 | + $this->params[$param] = [&$variable, $type, $maxLength, $driverOptions]; |
| 151 | + |
| 152 | + return $this->statement->bindParam($param, $variable, $type, $maxLength, $driverOptions); |
| 153 | + } |
| 154 | + |
| 155 | + public function bindColumn(int|string $column, mixed &$variable, ?int $type = null, ?int $maxLength = null, mixed $driverOptions = null): bool |
| 156 | + { |
| 157 | + // Record how many optional arguments were actually supplied so omitted |
| 158 | + // ones keep PDO's real defaults instead of being replayed as explicit |
| 159 | + // nulls (which would change the call contract / emit deprecations). |
| 160 | + $arity = \func_num_args(); |
| 161 | + $this->columns[$column] = [&$variable, $arity, $type, $maxLength, $driverOptions]; |
| 162 | + |
| 163 | + return $this->bindColumnTo($this->statement, $column, $variable, $arity, $type, $maxLength, $driverOptions); |
| 164 | + } |
| 165 | + |
| 166 | + private function reprepare(): void |
| 167 | + { |
| 168 | + $this->pdo->reconnect(); |
| 169 | + $this->statement = $this->pdo->prepareNative($this->query, $this->options); |
| 170 | + |
| 171 | + foreach ($this->attributes as $attribute => $value) { |
| 172 | + $this->statement->setAttribute($attribute, $value); |
| 173 | + } |
| 174 | + |
| 175 | + if ($this->fetchMode !== null) { |
| 176 | + $this->statement->setFetchMode(...$this->fetchMode); |
| 177 | + } |
| 178 | + |
| 179 | + foreach ($this->params as $param => $bind) { |
| 180 | + $this->statement->bindParam($param, $bind[0], $bind[1], $bind[2], $bind[3]); |
| 181 | + } |
| 182 | + |
| 183 | + foreach ($this->columns as $column => $bind) { |
| 184 | + $this->bindColumnTo($this->statement, $column, $bind[0], $bind[1], $bind[2], $bind[3], $bind[4]); |
| 185 | + } |
| 186 | + |
| 187 | + foreach ($this->values as $param => [$value, $type]) { |
| 188 | + $this->statement->bindValue($param, $value, $type); |
| 189 | + } |
| 190 | + } |
| 191 | + |
| 192 | + /** |
| 193 | + * Forward bindColumn passing only the optional arguments the caller |
| 194 | + * supplied ($arity counts column + variable + supplied options). |
| 195 | + */ |
| 196 | + private function bindColumnTo(\PDOStatement $statement, int|string $column, mixed &$variable, int $arity, ?int $type = null, ?int $maxLength = null, mixed $driverOptions = null): bool |
| 197 | + { |
| 198 | + return match (true) { |
| 199 | + $arity <= 2 => $statement->bindColumn($column, $variable), |
| 200 | + $arity === 3 => $statement->bindColumn($column, $variable, $type ?? \PDO::PARAM_STR), |
| 201 | + $arity === 4 => $statement->bindColumn($column, $variable, $type ?? \PDO::PARAM_STR, $maxLength ?? 0), |
| 202 | + default => $statement->bindColumn($column, $variable, $type ?? \PDO::PARAM_STR, $maxLength ?? 0, $driverOptions), |
| 203 | + }; |
| 204 | + } |
| 205 | +} |
0 commit comments