Add an entry to log, if the database is updated.

config/services.yaml

@@ -73,6 +73,11 @@ services:
         tags:
             - { name: "doctrine.orm.entity_listener" }
 
+    App\EventSubscriber\MigrationListener:
+        tags:
+            - { name: 'doctrine.event_subscriber' }
+
+
     tree_invalidation_listener:
         class: App\EntityListeners\TreeCacheInvalidationListener
         tags:

src/Entity/LogSystem/AbstractLogEntry.php

@@ -150,6 +150,12 @@ abstract class AbstractLogEntry extends DBElement
      */
     protected $extra = [];
 
+    public function __construct()
+    {
+        $this->timestamp = new DateTime();
+        $this->level = self::LEVEL_WARNING;
+    }
+
     /**
      * Get the user that caused the event associated with this log entry.
      * @return User

src/Entity/LogSystem/DatabaseUpdatedLogEntry.php

@@ -31,9 +31,11 @@ class DatabaseUpdatedLogEntry extends AbstractLogEntry
 {
     protected $typeString = "database_updated";
 
-    public function __construct()
+    public function __construct(string $oldVersion, string $newVersion)
     {
-        throw new LogEntryObsoleteException();
+        parent::__construct();
+        $this->extra['o'] = $oldVersion;
+        $this->extra['n'] = $newVersion;
     }
 
     /**
@@ -42,25 +44,26 @@ class DatabaseUpdatedLogEntry extends AbstractLogEntry
      */
     public function isSuccessful(): bool
     {
-        return $this->extra['s'];
+        //We dont save unsuccessful updates now, so just assume it to save space.
+        return $this->extra['s'] ?? true;
     }
 
     /**
      * Gets the database version before update.
      * @return int
      */
-    public function getOldVersion(): int
+    public function getOldVersion(): string
     {
-        return $this->extra['o'];
+        return (string) $this->extra['o'];
     }
 
     /**
      * Gets the (target) database version after update.
      * @return int
      */
-    public function getNewVersion(): int
+    public function getNewVersion(): string
     {
-        return $this->extra['n'];
+        return (string) $this->extra['n'];
     }
 
 }

src/Entity/LogSystem/UserLoginLogEntry.php

@@ -35,6 +35,7 @@ class UserLoginLogEntry extends AbstractLogEntry
 
     public function __construct(string $ip_address, bool $anonymize = true)
     {
+        parent::__construct();
         $this->level = self::LEVEL_INFO;
         $this->setIPAddress($ip_address, $anonymize);
     }

src/Entity/LogSystem/UserLogoutLogEntry.php

@@ -35,6 +35,7 @@ class UserLogoutLogEntry extends AbstractLogEntry
 
     public function __construct(string $ip_address, bool $anonymize = true)
     {
+        parent::__construct();
         $this->level = self::LEVEL_INFO;
         $this->setIPAddress($ip_address, $anonymize);
     }

src/EventSubscriber/MigrationListener.php

@@ -0,0 +1,87 @@
+<?php
+/**
+ * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
+ *
+ * Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
+ */
+
+namespace App\EventSubscriber;
+
+
+use App\Entity\LogSystem\DatabaseUpdatedLogEntry;
+use App\Services\LogSystem\EventLogger;
+use Doctrine\Common\EventSubscriber;
+use Doctrine\Migrations\Event\MigrationsEventArgs;
+use Doctrine\Migrations\Event\MigrationsVersionEventArgs;
+use Doctrine\Migrations\Events;
+
+class MigrationListener implements EventSubscriber
+{
+    protected $old_version = null;
+    protected $new_version = null;
+
+    protected $eventLogger;
+
+    public function __construct(EventLogger $eventLogger)
+    {
+        $this->eventLogger = $eventLogger;
+    }
+
+    public function onMigrationsMigrated(MigrationsEventArgs $args): void
+    {
+        //Dont do anything if this was a dry run
+        if ($args->isDryRun()) {
+            return;
+        }
+
+        //Save the version after the migration
+        $this->new_version = $args->getConfiguration()->getCurrentVersion();
+
+        //After everything is done, write the results to DB log
+        $this->old_version = empty($this->old_version) ? 'legacy/empty' : $this->old_version;
+        $this->new_version = empty($this->new_version) ? 'unknown' : $this->new_version;
+
+
+        try {
+            $log = new DatabaseUpdatedLogEntry($this->old_version, $this->new_version);
+            $this->eventLogger->logAndFlush($log);
+        } catch (\Exception $exception) {
+            //Ignore any exception occuring here...
+        }
+
+    }
+
+
+    public function onMigrationsMigrating(MigrationsEventArgs $args): void
+    {
+        // Save the version before any migration
+        if ($this->old_version == null) {
+            $this->old_version = $args->getConfiguration()->getCurrentVersion();
+        }
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getSubscribedEvents()
+    {
+        return [
+            Events::onMigrationsMigrated,
+            Events::onMigrationsMigrating,
+            ];
+    }
+}