GSyncTop::normalizeLine() - Code Metrics - Inspection of "top: harden grommunio-sync-top and InterProcessDat..." - grommunio/grommunio-sync - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 005db1...a034e0 )

unknown
created 2025-09-27 17:03 UTC
GSyncTop::normalizeLine() A

↳ Parent: GSyncTop
Complexity

Conditions	6
Paths	12
Size

Total Lines	30
Code Lines	18
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	18
c	0
b	0
f	0
nc	12
nop	1
dl	0
loc	30
rs	9.0444
#!/usr/bin/env php
<?php

/*
 * SPDX-License-Identifier: AGPL-3.0-only
 * SPDX-FileCopyrightText: Copyright 2007-2016 Zarafa Deutschland GmbH
 * SPDX-FileCopyrightText: Copyright 2020-2023 grommunio GmbH
 *
 * Shows realtime information about connected devices and active connections
 * in a top-style format.
 */

require_once 'vendor/autoload.php';
if (!defined('GSYNC_CONFIG')) {
	define('GSYNC_CONFIG', 'config.php');
}

include_once GSYNC_CONFIG;
setlocale(LC_ALL, "");

/*
 * MAIN
 */
declare(ticks=1);
define('BASE_PATH_CLI', __DIR__ . "/");
set_include_path(get_include_path() . PATH_SEPARATOR . BASE_PATH_CLI);

if (!defined('GSYNC_CONFIG')) {
	define('GSYNC_CONFIG', BASE_PATH_CLI . 'config.php');
}

include_once GSYNC_CONFIG;

try {
	GSync::CheckConfig();
	if (!function_exists("pcntl_signal")) {
		throw new FatalException("Function pcntl_signal() is not available. Please install package 'php8-pcntl' (or similar) on your system.");
	}

	if (php_sapi_name() != "cli") {
		throw new FatalException("This script can only be called from the CLI.");
	}

	$zpt = new GSyncTop();

	// check if help was requested from CLI
	if (in_array('-h', $argv) || in_array('--help', $argv)) {
		echo $zpt->UsageInstructions();

		exit(0);
	}

	if ($zpt->IsAvailable()) {
		pcntl_signal(SIGINT, $zpt->SignalHandler(...));
		$zpt->run();
		$zpt->scrClear();
		system("stty sane");
	}
	else {
		echo "grommunio-sync interprocess communication (IPC) is not available or TopCollector is disabled.\n";
	}
}
catch (GSyncException $zpe) {
	fwrite(STDERR, $zpe::class . ": " . $zpe->getMessage() . "\n");

	exit(1);
}

echo "terminated\n";

/*
 * grommunio-sync-top
 */
class GSyncTop {
	// show options
	public const SHOW_DEFAULT = 0;
	public const SHOW_ACTIVE_ONLY = 1;
	public const SHOW_UNKNOWN_ONLY = 2;
	public const SHOW_TERM_DEFAULT_TIME = 5; // 5 secs

	private $topCollector;
	private $starttime;
	private $currenttime;
	private $action;
	private $filter;
	private $status;
	private $statusexpire;
	private $helpexpire;
	private $doingTail;
	private $wide;
	private $wasEnabled;
	private $terminate;
	private $scrSize;
	private $pingInterval;
	private $showPush;
	private $showOption;
	private $showTermSec;

	private $linesActive = [];
	private $linesOpen = [];
	private $linesUnknown = [];
	private $linesTerm = [];
	private $pushConn = 0;
	private $activeConn = [];
	private $activeHosts = [];
	private $activeUsers = [];
	private $activeDevices = [];

