src/Database/Definition/DbaDefinition.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Database\Definition;
  23
  24 use Exception;
  25 use Friendica\Core\Hook;
  26
  27 /**
  28  * Stores the whole database definition
  29  */
  30 class DbaDefinition
  31 {
  32         /** @var string The relative path of the db structure config file */
  33         const DBSTRUCTURE_RELATIVE_PATH = '/static/dbstructure.config.php';
  34
  35         /** @var array The complete DB definition as an array */
  36         protected $definition;
  37
  38         /** @var string */
  39         protected $configFile;
  40
  41         /**
  42          * @param string $basePath The basepath of the dbstructure file (loads relative path in case of null)
  43          *
  44          * @throws Exception in case the config file isn't available/readable
  45          */
  46         public function __construct(string $basePath)
  47         {
  48                 $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
  49
  50                 if (!is_readable($this->configFile)) {
  51                         throw new Exception('Missing database structure config file static/dbstructure.config.php at basePath=' . $basePath);
  52                 }
  53         }
  54
  55         /**
  56          * @return array Returns the whole Definition as an array
  57          */
  58         public function getAll(): array
  59         {
  60                 return $this->definition;
  61         }
  62
  63         /**
  64          * Truncate field data for the given table
  65          *
  66          * @param string $table Name of the table to load field definitions for
  67          * @param array  $data  data fields
  68          *
  69          * @return array fields for the given
  70          */
  71         public function truncateFieldsForTable(string $table, array $data): array
  72         {
  73                 $definition = $this->definition;
  74                 if (empty($definition[$table])) {
  75                         return [];
  76                 }
  77
  78                 $fieldNames = array_keys($definition[$table]['fields']);
  79
  80                 $fields = [];
  81
  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 binary 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);
  94                                 }
  95                                 $fields[$field] = $data[$field];
  96                         }
  97                 }
  98
  99                 return $fields;
 100         }
 101
 102         /**
 103          * Loads the database structure definition from the static/dbstructure.config.php file.
 104          * On first pass, defines DB_UPDATE_VERSION constant.
 105          *
 106          * @param bool  $withAddonStructure Whether to tack on addons additional tables
 107          *
 108          * @throws Exception in case the definition cannot be found
 109          *
 110          * @see static/dbstructure.config.php
 111          *
 112          * @return self The current instance
 113          */
 114         public function load(bool $withAddonStructure = false): self
 115         {
 116                 $definition = require $this->configFile;
 117
 118                 if (!$definition) {
 119                         throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
 120                 }
 121
 122                 if ($withAddonStructure) {
 123                         Hook::callAll('dbstructure_definition', $definition);
 124                 }
 125
 126                 $this->definition = $definition;
 127
 128                 return $this;
 129         }
 130 }