X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FDatabase%2FDBStructure.php;h=4779487283a169535153c34b9b743615f2f4b298;hb=2b95a7e7cd76c573b82b2dbcc5ad08b1501ee89b;hp=5d0749c58308274baa10fef633cfb864e98b3ffd;hpb=3fe7d035d4a907b175e1cbb31cd34d6e58cfe8ae;p=friendica.git

diff --git a/src/Database/DBStructure.php b/src/Database/DBStructure.php
index 5d0749c583..4779487283 100644
--- a/src/Database/DBStructure.php
+++ b/src/Database/DBStructure.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -24,6 +24,7 @@ namespace Friendica\Database;
 use Exception;
 use Friendica\Core\Hook;
 use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
 use Friendica\DI;
 use Friendica\Model\Item;
 use Friendica\Model\User;
@@ -64,6 +65,53 @@ class DBStructure
 		echo DI::l10n()->t('The database version had been set to %s.', $version);
 	}
 
+	/**
+	 * Drop unused tables
+	 *
+	 * @param boolean $execute
+	 * @return void
+	 */
+	public static function dropTables(bool $execute)
+	{
+		$postupdate = DI::config()->get("system", "post_update_version", PostUpdate::VERSION);
+		if ($postupdate < PostUpdate::VERSION) {
+			echo DI::l10n()->t('The post update is at version %d, it has to be at %d to safely drop the tables.', $postupdate, PostUpdate::VERSION);
+			return;
+		}
+
+		$old_tables = ['fserver', 'gcign', 'gcontact', 'gcontact-relation', 'gfollower' ,'glink', 'item-delivery-data',
+			'item-activity', 'item-content', 'item_id', 'participation', 'poll', 'poll_result', 'queue', 'retriever_rule',
+			'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item'];
+
+		$tables = DBA::selectToArray(['INFORMATION_SCHEMA' => 'TABLES'], ['TABLE_NAME'],
+			['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']);
+
+		if (empty($tables)) {
+			echo DI::l10n()->t('No unused tables found.');
+			return;
+		}
+
+		if (!$execute) {
+			echo DI::l10n()->t('These tables are not used for friendica and will be deleted when you execute "dbstructure drop -e":') . "\n\n";
+		}
+
+		foreach ($tables as $table) {
+			if (in_array($table['TABLE_NAME'], $old_tables)) {
+				if ($execute) {
+					$sql = 'DROP TABLE ' . DBA::quoteIdentifier($table['TABLE_NAME']) . ';';
+					echo $sql . "\n";
+
+					$result = DBA::e($sql);
+					if (!DBA::isResult($result)) {
+						self::printUpdateError($sql);
+					}
+				} else {
+					echo $table['TABLE_NAME'] . "\n";
+				}
+			}
+		}
+	}
+
 	/**
 	 * Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
 	 */
@@ -112,6 +160,108 @@ class DBStructure
 		return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
 	}
 
