src/Database/Definition/DbaDefinition.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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          * Get field data for the given table
  65          *
  66          * @param string $table Tavle to load field definitions for
  67          * @param array $data data fields
  68          * @return array fields for the given
  69          */
  70         public function getFieldsForTable(string $table, array $data = []): array
  71         {
  72                 $definition = $this->definition;
  73                 if (empty($definition[$table])) {
  74                         return [];
  75                 }
  76
  77                 $fieldNames = array_keys($definition[$table]['fields']);
  78
  79                 $fields = [];
  80
  81                 // Assign all field that are present in the table
  82                 foreach ($fieldNames as $field) {
  83                         if (isset($data[$field])) {
  84                                 // Limit the length of varchar, varbinary, char and binrary fields
  85                                 if (is_string($data[$field]) && preg_match("/char\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
  86                                         $data[$field] = mb_substr($data[$field], 0, $result[1]);
  87                                 } elseif (is_string($data[$field]) && preg_match("/binary\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
  88                                         $data[$field] = substr($data[$field], 0, $result[1]);
  89                                 }
  90                                 $fields[$field] = $data[$field];
  91                         }
  92                 }
  93
  94                 return $fields;
  95         }
  96
  97         /**
  98          * Loads the database structure definition from the static/dbstructure.config.php file.
  99          * On first pass, defines DB_UPDATE_VERSION constant.
 100          *
 101          * @param bool  $withAddonStructure Whether to tack on addons additional tables
 102          *
 103          * @throws Exception in case the definition cannot be found
 104          *
 105          * @see static/dbstructure.config.php
 106          *
 107          * @return self The current instance
 108          */
 109         public function load(bool $withAddonStructure = false): self
 110         {
 111                 $definition = require $this->configFile;
 112
 113                 if (!$definition) {
 114                         throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
 115                 }
 116
 117                 if ($withAddonStructure) {
 118                         Hook::callAll('dbstructure_definition', $definition);
 119                 }
 120
 121                 $this->definition = $definition;
 122
 123                 return $this;
 124         }
 125 }