From 0da5c282d6854d9a8dbe1b2717bde4dfa5934d1c Mon Sep 17 00:00:00 2001
From: nuxsmin <nuxsmin@syspass.org>
Date: Sun, 11 Nov 2018 12:58:31 +0100
Subject: [PATCH] * [MOD] Improved logging when performing upgrades * [MOD] Log
 to file is turned on when debug mode is active

Signed-off-by: nuxsmin <nuxsmin@syspass.org>
---
 lib/SP/Bootstrap.php                          |  1 +
 lib/SP/Core/ModuleBase.php                    | 10 +++++---
 lib/SP/Providers/Log/FileLogHandler.php       |  1 +
 lib/SP/Providers/Log/LogInterface.php         |  3 ++-
 lib/SP/Services/Upgrade/UpgradeAppService.php |  9 +++++++
 lib/SP/Services/Upgrade/UpgradeAuthToken.php  |  1 -
 .../Services/Upgrade/UpgradeConfigService.php |  9 +++++++
 .../Upgrade/UpgradeDatabaseService.php        |  6 +++++
 tests/phpunit.xml                             | 25 +------------------
 tests/res/config/config.xml                   |  8 +++---
 10 files changed, 40 insertions(+), 33 deletions(-)

diff --git a/lib/SP/Bootstrap.php b/lib/SP/Bootstrap.php
index fcc8316c..2921e03d 100644
--- a/lib/SP/Bootstrap.php
+++ b/lib/SP/Bootstrap.php
@@ -255,6 +255,7 @@ final class Bootstrap
      * @throws Services\Upgrade\UpgradeException
      * @throws \DI\DependencyException
      * @throws \DI\NotFoundException
+     * @throws Storage\File\FileException
      */
     protected function initializeCommon()
     {
diff --git a/lib/SP/Core/ModuleBase.php b/lib/SP/Core/ModuleBase.php
index 83081005..f161751a 100644
--- a/lib/SP/Core/ModuleBase.php
+++ b/lib/SP/Core/ModuleBase.php
@@ -116,16 +116,20 @@ abstract class ModuleBase
 
     /**
      * Initializes event handlers
+     *
+     * @throws \DI\DependencyException
+     * @throws \DI\NotFoundException
      */
     protected function initEventHandlers()
     {
         $eventDispatcher = $this->container->get(EventDispatcher::class);
 
+        if (DEBUG) {
+            $eventDispatcher->attach($this->container->get(FileLogHandler::class));
+        }
+
         if ($this->configData->isLogEnabled()) {
             $eventDispatcher->attach($this->container->get(DatabaseLogHandler::class));
-            if (DEBUG) {
-                $eventDispatcher->attach($this->container->get(FileLogHandler::class));
-            }
         }
 
         if ($this->configData->isMailEnabled()) {
diff --git a/lib/SP/Providers/Log/FileLogHandler.php b/lib/SP/Providers/Log/FileLogHandler.php
index 6594360b..dae4316a 100644
--- a/lib/SP/Providers/Log/FileLogHandler.php
+++ b/lib/SP/Providers/Log/FileLogHandler.php
@@ -83,6 +83,7 @@ final class FileLogHandler extends Provider implements EventReceiver
      *                            </p>
      *
      * @return void
+     * @throws \SP\Core\Exceptions\InvalidClassException
      * @since 5.1.0
      */
     public function update(SplSubject $subject)
diff --git a/lib/SP/Providers/Log/LogInterface.php b/lib/SP/Providers/Log/LogInterface.php
index bed56144..bbb66d29 100644
--- a/lib/SP/Providers/Log/LogInterface.php
+++ b/lib/SP/Providers/Log/LogInterface.php
@@ -57,6 +57,7 @@ interface LogInterface
         'clear.eventlog',
         'clear.track',
         'unlock.track',
-        'plugin.load.error'
+        'plugin.load.error',
+        'upgrade.'
     ];
 }
\ No newline at end of file
diff --git a/lib/SP/Services/Upgrade/UpgradeAppService.php b/lib/SP/Services/Upgrade/UpgradeAppService.php
index 63058641..abf15c19 100644
--- a/lib/SP/Services/Upgrade/UpgradeAppService.php
+++ b/lib/SP/Services/Upgrade/UpgradeAppService.php
@@ -27,6 +27,7 @@ namespace SP\Services\Upgrade;
 use SP\Config\ConfigData;
 use SP\Core\Events\Event;
 use SP\Core\Events\EventMessage;
+use SP\Providers\Log\FileLogHandler;
 use SP\Services\Service;
 use SP\Util\VersionUtil;
 
@@ -123,4 +124,12 @@ final class UpgradeAppService extends Service implements UpgradeInterface
 
         return false;
     }
+
+    /**
+     * initialize
+     */
+    protected function initialize()
+    {
+        $this->eventDispatcher->attach($this->dic->get(FileLogHandler::class));
+    }
 }
\ No newline at end of file
diff --git a/lib/SP/Services/Upgrade/UpgradeAuthToken.php b/lib/SP/Services/Upgrade/UpgradeAuthToken.php
index 09ead2a1..14dffb11 100644
--- a/lib/SP/Services/Upgrade/UpgradeAuthToken.php
+++ b/lib/SP/Services/Upgrade/UpgradeAuthToken.php
@@ -147,6 +147,5 @@ final class UpgradeAuthToken extends Service
     protected function initialize()
     {
         $this->authtokenService = $this->dic->get(AuthTokenService::class);
-
     }
 }
