Aggregated stats (v4.0.0) (#38)

Author: melanger

.gitignore

@@ -1 +1,4 @@
-.idea
+.idea
+vendor
+modules
+composer.lock

CHANGELOG.md

@@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## [v4.0.0]
+#### Added
+- aggregated statistics (logins and unique users)
+
+#### Changed
+- new database tables
+- config options for table names replaced with one (optional) option `tableNames`
+- option 'config' for auth proc filter made optional
+- auth proc filter renamed to Statistics (PascalCase)
+- major refactoring
+
+#### Removed
+- `detailedDays` config option
+- compatibility for deprecated database config options
+- duplicate code
+
 ## [v3.2.1]
 #### Fixed
 - Fixed the bug in using double '$'

README.md

@@ -15,51 +15,38 @@ Once you have installed SimpleSAMLphp, installing this module is very simple. Fi
 ## Configuration
 1. Install MySQL Database and create database for statistics and user. 
 2. For this database run script to create tables. Script is available in config-templates/tables.sql.
-3. Copy config-templates/module_statisticsproxy.php to your folder vith config and fill it.
+3. Copy config-templates/module_proxystatistics.php to your config folder and fill it.
 4. Configure, according to mode
-* for mode PROXY, configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:  
+* for PROXY mode, configure IdPAttribute filter from Perun module to get sourceIdPName from IdP metadata:
 ```
-    XX => [
-            'class' => 'perun:IdPAttribute',
-            'attrMap' => [
-                    'name:en' => 'sourceIdPName',
-            ],
+    50 => [
+        'class' => 'perun:IdPAttribute',
+        'attrMap' => [
+            'name:en' => 'sourceIdPName',
+        ],
     ],
-    // where XX is priority (for example 30, must not be used for other modules)
+    // where 50 is priority (for example, must not be used for other modules)
 ```
-* for mode IDP, configure `idpEntityId` and `idpName` in `module_statisticsproxy.php`
+* for IDP mode, configure entity ID and name in `module_proxystatistics.php`
 ```
-    /*
-     * EntityId of IdP
-     * REQUIRED FOR IDP MODE
-     */
-    'idpEntityId' => '',
-    /*
-     * Name of IdP
-     * REQUIRED FOR IDP MODE
-     */
-    'idpName' => '',
+    'IDP' => [
+        'id' => '',
+        'name' => '',
+    ],
 ```
-* for mode SP, configure `spEntityId` and `spName` in `module_statisticsproxy.php`
+* for SP mode, configure entity ID and name in `module_proxystatistics.php`
 ```
-    /*
-     * EntityId of SP
-     * REQUIRED FOR SP MODE
-     */
-    'spEntityId' => '',
-    /*
-     * Name of SP
-     * REQUIRED FOR SP MODE
-     */
-    'spName' => '',
+    'SP' => [
+        'id' => '',
+        'name' => '',
+    ],
 ```
-5. Configure proxystatistic filter
+5. Configure proxystatistics filter
 ```
-    XX => array(
-            'class' => 'proxystatistics:statistics',
-            'config' => [],
-    ),                
-    // where XX is priority (for example 50, must not be used for other modules)
+    50 => [
+        'class' => 'proxystatistics:Statistics',
+    ],
+    // where 50 is priority (for example, must not be used for other modules)
 ```
 6. Add to `config.php`:
 ```

composer.json

@@ -1,7 +1,6 @@
 {
   "name": "cesnet/simplesamlphp-module-proxystatistics",
   "description": "A SimpleSAMLPHP module for statistics",
-  "version": "3.3.0-dev",
   "type": "simplesamlphp-module",
   "keywords": ["statistics","simplesamlphp"],
   "license": "BSD-2-Clause",
@@ -12,10 +11,14 @@
     }
   ],
   "require": {
-    "php": ">=5.4.0",
-    "cesnet/simplesamlphp-module-perun" : "~3.0",
+    "php": ">=7.1.0",
+    "cesnet/simplesamlphp-module-perun" : "^3.0",
     "simplesamlphp/simplesamlphp": "~1.17",
     "ext-mysqli": "*",
     "ext-json": "*"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "*",
+    "symplify/easy-coding-standard": "^7.2"
   }
 }

config-templates/module_proxystatistics.php

@@ -0,0 +1,85 @@
+<?php
+
+/**
+ * This is an example configuration of SimpleSAMLphp Perun interface and additional features.
+ * Copy this file to default config directory and edit the properties.
+ *
+ * @author Pavel Vyskočil <[email protected]>
+ * @author Pavel Břoušek <[email protected]>
+ */
+
+$config = [
+
+    /*
+     * Choose one of the following modes: PROXY, IDP, SP
+     */
+    'mode' => 'PROXY',
+
+    /*
+     * EntityId and name of IdP
+     * REQUIRED FOR IDP MODE
+     */
+    //'IDP' => [
+    //    'id' => '',
+    //    'name' => '',
+    //],
+
+    /*
+     * EntityId and name of SP
+     * REQUIRED FOR SP MODE
+     */
+    //'SP' => [
+    //    'id' => '',
+    //    'name' => '',
+    //],
+
+    /*
+     * Config for SimpleSAML\Database.
+     * If not set, the global config is used.
+     * @see SimpleSAML\Database
+     */
+    'store' => [
+        'database.dsn' => 'mysql:host=localhost;port=3306;dbname=STATS;charset=utf8',
+        'database.username' => 'stats',
+        'database.password' => 'stats',
+
+        /**
+         * Configuration for SSL
+         * If you want to use SSL, fill these values and uncomment the block of code
+         */
+        //'database.driver_options' => [
+        //    PDO::MYSQL_ATTR_SSL_KEY => '', // Path for the ssl key file
+        //    PDO::MYSQL_ATTR_SSL_CERT => '', // Path for the ssl cert file
+        //    PDO::MYSQL_ATTR_SSL_CA => '', // Path for the ssl ca file
+        //    PDO::MYSQL_ATTR_SSL_CAPATH => '', // Path for the ssl ca dir
+        //],
+    ],
+
+    /**
+     * Which attribute should be used as user ID.
+     * @default uid
+     */
+    //'userIdAttribute' => 'uid',
+
+    /**
+     * Database table names.
+     * Default is to keep the name (as in `tables.sql`)
+     */
+    'tableNames' => [
+        //'statistics_sums' => 'statistics_sums',
+        //'statistics_per_user' => 'statistics_per_user',
+        //'statistics_idp' => 'statistics_idp',
+        //'statistics_sp' => 'statistics_sp',
+    ],
+
+    /**
+     * Authentication source name if authentication should be required.
+     * Defaults to empty string.
+     */
+    //'requireAuth.source' => 'default-sp',
+
+    /**
+     * For how many days should the detailed statistics be kept. Minimum is 31.
+     */
+    //'keepPerUser' => 62,
+];