SimpleSAML\Module\logpeek\Controller\Logpeek

Complexity

Total Complexity

14

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	setAuthUtils()	0	3	1
B	main()	0	32	6
A	logFilter()	0	19	5
A	setModuleConfig()	0	3	1

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\logpeek\Controller;

use Exception;
use SimpleSAML\Assert\Assert;
use SimpleSAML\Configuration;
use SimpleSAML\Module\logpeek\Config;
use SimpleSAML\Module\logpeek\File;
use SimpleSAML\Module\logpeek\Syslog;
use SimpleSAML\Session;
use SimpleSAML\Utils;
use SimpleSAML\XHTML\Template;
use Symfony\Component\HttpFoundation\Request;

use function array_reverse;
use function intval;
use function count;
use function date;
use function preg_match;
use function strstr;

/**
 * Controller class for the logpeek module.
 *
 * This class serves the different views available in the module.
 *
 * @package simplesamlphp/simplesamlphp-module-logpeek
 */
class Logpeek
{
    /** @var \SimpleSAML\Configuration */
    protected Configuration $config;

    /** @var \SimpleSAML\Module\logpeek\Config\Logpeek */
    protected Config\Logpeek $moduleConfig;

    /** @var \SimpleSAML\Session */
    protected Session $session;

    /** @var \SimpleSAML\Utils\Auth */
    protected $authUtils;


    /**
     * Controller constructor.
     *
     * It initializes the global configuration and session for the controllers implemented here.
     *
     * @param \SimpleSAML\Configuration $config The configuration to use by the controllers.
     * @param \SimpleSAML\Session $session The session to use by the controllers.
     * @param \SimpleSAML\Module\logpeek\Config\Logpeek $moduleConfig The configuration for this module
     *
     * @throws \Exception
     */
    public function __construct(
        Configuration $config,
        Session $session,
        Config\Logpeek $moduleConfig

The parameter $moduleConfig is not used and could be removed.

    ) {
        $this->authUtils = new Utils\Auth();
        $this->config = $config;
        $this->moduleConfig = Config\Logpeek::fromYaml();
        $this->session = $session;
    }


    /**
     * Inject the \SimpleSAML\Utils\Auth dependency.
     *
     * @param \SimpleSAML\Utils\Auth $authUtils
     */
    public function setAuthUtils(Utils\Auth $authUtils): void
    {
        $this->authUtils = $authUtils;
    }


    /**
     * Inject the \SimpleSAML\Module\logpeek\Config\Logpeek dependency.
     *
     * @param \SimpleSAML\Module\logpeek\Config\Logpeek $moduleConfig
     */
    public function setModuleConfig(Config\Logpeek $moduleConfig): void
    {
        $this->moduleConfig = $moduleConfig;
    }


    /**
     * Main index controller.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request The current request.
     *
     * @return \SimpleSAML\XHTML\Template
     */
    public function main(Request $request): Template
    {
        $this->authUtils->requireAdmin();

        $logFile = $this->moduleConfig->getLogFile();
        $blockSize = $this->moduleConfig->getBlockSize();
        $myLog = new File\ReverseRead($logFile, $blockSize);

        $results = [];
        if ($request->query->has('tag') === true) {
            /** @psalm-var string $tag */
            $tag = $request->query->get('tag');
            Assert::notNull($tag);

            $results = $this->logFilter($myLog, $tag, $this->moduleConfig->getLines());
        }

        $fileModYear = intval(date("Y", $myLog->getFileMtime()));
        $firstLine = $myLog->getFirstLine();
        $firstTimeEpoch = Syslog\ParseLine::getUnixTime($firstLine ?: '', $fileModYear);
        $lastLine = $myLog->getLastLine();
        $lastTimeEpoch = Syslog\ParseLine::getUnixTime($lastLine ?: '', $fileModYear);
        $fileSize = $myLog->getFileSize();

        $t = new Template($this->config, 'logpeek:logpeek.twig');
        $t->data['results'] = $results;
        $t->data['trackid'] = $this->session->getTrackID();
        $t->data['timestart'] = date(DATE_RFC822, $firstTimeEpoch ?: time());
        $t->data['endtime'] = date(DATE_RFC822, $lastTimeEpoch ?: time());
        $t->data['filesize'] = $fileSize;

        return $t;
    }


    /**
     * @param \SimpleSAML\Module\logpeek\File\ReverseRead $objFile
     * @param string $tag
     * @param int $cut
     * @return array
     */
    private function logFilter(File\ReverseRead $objFile, string $tag, int $cut): array
    {
        if (!preg_match('/^(TR[a-f0-9{8}]|CL[a-f0-9]{8}|[a-f0-9]{10})$/D', $tag)) {
            throw new Exception('Invalid search tag');
        }

        $i = 0;
        $results = [];
        $line = $objFile->getPreviousLine();
        while ($line !== false && ($i++ < $cut)) {
            if (strstr($line, '[' . $tag . ']')) {
                $results[] = $line;
            }
            $line = $objFile->getPreviousLine();
        }

        $results[] = 'Searched ' . $i . ' lines backward. ' . count($results) . ' lines found.';
        $results = array_reverse($results);
        return $results;
    }
}