Implement database schema Migrator

This commit implements the new database schema Migrator which keeps track of the on-disk schema and the schema used by the codebase. It tries to makes future database schema upgrades user-friendlier.
author: Thomas Lange <code@nerdmind.de> 2021-06-24 21:09:24 +0200
committer: Thomas Lange <code@nerdmind.de> 2021-06-24 21:09:24 +0200
commit: d69d7e82b8bbb567668c935ace848c7dcf750b08 (patch)
tree: dfad6bc5ce73262e958c92a3c3875c619c28ffc8 /theme
parent: 55ae320e7cfd710f3ea0f295c880619217db2220 (diff)
download: blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.tar.gz
blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.tar.xz
blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.zip
6 files changed, 125 insertions, 19 deletions
diff --git a/theme/admin/html/main.php b/theme/admin/html/main.php
index a7772ed..db637da 100644
--- a/theme/admin/html/main.php
+++ b/theme/admin/html/main.php
@@ -10,7 +10,7 @@
 </head>
 <body>
 	<header id="main-header">
-		<div class="header-line">
+		<div class="header-line background">
 			<div class="header-content">
 				<a href="<?=Application::getURL()?>">
 					<img id="header-logo" src="<?=Application::getTemplateURL('rsrc/icon-public-domain.svg')?>" alt="Administration" />
diff --git a/theme/admin/html/migration.php b/theme/admin/html/migration.php
new file mode 100644
index 0000000..14405c4
--- /dev/null
+++ b/theme/admin/html/migration.php
@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html lang="<?=$BLOGMETA['LANG']?>">
+<head>
+	<meta charset="UTF-8" />
+	<meta name="referrer" content="origin-when-crossorigin" />
+	<meta name="viewport" content="width=device-width, initial-scale=1" />
+	<link rel="stylesheet" href="<?=Application::getTemplateURL('rsrc/css/main.css')?>" />
+	<title><?=$Language->text('maintenance_mode')?></title>
+</head>
+<body>
+<header id="main-header">
+	<div class="header-line background">
+		<div class="header-content">
+			<img id="header-logo" src="<?=Application::getTemplateURL('rsrc/icon-public-domain.svg')?>" alt="Administration" />
+			<div id="header-text"><?=escapeHTML($BLOGMETA['NAME'])?></div>
+			<div id="header-desc"><?=$Language->text('maintenance_mode')?></div>
+		</div>
+	</div>
+</header>
+<?php
+$migrations_list = $MIGRATION['LIST'];
+$database_schema = $MIGRATION['SCHEMA_VERSION']['DATABASE'];
+$codebase_schema = $MIGRATION['SCHEMA_VERSION']['CODEBASE'];
+?>
+<main id="main-content">
+	<h1><?=$Language->text('maintenance_mode')?></h1>
+	<?php if($migrated = $MIGRATION['SUCCESSFUL']): ?>
+		<p><?=$Language->text('migration_successful')?></p>
+		<ul>
+		<?php foreach($migrated as $migration): ?>
+			<li>Migration <code><?=$migration?></code></li>
+		<?php endforeach ?>
+		</ul>
+	<?php else: ?>
+		<p><?=$Language->text("migration_upgrade", [$database_schema, $codebase_schema])?></p>
+		<form action="" method="post">
+			<ul class="no-visual-list">
+			<?php foreach($migrations_list as $migration => $commands): ?>
+				<li>
+					<h2><strong>Migration <code><?=$migration?></code></strong></h2>
+					<p><?=$Language->text('migration_notice', [$migration-1, $migration])?></p>
+					<pre><?=$commands?></pre>
+				</li>
+			<?php endforeach ?>
+			</ul>
+			<input type="hidden" name="token" value="<?=Application::getSecurityToken()?>" ?>
+			<input type="submit" name="run" value="<?=$Language->text('migration_submit')?>" id="delete-button" />
+		</form>
+	<?php endif ?>
+</main>
+<footer id="main-footer">
+	<ul>
+		<li><i class="fa fa-github-square"></i><a href="https://github.com/Nerdmind/Blog/releases" target="_blank">Releases</a></li>
+		<li><i class="fa fa-book"></i><a href="https://github.com/Nerdmind/Blog/wiki" target="_blank">Documentation</a></li>
+		<li><i class="fa fa-bug"></i><a href="https://github.com/Nerdmind/Blog/issues">Bugreport</a></li>
+	</ul>
+</footer>
+</body>
+</html>
diff --git a/theme/admin/lang/de.php b/theme/admin/lang/de.php
index 0a848a6..3c7e834 100644
--- a/theme/admin/lang/de.php
+++ b/theme/admin/lang/de.php
@@ -143,3 +143,13 @@ $LANGUAGE['markdown_code'] = 'Codeblock';
 $LANGUAGE['markdown_quote'] = 'Zitat';
 $LANGUAGE['markdown_list_ul'] = 'Liste [ungeordnet]';
 $LANGUAGE['markdown_list_ol'] = 'Liste [geordnet]';
