3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Test\Util\Database;
24 use Friendica\Database\Database;
25 use Friendica\Database\DatabaseException;
30 * Overrides the Friendica database class for re-using the connection
33 * Overrides functionality to enforce one transaction per call (for nested transactions)
35 class StaticDatabase extends Database
40 private static $staticConnection;
43 private $_locked = false;
46 * Override the behaviour of connect, due there is just one, static connection at all
48 * @return bool Success
50 public function connect(): bool
52 if (!is_null($this->connection) && $this->connected()) {
56 if (!isset(self::$staticConnection)) {
57 self::statConnect($_SERVER);
60 $this->driver = 'pdo';
61 $this->connection = self::$staticConnection;
62 $this->connected = true;
63 $this->emulate_prepares = false;
65 return $this->connected;
69 * Override the transaction since there are now hierachical transactions possible
73 public function transaction(): bool
75 if (!$this->in_transaction && !$this->connection->beginTransaction()) {
79 $this->in_transaction = true;
83 /** Mock for locking tables */
84 public function lock($table): bool
90 $this->in_transaction = true;
91 $this->_locked = true;
96 /** Mock for unlocking tables */
97 public function unlock(): bool
99 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
100 $this->performCommit();
102 $this->in_transaction = false;
103 $this->_locked = false;
111 * @return bool Was the command executed successfully?
113 public function commit(): bool
115 if (!$this->performCommit()) {
118 $this->in_transaction = false;
123 * Setup of the global, static connection
124 * Either through explicit calling or through implicit using the Database
126 * @param array $server $_SERVER variables
130 public static function statConnect(array $server)
133 $db_host = $db_user = $db_data = $db_pw = '';
135 // Use environment variables for mysql if they are set beforehand
136 if (!empty($server['MYSQL_HOST'])
137 && (!empty($server['MYSQL_USERNAME']) || !empty($server['MYSQL_USER']))
138 && $server['MYSQL_PASSWORD'] !== false
139 && !empty($server['MYSQL_DATABASE']))
141 $db_host = $server['MYSQL_HOST'];
142 if (!empty($server['MYSQL_PORT'])) {
143 $db_host .= ':' . $server['MYSQL_PORT'];
146 if (!empty($server['MYSQL_USERNAME'])) {
147 $db_user = $server['MYSQL_USERNAME'];
149 $db_user = $server['MYSQL_USER'];
151 $db_pw = (string) $server['MYSQL_PASSWORD'];
152 $db_data = $server['MYSQL_DATABASE'];
155 if (empty($db_host) || empty($db_user) || empty($db_data)) {
156 throw new DatabaseException('Either one of the following settings are missing: Host, User or Database', 999, 'CONNECT');
160 $serveraddr = trim($db_host);
161 $serverdata = explode(':', $serveraddr);
162 $server = $serverdata[0];
163 if (count($serverdata) > 1) {
164 $port = (int) trim($serverdata[1]);
166 $server = trim($server);
167 $user = trim($db_user);
168 $pass = trim($db_pw);
169 $db = trim($db_data);
171 if (!(strlen($server) && strlen($user) && strlen($db))) {
175 $connect = "mysql:host=" . $server . ";dbname=" . $db;
178 $connect .= ";port=" . $port;
182 self::$staticConnection = @new ExtendedPDO($connect, $user, $pass);
183 self::$staticConnection->setAttribute(PDO::ATTR_AUTOCOMMIT,0);
184 } catch (PDOException $e) {
186 * @TODO Try to find a way to log this exception as it contains valueable information
187 * @nupplaphil@github.com comment:
189 * There is no easy possibility to add a logger here, that's why
190 * there isn't any yet and instead a placeholder.. This execution
191 * point is a critical state during a testrun, and tbh I'd like to
192 * leave here no further logic (yet) because I spent hours debugging
193 * cases, where transactions weren't fully closed and
194 * strange/unpredictable errors occur (sometimes -mainly during
195 * debugging other errors :) ...)
201 * @return ExtendedPDO The global, static connection
203 public static function getGlobConnection()
205 return self::$staticConnection;
209 * Perform a global rollback for every nested transaction of the static connection
211 public static function statRollback()
213 if (isset(self::$staticConnection)) {
214 while (self::$staticConnection->getTransactionDepth() > 0) {
215 self::$staticConnection->rollBack();