[Eventlog] Show extra data in log table.

src/DataTables/Column/LogEntryExtraColumn.php

@@ -0,0 +1,121 @@
+<?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\DataTables\Column;
+
+
+use App\Entity\LogSystem\DatabaseUpdatedLogEntry;
+use App\Entity\LogSystem\ElementCreatedLogEntry;
+use App\Entity\LogSystem\ElementDeletedLogEntry;
+use App\Entity\LogSystem\ElementEditedLogEntry;
+use App\Entity\LogSystem\ExceptionLogEntry;
+use App\Entity\LogSystem\InstockChangedLogEntry;
+use App\Entity\LogSystem\UserLoginLogEntry;
+use App\Entity\LogSystem\UserLogoutLogEntry;
+use App\Entity\LogSystem\UserNotAllowedLogEntry;
+use Omines\DataTablesBundle\Column\AbstractColumn;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class LogEntryExtraColumn extends AbstractColumn
+{
+    protected $translator;
+
+    public function __construct(TranslatorInterface $translator)
+    {
+        $this->translator = $translator;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function normalize($value)
+    {
+        return $value;
+    }
+
+    public function render($value, $context)
+    {
+        if ($context instanceof UserLoginLogEntry || $context instanceof UserLogoutLogEntry) {
+            return sprintf(
+                "<i>%s</i>: %s",
+                $this->translator->trans('log.user_login.ip'),
+                htmlspecialchars($context->getIPAddress())
+            );
+        }
+
+        if ($context instanceof ExceptionLogEntry) {
+            return sprintf(
+                '<i>%s</i> %s:%d : %s',
+                htmlspecialchars($context->getExceptionClass()),
+                htmlspecialchars($context->getFile()),
+                $context->getLine(),
+                htmlspecialchars($context->getMessage())
+            );
+        }
+
+        if ($context instanceof DatabaseUpdatedLogEntry) {
+            return sprintf(
+                '<i>%s</i> %s <i class="fas fa-long-arrow-alt-right"></i> %s',
+                $this->translator->trans($context->isSuccessful() ? 'log.database_updated.success' : 'log.database_updated.failure'),
+                $context->getOldVersion(),
+                $context->getNewVersion()
+            );
+        }
+
+        if ($context instanceof ElementCreatedLogEntry && $context->hasCreationInstockValue()) {
+            return sprintf(
+                '<i>%s</i>: %s',
+                $this->translator->trans('log.element_created.original_instock'),
+                $context->getCreationInstockValue()
+            );
+        }
+
+        if ($context instanceof ElementDeletedLogEntry) {
+            return sprintf(
+                '<i>%s</i>: %s',
+                $this->translator->trans('log.element_deleted.old_name'),
+                $context->getOldName()
+            );
+        }
+
+        if ($context instanceof ElementEditedLogEntry && !empty($context->getMessage())) {
+            return htmlspecialchars($context->getMessage());
+        }
+
+        if ($context instanceof InstockChangedLogEntry) {
+            return sprintf(
+                '<i>%s</i>; %s <i class="fas fa-long-arrow-alt-right"></i> %s (%s); %s: %s',
+                $this->translator->trans($context->isWithdrawal() ? 'log.instock_changed.withdrawal' : 'log.instock_changed.added'),
+                $context->getOldInstock(),
+                $context->getNewInstock(),
+                (!$context->isWithdrawal() ? '+' : '-') . $context->getDifference(true),
+                $this->translator->trans('log.instock_changed.comment'),
+                htmlspecialchars($context->getComment())
+            );
+        }
+
+        if ($context instanceof UserNotAllowedLogEntry) {
+            return htmlspecialchars($context->getMessage());
+        }
+
+        return "";
+    }
+}

src/DataTables/LogDataTable.php

@@ -24,6 +24,7 @@ namespace App\DataTables;
 
 use App\DataTables\Column\EntityColumn;
 use App\DataTables\Column\LocaleDateTimeColumn;
+use App\DataTables\Column\LogEntryExtraColumn;
 use App\DataTables\Column\LogEntryTargetColumn;
 use App\Entity\Attachments\Attachment;
 use App\Entity\LogSystem\AbstractLogEntry;
@@ -150,6 +151,10 @@ class LogDataTable implements DataTableTypeInterface
             'label' => $this->translator->trans('log.target')
         ]);
 
