Add function param/return types, fix a lot more phpstorm complaints

13 files changed, 82 insertions, 88 deletions

diff --git a/modules-available/locationinfo/api.inc.php b/modules-available/locationinfo/api.inc.php
index 14be7718..24919ba1 100644
--- a/modules-available/locationinfo/api.inc.php
+++ b/modules-available/locationinfo/api.inc.php
@@ -14,7 +14,7 @@ function HandleParameters()
 
 	$get = Request::get('get', 0, 'string');
 	$uuid = Request::get('uuid', false, 'string');
-	$output = false;
+	$output = null;
 	if ($get === "timestamp") {
 		$output = array('ts' => getLastChangeTs($uuid));
 	} elseif ($get === "machines") {
@@ -24,7 +24,7 @@ function HandleParameters()
 		$output = array_values($output);
 	} elseif ($get === "config") {
 		$type = InfoPanel::getConfig($uuid, $output);
-		if ($type === false) {
+		if ($type === null) {
 			http_response_code(404);
 			die('Panel not found');
 		}
@@ -38,7 +38,7 @@ function HandleParameters()
 		$locationIds = LocationInfo::getLocationsOr404($uuid);
 		$output = LocationInfo::getCalendar($locationIds);
 	}
-	if ($output !== false) {
+	if ($output !== null) {
 		Header('Content-Type: application/json; charset=utf-8');
 		echo json_encode($output);
 	} else {
@@ -59,7 +59,7 @@ function HandleParameters()
  * @param string $paneluuid panels uuid
  * @return int UNIX_TIMESTAMP
  */
-function getLastChangeTs($paneluuid)
+function getLastChangeTs(string $paneluuid): int
 {
 	$panel = Database::queryFirst('SELECT lastchange, locationids FROM locationinfo_panel WHERE paneluuid = :paneluuid',
 		compact('paneluuid'));
@@ -84,7 +84,7 @@ function getLastChangeTs($paneluuid)
  * @param int[] $idList list of the location ids.
  * @return array aggregated PC states
  */
-function getPcStates($idList, $paneluuid)
+function getPcStates(array $idList, string $paneluuid): array
 {
 	$pcStates = array();
 	foreach ($idList as $id) {
@@ -130,7 +130,7 @@ function getPcStates($idList, $paneluuid)
  * @param int[] $idList Array list of the locations.
  * @return array location tree data
  */
-function getLocationTree($idList)
+function getLocationTree(array $idList): array
 {
 	if (in_array(0, $idList)) {
 		return array_values(Location::getTree());
@@ -140,7 +140,7 @@ function getLocationTree($idList)
 	return findLocations($locations, $idList);
 }
 
-function findLocations($locations, $idList)
+function findLocations(array $locations, array $idList): array
 {
 	$ret = array();
 	foreach ($locations as $location) {
diff --git a/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpEws/ArrayType/ArrayOfStringsType.php b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpEws/ArrayType/ArrayOfStringsType.php
index 6443d31d..28792929 100644
--- a/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpEws/ArrayType/ArrayOfStringsType.php
+++ b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpEws/ArrayType/ArrayOfStringsType.php
@@ -32,6 +32,6 @@ class ArrayOfStringsType extends ArrayType
      */
     public function __toString()
     {
-        return $this->String;
+        return implode(' + ', $this->String);
     }
 }
diff --git a/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php
index 21c77cbf..98f23dfa 100644
--- a/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php
+++ b/modules-available/locationinfo/exchange-includes/jamesiarmes/PhpNtlm/SoapClient.php
@@ -26,6 +26,9 @@ class SoapClient extends \SoapClient
      */
     protected $options;
 
+	 protected $__last_response;
+	 protected $__last_request_headers;
+
     /**
      * {@inheritdoc}
      *
@@ -68,7 +71,7 @@ class SoapClient extends \SoapClient
     /**
      * {@inheritdoc}
      */
-    public function __doRequest($request, $location, $action, $version, $one_way = 0)
+    public function __doRequest($request, $location, $action, $version, $oneWay = 0)
     {
         $headers = $this->buildHeaders($action);
         $this->__last_request = $request;
diff --git a/modules-available/locationinfo/inc/coursebackend.inc.php b/modules-available/locationinfo/inc/coursebackend.inc.php
index 04b5aa92..ea1bebac 100644
--- a/modules-available/locationinfo/inc/coursebackend.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend.inc.php
@@ -152,10 +152,6 @@ abstract class CourseBackend
 	/**
 	 * In case you want to sanitize or otherwise mangle a property for your backend,
 	 * override this.
-	 *
-	 * @param string $prop
-	 * @param $value
-	 * @return mixed
 	 */
 	public function mangleProperty(string $prop, $value)
 	{
@@ -179,9 +175,9 @@ abstract class CourseBackend
 	 * Method for fetching the schedule of the given rooms on a server.
 	 *
 	 * @param array $requestedLocationIds array of room ID to fetch
-	 * @return array|bool array containing the timetables as value and roomid as key as result, or false on error
+	 * @return array array containing the timetables as value and roomid as key as result, or false on error
 	 */
-	public final function fetchSchedule(array $requestedLocationIds)
+	public final function fetchSchedule(array $requestedLocationIds): array
 	{
 		if (empty($requestedLocationIds))
 			return array();
@@ -236,9 +232,6 @@ abstract class CourseBackend
 			]);
 		}
 		$backendResponse = $this->fetchSchedulesInternal(array_unique($remoteIds));
-		if ($backendResponse === false) {
-			return false;
-		}
 
 		// Fetching might have taken a while, get current time again
 		$NOW = time();
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
index f03444c2..786ab459 100644
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_davinci.inc.php
@@ -68,7 +68,7 @@ class CourseBackend_Davinci extends CourseBackend
 	 * @param string $roomId unique name of the room, as used by davinci
 	 * @param \DateTime $startDate start date to fetch
 	 * @param \DateTime $endDate end date of range to fetch
-	 * @return array|bool if successful the array representation of the timetable
+	 * @return false|string if successful the array representation of the timetable
 	 */
 	private function fetchRoomRaw(string $roomId, DateTime $startDate, DateTime $endDate)
 	{
diff --git a/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php b/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
index 5920231f..df33dadd 100755
--- a/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
+++ b/modules-available/locationinfo/inc/coursebackend/coursebackend_exchange.inc.php
@@ -173,8 +173,13 @@ class CourseBackend_Exchange extends CourseBackend
 
 			// Iterate over the events that were found, printing some data for each.
 			foreach ($items as $item) {
-				$start = new DateTime($item->Start);
-				$end = new DateTime($item->End);
+				try {
+					$start = new DateTime($item->Start);
+					$end = new DateTime($item->End);
+				} catch (Exception $e) {
+					$this->addError("Invalid date range: '{$item->Start}' -> '{$item->End}'", false);
+					continue;
+				}
 
 				$schedules[$roomId][] = array(
 					'title' => $item->Subject,
diff --git a/modules-available/locationinfo/inc/icalcoursebackend.inc.php b/modules-available/locationinfo/inc/icalcoursebackend.inc.php
index 44691bb4..838d18b7 100644
--- a/modules-available/locationinfo/inc/icalcoursebackend.inc.php
+++ b/modules-available/locationinfo/inc/icalcoursebackend.inc.php
@@ -18,16 +18,6 @@ abstract class ICalCourseBackend extends CourseBackend
 	/** @var bool|resource */
 	private $curlHandle = false;
 
-	/**
-	 * Initialize values
-	 *
-	 * @param string $location
-	 * @param bool $verifyCert
-	 * @param bool $verifyHostname
-	 * @param string $authMethod
-	 * @param string $user
-	 * @param string $pass
-	 */
 	protected function init(
 		string $location, bool $verifyCert, bool $verifyHostname,
 		string $authMethod = 'NONE', string $user = '', string $pass = '')
@@ -52,11 +42,18 @@ abstract class ICalCourseBackend extends CourseBackend
 	{
 		if (!$this->isOK())
 			return null;
+
+		try {
+			$ical = new ICalParser(['filterDaysBefore' => 7, 'filterDaysAfter' => 7]);
+		} catch (Exception $e) {
+			$this->addError('Error instantiating ICalParser: ' . $e->getMessage(), true);
+			return null;
+		}
+
 		if ($this->curlHandle === false) {
 			$this->curlHandle = curl_init();
 		}
 
-		$ical = new ICalParser(['filterDaysBefore' => 7, 'filterDaysAfter' => 7]);
 		$options = [
 			CURLOPT_WRITEFUNCTION => function ($ch, $data) use ($ical) {
 				$ical->feedData($data);
@@ -119,8 +116,6 @@ abstract class ICalCourseBackend extends CourseBackend
 
 	/**
 	 * Get a usable title from either SUMMARY or DESCRIPTION
-	 *
-	 * @param ICalEvent $event
 	 */
 	protected function toTitle(ICalEvent $event): string
 	{
diff --git a/modules-available/locationinfo/inc/icalevent.inc.php b/modules-available/locationinfo/inc/icalevent.inc.php
index 0c234f48..c5aea349 100644
--- a/modules-available/locationinfo/inc/icalevent.inc.php
+++ b/modules-available/locationinfo/inc/icalevent.inc.php
@@ -153,10 +153,10 @@ class ICalEvent
 	/**
 	 * Magic getter method
 	 *
-	 * @param  string $additionalPropertyName
+	 * @param string $additionalPropertyName
 	 * @return mixed
 	 */
-	public function __get($additionalPropertyName)
+	public function __get(string $additionalPropertyName)
 	{
 		if (array_key_exists($additionalPropertyName, $this->additionalProperties)) {
 			return $this->additionalProperties[$additionalPropertyName];
@@ -167,11 +167,8 @@ class ICalEvent
 
 	/**
 	 * Magic isset method
-	 *
-	 * @param  string $name
-	 * @return boolean
 	 */
-	public function __isset($name)
+	public function __isset(string $name): bool
 	{
 		return is_null($this->$name) === false;
 	}
diff --git a/modules-available/locationinfo/inc/icalparser.inc.php b/modules-available/locationinfo/inc/icalparser.inc.php
index 69ff84d0..c6d94a12 100644
--- a/modules-available/locationinfo/inc/icalparser.inc.php
+++ b/modules-available/locationinfo/inc/icalparser.inc.php
@@ -989,9 +989,8 @@ class ICalParser
 			}
 
 			return $matches;
-		} else {
-			return null; // Ignore this match
 		}
+		return null; // Ignore this match
 	}
 
 	/**
@@ -1968,9 +1967,8 @@ class ICalParser
 	{
 		if (empty($event['EXDATE_array'])) {
 			return array();
-		} else {
-			$exdates = $event['EXDATE_array'];
 		}
+		$exdates = $event['EXDATE_array'];
 
 		$output = array();
 		$currentTimeZone = $this->defaultTimeZone;
diff --git a/modules-available/locationinfo/inc/infopanel.inc.php b/modules-available/locationinfo/inc/infopanel.inc.php
index 14d2d949..c0352c26 100644
--- a/modules-available/locationinfo/inc/infopanel.inc.php
+++ b/modules-available/locationinfo/inc/infopanel.inc.php
@@ -7,16 +7,16 @@ class InfoPanel
 	 * Gets the config of the location.
 	 *
 	 * @param int $locationID ID of the location
-	 * @param mixed $config the panel config will be returned here
-	 * @return string|bool paneltype, false if not exists
+	 * @param ?array $config the panel config will be returned here
+	 * @return ?string panel type, null if not exists
 	 */
-	public static function getConfig($paneluuid, &$config)
+	public static function getConfig(string $paneluuid, ?array &$config): ?string
 	{
 		$panel = Database::queryFirst('SELECT panelname, panelconfig, paneltype, locationids FROM locationinfo_panel WHERE paneluuid = :paneluuid',
 			compact('paneluuid'));
 
 		if ($panel === false) {
-			return false;
+			return null;
 		}
 
 		$config = LocationInfo::defaultPanelConfig($panel['paneltype']);
@@ -87,13 +87,10 @@ class InfoPanel
 	 * @param array $array location list to populate with machine data
 	 * @param bool $withPosition Defines if coords should be included or not.
 	 */
-	public static function appendMachineData(&$array, $idList = false, $withPosition = false, $withHostname = false)
+	public static function appendMachineData(?array &$array, array $idList, bool $withPosition = false, bool $withHostname = false): void
 	{
-		if (empty($array) && $idList === false)
+		if (empty($array) || empty($idList))
 			return;
-		if ($idList === false) {
-			$idList = array_keys($array);
-		}
 
 		$ignoreList = array();
 		if (Module::isAvailable('runmode')) {
@@ -217,12 +214,12 @@ class InfoPanel
 	 * @param int[] $idList location ids
 	 * @return  int[] more location ids
 	 */
-	private static function getLocationsWithParents($idList)
+	private static function getLocationsWithParents(array $idList): array
 	{
 		$locations = Location::getLocationsAssoc();
 		$allIds = $idList;
 		foreach ($idList as $id) {
-			if (isset($locations[$id]) && isset($locations[$id]['parents'])) {
+			if (isset($locations[$id]['parents'])) {
 				$allIds = array_merge($allIds, $locations[$id]['parents']);
 			}
 		}
@@ -238,9 +235,9 @@ class InfoPanel
 	 * 'HourClose' => hh, 'MinutesClose' => mm }
 	 *
 	 * @param array $openingtime The opening time in the db saved format.
-	 * @return mixed The opening time in the frontend needed format.
+	 * @return array The opening time in the frontend needed format.
 	 */
-	private static function formatOpeningtime($openingtime)
+	private static function formatOpeningtime(array $openingtime): array
 	{
 		$result = array();
 		foreach ($openingtime as $entry) {
diff --git a/modules-available/locationinfo/inc/locationinfo.inc.php b/modules-available/locationinfo/inc/locationinfo.inc.php
index 004ef881..42829a18 100644
--- a/modules-available/locationinfo/inc/locationinfo.inc.php
+++ b/modules-available/locationinfo/inc/locationinfo.inc.php
@@ -7,9 +7,9 @@ class LocationInfo
 	 * Gets the pc data and returns it's state.
 	 *
 	 * @param array $pc The pc data from the db. Array('state' => xx, 'lastseen' => xxx)
-	 * @return int pc state
+	 * @return string pc state
 	 */
-	public static function getPcState($pc)
+	public static function getPcState(array $pc): string
 	{
 		$lastseen = (int)$pc['lastseen'];
 		$NOW = time();
@@ -22,11 +22,12 @@ class LocationInfo
 
 	/**
 	 * Return list of locationids associated with given panel.
+	 *
 	 * @param string $paneluuid panel
 	 * @param bool $recursive if true and paneltype == SUMMARY the result is recursive with all child room ids.
 	 * @return int[] locationIds
 	 */
-	public static function getLocationsOr404($paneluuid, $recursive = true)
+	public static function getLocationsOr404(string $paneluuid, bool $recursive = true): array
 	{
 		$panel = Database::queryFirst('SELECT paneltype, locationids FROM locationinfo_panel WHERE paneluuid = :paneluuid',
 			compact('paneluuid'));
@@ -48,7 +49,7 @@ class LocationInfo
 	 * @param int $serverId id of server
 	 * @param string|array $message error message to set, array of error message struct, null or false clears error.
 	 */
-	public static function setServerError($serverId, $message)
+	public static function setServerError(int $serverId, $message): void
 	{
 		if (is_array($message)) {
 			$fatal = false;
@@ -86,7 +87,7 @@ class LocationInfo
 	 *
 	 * @return array Return a default config.
 	 */
-	public static function defaultPanelConfig($type)
+	public static function defaultPanelConfig(string $type): array
 	{
 		if ($type === 'DEFAULT') {
 			return array(
diff --git a/modules-available/locationinfo/inc/locationinfohooks.inc.php b/modules-available/locationinfo/inc/locationinfohooks.inc.php
index ee46260a..8ec217cc 100644
--- a/modules-available/locationinfo/inc/locationinfohooks.inc.php
+++ b/modules-available/locationinfo/inc/locationinfohooks.inc.php
@@ -5,9 +5,9 @@ class LocationInfoHooks
 
 	/**
 	 * @param string $uuid panel uuid
-	 * @return bool|string panel name if exists, false otherwise
+	 * @return false|string panel name if exists, false otherwise
 	 */
-	public static function getPanelName($uuid)
+	public static function getPanelName(string $uuid)
 	{
 		$ret = Database::queryFirst('SELECT panelname FROM locationinfo_panel WHERE paneluuid = :uuid', compact('uuid'));
 		if ($ret === false)
@@ -18,14 +18,11 @@ class LocationInfoHooks
 	/**
 	 * Hook called by runmode module where we should modify the client config according to our
 	 * needs. Disable standby/logout timeouts, enable autologin, set URL.
-	 *
-	 * @param $machineUuid
-	 * @param $panelUuid
 	 */
-	public static function configHook($machineUuid, $panelUuid)
+	public static function configHook(string $machineUuid, string $panelUuid): void
 	{
 		$type = InfoPanel::getConfig($panelUuid, $data);
-		if ($type === false)
+		if ($type === null)
 			return; // TODO: Invalid panel - what should we do?
 		if ($type === 'URL') {
 			// Check if we should set the insecure SSL mode (accept invalid/self signed certs etc.)
@@ -93,10 +90,8 @@ class LocationInfoHooks
 	/**
 	 * Turn multiline list into space separated list, removing any
 	 * comments (starting with #)
-	 * @param string $list
-	 * @return string
 	 */
-	private static function mangleList($list)
+	private static function mangleList(string $list): string
 	{
 		return preg_replace('/\s*(#[^\n]*)?(\n|$)/', ' ', $list);
 	}
diff --git a/modules-available/locationinfo/page.inc.php b/modules-available/locationinfo/page.inc.php
index 91de0012..5e5b66f0 100644
--- a/modules-available/locationinfo/page.inc.php
+++ b/modules-available/locationinfo/page.inc.php
@@ -81,7 +81,7 @@ class Page_LocationInfo extends Page
 			$this->showLocationsTable();
 			break;
 		case 'backends':
-			$this->showBackendsTable($backends);
+			$this->showBackendsTable($backends ?? []);
 			break;
 		case 'edit-panel':
 			$this->showPanelConfig();
@@ -130,11 +130,13 @@ class Page_LocationInfo extends Page
 		}
 	}
 
-	private function getTime(string $str): int
+	private static function getTime(string $str): ?int
 	{
 		$str = explode(':', $str);
-		if (count($str) !== 2) return false;
-		if ($str[0] < 0 || $str[0] > 23 || $str[1] < 0 || $str[1] > 59) return false;
+		if (count($str) !== 2)
+			return null;
+		if ($str[0] < 0 || $str[0] > 23 || $str[1] < 0 || $str[1] > 59)
+			return null;
 		return $str[0] * 60 + $str[1];
 	}
 
@@ -247,7 +249,7 @@ class Page_LocationInfo extends Page
 		}
 
 		// Permission
-		$this->assertPanelPermission($paneluuid, 'panel.edit', $params['locationids']);
+		$this->assertPanelPermission($paneluuid, 'panel.edit', $params['locationids'] ?? []);
 
 		if ($paneluuid === 'new') {
 			$paneluuid = Util::randomUuid();
@@ -270,6 +272,9 @@ class Page_LocationInfo extends Page
 		Util::redirect('?do=locationinfo');
 	}
 
+	/**
+	 * @return array{config: array, locationids: array}
+	 */
 	private function preparePanelConfigDefault(): array
 	{
 		// Check locations
@@ -325,6 +330,9 @@ class Page_LocationInfo extends Page
 		return array('config' => $conf, 'locationids' => $locationids);
 	}
 
+	/**
+	 * @return array{config: array, locationids: array}
+	 */
 	private function preparePanelConfigUrl(): array
 	{
 		$bookmarkNames = Request::post('bookmarkNames', [], 'array');
@@ -343,8 +351,8 @@ class Page_LocationInfo extends Page
 			'url' => Request::post('url', 'https://www.bwlehrpool.de/', 'string'),
 			'insecure-ssl' => Request::post('insecure-ssl', 0, 'int'),
 			'reload-minutes' => max(0, Request::post('reloadminutes', 0, 'int')),
-			'whitelist' => preg_replace("/[\r\n]+/ms", "\n", Request::post('whitelist', '', 'string')),
-			'blacklist' => preg_replace("/[\r\n]+/ms", "\n", Request::post('blacklist', '', 'string')),
+			'whitelist' => preg_replace("/[\r\n]+/m", "\n", Request::post('whitelist', '', 'string')),
+			'blacklist' => preg_replace("/[\r\n]+/m", "\n", Request::post('blacklist', '', 'string')),
 			'split-login' => Request::post('split-login', 0, 'bool'),
 			'browser' => Request::post('browser', 'slx-browser', 'string'),
 			'interactive' => Request::post('interactive', '0', 'bool'),
@@ -355,6 +363,9 @@ class Page_LocationInfo extends Page
 		return array('config' => $conf, 'locationids' => []);
 	}
 
+	/**
+	 * @return array{config: array, locationids: array}
+	 */
 	private function preparePanelConfigSummary(): array
 	{
 		// Build json structure
@@ -687,7 +698,7 @@ class Page_LocationInfo extends Page
 				} else {
 					$cred->initForRender();
 				}
-				$cred->title = Dictionary::translateFile('backend-' . $s, $cred->property, true);
+				$cred->title = Dictionary::translateFile('backend-' . $s, $cred->property);
 				$cred->helptext = Dictionary::translateFile('backend-' . $s, $cred->property . "_helptext");
 				$cred->credentialsHtml = Render::parse('server-prop-' . $cred->template, (array)$cred);
 			}
@@ -776,9 +787,9 @@ class Page_LocationInfo extends Page
 		$DAYLIST = array_flip(['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']);
 		$new = [];
 		foreach ($array as $row) {
-			$s = $this->getTime($row['openingtime']);
-			$e = $this->getTime($row['closingtime']);
-			if ($s === false || $e === false || $e <= $s)
+			$s = Page_LocationInfo::getTime($row['openingtime']);
+			$e = Page_LocationInfo::getTime($row['closingtime']);
+			if ($s === null || $e === null || $e <= $s)
 				continue;
 			foreach ($row['days'] as $day) {
 				$day = $DAYLIST[$day] ?? -1;
@@ -833,10 +844,10 @@ class Page_LocationInfo extends Page
 				// Chain
 				$last++;
 			} else {
-				$string = Dictionary::translate($DAYLIST[$first], true);
+				$string = Dictionary::translate($DAYLIST[$first]);
 				if ($first !== $last) {
 					$string .= ($first + 1 === $last ? ",\xe2\x80\x89" : "\xe2\x80\x89-\xe2\x80\x89")
-						. Dictionary::translate($DAYLIST[$last], true);
+						. Dictionary::translate($DAYLIST[$last]);
 				}
 				$output[] = $string;
 				$first = $last = $day;
@@ -1034,7 +1045,7 @@ class Page_LocationInfo extends Page
 			die('Missing parameter uuid');
 		}
 		$type = InfoPanel::getConfig($uuid, $config);
-		if ($type === false) {
+		if ($type === null) {
 			http_response_code(404);
 			die('Panel with given uuid not found');
 		}
@@ -1082,8 +1093,7 @@ class Page_LocationInfo extends Page
 
 	/**
 	 * @param string|array $panelOrUuid UUID of panel, or array with keys paneltype and locationds
-	 * @param string $permission
-	 * @param int[]|null $additionalLocations
+	 * @param int[] $additionalLocations
 	 */
 	private function assertPanelPermission($panelOrUuid, string $permission, array $additionalLocations = null): void
 	{