Move core:StatisticsWithAttribute to statistics-module

modules/core/docs/authproc_statisticswithattribute.md

-`core:StatisticsWithAttribute`
-==============================
-
-This filter logs a statistics entry that can be parsed by the statistics module.
-
-Parameters
-----------
-
-`attributename`
-:   The name of an attribute that should be included in the statistics entry.
-
-`type`
-:   The type of the statistics entry.
-
-`skipPassive`
-:   A boolean indicating whether passive requests should be skipped. Defaults to `false`, in which case the type tag is prefixed with 'passive-'.
-
-Example
--------
-
-Log the realm of the user:
-
-    45 => [
-        'class' => 'core:StatisticsWithAttribute',
-        'attributename' => 'realm',
-        'type' => 'saml20-idp-SSO',
-    ],

modules/core/src/Auth/Process/StatisticsWithAttribute.php

-<?php
-
-declare(strict_types=1);
-
-namespace SimpleSAML\Module\core\Auth\Process;
-
-use SimpleSAML\{Auth, Logger};
-use SimpleSAML\Assert\Assert;
-
-use function array_key_exists;
-use function boolval;
-use function is_null;
-
-/**
- * Log a line in the STAT log with one attribute.
- *
- * @package SimpleSAMLphp
- */
-class StatisticsWithAttribute extends Auth\ProcessingFilter
-{
-    /**
-     * The attribute to log
-     * @var string|null
-     */
-    private ?string $attribute = null;
-
-    /**
-     * @var string
-     */
-    private string $typeTag = 'saml20-idp-SSO';
-
-    /**
-     * @var bool
-     */
-    private bool $skipPassive = false;
-
-
-    /**
-     * Initialize this filter.
-     *
-     * @param array &$config  Configuration information about this filter.
-     * @param mixed $reserved  For future use.
-     */
-    public function __construct(array &$config, $reserved)
-    {
-        parent::__construct($config, $reserved);
-
-        if (array_key_exists('attributename', $config)) {
-            Assert::stringNotEmpty(
-                $config['attributename'],
-                'Invalid attribute name given to core:StatisticsWithAttribute filter.',
-            );
-            $this->attribute = $config['attributename'];
-        }
-
-        if (array_key_exists('type', $config)) {
-            Assert::stringNotEmpty($config['type'], 'Invalid typeTag given to core:StatisticsWithAttribute filter.');
-            $this->typeTag = $config['type'];
-        }
-
-        if (array_key_exists('skipPassive', $config)) {
-            $this->skipPassive = boolval($config['skipPassive']);
-        }
-    }
-
-
-    /**
-     * Log line.
-     *
-     * @param array &$state  The current state.
-     */
-    public function process(array &$state): void
-    {
-        Assert::keyExists($state, 'Attributes');
-
-        $logAttribute = 'NA';
-        $isPassive = '';
-
-        if (array_key_exists('isPassive', $state) && $state['isPassive'] === true) {
-            if ($this->skipPassive === true) {
-                // We have a passive request. Skip logging statistics
-                return;
-            }
-            $isPassive = 'passive-';
-        }
-
-        if (!is_null($this->attribute) && array_key_exists($this->attribute, $state['Attributes'])) {
-            $logAttribute = $state['Attributes'][$this->attribute][0];
-        }
-
-        $source = $this->setIdentifier('Source', $state);
-        $dest = $this->setIdentifier('Destination', $state);
-
-        if (!array_key_exists('PreviousSSOTimestamp', $state)) {
-            // The user hasn't authenticated with this SP earlier in this session
-            Logger::stats($isPassive . $this->typeTag . '-first ' . $dest . ' ' . $source . ' ' . $logAttribute);
-        }
-
-        Logger::stats($isPassive . $this->typeTag . ' ' . $dest . ' ' . $source . ' ' . $logAttribute);
-    }
-
-
-    /**
-     * @param string &$direction  Either 'Source' or 'Destination'.
-     * @param array $state  The current state.
-     *
-     * @return string
-     */
-    private function setIdentifier(string $direction, array $state): string
-    {
-        if (array_key_exists($direction, $state)) {
-            if (isset($state[$direction]['core:statistics-id'])) {
-                return $state[$direction]['core:statistics-id'];
-            } else {
-                return $state[$direction]['entityid'];
-            }
-        }
-        return 'NA';
-    }
-}