+        $dataTable->add('extra', LogEntryExtraColumn::class, [
+            'label' => $this->translator->trans('log.extra')
+        ]);
+
         $dataTable->addOrderBy('timestamp', DataTable::SORT_DESCENDING);
 
         $dataTable->createAdapter(ORMAdapter::class, [

src/Entity/LogSystem/AbstractLogEntry.php

@@ -56,7 +56,8 @@ use Psr\Log\LogLevel;
  *  6 = "ElementCreatedLogEntry",
  *  7 = "ElementEditedLogEntry",
  *  8 = "ConfigChangedLogEntry",
- *  9 = "DatabaseUpdatedLogEntry"
+ *  9 = "InstockChangedLogEntry",
+ *  10 = "DatabaseUpdatedLogEntry"
  * })
  */
 abstract class AbstractLogEntry extends DBElement
@@ -144,6 +145,11 @@ abstract class AbstractLogEntry extends DBElement
      */
     protected $typeString = "unknown";
 
+    /** @var array The extra data in raw (short form) saved in the DB
+     * @ORM\Column(name="extra", type="json")
+     */
+    protected $extra = [];
+
     /**
      * Get the user that caused the event associated with this log entry.
      * @return User
@@ -305,6 +311,11 @@ abstract class AbstractLogEntry extends DBElement
         return $this;
     }
 
+    public function getExtraData(): array
+    {
+        return $this->extra;
+    }
+
     /**
      * This function converts the internal numeric log level into an PSR3 compatible level string.
      * @param  int  $level The numerical log level

src/Entity/LogSystem/DatabaseUpdatedLogEntry.php

@@ -36,4 +36,31 @@ class DatabaseUpdatedLogEntry extends AbstractLogEntry
         throw new LogEntryObsoleteException();
     }
 
+    /**
+     * Checks if the database update was successful.
+     * @return bool
+     */
+    public function isSuccessful(): bool
+    {
+        return $this->extra['s'];
+    }
+
+    /**
+     * Gets the database version before update.
+     * @return int
+     */
+    public function getOldVersion(): int
+    {
+        return $this->extra['o'];
+    }
+
+    /**
+     * Gets the (target) database version after update.
+     * @return int
+     */
+    public function getNewVersion(): int
+    {
+        return $this->extra['n'];
+    }
+
 }

src/Entity/LogSystem/ElementCreatedLogEntry.php

@@ -31,4 +31,22 @@ use Doctrine\ORM\Mapping as ORM;
 class ElementCreatedLogEntry extends AbstractLogEntry
 {
     protected $typeString = "element_created";
+
+    /**
+     * Gets the instock when the part was created
+     * @return int|null
+     */
+    public function getCreationInstockValue(): ?int
+    {
+        return $this->extra['i'] ?? null;
+    }
+
+    /**
+     * Checks if a creation instock value was saved with this entry.
+     * @return bool
+     */
+    public function hasCreationInstockValue(): bool
+    {
+        return $this->getCreationInstockValue() !== null;
+    }
 }

src/Entity/LogSystem/ElementDeletedLogEntry.php

@@ -30,4 +30,9 @@ use Doctrine\ORM\Mapping as ORM;
 class ElementDeletedLogEntry extends AbstractLogEntry
 {
     protected $typeString = "element_deleted";
+
+    public function getOldName(): string
+    {
+        return $this->extra['n'];
+    }
 }

src/Entity/LogSystem/ElementEditedLogEntry.php

@@ -30,4 +30,13 @@ use Doctrine\ORM\Mapping as ORM;
 class ElementEditedLogEntry extends AbstractLogEntry
 {
     protected $typeString = "element_edited";
+
+    /**
+     * Returns the message associated with this edit change
+     * @return string
+     */
+    public function getMessage() : string
+    {
+        return $this->extra['m'] ?? '';
+    }
 }

src/Entity/LogSystem/ExceptionLogEntry.php

@@ -37,4 +37,41 @@ class ExceptionLogEntry extends AbstractLogEntry
     {
         throw new LogEntryObsoleteException();
     }
+
+    /**
+     * The class name of the exception that caused this log entry.
+     * @return string
+     */
+    public function getExceptionClass(): string
+    {
+        return $this->extra['t'] ?? "Unknown Class";
+    }
+
+    /**
+     * Returns the file where the exception happened.
+     * @return string
+     */
+    public function getFile(): string
+    {
+        return $this->extra['f'];
+    }
+
+    /**
+     * Returns the line where the exception happened
+     * @return int
+     */
+    public function getLine(): int
+    {
+        return $this->extra['l'];
+    }
+
+    /**
+     * Return the message of the exception.
+     * @return string
+     */
+    public function getMessage(): string
+    {
+        return $this->extra['m'];
+    }
+
 }