	private const LINE_DEFAULTS = [
		'pid' => 0,
		'ip' => '',
		'user' => '',
		'command' => '',
		'time' => 0,
		'devagent' => '',
		'devid' => '',
		'addinfo' => '',
		'asversion' => '',
		'start' => 0,
		'update' => 0,
		'ended' => 0,
		'push' => false,
	];

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->starttime = time();
		$this->currenttime = time();
		$this->action = "";
		$this->filter = false;
		$this->status = false;
		$this->statusexpire = 0;
		$this->helpexpire = 0;
		$this->doingTail = false;
		$this->wide = false;
		$this->terminate = false;
		$this->showPush = true;
		$this->showOption = self::SHOW_DEFAULT;
		$this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
		$this->scrSize = ['width' => 80, 'height' => 24];
		$this->pingInterval = (defined('PING_INTERVAL') && PING_INTERVAL > 0) ? PING_INTERVAL : 12;

		// get a TopCollector
		$this->topCollector = new TopCollector();
	}

	/**
	 * Requests data from the running grommunio-sync processes.
	 */
	private function initialize() {
		// request feedback from active processes
		$this->wasEnabled = $this->topCollector->CollectData();

		// remove obsolete data
		$this->topCollector->ClearLatest(true);

		// start with default colours
		$this->scrDefaultColors();
	}

	/**
	 * Main loop of grommunio-sync-top
	 * Runs until termination is requested.
	 */
	public function run() {
		$this->initialize();

		do {
			$this->currenttime = time();

			// see if shared memory is active
			if (!$this->IsAvailable()) {
				$this->terminate = true;
			}

			// active processes should continue sending data
			$this->topCollector->CollectData();

			// get and process data from processes
			$this->topCollector->ClearLatest();
			$topdata = $this->topCollector->ReadLatest();
			$this->processData($topdata);

			// check if screen size changed
			$s = $this->scrGetSize();
			if ($this->scrSize['width'] != $s['width']) {
				if ($s['width'] > 180) {
					$this->wide = true;
				}
				else {
					$this->wide = false;
				}
			}
			$this->scrSize = $s;

			// print overview
			$this->scrOverview();

			// wait for user input
			$this->readLineProcess();
		}
		while ($this->terminate !== true);
	}

	/**
	 * Indicates if TopCollector is available collecting data.
	 *
	 * @return bool
	 */
	public function IsAvailable() {
		if (defined('TOPCOLLECTOR_DISABLED') && constant('TOPCOLLECTOR_DISABLED') === true) {
			return false;
		}

		return $this->topCollector->IsActive();
	}

	/**
	 * Processes data written by the running processes.
	 *
	 * @param array $data
	 */
	private function processData($data) {
		$this->linesActive = [];
		$this->linesOpen = [];
		$this->linesUnknown = [];
		$this->linesTerm = [];
		$this->pushConn = 0;
		$this->activeConn = [];
		$this->activeHosts = [];
		$this->activeUsers = [];
		$this->activeDevices = [];

		if (!is_array($data)) {

			return;
		}

		foreach ($data as $devid => $users) {
			foreach ($users as $user => $pids) {
				foreach ($pids as $pid => $line) {
					if (!is_array($line)) {
						continue;
					}

					$line = $this->normalizeLine($line);
					if ($line['pid'] === 0) {
						continue;
					}

					if (is_numeric($line['command'])) {
						$command = Utils::GetCommandFromCode((int) $line['command']);
						$line['command'] = ($command !== false) ? $command : 'Unknown';
					}
					elseif ($line['command'] === '') {
						$line['command'] = 'Unknown';
					}
					else {
						$line['command'] = (string) $line['command'];
					}

					if ($line["ended"] === 0) {
						$this->activeDevices[$devid] = 1;
						$this->activeUsers[$user] = 1;
						$this->activeConn[$line['pid']] = 1;
						$this->activeHosts[$line['ip']] = 1;

						$line["time"] = $this->currenttime - $line['start'];
						if ($line['push'] === true) {
							++$this->pushConn;
						}

						// ignore push connections
						if ($line['push'] === true && !$this->showPush) {
							continue;
						}

						if ($this->filter !== false) {
							$f = $this->filter;
							if (!($line["pid"] == $f || $line["ip"] == $f || strtolower((string) $line['command']) == strtolower($f) || preg_match("/.*?{$f}.*?/i", (string) $line['user']) ||
							if (!($line["pid"] == $f || $line["ip"] == $f || strtolower((string) $line['command']) == strtolower(/** @scrutinizer ignore-type */ $f) || preg_match("/.*?{$f}.*?/i", (string) $line['user']) ||
								preg_match("/.*?{$f}.*?/i", (string) $line['devagent']) || preg_match("/.*?{$f}.*?/i", (string) $line['devid']) || preg_match("/.*?{$f}.*?/i", (string) $line['addinfo']))) {
								continue;
							}
						}

						$lastUpdate = $this->currenttime - $line["update"];
						if ($this->currenttime - $line["update"] < 2) {
							$this->linesActive[$line["update"] . $line["pid"]] = $line;
						}
						elseif (($line['push'] === true && $lastUpdate > ($this->pingInterval + 2)) || ($line['push'] !== true && $lastUpdate > 4)) {
							$this->linesUnknown[$line["update"] . $line["pid"]] = $line;
						}
						else {
							$this->linesOpen[$line["update"] . $line["pid"]] = $line;
						}
					}
					else {
						// do not show terminated + expired connections
						if ($this->currenttime > $line['ended'] + $this->showTermSec) {
							continue;
						}

						if ($this->filter !== false) {
							$f = $this->filter;
							if (
								!(
									$line['pid'] == $f ||
									$line['ip'] == $f ||
									strtolower((string) $line['command']) == strtolower($f) ||
									preg_match("/.*?{$f}.*?/i", (string) $line['user']) ||
									preg_match("/.*?{$f}.*?/i", (string) $line['devagent']) ||
									preg_match("/.*?{$f}.*?/i", (string) $line['devid']) ||
									preg_match("/.*?{$f}.*?/i", (string) $line['addinfo'])
								)) {
								continue;
							}
						}

						$line['time'] = $line['ended'] - $line['start'];
						$this->linesTerm[$line['update'] . $line['pid']] = $line;
					}
				}
			}
		}

		// sort by execution time
		krsort($this->linesActive);
		krsort($this->linesOpen);
		krsort($this->linesUnknown);
		krsort($this->linesTerm);
	}

	private function normalizeLine(array $line): array {
		$normalized = array_replace(self::LINE_DEFAULTS, $line);

		$normalized['pid'] = (int) $normalized['pid'];
		$normalized['update'] = (int) $normalized['update'];
		$normalized['start'] = (int) $normalized['start'];
		$normalized['ended'] = (int) $normalized['ended'];
		$normalized['time'] = (int) ($normalized['time'] ?? 0);

		if (!is_bool($normalized['push'])) {
			if (is_scalar($normalized['push'])) {
				$normalized['push'] = filter_var($normalized['push'], FILTER_VALIDATE_BOOL, FILTER_NULL_ON_FAILURE) ?? false;
			}
			else {
				$normalized['push'] = false;
			}
		}

		foreach (['ip', 'user', 'devagent', 'devid', 'addinfo', 'asversion'] as $key) {
			$normalized[$key] = (string) $normalized[$key];
		}

		if (is_string($normalized['command']) || is_numeric($normalized['command'])) {
			$normalized['command'] = (string) $normalized['command'];
		}
		else {
			$normalized['command'] = '';
		}

		return $normalized;
	}

	/**
	 * Prints data to the terminal.
	 */
	private function scrOverview() {
		$linesAvail = $this->scrSize['height'] - 7;
		$lc = 1;
		echo "\e[?25l\e[1;1H";
		$this->scrPrintAt($lc, 0, sprintf(
			"grommunio-sync-top live stats (%s, Gromox %s) %s\n",
			$this->getVersion(),
			phpversion("mapi"),
			date("Y-m-d H:i:s")
		));
		++$lc;

		$this->scrPrintAt($lc, 0, sprintf(
			"Conn: \e[1m%4d\e[0m open, \e[1m%4d\e[0m push; " .
			"\e[1m%4d\e[0m users, \e[1m%4d\e[0m devices, \e[1m%4d\e[0m hosts\n",
			count($this->activeConn),
			$this->pushConn,
			count($this->activeUsers),
			count($this->activeDevices),
			count($this->activeHosts)
		));
		++$lc;

		// remove old status
		if ($this->statusexpire < $this->currenttime) {
			$this->status = false;
		}

		// show request information and help command
		if ($this->starttime + 6 > $this->currenttime) {
			$this->status = sprintf("Requesting information (takes up to %dsecs)", $this->pingInterval) . str_repeat(".", $this->currenttime - $this->starttime) . "  type \033[01;31mh\033[00;31m or \033[01;31mhelp\033[00;31m for usage instructions";
			$this->statusexpire = $this->currenttime + 1;
		}

		$str = "";
		if (!$this->showPush) {
			$str .= "\033[00;32mPush: \033[01;32mNo\033[0m   ";
		}

		if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
			$str .= "\033[01;32mActive only\033[0m   ";
		}

		if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
			$str .= "\033[01;32mUnknown only\033[0m   ";
		}

		if ($this->showTermSec != self::SHOW_TERM_DEFAULT_TIME) {
			$str .= "\033[01;32mTerminated: " . $this->showTermSec . "s\033[0m   ";
		}

		if ($this->filter !== false || ($this->status !== false && $this->statusexpire > $this->currenttime)) {
			// print filter in green
			if ($this->filter !== false) {
				$str .= "\033[00;32mFilter: \033[01;32m{$this->filter}\033[0m   ";
			}
			// print status in red
			if ($this->status !== false) {
				$str .= "\033[00;31m{$this->status}\033[0m";
			}
		}
		$this->scrPrintAt($lc, 0, "Action: \033[01m" . $this->action . "\033[0m\n");
		++$lc;
		$this->scrPrintAt($lc, 0, $str . "\n");
		++$lc;
		$header = $this->getLine(['pid' => 'PID', 'ip' => 'ADDRESS', 'user' => 'USER', 'command' => 'COMMAND', 'time' => 'TIME', 'devagent' => 'AGENT', 'devid' => 'DEVID', 'addinfo' => 'Additional Information', 'asversion' => 'EAS']);
		$this->scrPrintAt($lc, 0, "\033[7m" . $header . str_repeat(" ", $this->scrSize['width'] - ($this->scrSize['width'] > strlen($header) ? strlen($header) : 0)) . "\033[0m\n");
		++$lc;

		if ($linesAvail < 1) {
			echo "Terminal too small, no room to display any useful information.";
			++$lc;

			return;
		}

		// print help text if requested
		$help = false;
		if ($this->helpexpire > $this->currenttime) {
			$help = $this->scrHelp();
			$linesAvail -= (count($help) + 1);
		}

		$toPrintActive = $linesAvail;
		$toPrintOpen = $linesAvail;
		$toPrintUnknown = $linesAvail;
		$toPrintTerm = $linesAvail;

		// default view: show all unknown, no terminated and half active+open
		if (count($this->linesActive) + count($this->linesOpen) + count($this->linesUnknown) > $linesAvail) {
			$toPrintUnknown = count($this->linesUnknown);
			$toPrintActive = count($this->linesActive);
			$toPrintOpen = $linesAvail - $toPrintUnknown - $toPrintActive;
			$toPrintTerm = 0;
		}

		if ($this->showOption == self::SHOW_ACTIVE_ONLY) {
			$toPrintActive = $linesAvail;
			$toPrintOpen = 0;
			$toPrintUnknown = 0;
			$toPrintTerm = 0;
		}

		if ($this->showOption == self::SHOW_UNKNOWN_ONLY) {
			$toPrintActive = 0;
			$toPrintOpen = 0;
			$toPrintUnknown = $linesAvail;
			$toPrintTerm = 0;
		}

		$linesprinted = 0;
		foreach ($this->linesActive as $time => $l) {
			if ($linesprinted >= $toPrintActive) {
				break;
			}

			$this->scrPrintAt($lc, 0, "\033[01m" . $this->getLine($l) . "\033[0m\n");
			++$lc;
			++$linesprinted;
		}

		$linesprinted = 0;
		foreach ($this->linesOpen as $time => $l) {
			if ($linesprinted >= $toPrintOpen) {
				break;
			}

			$this->scrPrintAt($lc, 0, $this->getLine($l) . "\n");
			++$lc;
			++$linesprinted;
		}

		$linesprinted = 0;
		foreach ($this->linesUnknown as $time => $l) {
			if ($linesprinted >= $toPrintUnknown) {
				break;
			}
			$time = intval($time);
			$color = "0;31m";
			if (!isset($l['start'])) {
				$l['start'] = $time;
			}
			if ((!isset($l['push']) || $l['push'] == false) && $time - $l["start"] > 30) {
				$color = "1;31m";
			}
			$this->scrPrintAt($lc, 0, "\033[0" . $color . $this->getLine($l) . "\033[0m\n");
			++$lc;
			++$linesprinted;
		}

		if ($toPrintTerm > 0) {
			$toPrintTerm = $linesAvail - $lc + 5;
		}

		$linesprinted = 0;
		foreach ($this->linesTerm as $time => $l) {
			if ($linesprinted >= $toPrintTerm) {
				break;
			}

			$this->scrPrintAt($lc, 0, "\033[01;30m" . $this->getLine($l) . "\033[0m\n");
			++$lc;
			++$linesprinted;
		}

		// add the lines used when displaying the help text
		if ($help !== false) {
			while ($lc < $linesAvail + 7) {
				$this->scrPrintAt($lc, 0, "\033[K\n");
				++$lc;
			}
			if ($linesAvail < 1) {
				$this->scrPrintAt($lc, 0, "Can't display help text, terminal has not enough lines. Use -h or --help to see help information. \n");
				++$lc;
			}
			else {
				foreach ($help as $h) {
					$this->scrPrintAt($lc, 0, $h . "\n");
					++$lc;
				}
			}
		}
		$this->scrPrintAt($lc, 0, "\033[K\n");
		++$lc;
		$this->scrPrintAt($lc, 0, "Colorscheme: \033[01mActive  \033[0mOpen  \033[01;31mUnknown  \033[01;30mTerminated\033[0m");
		/* Clear rest of area */
		echo "\e[J";
		/* Reposition cursor to Action: line */
		printf("\e[3;%dH\e[?25h", 9 + strlen($this->action));
	}

	/**
	 * Waits for a keystroke and processes the requested command.
	 */
	private function readLineProcess() {
		$ans = explode("^^", (string) `bash -c "read -n 1 -t 1 ANS ; echo \\\$?^^\\\$ANS;"`);

		if ($ans[0] < 128) {
			if (isset($ans[1]) && bin2hex(trim($ans[1])) == "7f") {
				$this->action = substr($this->action, 0, -1);
			}

			if (isset($ans[1]) && $ans[1] != "") {
				$this->action .= trim((string) preg_replace("/[^A-Za-z0-9:]/", "", $ans[1]));
			}

			if (bin2hex($ans[0]) == "30" && bin2hex($ans[1]) == "0a") {
				$cmds = explode(':', $this->action);
				if ($cmds[0] == "quit" || $cmds[0] == "q" || (isset($cmds[1]) && $cmds[0] == "" && $cmds[1] == "q")) {
					$this->topCollector->CollectData(true);
					$this->topCollector->ClearLatest(true);

					$this->terminate = true;
				}
				elseif ($cmds[0] == "clear") {
					$this->topCollector->ClearLatest(true);
					$this->topCollector->CollectData(true);
					$this->topCollector->ReInitIPC();
				}
				elseif ($cmds[0] == "filter" || $cmds[0] == "f") {
					if (!isset($cmds[1]) || $cmds[1] == "") {
						$this->filter = false;
						$this->status = "No filter";
						$this->statusexpire = $this->currenttime + 5;
					}
					else {
						$this->filter = $cmds[1];
						$this->status = false;
					}
				}
				elseif ($cmds[0] == "option" || $cmds[0] == "o") {
					if (!isset($cmds[1]) || $cmds[1] == "") {
						$this->status = "Option value needs to be specified. See 'help' or 'h' for instructions";
						$this->statusexpire = $this->currenttime + 5;
					}
					elseif ($cmds[1] == "p" || $cmds[1] == "push" || $cmds[1] == "ping") {
						$this->showPush = !$this->showPush;
					}
					elseif ($cmds[1] == "a" || $cmds[1] == "active") {
						$this->showOption = self::SHOW_ACTIVE_ONLY;
					}
					elseif ($cmds[1] == "u" || $cmds[1] == "unknown") {
						$this->showOption = self::SHOW_UNKNOWN_ONLY;
					}
					elseif ($cmds[1] == "d" || $cmds[1] == "default") {
						$this->showOption = self::SHOW_DEFAULT;
						$this->showTermSec = self::SHOW_TERM_DEFAULT_TIME;
						$this->showPush = true;
					}
					elseif (is_numeric($cmds[1])) {
						$this->showTermSec = $cmds[1];
					}
					else {
						$this->status = sprintf("Option '%s' unknown", $cmds[1]);
						$this->statusexpire = $this->currenttime + 5;
					}
				}
				elseif ($cmds[0] == "reset" || $cmds[0] == "r") {
					$this->filter = false;
					$this->wide = false;
					$this->helpexpire = 0;
					$this->status = "reset";
					$this->statusexpire = $this->currenttime + 2;
				}
				// enable/disable wide view
				elseif ($cmds[0] == "wide" || $cmds[0] == "w") {
					$this->wide = !$this->wide;
					$this->status = ($this->wide) ? "w i d e  view" : "normal view";
					$this->statusexpire = $this->currenttime + 2;
				}
				elseif ($cmds[0] == "help" || $cmds[0] == "h") {
					$this->helpexpire = $this->currenttime + 20;
				}
				// grep the log file
				elseif (($cmds[0] == "log" || $cmds[0] == "l") && isset($cmds[1])) {
					if (!file_exists(LOGFILE)) {
						$this->status = "Logfile can not be found: " . LOGFILE;
					}
					else {
						system('bash -c "fgrep -a ' . escapeshellarg($cmds[1]) . ' ' . LOGFILE . ' | less +G" > `tty`');
						$this->status = "Returning from log, updating data";
					}
					$this->statusexpire = time() + 5; // it might be much "later" now
				}
				// tail the log file
				elseif ($cmds[0] == "tail" || $cmds[0] == "t") {
					if (!file_exists(LOGFILE)) {
						$this->status = "Logfile can not be found: " . LOGFILE;
					}
					else {
						$this->doingTail = true;
						$this->scrClear();
						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
						$secondary = "";
						if (isset($cmds[1])) {
							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
						}
						system('bash -c "tail -f ' . LOGFILE . $secondary . '" > `tty`');
						$this->doingTail = false;
						$this->status = "Returning from tail, updating data";
					}
					$this->statusexpire = time() + 5; // it might be much "later" now
				}
				// tail the error log file
				elseif ($cmds[0] == "error" || $cmds[0] == "e") {
					if (!file_exists(LOGERRORFILE)) {
						$this->status = "Error logfile can not be found: " . LOGERRORFILE;
					}
					else {
						$this->doingTail = true;
						$this->scrClear();
						$this->scrPrintAt(1, 0, $this->scrAsBold("Press CTRL+C to return to grommunio-sync-top\n\n"));
						$secondary = "";
						if (isset($cmds[1])) {
							$secondary = " -n 200 | grep " . escapeshellarg($cmds[1]);
						}
						system('bash -c "tail -f ' . LOGERRORFILE . $secondary . '" > `tty`');
						$this->doingTail = false;
						$this->status = "Returning from tail, updating data";
					}
					$this->statusexpire = time() + 5; // it might be much "later" now
				}
				elseif ($cmds[0] != "") {
					$this->status = sprintf("Command '%s' unknown", $cmds[0]);
					$this->statusexpire = $this->currenttime + 8;
				}
				$this->action = "";
			}
		}
	}

	/**
	 * Signal handler function.
	 *
	 * @param int $signo signal number
	 */
	public function SignalHandler($signo) {
	public function SignalHandler(/** @scrutinizer ignore-unused */ $signo) {
		// don't terminate if the signal was sent by terminating tail
		if (!$this->doingTail) {
			$this->topCollector->CollectData(true);
			$this->topCollector->ClearLatest(true);
			$this->terminate = true;
		}
	}

	/**
	 * Returns usage instructions.
	 *
	 * @return string
	 */
	public function UsageInstructions() {
		$help = "Usage:\n\tgrommunio-sync-top\n\n" .
				"  grommunio-sync-top is a live top-like overview of what grommunio-sync is doing. It does not have specific command line options.\n\n" .
				"  When grommunio-sync-top is running you can specify certain actions and options which can be executed (listed below).\n" .
				"  This help information can also be shown inside grommunio-sync-top by hitting 'help' or 'h'.\n\n";
		$scrhelp = $this->scrHelp();
		unset($scrhelp[0]);

		$help .= implode("\n", $scrhelp);
		$help .= "\n\n";

		return $help;
	}

	/**
	 * Prints a 'help' text at the end of the page.
	 *
	 * @return array with help lines
	 */
	private function scrHelp() {
		$h = [];
		$secs = $this->helpexpire - $this->currenttime;
		$h[] = "Actions supported by grommunio-sync-top (help page still displayed for " . $secs . "secs)";
		$h[] = "  " . $this->scrAsBold("Action") . "                " . $this->scrAsBold("Comment");
		$h[] = "  " . $this->scrAsBold("h") . " or " . $this->scrAsBold("help") . "             Displays this information.";
		$h[] = "  " . $this->scrAsBold("q") . ", " . $this->scrAsBold("quit") . " or " . $this->scrAsBold(":q") . "         Exits grommunio-sync-top.";
		$h[] = "  " . $this->scrAsBold("w") . " or " . $this->scrAsBold("wide") . "             Tries not to truncate data. Automatically done if more than 180 columns available.";
		$h[] = "  " . $this->scrAsBold("f:VAL") . " or " . $this->scrAsBold("filter:VAL") . "   Only display connections which contain VAL. This value is case-insensitive.";
		$h[] = "  " . $this->scrAsBold("f:") . " or " . $this->scrAsBold("filter:") . "         Without a search word: resets the filter.";
		$h[] = "  " . $this->scrAsBold("l:STR") . " or " . $this->scrAsBold("log:STR") . "      Issues 'less +G' on the logfile, after grepping on the optional STR.";
		$h[] = "  " . $this->scrAsBold("t:STR") . " or " . $this->scrAsBold("tail:STR") . "     Issues 'tail -f' on the logfile, grepping for optional STR.";
		$h[] = "  " . $this->scrAsBold("e:STR") . " or " . $this->scrAsBold("error:STR") . "    Issues 'tail -f' on the error logfile, grepping for optional STR.";
		$h[] = "  " . $this->scrAsBold("r") . " or " . $this->scrAsBold("reset") . "            Resets 'wide' or 'filter'.";
		$h[] = "  " . $this->scrAsBold("o:") . " or " . $this->scrAsBold("option:") . "         Sets display options. Valid options specified below";
		$h[] = "  " . $this->scrAsBold("  p") . " or " . $this->scrAsBold("push") . "           Lists/not lists active and open push connections.";
		$h[] = "  " . $this->scrAsBold("  a") . " or " . $this->scrAsBold("action") . "         Lists only active connections.";
		$h[] = "  " . $this->scrAsBold("  u") . " or " . $this->scrAsBold("unknown") . "        Lists only unknown connections.";
		$h[] = "  " . $this->scrAsBold("  10") . " or " . $this->scrAsBold("20") . "            Lists terminated connections for 10 or 20 seconds. Any other number can be used.";
		$h[] = "  " . $this->scrAsBold("  d") . " or " . $this->scrAsBold("default") . "        Uses default options";

		return $h;
	}

	/**
	 * Encapsulates string with different color escape characters.
	 *
	 * @param string $text
	 *
	 * @return string same text as bold
	 */
	private function scrAsBold($text) {
		return "\033[01m" . $text . "\033[0m";
	}

	/**
	 * Prints one line of precessed data.
	 *
	 * @param array $l line information
	 *
	 * @return string
	 */
	private function getLine($l) {
		if (!isset($l['pid']) || !isset($l['ip']) || !isset($l['user']) || !isset($l['command']) || !isset($l['time']) || !isset($l['devagent']) || !isset($l['devid']) || !isset($l['addinfo']) || !isset($l['asversion'])) {
			return "";
		}
		if ($this->wide === true) {
			return sprintf("%s%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 7), $this->ptStr($l['ip'], 40), $this->ptStr($l['user'], 24), $this->ptStr($l['command'], 16), $this->ptStr($this->sec2min($l['time']), 8), $this->ptStr($l['devagent'], 28), $this->ptStr($l['asversion'], 5), $this->ptStr($l['devid'], 33, true), $l['addinfo']);
		}

		return sprintf("%s%s%s%s%s%s%s%s%s", $this->ptStr($l['pid'], 7), $this->ptStr($l['ip'], 16), $this->ptStr($l['user'], 8), $this->ptStr($l['command'], 8), $this->ptStr($this->sec2min($l['time']), 6), $this->ptStr($l['devagent'], 20), $this->ptStr($l['asversion'], 5), $this->ptStr($l['devid'], 12, true), $l['addinfo']);
	}

	/**
	 * Pads and trims string.
	 *
	 * @param string $str       to be trimmed/padded
	 * @param int    $size      characters to be considered
	 * @param bool   $cutmiddle (optional) indicates where to long information should
	 *                          be trimmed of, false means at the end
	 *
	 * @return string
	 */
	private function ptStr($str, $size, $cutmiddle = false) {
		if (strlen($str) < $size) {
			return str_pad($str, $size);
		}
		if ($cutmiddle === true) {
			$cut = ($size - 2) / 2;

			return $this->ptStr(substr($str, 0, $cut) . ".." . substr($str, (-1) * ($cut - 1)), $size);
		}

		return substr($str, 0, $size - 3) . ".. ";
	}

	/**
	 * Tries to discover the size of the current terminal.
	 *
	 * @return array 'width' and 'height' as keys
	 */
	private function scrGetSize() {
		$tty = strtolower(exec('stty -a | fgrep columns'));
		if (preg_match_all("/rows.([0-9]+);.columns.([0-9]+);/", $tty, $output) ||
			preg_match_all("/([0-9]+).rows;.([0-9]+).columns;/", $tty, $output)) {
			return ['width' => $output[2][0], 'height' => $output[1][0]];
		}

		return ['width' => 80, 'height' => 24];
	}

	/**
	 * Returns the version of the current grommunio-sync installation.
	 *
	 * @return string
	 */
	private function getVersion() {
		return GROMMUNIOSYNC_VERSION;
	}

	/**
	 * Converts seconds in MM:SS.
	 *
	 * @param int $s seconds
	 *
	 * @return string
	 */
	private function sec2min($s) {
		if (!is_int($s)) {

			return $s;
		}

		return sprintf("%02.2d:%02.2d", floor($s / 60), $s % 60);
	}

	/**
	 * Resets the default colors of the terminal.
	 */
	private function scrDefaultColors() {
		echo "\033[0m";
	}

	/**
	 * Clears screen of the terminal.
	 */
	public function scrClear() {
		echo "\033[2J";
	}

	/**
	 * Prints a text at a specific screen/terminal coordinates.
	 *
	 * @param int    $row  row number
	 * @param int    $col  column number
	 * @param string $text to be printed
	 */
	private function scrPrintAt($row, $col, $text = "") {
		echo "\033[" . $row . ";" . $col . "H" . preg_replace("/\n/", "\e[K\n", $text);
	}
}

grommunio / grommunio-sync

Push — master ( 005db1...a034e0 )

GSyncTop::normalizeLine() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