+	public static function writeStructure()
+	{
+		$tables = [];
+		foreach (self::definition(null) as $name => $definition) {
+			$indexes  = [[
+				'name'   => 'Name',
+				'fields' => 'Fields',
+			],
+			[
+				'name'   => '-',
+				'fields' => '-',
+			]];
+
+			$lengths = ['name' => 4, 'fields' => 6];
+			foreach ($definition['indexes'] as $key => $value) {
+				$fieldlist = implode(', ', $value);
+				$indexes[] = ['name' => $key, 'fields' => $fieldlist];
+				$lengths['name']   = max($lengths['name'], strlen($key));
+				$lengths['fields'] = max($lengths['fields'], strlen($fieldlist));
+			}
+
+			array_walk_recursive($indexes, function(&$value, $key) use ($lengths)
+			{
+				$value = str_pad($value, $lengths[$key], $value === '-' ? '-' : ' ');
+			});
+
+			$foreign = [];
+			$fields  = [[
+				'name'    => 'Field',
+				'comment' => 'Description',
+				'type'    => 'Type',
+				'null'    => 'Null',
+				'primary' => 'Key',
+				'default' => 'Default',
+				'extra'   => 'Extra',
+			],
+			[
+				'name'    => '-',
+				'comment' => '-',
+				'type'    => '-',
+				'null'    => '-',
+				'primary' => '-',
+				'default' => '-',
+				'extra'   => '-',
+			]];
+			$lengths = [
+				'name'    => 5,
+				'comment' => 11,
+				'type'    => 4,
+				'null'    => 4,
+				'primary' => 3,
+				'default' => 7,
+				'extra'   => 5,
+			];
+			foreach ($definition['fields'] as $key => $value) {
+				$field = [];
+				$field['name']    = $key;
+				$field['comment'] = $value['comment'] ?? '';
+				$field['type']    = $value['type'];
+				$field['null']    = ($value['not null'] ?? false) ? 'NO' : 'YES';
+				$field['primary'] = ($value['primary'] ?? false) ? 'PRI' : '';
+				$field['default'] = $value['default'] ?? 'NULL';
+				$field['extra']   = $value['extra'] ?? '';
+
+				foreach ($field as $fieldname => $fieldvalue) {
+					$lengths[$fieldname] = max($lengths[$fieldname] ?? 0, strlen($fieldvalue));
+				}
+				$fields[] = $field;
+
+				if (!empty($value['foreign'])) {
+					$foreign[] = [
+						'field'       => $key,
+						'targettable' => array_keys($value['foreign'])[0],
+						'targetfield' => array_values($value['foreign'])[0]
+					];
+				}
+			}
+
+			array_walk_recursive($fields, function(&$value, $key) use ($lengths)
+			{
+				$value = str_pad($value, $lengths[$key], $value === '-' ? '-' : ' ');
+			});
+
+			$tables[] = ['name' => $name, 'comment' => $definition['comment']];
+			$content = Renderer::replaceMacros(Renderer::getMarkupTemplate('structure.tpl'), [
+				'$name'    => $name,
+				'$comment' => $definition['comment'],
+				'$fields'  => $fields,
+				'$indexes' => $indexes,
+				'$foreign' => $foreign,
+			]);
+			$filename = DI::basePath() . '/doc/database/db_' . $name . '.md';
+			file_put_contents($filename, $content);
+		}
+		asort($tables);
+		$content = Renderer::replaceMacros(Renderer::getMarkupTemplate('tables.tpl'), [
+			'$tables'  => $tables,
+		]);
+		$filename = DI::basePath() . '/doc/database.md';
+		file_put_contents($filename, $content);
+	}
+
 	public static function printStructure($basePath)
 	{
 		$database = self::definition($basePath, false);
@@ -145,6 +295,9 @@ class DBStructure
 	public static function definition($basePath, $with_addons_structure = true)
 	{
 		if (!self::$definition) {
+			if (empty($basePath)) {
+				$basePath = DI::app()->getBasePath();
+			}
 
 			$filename = $basePath . '/static/dbstructure.config.php';
 
@@ -191,6 +344,12 @@ class DBStructure
 		// Assign all field that are present in the table
 		foreach ($fieldnames as $field) {
 			if (isset($data[$field])) {
+				// Limit the length of varchar, varbinary, char and binrary fields
+				if (is_string($data[$field]) && preg_match("/char\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
+					$data[$field] = mb_substr($data[$field], 0, $result[1]);
+				} elseif (is_string($data[$field]) && preg_match("/binary\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
+					$data[$field] = substr($data[$field], 0, $result[1]);
+				}
 				$fields[$field] = $data[$field];
 			}
 		}
@@ -321,6 +480,54 @@ class DBStructure
 		return ($sql);
 	}
 
+	/**
+	 * Perform a database structure dryrun (means: just simulating)
+	 *
+	 * @throws Exception
+	 */
+	public static function dryRun()
+	{
+		self::update(DI::app()->getBasePath(), true, false);
+	}
+
+	/**
+	 * Updates DB structure and returns eventual errors messages
+	 *
+	 * @param bool $enable_maintenance_mode Set the maintenance mode
+	 * @param bool $verbose                 Display the SQL commands
+	 *
+	 * @return string Empty string if the update is successful, error messages otherwise
+	 * @throws Exception
+	 */
+	public static function performUpdate(bool $enable_maintenance_mode = true, bool $verbose = false)
+	{
+		if ($enable_maintenance_mode) {
+			DI::config()->set('system', 'maintenance', 1);
+		}
+
+		$status = self::update(DI::app()->getBasePath(), $verbose, true);
+
+		if ($enable_maintenance_mode) {
+			DI::config()->set('system', 'maintenance', 0);
+			DI::config()->set('system', 'maintenance_reason', '');
+		}
+
+		return $status;
+	}
+
+	/**
+	 * Updates DB structure from the installation and returns eventual errors messages
+	 *
+	 * @param string $basePath   The base path of this application
+	 *
+	 * @return string Empty string if the update is successful, error messages otherwise
+	 * @throws Exception
+	 */
+	public static function install(string $basePath)
+	{
+		return self::update($basePath, false, true, true);
+	}
+
 	/**
 	 * Updates DB structure and returns eventual errors messages
 	 *
@@ -333,14 +540,15 @@ class DBStructure
 	 * @return string Empty string if the update is successful, error messages otherwise
 	 * @throws Exception
 	 */
-	public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
+	private static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
 	{
-		if ($action && !$install) {
-			if (self::isUpdating()) {
-				return DI::l10n()->t('Another database update is currently running.');
-			}
+		$in_maintenance_mode = DI::config()->get('system', 'maintenance');
 
-			DI::config()->set('system', 'maintenance', 1);
+		if ($action && !$install && self::isUpdating()) {
+			return DI::l10n()->t('Another database update is currently running.');
+		}
+
+		if ($in_maintenance_mode) {
 			DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
 		}
 
@@ -350,7 +558,7 @@ class DBStructure
 
 		$errors = '';
 
-		Logger::log('updating structure', Logger::DEBUG);
+		Logger::info('updating structure');
 
 		// Get the current structure
 		$database = [];
@@ -363,7 +571,7 @@ class DBStructure
 			foreach ($tables AS $table) {
 				$table = current($table);
 
-				Logger::log(sprintf('updating structure for table %s ...', $table), Logger::DEBUG);
+				Logger::info('updating structure', ['table' => $table]);
 				$database[$table] = self::tableStructure($table);
 			}
 		}
@@ -640,7 +848,7 @@ class DBStructure
 				}
 
 				if ($action) {
-					if (!$install) {
+					if ($in_maintenance_mode) {
 						DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
 					}
 
@@ -697,9 +905,6 @@ class DBStructure
 		self::checkInitialValues();
 
 		if ($action && !$install) {
-			DI::config()->set('system', 'maintenance', 0);
-			DI::config()->set('system', 'maintenance_reason', '');
-
 			if ($errors) {
 				DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
 			} else {
@@ -1046,12 +1251,54 @@ class DBStructure
 	/**
 	 * Check if initial database values do exist - or create them
 	 */
-	public static function checkInitialValues()
+	public static function checkInitialValues(bool $verbose = false)
 	{
-		if (self::existsTable('verb') && !DBA::exists('verb', ['id' => 1])) {
-			foreach (Item::ACTIVITIES as $index => $activity) {
-				DBA::insert('verb', ['id' => $index + 1, 'name' => $activity], true);
+		if (self::existsTable('verb')) {
+			if (!DBA::exists('verb', ['id' => 1])) {
+				foreach (Item::ACTIVITIES as $index => $activity) {
+					DBA::insert('verb', ['id' => $index + 1, 'name' => $activity], Database::INSERT_IGNORE);
+				}
+				if ($verbose) {
+					echo "verb: activities added\n";
+				}
+			} elseif ($verbose) {
+				echo "verb: activities already added\n";
+			}
+
+			if (!DBA::exists('verb', ['id' => 0])) {
+				DBA::insert('verb', ['name' => '']);
+				$lastid = DBA::lastInsertId();
+				if ($lastid != 0) {
+					DBA::update('verb', ['id' => 0], ['id' => $lastid]);
+					if ($verbose) {
+						echo "Zero verb added\n";
+					}
+				}
+			} elseif ($verbose) {
+				echo "Zero verb already added\n";
+			}
+		} elseif ($verbose) {
+			echo "verb: Table not found\n";
+		}
+
+		if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
+			$user = [
+				"verified" => true,
+				"page-flags" => User::PAGE_FLAGS_SOAPBOX,
+				"account-type" => User::ACCOUNT_TYPE_RELAY,
+			];
+			DBA::insert('user', $user);
+			$lastid = DBA::lastInsertId();
+			if ($lastid != 0) {
+				DBA::update('user', ['uid' => 0], ['uid' => $lastid]);
+				if ($verbose) {
+					echo "Zero user added\n";
+				}
 			}
+		} elseif (self::existsTable('user') && $verbose) {
+			echo "Zero user already added\n";
+		} elseif ($verbose) {
+			echo "user: Table not found\n";
 		}
 
 		if (self::existsTable('contact') && !DBA::exists('contact', ['id' => 0])) {
@@ -1059,18 +1306,45 @@ class DBStructure
 			$lastid = DBA::lastInsertId();
 			if ($lastid != 0) {
 				DBA::update('contact', ['id' => 0], ['id' => $lastid]);
-			}		
+				if ($verbose) {
+					echo "Zero contact added\n";
+				}
+			}
+		} elseif (self::existsTable('contact') && $verbose) {
+			echo "Zero contact already added\n";
+		} elseif ($verbose) {
+			echo "contact: Table not found\n";
+		}
+
+		if (self::existsTable('tag') && !DBA::exists('tag', ['id' => 0])) {
+			DBA::insert('tag', ['name' => '']);
+			$lastid = DBA::lastInsertId();
+			if ($lastid != 0) {
+				DBA::update('tag', ['id' => 0], ['id' => $lastid]);
+				if ($verbose) {
+					echo "Zero tag added\n";
+				}
+			}
+		} elseif (self::existsTable('tag') && $verbose) {
+			echo "Zero tag already added\n";
+		} elseif ($verbose) {
+			echo "tag: Table not found\n";
 		}
 
 		if (self::existsTable('permissionset')) {
 			if (!DBA::exists('permissionset', ['id' => 0])) {
-				DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']);	
+				DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']);
 				$lastid = DBA::lastInsertId();
 				if ($lastid != 0) {
 					DBA::update('permissionset', ['id' => 0], ['id' => $lastid]);
+					if ($verbose) {
+						echo "Zero permissionset added\n";
+					}
 				}
+			} elseif ($verbose) {
+				echo "Zero permissionset already added\n";
 			}
-			if (!self::existsForeignKeyForField('item', 'psid')) {
+			if (self::existsTable('item') && !self::existsForeignKeyForField('item', 'psid')) {
 				$sets = DBA::p("SELECT `psid`, `item`.`uid`, `item`.`private` FROM `item`
 					LEFT JOIN `permissionset` ON `permissionset`.`id` = `item`.`psid`
 					WHERE `permissionset`.`id` IS NULL AND NOT `psid` IS NULL");
@@ -1091,36 +1365,8 @@ class DBStructure
 				}
 				DBA::close($sets);
 			}
-		}
-	
-		if (self::existsTable('tag') && !DBA::exists('tag', ['id' => 0])) {
-			DBA::insert('tag', ['name' => '']);
-			$lastid = DBA::lastInsertId();
-			if ($lastid != 0) {
-				DBA::update('tag', ['id' => 0], ['id' => $lastid]);
-			}
-		}
-
-		if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
-			$system = User::getSystemAccount();
-			$user = [
-				"username" => $system['name'],
-				"nickname" => $system['nick'],
-				"register_date" => $system['created'],
-				"pubkey" => $system['pubkey'],
-				"prvkey" => $system['prvkey'],
-				"spubkey" => $system['spubkey'],
-				"sprvkey" => $system['sprvkey'],
-				"verified" => true,
-				"page-flags" => User::PAGE_FLAGS_SOAPBOX,
-				"account-type" => User::ACCOUNT_TYPE_RELAY,
-			];
-	
-			DBA::insert('user', $user);
-			$lastid = DBA::lastInsertId();
-			if ($lastid != 0) {
-				DBA::update('user', ['uid' => 0], ['uid' => $lastid]);
-			}
+		} elseif ($verbose) {
+			echo "permissionset: Table not found\n";
 		}
 
 		if (!self::existsForeignKeyForField('tokens', 'client_id')) {