simplesamlphp / simplesamlphp-module-statistics

src/LogCleaner.php

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\statistics;

use Exception;
use SimpleSAML\Configuration;

/**
 * @package SimpleSAMLphp
 */
class LogCleaner
{
    /** @var \SimpleSAML\Configuration */
    private Configuration $statconfig;

    /** @var string */
    private string $statdir;

    /** @var string */
    private string $inputfile;

    /** @var array */
    private array $statrules;

    /** @var int */
    private int $offset;


    /**
     * Constructor
     *
     * @param string|null $inputfile
     */
    public function __construct(?string $inputfile = null)
    {
        $this->statconfig = Configuration::getConfig('module_statistics.php');

        $this->statdir = $this->statconfig->getString('statdir');
        $this->inputfile = $this->statconfig->getString('inputfile');
        $this->statrules = $this->statconfig->getValue('statrules');
        $this->offset = $this->statconfig->getOptionalInteger('offset', 0);

        if (isset($inputfile)) {
            $this->inputfile = $inputfile;
        }
    }


    /**
     */
    public function dumpConfig(): void
    {
        echo 'Statistics directory   : ' . $this->statdir . "\n";
        echo 'Input file             : ' . $this->inputfile . "\n";
        echo 'Offset                 : ' . $this->offset . "\n";
    }


    /**
     * @param bool $debug
     * @return array
     * @throws \Exception
     */
    public function clean(bool $debug = false): array
    {
        if (!is_dir($this->statdir)) {
            throw new Exception('Statistics module: output dir does not exist [' . $this->statdir . ']');
        }

        if (!file_exists($this->inputfile)) {
            throw new Exception('Statistics module: input file does not exist [' . $this->inputfile . ']');
        }

        $file = fopen($this->inputfile, 'r');

        $logparser = new LogParser(
            $this->statconfig->getOptionalValue('datestart', 0),
            $this->statconfig->getOptionalValue('datelength', 15),
            $this->statconfig->getOptionalValue('offsetspan', 44),
        );

        $sessioncounter = [];

        $i = 0;
        // Parse through log file, line by line
        while (!feof($file)) {
            $logline = fgets($file, 4096);

            // Continue if STAT is not found on line
            if (!preg_match('/STAT/', $logline)) {
                continue;
            }
            $i++;

            // Parse log, and extract epoch time and rest of content.
            $epoch = $logparser->parseEpoch($logline);
            $content = $logparser->parseContent($logline);

            if (($i % 10000) == 0) {
                echo "Read line " . $i . "\n";
            }

            $trackid = $content[4];

            if (!isset($sessioncounter[$trackid])) {
                $sessioncounter[$trackid] = 0;
            }
            $sessioncounter[$trackid]++;

            if ($debug) {
                echo "----------------------------------------\n";
                echo 'Log line: ' . $logline . "\n";
                echo 'Date parse [' . substr($logline, 0, $this->statconfig->getOptionalValue('datelength', 15)) .
                    '] to [' . date(DATE_RFC822, $epoch) . ']' . "\n";
                $ret = print_r($content, true);
                echo htmlentities($ret);

It seems like $ret can also be of type true; however, parameter $string of htmlentities() does only seem to accept string, maybe add an additional type check?

                if ($i >= 13) {
                    exit;

Using exit here is not recommended.

In this branch, the function will implicitly return null which is incompatible with the type-hinted return array. Consider adding a return statement or allowing null as return value.

                }
            }
        }

        $histogram = [];
        foreach ($sessioncounter as $trackid => $sc) {
            if (!isset($histogram[$sc])) {
                $histogram[$sc] = 0;
            }
            $histogram[$sc]++;
        }
        ksort($histogram);

        $todelete = [];
        foreach ($sessioncounter as $trackid => $sc) {
            if ($sc > 200) {
                $todelete[] = $trackid;
            }
        }

        return $todelete;
    }


    /**
     * @param array $todelete
     * @param string $outputfile
     * @throws \Exception
     */
    public function store(array $todelete, string $outputfile): void
    {
        echo "Preparing to delete [" . count($todelete) . "] trackids\n";

        if (!is_dir($this->statdir)) {
            throw new Exception('Statistics module: output dir do not exists [' . $this->statdir . ']');
        }

        if (!file_exists($this->inputfile)) {
            throw new Exception('Statistics module: input file do not exists [' . $this->inputfile . ']');
        }

        $file = fopen($this->inputfile, 'r');

        // Open the output file in a way that guarantees that we will not overwrite a random file.
        if (file_exists($outputfile)) {
            // Delete existing output file.
            unlink($outputfile);
        }
        $outfile = fopen($outputfile, 'x'); // Create the output file

        $logparser = new LogParser(
            $this->statconfig->getOptionalValue('datestart', 0),
            $this->statconfig->getOptionalValue('datelength', 15),
            $this->statconfig->getOptionalValue('offsetspan', 44),
        );

        $i = 0;
        // Parse through log file, line by line
        while (!feof($file)) {
            $logline = fgets($file, 4096);

            // Continue if STAT is not found on line.
            if (!preg_match('/STAT/', $logline)) {
                continue;
            }
            $i++;

            $content = $logparser->parseContent($logline);

            if (($i % 10000) == 0) {
                echo "Read line " . $i . "\n";
            }

            $trackid = $content[4];
            if (in_array($trackid, $todelete, true)) {
                continue;
            }

            fputs($outfile, $logline);
        }
        fclose($file);
        fclose($outfile);
    }
}