gnu-social/src/Util/SchemaDefDriver.php

170 lines
5.9 KiB
PHP
Raw Normal View History

<?php
/*
* This file is part of GNU social - https://www.gnu.org/software/social
*
* GNU social is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* GNU social is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with GNU social. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Doctrine metadata driver which implements our old `schemaDef` interface
*
* @package GNUsocial
* @category DB
*
* @author Hugo Sales <hugo@fc.up.pt>
* @copyright 2020 Free Software Foundation, Inc http://www.fsf.org
* @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
*/
namespace App\Util;
use Doctrine\Persistence\Mapping\ClassMetadata;
use Doctrine\Persistence\Mapping\Driver\StaticPHPDriver;
use Functional as F;
class SchemaDefDriver extends StaticPHPDriver
{
/**
* PEAR DB type => Doctrine type
*/
private const types = [
'varchar' => 'string',
2020-03-30 18:15:30 +01:00
'char' => 'string', // char is a fixed witdh varchar
'int' => 'integer',
2020-03-30 18:15:30 +01:00
'serial' => 'integer',
'tinyint' => 'smallint', // no portable tinyint
'bigint' => 'bigint',
'bool' => 'boolean',
'numeric' => 'decimal',
'text' => 'text',
'datetime' => 'datetime',
// Unused in V2, but might start being used
'date' => 'date',
'time' => 'time',
'datetimez' => 'datetimez',
'object' => 'object',
'array' => 'array',
'simplearray' => 'simplearray',
'json_array' => 'json_array',
'float' => 'float',
'guid' => 'guid',
'blob' => 'blob',
];
/**
2020-03-30 18:15:30 +01:00
* Fill in the database $metadata for $class_name
*
2020-03-30 18:15:30 +01:00
* @param string $class_name
* @param ClassMetadata $metadata
*/
2020-03-30 18:15:30 +01:00
public function loadMetadataForClass($class_name, ClassMetadata $metadata)
{
2020-03-30 18:15:30 +01:00
$schema = $class_name::schemaDef();
$metadata->setPrimaryTable(['name' => $schema['name'],
2020-03-30 18:15:30 +01:00
'indexes' => self::kv_to_name_col($schema['indexes'] ?? []),
'uniqueConstraints' => self::kv_to_name_col($schema['unique keys'] ?? []),
'options' => ['comment' => $schema['description'] ?? ''],
]);
foreach ($schema['fields'] as $name => $opts) {
2020-03-30 18:15:30 +01:00
// TODO
// Convert old to new types
$type = // $name === 'date'
// // Old date fields were stored as int, store as datetime/timestamp
// ? 'datetime'
// // For ints, prepend the size (smallint)
// // The size field doesn't exist otherwise
// :
self::types[($opts['size'] ?? '') . $opts['type']];
$unique = null;
2020-03-30 18:15:30 +01:00
foreach ($schema['unique keys'] ?? [] as $key => $uniq_arr) {
if (in_array($name, $uniq_arr)) {
$unique = $key;
break;
}
}
$field = [
// boolean, optional
'id' => in_array($name, $schema['primary key']),
// string
'fieldName' => $name,
// string
'type' => $type,
// stringn, optional
'unique' => $unique,
// String length, ignored if not a string
// int, optional
'length' => $opts['length'] ?? null,
// boolean, optional
'nullable' => !($opts['not null'] ?? false),
// Numeric precision and scale, ignored if not a number
// integer, optional
'precision' => $opts['precision'] ?? null,
// integer, optional
'scale' => $opts['scale'] ?? null,
'options' => [
2020-03-30 18:15:30 +01:00
'comment' => $opts['description'] ?? null,
'default' => $opts['default'] ?? null,
'unsigned' => $opts['unsigned'] ?? null,
// bool, optional
'fixed' => $opts['type'] === 'char',
// 'collation' => string, unused
// 'check', unused
],
// 'columnDefinition', unused
];
// The optional feilds from earlier were populated with null, remove them
$field = array_filter($field, F\not('is_null'));
$field['options'] = array_filter($field['options'], F\not('is_null'));
$metadata->mapField($field);
2020-03-30 18:15:30 +01:00
if ($opts['type'] === 'serial') {
$metadata->setIdGeneratorType($metadata::GENERATOR_TYPE_AUTO);
}
}
// TODO foreign keys
}
/**
* Override StaticPHPDriver's method,
* we care about classes that have the method `schemaDef`,
* instead of `loadMetadata`.
*
2020-03-30 18:15:30 +01:00
* @param string $class_name
* @return bool
*/
2020-03-30 18:15:30 +01:00
public function isTransient($class_name)
{
2020-03-30 18:15:30 +01:00
return !method_exists($class_name, 'schemaDef');
}
/**
* Convert [$key => $val] to ['name' => $key, 'columns' => $val]
* @param array $arr
* @return array
*/
private static function kv_to_name_col(array $arr): array
{
$res = [];
foreach ($arr as $name => $cols) {
$res[] = ['name' => $name, 'columns' => $cols];
}
return $res;
}
}