SimpleSAML\Module\memcacheMonitor\MemcacheMonitor

Complexity

Total Complexity

35

Size/Duplication

Total Lines	219
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
C	renderStats()	0	94	10
D	humanreadable()	0	46	19
A	tdate()	0	3	1
A	hours()	0	15	4

<?php

declare(strict_types=1);

namespace SimpleSAML\Module\memcacheMonitor;

use SimpleSAML\Configuration;
use SimpleSAML\Locale\Translate;
use SimpleSAML\Memcache;
use SimpleSAML\XHTML\Template;

/**
 * Handles interactions with SSP's memcacheMonitor system.
 */
class MemcacheMonitor
{
    /**
     * The configuration that holds the memcache configuration
     * @var \SimpleSAML\Configuration
     */
    private Configuration $config;

    /**
     * An associative array with keys matching the stats, and values pointing to the formatting function for that key
     * @var array<mixed>
     */
    private array $formats = [
        'bytes' => [self::class, 'humanreadable'],
        'bytes_read' => [self::class, 'humanreadable'],
        'bytes_written' => [self::class, 'humanreadable'],
        'limit_maxbytes' => [self::class, 'humanreadable'],
        'time' => [self::class, 'tdate'],
        'uptime' => [self::class, 'hours'],
    ];


    /**
     * @param \SimpleSAML\Configuration $config The configuration to use.
     */
    public function __construct(Configuration $config)
    {
        $this->config = $config;
    }


    /**
     * Retrieve stats, render them into a human readable page
     */
    public function renderStats(): Template
    {
        $statsraw = Memcache::getStats();
        $stats = $statsraw;

        foreach ($stats as $key => &$entry) {
            if (array_key_exists($key, $this->formats)) {
                $func = $this->formats[$key];
                foreach ($entry as $k => $val) {
                    $entry[$k] = call_user_func($func, $val);
                }
            }
        }

        $t = new Template($this->config, 'memcacheMonitor:memcachestat.twig');
        $rowTitles = [
            'accepting_conns' => Translate::noop('{memcacheMonitor:memcachestat:accepting_conns}'),
            'auth_cmds' => Translate::noop('{memcacheMonitor:memcachestat:auth_cmds}'),
            'auth_errors' => Translate::noop('{memcacheMonitor:memcachestat:auth_errors}'),
            'bytes' => Translate::noop('{memcacheMonitor:memcachestat:bytes}'),
            'bytes_read' => Translate::noop('{memcacheMonitor:memcachestat:bytes_read}'),
            'bytes_written' => Translate::noop('{memcacheMonitor:memcachestat:bytes_written}'),
            'cas_badval' => Translate::noop('{memcacheMonitor:memcachestat:cas_badval}'),
            'cas_hits' => Translate::noop('{memcacheMonitor:memcachestat:cas_hits}'),
            'cas_misses' => Translate::noop('{memcacheMonitor:memcachestat:cas_misses}'),
            'cmd_flush' => Translate::noop('{memcacheMonitor:memcachestat:cmd_flush}'),
            'cmd_get' => Translate::noop('{memcacheMonitor:memcachestat:cmd_get}'),
            'cmd_set' => Translate::noop('{memcacheMonitor:memcachestat:cmd_set}'),
            'cmd_touch' => Translate::noop('Cumulative number of touch reqs'),
            'connection_structures' => Translate::noop('{memcacheMonitor:memcachestat:connection_structures}'),
            'conn_yields' => Translate::noop('{memcacheMonitor:memcachestat:conn_yields}'),
            'curr_connections' => Translate::noop('{memcacheMonitor:memcachestat:curr_connections}'),
            'curr_items' => Translate::noop('{memcacheMonitor:memcachestat:curr_items}'),
            'decr_hits' => Translate::noop('{memcacheMonitor:memcachestat:decr_hits}'),
            'decr_misses' => Translate::noop('{memcacheMonitor:memcachestat:decr_misses}'),
            'delete_hits' => Translate::noop('{memcacheMonitor:memcachestat:delete_hits}'),
            'delete_misses' => Translate::noop('Total DELETE commands (failed)'),
            'expired_unfetched' => Translate::noop('{memcacheMonitor:memcachestat:expired_unfetched}'),
            'evicted_unfetched' => Translate::noop('{memcacheMonitor:memcachestat:evicted_unfetched}'),
            'evictions' => Translate::noop('{memcacheMonitor:memcachestat:evictions}'),
            'get_hits' => Translate::noop('{memcacheMonitor:memcachestat:get_hits}'),
            'get_misses' => Translate::noop('{memcacheMonitor:memcachestat:get_misses}'),
            'hash_bytes' => Translate::noop('Bytes currently used by hash tables'),
            'hash_is_expanding' => Translate::noop('Indicates if the hash table is being grown to a new size'),
            'hash_power_level' => Translate::noop('Current size multiplier for hash table'),
            'incr_hits' => Translate::noop('{memcacheMonitor:memcachestat:incr_hits}'),
            'incr_misses' => Translate::noop('{memcacheMonitor:memcachestat:incr_misses}'),
            'libevent' => Translate::noop('Libevent version'),
            'limit_maxbytes' => Translate::noop('{memcacheMonitor:memcachestat:limit_maxbytes}'),
            'listen_disabled_num' => Translate::noop('{memcacheMonitor:memcachestat:listen_disabled_num}'),
            'pid' => Translate::noop('{memcacheMonitor:memcachestat:pid}'),
            'pointer_size' => Translate::noop('{memcacheMonitor:memcachestat:pointer_size}'),
            'reclaimed' => Translate::noop('{memcacheMonitor:memcachestat:reclaimed}'),
            'reserved_fds' => Translate::noop('Number of file descriptors used internally'),
            'rusage_system' => Translate::noop('{memcacheMonitor:memcachestat:rusage_system}'),
            'rusage_user' => Translate::noop('{memcacheMonitor:memcachestat:rusage_user}'),
            'threads' => Translate::noop('{memcacheMonitor:memcachestat:threads}'),
            'time' => Translate::noop('Current time'),
            'total_connections' => Translate::noop('{memcacheMonitor:memcachestat:total_connections}'),
            'total_items' => Translate::noop('{memcacheMonitor:memcachestat:total_items}'),
            'touch_hits' => Translate::noop('Number of keys that have been touched with a new expiration time'),
            'touch_misses' => Translate::noop('Number of items that have been touched and not found'),
            'uptime' => Translate::noop('{memcacheMonitor:memcachestat:uptime}'),
            'version' => Translate::noop('{memcacheMonitor:memcachestat:version}'),
        ];

        // Identify column headings
        $colTitles = [];
        foreach ($stats as $rowTitle => $rowData) {
            foreach ($rowData as $colTitle => $foo) {
                if (!in_array($colTitle, $colTitles, true)) {
                    $colTitles[] = $colTitle;
                }
            }
        }

        if (array_key_exists('bytes', $statsraw) && array_key_exists('limit_maxbytes', $statsraw)) {
            $usage = [];
            $maxpix = 400;
            foreach ($statsraw['bytes'] as $key => $row_data) {
                $pix = floor($statsraw['bytes'][$key] * $maxpix / $statsraw['limit_maxbytes'][$key]);
                $usage[$key] = $pix . 'px';
            }
            $t->data['maxpix'] = $maxpix . 'px';
            $t->data['usage'] = $usage;
        }

        $t->data['title'] = 'Memcache stats';
        $t->data['rowTitles'] = $rowTitles;
        $t->data['colTitles'] = $colTitles;
        $t->data['statsraw'] = $statsraw;
        $t->data['table'] = $stats;

        return $t;
    }


