3 * @copyright Copyright (C) 2010-2023, 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;
64 return $this->connected;
68 * Override the transaction since there are now hierarchical transactions possible
72 public function transaction(): bool
74 if (!$this->in_transaction && !$this->connection->beginTransaction()) {
78 $this->in_transaction = true;
82 /** Mock for locking tables */
83 public function lock($table): bool
89 $this->in_transaction = true;
90 $this->_locked = true;
95 /** Mock for unlocking tables */
96 public function unlock(): bool
98 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
99 $this->performCommit();
101 $this->in_transaction = false;
102 $this->_locked = false;
110 * @return bool Was the command executed successfully?
112 public function commit(): bool
114 if (!$this->performCommit()) {
117 $this->in_transaction = false;
122 * Setup of the global, static connection
123 * Either through explicit calling or through implicit using the Database
125 * @param array $server $_SERVER variables
129 public static function statConnect(array $server)
132 $db_host = $db_user = $db_data = $db_pw = '';
134 // Use environment variables for mysql if they are set beforehand
135 if (!empty($server['MYSQL_HOST'])
136 && (!empty($server['MYSQL_USERNAME']) || !empty($server['MYSQL_USER']))
137 && $server['MYSQL_PASSWORD'] !== false
138 && !empty($server['MYSQL_DATABASE']))
140 $db_host = $server['MYSQL_HOST'];
141 if (!empty($server['MYSQL_PORT'])) {
142 $db_host .= ':' . $server['MYSQL_PORT'];
145 if (!empty($server['MYSQL_USERNAME'])) {
146 $db_user = $server['MYSQL_USERNAME'];
148 $db_user = $server['MYSQL_USER'];
150 $db_pw = (string) $server['MYSQL_PASSWORD'];
151 $db_data = $server['MYSQL_DATABASE'];
154 if (empty($db_host) || empty($db_user) || empty($db_data)) {
155 throw new DatabaseException('Either one of the following settings are missing: Host, User or Database', 999, 'CONNECT');
159 $serveraddr = trim($db_host);
160 $serverdata = explode(':', $serveraddr);
161 $server = $serverdata[0];
162 if (count($serverdata) > 1) {
163 $port = (int) trim($serverdata[1]);
165 $server = trim($server);
166 $user = trim($db_user);
167 $pass = trim($db_pw);
168 $db = trim($db_data);
170 if (!(strlen($server) && strlen($user) && strlen($db))) {
174 $connect = "mysql:host=" . $server . ";dbname=" . $db;
177 $connect .= ";port=" . $port;
181 self::$staticConnection = @new ExtendedPDO($connect, $user, $pass);
182 self::$staticConnection->setAttribute(PDO::ATTR_AUTOCOMMIT,0);
183 } catch (PDOException $e) {
185 * @TODO Try to find a way to log this exception as it contains valuable information
186 * @nupplaphil@github.com comment:
188 * There is no easy possibility to add a logger here, that's why
189 * there isn't any yet and instead a placeholder.. This execution
190 * point is a critical state during a testrun, and tbh I'd like to
191 * leave here no further logic (yet) because I spent hours debugging
192 * cases, where transactions weren't fully closed and
193 * strange/unpredictable errors occur (sometimes -mainly during
194 * debugging other errors :) ...)
200 * @return ExtendedPDO The global, static connection
202 public static function getGlobConnection()
204 return self::$staticConnection;
208 * Perform a global rollback for every nested transaction of the static connection
210 public static function statRollback()
212 if (isset(self::$staticConnection)) {
213 while (self::$staticConnection->getTransactionDepth() > 0) {
214 self::$staticConnection->rollBack();