\ No newline at end of file
diff --git a/lib/SP/Services/Upgrade/UpgradeConfigService.php b/lib/SP/Services/Upgrade/UpgradeConfigService.php
index 23e40e01..0ea110d5 100644
--- a/lib/SP/Services/Upgrade/UpgradeConfigService.php
+++ b/lib/SP/Services/Upgrade/UpgradeConfigService.php
@@ -28,6 +28,7 @@ use SP\Config\ConfigData;
 use SP\Core\Events\Event;
 use SP\Core\Events\EventMessage;
 use SP\Core\MimeTypes;
+use SP\Providers\Log\FileLogHandler;
 use SP\Services\Service;
 use SP\Util\VersionUtil;
 
@@ -306,4 +307,12 @@ final class UpgradeConfigService extends Service implements UpgradeInterface
                 ->addDetail(__u('Version'), $version))
         );
     }
+
+    /**
+     * initialize
+     */
+    protected function initialize()
+    {
+        $this->eventDispatcher->attach($this->dic->get(FileLogHandler::class));
+    }
 }
\ No newline at end of file
diff --git a/lib/SP/Services/Upgrade/UpgradeDatabaseService.php b/lib/SP/Services/Upgrade/UpgradeDatabaseService.php
index baaf857e..9b4ca80c 100644
--- a/lib/SP/Services/Upgrade/UpgradeDatabaseService.php
+++ b/lib/SP/Services/Upgrade/UpgradeDatabaseService.php
@@ -27,6 +27,7 @@ namespace SP\Services\Upgrade;
 use SP\Config\ConfigData;
 use SP\Core\Events\Event;
 use SP\Core\Events\EventMessage;
+use SP\Providers\Log\FileLogHandler;
 use SP\Services\Service;
 use SP\Storage\Database\Database;
 use SP\Storage\Database\MySQLFileParser;
@@ -213,8 +214,13 @@ final class UpgradeDatabaseService extends Service implements UpgradeInterface
         }
     }
 
+    /**
+     * initialize
+     */
     protected function initialize()
     {
+        $this->eventDispatcher->attach($this->dic->get(FileLogHandler::class));
+
         $this->db = $this->dic->get(Database::class);
     }
 }
\ No newline at end of file
diff --git a/tests/phpunit.xml b/tests/phpunit.xml
index 440b90eb..1f62c5ba 100644
--- a/tests/phpunit.xml
+++ b/tests/phpunit.xml
@@ -1,27 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  ~ sysPass
-  ~
-  ~ @author nuxsmin
-  ~ @link https://syspass.org
-  ~ @copyright 2012-2018, Rubén Domínguez nuxsmin@$syspass.org
-  ~
-  ~ This file is part of sysPass.
-  ~
-  ~ sysPass 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 3 of the License, or
-  ~ (at your option) any later version.
-  ~
-  ~ sysPass 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 sysPass.  If not, see <http://www.gnu.org/licenses/>.
-  -->
-
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
          bootstrap="./SP/bootstrap.php"
@@ -54,6 +31,6 @@
     </filter>
     <logging>
         <log type="coverage-clover" target="./_output/coverage-clover.xml"/>
-        <log type="coverage-text" target="php://stdout" showUncoveredFiles="false" showOnlySummary="true" />
+        <log type="coverage-text" target="php://stdout" showUncoveredFiles="true" showOnlySummary="true" />
     </logging>
 </phpunit>
\ No newline at end of file
diff --git a/tests/res/config/config.xml b/tests/res/config/config.xml
index 416b7f20..f48f7344 100644
--- a/tests/res/config/config.xml
+++ b/tests/res/config/config.xml
@@ -9,11 +9,11 @@
   <authBasicAutoLoginEnabled>1</authBasicAutoLoginEnabled>
   <authBasicDomain></authBasicDomain>
   <authBasicEnabled>1</authBasicEnabled>
-  <backup_hash>f09da3c1942076460f8dc05004aa2206436712cf</backup_hash>
+  <backup_hash>335463b295db194139a4483b30bed5dc4a8e8fab</backup_hash>
   <checkUpdates>0</checkUpdates>
   <checknotices>0</checknotices>
-  <configDate>1541934251</configDate>
-  <configHash>91de39c679ecf1d6e64cb6c0a1fde6c4ede91127</configHash>
+  <configDate>1541937033</configDate>
+  <configHash>c80d905efab57187b4a1f32374fafbcff3c4d57b</configHash>
   <configSaver></configSaver>
   <configVersion></configVersion>
   <databaseVersion></databaseVersion>
@@ -32,7 +32,7 @@
   <dokuwikiUrlBase></dokuwikiUrlBase>
   <dokuwikiUser></dokuwikiUser>
   <encryptSession>0</encryptSession>
-  <export_hash>c3595e381a6ccc90731a642ec5e94a812a0f0875</export_hash>
+  <export_hash>d101e3b4cfc15c62090eb1c5f737a454e9a7c35e</export_hash>
   <filesAllowedExts>
     <item type="filesAllowedExts">PDF</item>
     <item type="filesAllowedExts">JPG</item>