src/Entity/LogSystem/InstockChangedLogEntry.php

@@ -22,6 +22,7 @@
 namespace App\Entity\LogSystem;
 
 
+use App\Entity\Parts\Part;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
@@ -31,4 +32,74 @@ use Doctrine\ORM\Mapping as ORM;
 class InstockChangedLogEntry extends AbstractLogEntry
 {
     protected $typeString = "instock_changed";
+
+    /**
+     * Get the old instock
+     * @return int
+     */
+    public function getOldInstock(): int
+    {
+        return $this->extra['o'];
+    }
+
+    /**
+     * Get the new instock
+     * @return int
+     */
+    public function getNewInstock(): int
+    {
+        return $this->extra['n'];
+    }
+
+    /**
+     * Gets the comment associated with the instock change
+     * @return string
+     */
+    public function getComment(): string
+    {
+        return $this->extra['c'];
+    }
+
+    /**
+     * Returns the price that has to be payed for the change (in the base currency).
+     * @param $absolute bool Set this to true, if you want only get the absolute value of the price (without minus)
+     * @return float
+     */
+    public function getPrice(bool $absolute = false): float
+    {
+        if ($absolute) {
+            return abs($this->extra['p']);
+        }
+        return $this->extra['p'];
+    }
+
+    /**
+     * Returns the difference value of the change ($new_instock - $old_instock).
+     * @param $absolute bool  Set this to true if you want only the absolute value of the difference.
+     * @return int Difference is positive if instock has increased, negative if decreased.
+     */
+    public function getDifference(bool $absolute = false): int
+    {
+        // Check if one of the instock values is unknown
+        if ($this->getNewInstock() == -2 || $this->getOldInstock() == -2) {
+            return 0;
+        }
+
+        $difference = $this->getNewInstock() - $this->getOldInstock();
+        if ($absolute) {
+            return abs($difference);
+        }
+
+        return $difference;
+    }
+
+    /**
+     * Checks if the Change was an withdrawal of parts.
+     * @return bool True if the change was an withdrawal, false if not.
+     */
+    public function isWithdrawal(): bool
+    {
+        return $this->getNewInstock() < $this->getOldInstock();
+    }
+
 }

src/Entity/LogSystem/UserLoginLogEntry.php

@@ -31,4 +31,24 @@ use Doctrine\ORM\Mapping as ORM;
 class UserLoginLogEntry extends AbstractLogEntry
 {
     protected $typeString = "user_login";
+
+    /**
+     * Return the (anonymized) IP address used to login the user.
+     * @return string
+     */
+    public function getIPAddress(): string
+    {
+        return $this->extra['i'];
+    }
+
+    /**
+     * Sets the IP address used to login the user
+     * @param string $ip The IP address used to login the user.
+     * @return $this
+     */
+    public function setIPAddress(string $ip): self
+    {
+        $this->extra['i'] = $ip;
+        return $this;
+    }
 }

src/Entity/LogSystem/UserLogoutLogEntry.php

@@ -31,4 +31,24 @@ use Doctrine\ORM\Mapping as ORM;
 class UserLogoutLogEntry extends AbstractLogEntry
 {
     protected $typeString = "user_logout";
+
+    /**
+     * Return the (anonymized) IP address used to login the user.
+     * @return string
+     */
+    public function getIPAddress(): string
+    {
+        return $this->extra['i'];
+    }
+
+    /**
+     * Sets the IP address used to login the user
+     * @param string $ip The IP address used to login the user.
+     * @return $this
+     */
+    public function setIPAddress(string $ip): self
+    {
+        $this->extra['i'] = $ip;
+        return $this;
+    }
 }

src/Entity/LogSystem/UserNotAllowedLogEntry.php

@@ -31,11 +31,16 @@ use Doctrine\ORM\Mapping as ORM;
  */
 class UserNotAllowedLogEntry extends AbstractLogEntry
 {
-    protected $type = 'user_not_allowed';
+    protected $typeString = 'user_not_allowed';
 
     public function __construct()
     {
         //Obsolete, use server log now.
         throw new LogEntryObsoleteException();
     }
+
+    public function getMessage(): string
+    {
+        return $this->extra['p'] ?? '';
+    }
 }