+
+#===============================================================================
+# Migrations
+#===============================================================================
+$LANGUAGE['maintenance_mode'] = 'Wartungsmodus';
+$LANGUAGE['migration_upgrade'] = 'Eine Migration des Datenbankschemas ist erforderlich!<br>Die Datenbank verwendet die
+	Schema-Version <code>%d</code>, aber die Applikation benutzt die höhere Schema-Version <code>%d</code>.';
+$LANGUAGE['migration_notice'] = 'Die folgenden Kommandos migrieren das Datenbankschema von <code>%d</code> nach <code>%d</code>.';
+$LANGUAGE['migration_successful'] = 'Die folgenden Migrationen waren erfolgreich:';
+$LANGUAGE['migration_submit'] = 'Migrationen ausführen';
diff --git a/theme/admin/lang/en.php b/theme/admin/lang/en.php
index 174a1d7..20482d4 100644
--- a/theme/admin/lang/en.php
+++ b/theme/admin/lang/en.php
@@ -143,3 +143,13 @@ $LANGUAGE['markdown_code'] = 'Code block';
 $LANGUAGE['markdown_quote'] = 'Quote';
 $LANGUAGE['markdown_list_ul'] = 'List [unordered]';
 $LANGUAGE['markdown_list_ol'] = 'List [ordered]';
+
+#===============================================================================
+# Migrations
+#===============================================================================
+$LANGUAGE['maintenance_mode'] = 'Maintenance mode';
+$LANGUAGE['migration_upgrade'] = 'A database schema migration is required!<br>The on-disk schema version is
+	<code>%d</code> but the application uses the higher schema version <code>%d</code>.';
+$LANGUAGE['migration_notice'] = 'The following commands will migrate the database schema from <code>%d</code> to <code>%d</code>.';
+$LANGUAGE['migration_successful'] = 'The following migrations were successful:';
+$LANGUAGE['migration_submit'] = 'Run migrations';
diff --git a/theme/admin/rsrc/css/main.css b/theme/admin/rsrc/css/main.css
index cfc6db9..7d93d94 100644
--- a/theme/admin/rsrc/css/main.css
+++ b/theme/admin/rsrc/css/main.css
@@ -140,18 +140,18 @@ body {
 .header-line {
   padding: 0.5rem 0.75rem;
   overflow: hidden;
-}
-.header-line:first-child {
-  background: #5E819F;
-  position: sticky;
-  top: 0;
-}
-.header-line:last-child {
   background: #EEE;
+  padding: 0.25rem 0.75rem;
+}
+.header-line + .header-line {
   border: 0.05rem solid #AAA;
   border-left: none;
   border-right: none;
-  padding: 0.25rem 0.75rem;
+}
+.header-line.background {
+  background: #5E819F;
+  position: sticky;
+  top: 0;
 }
 
 /*++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
@@ -308,11 +308,18 @@ pre {
   overflow: auto;
   -moz-tab-size: 4;
   tab-size: 4;
+  background: #EEE;
+  padding: 0.5rem;
+  border: 0.05rem solid #AAA;
+  font-style: italic;
 }
 
 code, pre {
   font-family: "monospace";
-  color: #B03060;
+}
+
+code {
+  color: #008B45;
 }
 
 p {
@@ -344,6 +351,12 @@ img {
   display: none;
 }
 
+.no-visual-list {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+}
+
 #database-result {
   color: inherit;
 }
diff --git a/theme/admin/rsrc/css/main.scss b/theme/admin/rsrc/css/main.scss
index d1f43c9..cc9bbb1 100644
--- a/theme/admin/rsrc/css/main.scss
+++ b/theme/admin/rsrc/css/main.scss
@@ -145,19 +145,20 @@ body {
 .header-line {
 	padding: 0.5rem 0.75rem;
 	overflow: hidden;
+	background: #EEE;
 
-	&:first-child {
-		background: #5E819F;
-		position: sticky;
-		top: 0;
-	}
+	padding: 0.25rem 0.75rem;
 
-	&:last-child {
-		background: #EEE;
+	+.header-line {
 		border: 0.05rem solid #AAA;
 		border-left: none;
 		border-right: none;
-		padding: 0.25rem 0.75rem;
+	}
+
+	&.background {
+		background: #5E819F;
+		position: sticky;
+		top: 0;
 	}
 }
 
@@ -341,11 +342,18 @@ pre {
 	overflow: auto;
 	-moz-tab-size: 4;
 	tab-size: 4;
+	background: #EEE;
+	padding: 0.5rem;
+	border: 0.05rem solid #AAA;
+	font-style: italic;
 }
 
 code, pre {
 	font-family: "monospace";
-	color: #B03060;
+}
+
+code {
+	color: #008B45;
 }
 
 p {
@@ -377,6 +385,12 @@ img {
 	display: none;
 }
 
+.no-visual-list {
+	margin: 0;
+	padding: 0;
+	list-style: none;
+}
+
 #database-result {
 	color: inherit;
 }
author	Thomas Lange <code@nerdmind.de>	2021-06-24 21:09:24 +0200
committer	Thomas Lange <code@nerdmind.de>	2021-06-24 21:09:24 +0200
commit	d69d7e82b8bbb567668c935ace848c7dcf750b08 (patch)
tree	dfad6bc5ce73262e958c92a3c3875c619c28ffc8 /theme
parent	55ae320e7cfd710f3ea0f295c880619217db2220 (diff)
download	blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.tar.gz blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.tar.xz blog-d69d7e82b8bbb567668c935ace848c7dcf750b08.zip