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\Database\Definition;
25 use Friendica\Core\Hook;
28 * Stores the whole database definition
32 /** @var string The relative path of the db structure config file */
33 const DBSTRUCTURE_RELATIVE_PATH = '/static/dbstructure.config.php';
35 /** @var array The complete DB definition as an array */
36 protected $definition;
39 protected $configFile;
42 * @param string $basePath The basepath of the dbstructure file (loads relative path in case of null)
44 * @throws Exception in case the config file isn't available/readable
46 public function __construct(string $basePath)
48 $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
50 if (!is_readable($this->configFile)) {
51 throw new Exception('Missing database structure config file static/dbstructure.config.php at basePath=' . $basePath);
56 * @return array Returns the whole Definition as an array
58 public function getAll(): array
60 return $this->definition;
64 * Truncate field data for the given table
66 * @param string $table Name of the table to load field definitions for
67 * @param array $data data fields
69 * @return array fields for the given
71 public function truncateFieldsForTable(string $table, array $data): array
73 $definition = $this->definition;
74 if (empty($definition[$table])) {
78 $fieldNames = array_keys($definition[$table]['fields']);
82 // Assign all field that are present in the table
83 foreach ($fieldNames as $field) {
84 if (isset($data[$field])) {
85 // Limit the length of varchar, varbinary, char and binrary fields
86 if (is_string($data[$field]) && preg_match("/char\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
87 $data[$field] = mb_substr($data[$field], 0, $result[1]);
88 } elseif (is_string($data[$field]) && preg_match("/binary\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
89 $data[$field] = substr($data[$field], 0, $result[1]);
90 } elseif (is_numeric($data[$field]) && $definition[$table]['fields'][$field]['type'] === 'int') {
91 $data[$field] = min(max((int)$data[$field], -2147483648), 2147483647);
92 } elseif (is_numeric($data[$field]) && $definition[$table]['fields'][$field]['type'] === 'int unsigned') {
93 $data[$field] = min(max((int)$data[$field], 0), 4294967295);
95 $fields[$field] = $data[$field];
103 * Loads the database structure definition from the static/dbstructure.config.php file.
104 * On first pass, defines DB_UPDATE_VERSION constant.
106 * @param bool $withAddonStructure Whether to tack on addons additional tables
108 * @throws Exception in case the definition cannot be found
110 * @see static/dbstructure.config.php
112 * @return self The current instance
114 public function load(bool $withAddonStructure = false): self
116 $definition = require $this->configFile;
119 throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
122 if ($withAddonStructure) {
123 Hook::callAll('dbstructure_definition', $definition);
126 $this->definition = $definition;