Store detailed statistics(with some user identifier) for several days

Author: melanger

CHANGELOG.md

@@ -21,6 +21,7 @@ All notable changes to this project will be documented in this file.
 #### Added
 - Added configuration file for ESLint
 - Module now supports running statistics as IDP/SP
+- Store detailed statistics(include some user identifier) for several days 
 
 #### Changed
 - Using of short array syntax (from array() to [])

config-templates/module_statisticsproxy.php

@@ -65,11 +65,29 @@
         */
     ],
 
+    /*
+     * For how many days should detailed statistics (per user) be kept.
+     * @default 0
+     */
+    'detailedDays' => 0,
+
+    /**
+     * Which attribute should be used as user ID.
+     * @default uid
+     */
+    'userIdAttribute' => 'uid',
+
     /*
      * Fill the table name for statistics
      */
     'statisticsTableName' => 'statisticsTableName',
 
+    /*
+     * Fill the table name for detailed statistics
+     * @default
+     */
+    'detailedStatisticsTableName' => 'statistics_detail',
+
     /*
      * Fill the table name for identityProvidersMap
      */

config-templates/tables.sql

@@ -11,6 +11,19 @@ CREATE TABLE statistics (
     PRIMARY KEY (year, month, day, sourceIdp, service)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
+CREATE TABLE statistics_detail (
+    year INT NOT NULL,
+    month INT NOT NULL,
+    day INT NOT NULL,
+    sourceIdp VARCHAR(255) NOT NULL,
+    service VARCHAR(255) NOT NULL,
+    user VARCHAR(255) NOT NULL,
+    count INT,
+    INDEX (sourceIdp),
+    INDEX (service),
+    PRIMARY KEY (year, month, day, sourceIdp, service, user)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
 --Tables for mapping identifier to name
 CREATE TABLE identityProvidersMap(
 	entityId VARCHAR(255) NOT NULL,

hooks/hook_cron.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Hook to run a cron job.
+ *
+ * @param array &$croninfo  Output
+ * @return void
+ */
+function proxystatistics_hook_cron(&$croninfo)
+{
+    if ($croninfo['tag'] !== 'daily') {
+        \SimpleSAML\Logger::debug('cron [proxystatistics]: Skipping cron in cron tag ['.$croninfo['tag'].'] ');
+        return;
+    }
+
+    \SimpleSAML\Logger::info('cron [proxystatistics]: Running cron in cron tag ['.$croninfo['tag'].'] ');
+
+    try {
+        $dbCmd = new \SimpleSAML\Module\proxystatistics\Auth\Process\DatabaseCommand();
+        $dbCmd->deleteOldDetailedStatistics();
+    } catch (\Exception $e) {
+        $croninfo['summary'][] = 'Error during deleting old detailed statistics: '.$e->getMessage();
+    }
+}

lib/Auth/Process/DatabaseCommand.php

@@ -14,19 +14,49 @@ class DatabaseCommand
     private $databaseConnector;
     private $conn;
     private $statisticsTableName;
+    private $detailedStatisticsTableName;
     private $identityProvidersMapTableName;
     private $serviceProvidersMapTableName;
 
     public function __construct()
     {
         $this->databaseConnector = new DatabaseConnector();
         $this->conn = $this->databaseConnector->getConnection();
-        assert($this->conn != null);
+        assert($this->conn !== null);
         $this->statisticsTableName = $this->databaseConnector->getStatisticsTableName();
+        $this->detailedStatisticsTableName = $this->databaseConnector->getDetailedStatisticsTableName();
         $this->identityProvidersMapTableName = $this->databaseConnector->getIdentityProvidersMapTableName();
         $this->serviceProvidersMapTableName = $this->databaseConnector->getServiceProvidersMapTableName();
     }
 
+    private function writeLogin($year, $month, $day, $sourceIdp, $service, $user = null)
+    {
+        $params = [
+            'year' => $year,
+            'month' => $month,
+            'day' => $day,
+            'sourceIdp' => $sourceIdp,
+            'service' => $service,
+            'count' => 1,
+        ];
+        $table = $this->statisticsTableName;
+        if ($user && $this->databaseConnector->getDetailedDays() > 0) {
+            // write also into aggregated statistics
+            self::writeLogin($year, $month, $day, $sourceIdp, $service);
+            $params['user'] = $user;
+            $table = $this->detailedStatisticsTableName;
+        }
+        $fields = array_keys($params);
+        $placeholders = array_map(function ($field) {
+            return ':' . $field;
+
+        }, $fields);
+        $query = "INSERT INTO " . $table . " (" . implode(', ', $fields) . ")" .
+                 " VALUES (" . implode(', ', $placeholders) . ") ON DUPLICATE KEY UPDATE count = count + 1";
+
+        return $this->conn->write($query, $params);
+    }
+
     public function insertLogin(&$request, &$date)
     {
         if (!in_array($this->databaseConnector->getMode(), ['PROXY', 'IDP', 'SP'])) {
@@ -59,11 +89,9 @@ public function insertLogin(&$request, &$date)
                 " is empty and login log wasn't inserted into the database."
             );
         } else {
-            if ($this->conn->write(
-                "INSERT INTO " . $this->statisticsTableName . "(year, month, day, sourceIdp, service, count)" .
-                " VALUES (:year, :month, :day, :idp, :sp, '1') ON DUPLICATE KEY UPDATE count = count + 1",
-                ['year'=>$year, 'month'=>$month, 'day'=>$day, 'idp'=>$idpEntityID, 'sp'=>$spEntityId]
-            ) === false) {
+            $idAttribute = $this->databaseConnector->getUserIdAttribute();
+            $userId = isset($request['Attributes'][$idAttribute]) ? $request['Attributes'][$idAttribute][0] : null;
+            if ($this->writeLogin($year, $month, $day, $idpEntityID, $spEntityId, $userId) === false) {
                 Logger::error("The login log wasn't inserted into table: " . $this->statisticsTableName . ".");
             }
 
@@ -197,17 +225,30 @@ public function getLoginCountPerIdp($days)
         return $this->conn->read($query, $params)->fetchAll(PDO::FETCH_NUM);
     }
 
-    private static function addDaysRange($days, &$query, &$params)
+    private static function addDaysRange($days, &$query, &$params, $not = false)
     {
         if ($days != 0) {    // 0 = all time
             if (stripos($query, "WHERE") === false) {
                 $query .= "WHERE";
             } else {
                 $query .= "AND";
             }
-            $query .= " CONCAT(year,'-',LPAD(month,2,'00'),'-',LPAD(day,2,'00')) " .
-                  "BETWEEN CURDATE() - INTERVAL :days DAY AND CURDATE() ";
+            $query .= " CONCAT(year,'-',LPAD(month,2,'00'),'-',LPAD(day,2,'00')) ";
+            if ($not) {
+                $query .= "NOT ";
+            }
+            $query .= "BETWEEN CURDATE() - INTERVAL :days DAY AND CURDATE() ";
             $params['days'] = $days;
         }
     }
+
+    public function deleteOldDetailedStatistics()
+    {
+        if ($this->databaseConnector->getDetailedDays() > 0) {
+            $query = "DELETE FROM " . $this->detailedStatisticsTableName . " ";
+            $params = [];
+            self::addDaysRange($this->databaseConnector->getDetailedDays(), $query, $params, true);
+            return $this->conn->write($query, $params);
+        }
+    }
 }

lib/Auth/Process/DatabaseConnector.php

@@ -14,13 +14,16 @@
 class DatabaseConnector
 {
     private $statisticsTableName;
+    private $detailedStatisticsTableName;
     private $identityProvidersMapTableName;
     private $serviceProvidersMapTableName;
     private $mode;
     private $idpEntityId;
     private $idpName;
     private $spEntityId;
     private $spName;
+    private $detailedDays;
+    private $userIdAttribute;
     private $conn = null;
 
     const CONFIG_FILE_NAME = 'module_statisticsproxy.php';
@@ -35,6 +38,7 @@ class DatabaseConnector
     /** @deprecated */
     const DATABASE = 'databaseName';
     const STATS_TABLE_NAME = 'statisticsTableName';
+    const DETAILED_STATS_TABLE_NAME = 'detailedStatisticsTableName';
     const IDP_MAP_TABLE_NAME = 'identityProvidersMapTableName';
     const SP_MAP_TABLE_NAME = 'serviceProvidersMapTableName';
     /** @deprecated */
@@ -53,6 +57,8 @@ class DatabaseConnector
     const IDP_NAME = 'idpName';
     const SP_ENTITY_ID = 'spEntityId';
     const SP_NAME = 'spName';
+    const DETAILED_DAYS = 'detailedDays';
+    const USER_ID_ATTRIBUTE = 'userIdAttribute';
 
     public function __construct()
     {
@@ -87,13 +93,16 @@ public function __construct()
         $this->storeConfig = Configuration::loadFromArray($this->storeConfig);
 
         $this->statisticsTableName = $conf->getString(self::STATS_TABLE_NAME);
+        $this->detailedStatisticsTableName = $conf->getString(self::DETAILED_STATS_TABLE_NAME, 'statistics_detail');
         $this->identityProvidersMapTableName = $conf->getString(self::IDP_MAP_TABLE_NAME);
         $this->serviceProvidersMapTableName = $conf->getString(self::SP_MAP_TABLE_NAME);
         $this->mode = $conf->getString(self::MODE, 'PROXY');
         $this->idpEntityId = $conf->getString(self::IDP_ENTITY_ID, '');
         $this->idpName = $conf->getString(self::IDP_NAME, '');
         $this->spEntityId = $conf->getString(self::SP_ENTITY_ID, '');
         $this->spName = $conf->getString(self::SP_NAME, '');
+        $this->detailedDays = $conf->getInteger(self::DETAILED_DAYS, 0);
+        $this->userIdAttribute = $conf->getString(self::USER_ID_ATTRIBUTE, 'uid');
     }
 
     public function getConnection()
@@ -106,6 +115,11 @@ public function getStatisticsTableName()
         return $this->statisticsTableName;
     }
 
+    public function getDetailedStatisticsTableName()
+    {
+        return $this->detailedStatisticsTableName;
+    }
+
     public function getIdentityProvidersMapTableName()
     {
         return $this->identityProvidersMapTableName;
@@ -140,4 +154,14 @@ public function getSpName()
     {
         return $this->spName;
     }
+
+    public function getDetailedDays()
+    {
+        return $this->detailedDays;
+    }
+
+    public function getUserIdAttribute()
+    {
+        return $this->userIdAttribute;
+    }
 }