    /**
     * @param int $input
     * @return string
     *
     * @phpstan-ignore method.unused
     */
    private function tdate(int $input): string
    {
        return date(DATE_RFC822, $input);
    }


    /**
     * @param int $input
     * @return string
     *
     * @phpstan-ignore method.unused
     */
    private function hours(int $input): string
    {
        if ($input < 60) {
            return number_format($input, 2) . ' sec';
        }

        if ($input < 60 * 60) {
            return number_format(($input / 60), 2) . ' min';
        }

        if ($input < 24 * 60 * 60) {
            return number_format(($input / (60 * 60)), 2) . ' hours';
        }

        return number_format($input / (24 * 60 * 60), 2) . ' days';
    }


    /**
     * @param int $input
     * @return string
     *
     * @phpstan-ignore method.unused
     */
    private function humanreadable(int $input): string
    {
        $output = "";
        $input = abs($input);

        if ($input >= (1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 100)) {
            $output = sprintf("%5ldEi", $input / (1024 * 1024 * 1024 * 1024 * 1024 * 1024));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 1024 * 1024 * 10)) {
            $output = sprintf("%5.1fEi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 1024 * 1024)) {
            $output = sprintf("%5.2fEi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 1024 * 100)) {
            $output = sprintf("%5ldPi", $input / (1024 * 1024 * 1024 * 1024 * 1024));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 1024 * 10)) {
            $output = sprintf("%5.1fPi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 1024)) {
            $output = sprintf("%5.2fPi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 100)) {
            $output = sprintf("%5ldTi", $input / (1024 * 1024 * 1024 * 1024));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024 * 10)) {
            $output = sprintf("%5.1fTi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 1024)) {
            $output = sprintf("%5.2fTi", $input / (1024.0 * 1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024 * 100)) {
            $output = sprintf("%5ldGi", $input / (1024 * 1024 * 1024));
        } elseif ($input >= (1024 * 1024 * 1024 * 10)) {
            $output = sprintf("%5.1fGi", $input / (1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 1024)) {
            $output = sprintf("%5.2fGi", $input / (1024.0 * 1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024 * 100)) {
            $output = sprintf("%5ldMi", $input / (1024 * 1024));
        } elseif ($input >= (1024 * 1024 * 10)) {
            $output = sprintf("%5.1fM", $input / (1024.0 * 1024.0));
        } elseif ($input >= (1024 * 1024)) {
            $output = sprintf("%5.2fMi", $input / (1024.0 * 1024.0));
        } elseif ($input >= (1024 * 100)) {
            $output = sprintf("%5ldKi", $input / 1024);
        } elseif ($input >= (1024 * 10)) {
            $output = sprintf("%5.1fKi", $input / 1024.0);
        } elseif ($input >= (1024)) {
            $output = sprintf("%5.2fKi", $input / 1024.0);
        } else {
            $output = sprintf("%5ld", $input);
        }

        return $output;
    }
}