src/Util/Writer/ViewDefinitionSqlWriter.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\Util\Writer;
  23
  24 use Friendica\Database\Definition\ViewDefinition;
  25
  26 /**
  27  * SQL writer utility for the db view definition
  28  */
  29 class ViewDefinitionSqlWriter
  30 {
  31         /**
  32          * Creates a complete SQL definition bases on a give View Definition class
  33          *
  34          * @param ViewDefinition $definition The View definition class
  35          *
  36          * @return string The SQL definition as a string
  37          */
  38         public static function create(ViewDefinition $definition): string
  39         {
  40                 $sqlString = '';
  41
  42                 foreach ($definition->getAll() as $viewName => $viewStructure) {
  43                         $sqlString .= "--\n";
  44                         $sqlString .= "-- VIEW $viewName\n";
  45                         $sqlString .= "--\n";
  46                         $sqlString .= static::dropView($viewName);
  47                         $sqlString .= static::createView($viewName, $viewStructure);
  48                 }
  49
  50                 return $sqlString;
  51         }
  52
  53         /**
  54          * Creates the SQL definition to drop a view
  55          *
  56          * @param string $viewName the view name
  57          *
  58          * @return string The SQL definition
  59          */
  60         public static function dropView(string $viewName): string
  61         {
  62                 return sprintf("DROP VIEW IF EXISTS `%s`", static::escape($viewName)) . ";\n";
  63         }
  64
  65         /**
  66          * Creates the SQL definition to create a new view
  67          *
  68          * @param string $viewName      The view name
  69          * @param array  $viewStructure The structure information of the view
  70          *
  71          * @return string The SQL definition
  72          */
  73         public static function createView(string $viewName, array $viewStructure): string
  74         {
  75                 $sql_rows = [];
  76                 foreach ($viewStructure['fields'] as $fieldname => $origin) {
  77                         if (is_string($origin)) {
  78                                 $sql_rows[] = $origin . " AS `" . static::escape($fieldname) . "`";
  79                         } elseif (is_array($origin) && (sizeof($origin) == 2)) {
  80                                 $sql_rows[] = "`" . static::escape($origin[0]) . "`.`" . static::escape($origin[1]) . "` AS `" . static::escape($fieldname) . "`";
  81                         }
  82                 }
  83                 return sprintf("CREATE VIEW `%s` AS SELECT \n\t", static::escape($viewName)) .
  84                            implode(",\n\t", $sql_rows) . "\n\t" . $viewStructure['query'] . ";\n\n";
  85         }
  86
  87         /**
  88          * Standard escaping for SQL definitions
  89          *
  90          * @param string $sqlString the SQL string to escape
  91          *
  92          * @return string escaped SQL string
  93          */
  94         public static function escape(string $sqlString): string
  95         {
  96                 return str_replace("'", "\\'", $sqlString);
  97         }
  98 }