fix: 🐛 Fix possible exceptions and refactor code

Refactored code to include more logging. Also fixed some possible
exception places.

Author: Dominik Frantisek Bucik

lib/Auth/Process/Statistics.php

@@ -5,11 +5,17 @@
 namespace SimpleSAML\Module\proxystatistics\Auth\Process;
 
 use DateTime;
+use Exception;
 use SimpleSAML\Auth\ProcessingFilter;
+use SimpleSAML\Logger;
 use SimpleSAML\Module\proxystatistics\DatabaseCommand;
 
 class Statistics extends ProcessingFilter
 {
+    private const STAGE = 'proxystatistics:Statistics';
+
+    private const DEBUG_PREFIX = self::STAGE . ' - ';
+
     public function __construct($config, $reserved)
     {
         parent::__construct($config, $reserved);
@@ -19,6 +25,12 @@ public function process(&$request)
     {
         $dateTime = new DateTime();
         $dbCmd = new DatabaseCommand();
-        $dbCmd->insertLogin($request, $dateTime);
+        try {
+            $dbCmd->insertLogin($request, $dateTime);
+        } catch (Exception $ex) {
+            Logger::error(
+                self::DEBUG_PREFIX . 'Caught exception while inserting login into statistics: ' . $ex->getMessage()
+            );
+        }
     }
 }

lib/Config.php

@@ -20,6 +20,8 @@ class Config
 
     public const MODE_PROXY = 'PROXY';
 
+    private const KNOWN_MODES = ['PROXY', 'IDP', 'SP', 'MULTI_IDP'];
+
     private const STORE = 'store';
 
     private const MODE = 'mode';
@@ -40,22 +42,33 @@ class Config
 
     private $sourceIdpEntityIdAttribute;
 
+    private $tables;
+
+    private $keepPerUser;
+
+    private $requiredAuthSource;
+
+    private $idAttribute;
+
     private static $instance;
 
     private function __construct()
     {
         $this->config = Configuration::getConfig(self::CONFIG_FILE_NAME);
         $this->store = $this->config->getConfigItem(self::STORE, null);
-        $this->tables = $this->config->getArray('tables', []);
-        $this->mode = $this->config->getValueValidate(self::MODE, ['PROXY', 'IDP', 'SP', 'MULTI_IDP'], 'PROXY');
+        $this->tables = $this->config->getArray('tables', []);;
         $this->sourceIdpEntityIdAttribute = $this->config->getString(self::SOURCE_IDP_ENTITY_ID_ATTRIBUTE, '');
+        $this->mode = $this->config->getValueValidate(self::MODE, self::KNOWN_MODES, self::MODE_PROXY);
+        $this->keepPerUser = $this->config->getIntegerRange(self::KEEP_PER_USER, 31, 1827, 31);
+        $this->requiredAuthSource = $this->config->getString(self::REQUIRE_AUTH_SOURCE, '');
+        $this->idAttribute = $this->config->getString(self::USER_ID_ATTRIBUTE, 'uid');
     }
 
     private function __clone()
     {
     }
 
-    public static function getInstance()
+    public static function getInstance(): self
     {
         if (null === self::$instance) {
             self::$instance = new self();
@@ -81,17 +94,19 @@ public function getStore()
 
     public function getIdAttribute()
     {
-        return $this->config->getString(self::USER_ID_ATTRIBUTE, 'uid');
+        return $this->idAttribute;
     }
 
     public function getSourceIdpEntityIdAttribute()
     {
         return $this->sourceIdpEntityIdAttribute;
     }
 
-    public function getSideInfo($side)
+    public function getSideInfo(string $side)
     {
-        assert(in_array($side, [self::SIDES], true));
+        if (!in_array($side, self::SIDES, true)) {
+            throw new \Exception('Unrecognized side parameter value passed \'' . $side . '\'.');
+        }
 
         return array_merge([
             'name' => '',
@@ -101,11 +116,11 @@ public function getSideInfo($side)
 
     public function getRequiredAuthSource()
     {
-        return $this->config->getString(self::REQUIRE_AUTH_SOURCE, '');
+        return$this->requiredAuthSource;
     }
 
     public function getKeepPerUser()
     {
-        return $this->config->getIntegerRange(self::KEEP_PER_USER, 31, 1827, 31);
+        return $this->keepPerUser;
     }
 }