Added MULTI_IDP mode

Author: BaranekD

CHANGELOG.md

@@ -2,6 +2,8 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
+#### Added
+- Added MULTI_IDP mode
 
 ## [v4.1.0]
 #### Removed

README.md

@@ -17,7 +17,8 @@ Once you have installed SimpleSAMLphp, installing this module is very simple. Fi
 2. For this database run script to create tables. Script is available in config-templates/tables.sql.
 3. Copy config-templates/module_proxystatistics.php to your config folder and fill it.
 4. Configure, according to mode
-* for PROXY mode, configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:
+
+* PROXY - collects data about number of logins from each identity provider and accessed services; for PROXY mode, configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:
 ```
     50 => [
         'class' => 'perun:IdPAttribute',
@@ -27,20 +28,27 @@ Once you have installed SimpleSAMLphp, installing this module is very simple. Fi
     ],
     // where 50 is priority (for example, must not be used for other modules)
 ```
-* for IDP mode, configure entity ID and name in `module_proxystatistics.php`
+* IDP - collects data about accessed services through given identity provider; for IDP mode, configure entity ID and name in `module_proxystatistics.php`
 ```
     'IDP' => [
         'id' => '',
         'name' => '',
     ],
 ```
-* for SP mode, configure entity ID and name in `module_proxystatistics.php`
+* SP - collects data about identity providers used for access to given service; for SP mode, configure entity ID and name in `module_proxystatistics.php`
 ```
     'SP' => [
         'id' => '',
         'name' => '',
     ],
 ```
+* MULTI_IDP - similar to IDP mode, stores more identity providers in one database; for MULTI_IDP mode, configure entity ID and name in each `module_proxystatistics.php` we want to get statistics from
+```
+    'IDP' => [
+        'id' => '',
+        'name' => '',
+    ],
+```
 5. Configure proxystatistics filter
 ```
     50 => [

config-templates/module_proxystatistics.php

@@ -11,13 +11,17 @@
 $config = [
 
     /*
-     * Choose one of the following modes: PROXY, IDP, SP
+     * Choose one of the following modes: PROXY, IDP, SP, MULTI_IDP
+     * PROXY - collects data about number of logins from each identity provider and accessed services
+     * IDP - collects data about accessed services through given identity provider
+     * SP - collects data about identity providers used for access to given service
+     * MULTI_IDP - similar to IDP mode, stores more identity providers in one database
      */
     'mode' => 'PROXY',
 
     /*
      * EntityId and name of IdP
-     * REQUIRED FOR IDP MODE
+     * REQUIRED FOR IDP AND MULTI_IDP MODE
      */
     //'IDP' => [
     //    'id' => '',

dictionaries/stats.definition.json

@@ -143,6 +143,10 @@
     "en": "identity provider",
     "cs": "poskytovatele identity"
   },
+  "through_mode_MULTI_IDP": {
+    "en": "identity provider",
+    "cs": "poskytovatele identity"
+  },
   "summary_logins_info": {
     "en": "The chart shows overall number of logins from identity providers for each day.",
     "cs": "Graf zobrazuje počet přihlášení za každý den."

lib/Config.php

@@ -16,6 +16,8 @@ class Config
 
     public const MODE_SP = 'SP';
 
+    public const MODE_MULTI_IDP = 'MULTI_IDP';
+
     public const SIDES = [self::MODE_IDP, self::MODE_SP];
 
     public const MODE_PROXY = 'PROXY';
@@ -43,7 +45,7 @@ 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'], 'PROXY');
+        $this->mode = $this->config->getValueValidate(self::MODE, ['PROXY', 'IDP', 'SP', 'MULTI_IDP'], 'PROXY');
     }
 
     private function __clone()

lib/DatabaseCommand.php

@@ -218,7 +218,7 @@ private function getEntities($request)
             Config::MODE_IDP => [],
             Config::MODE_SP => [],
         ];
-        if ($this->mode !== Config::MODE_IDP) {
+        if ($this->mode !== Config::MODE_IDP && $this->mode !== Config::MODE_MULTI_IDP) {
             $entities[Config::MODE_IDP]['id'] = $request['saml:sp:IdP'];
             $entities[Config::MODE_IDP]['name'] = $request['Attributes']['sourceIdPName'][0];
         }
@@ -227,13 +227,20 @@ private function getEntities($request)
             $entities[Config::MODE_SP]['name'] = $request['Destination']['name']['en'] ?? '';
         }
 
-        if ($this->mode !== Config::MODE_PROXY) {
+        if ($this->mode !== Config::MODE_PROXY && $this->mode !== Config::MODE_MULTI_IDP) {
             $entities[$this->mode] = $this->config->getSideInfo($this->mode);
             if (empty($entities[$this->mode]['id']) || empty($entities[$this->mode]['name'])) {
                 Logger::error('Invalid configuration (id, name) for ' . $this->mode);
             }
         }
 
+        if ($this->mode === Config::MODE_MULTI_IDP) {
+            $entities[Config::MODE_IDP] = $this->config->getSideInfo(Config::MODE_IDP);
+            if (empty($entities[$this->mode]['id']) || empty($entities[$this->mode]['name'])) {
+                Logger::error('Invalid configuration (id, name) for ' . $this->mode);
+            }
+        }
+
         return $entities;
     }
 

lib/Templates.php

@@ -195,7 +195,7 @@ public static function showSummary()
         $mode = Config::getInstance()->getMode();
         $t->data['mode'] = $mode;
         $t->data['summaryGraphs'] = [];
-        if ($mode === Config::MODE_PROXY) {
+        if ($mode === Config::MODE_PROXY || $mode === Config::MODE_MULTI_IDP) {
             foreach (Config::SIDES as $side) {
                 $t->data['summaryGraphs'][$side] = [];
                 $t->data['summaryGraphs'][$side]['Providers'] = 'col-md-6 graph';