chore: add value object for thermal zone

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>

Author: kesselb

js/script.js

@@ -293,8 +293,8 @@
 					var data = response.ocs.data;
 					document.getElementById("servertime").innerHTML = data.servertime;
 					document.getElementById("uptime").innerHTML = data.uptime;
-					for (i in data.thermalzones) {
-						document.getElementById(data.thermalzones[i]['hash']).innerHTML = data.thermalzones[i]['temp'];
+					for (const thermalzone of data.thermalzones) {
+						document.getElementById(thermalzone.zone).textContent = thermalzone.temp;
 					}
 				},
 				error: function (data) {

lib/Controller/ApiController.php

@@ -138,12 +138,11 @@ public function info(): DataResponse {
 	public function BasicData(): DataResponse {
 		$servertime = $this->os->getTime();
 		$uptime = $this->formatUptime($this->os->getUptime());
-		$thermalzones = $this->os->getThermalZones();
 
 		return new DataResponse([
 			'servertime' => $servertime,
 			'uptime' => $uptime,
-			'thermalzones' => $thermalzones
+			'thermalzones' => $this->os->getThermalZones()
 		]);
 	}
 

lib/OperatingSystems/IOperatingSystem.php

@@ -29,6 +29,7 @@
 use OCA\ServerInfo\Resources\Disk;
 use OCA\ServerInfo\Resources\Memory;
 use OCA\ServerInfo\Resources\NetInterface;
+use OCA\ServerInfo\Resources\ThermalZone;
 
 interface IOperatingSystem {
 	public function supported(): bool;
@@ -86,13 +87,7 @@ public function getUptime(): int;
 	/**
 	 * Get info about available thermal zones.
 	 *
-	 * [
-	 *       [
-	 *             'hash' => string,
-	 *             'type' => string,
-	 *             'temp' => float,
-	 *       ],
-	 * ]
+	 * @return ThermalZone[]
 	 */
 	public function getThermalZones(): array;
 }

lib/OperatingSystems/Linux.php

@@ -26,6 +26,7 @@
 use OCA\ServerInfo\Resources\Disk;
 use OCA\ServerInfo\Resources\Memory;
 use OCA\ServerInfo\Resources\NetInterface;
+use OCA\ServerInfo\Resources\ThermalZone;
 use RuntimeException;
 
 class Linux implements IOperatingSystem {
@@ -229,22 +230,24 @@ public function getDiskInfo(): array {
 	}
 
 	public function getThermalZones(): array {
-		$thermalZones = glob('/sys/class/thermal/thermal_zone*') ?: [];
-		$result = [];
+		$data = [];
+
+		$zones = glob('/sys/class/thermal/thermal_zone*');
+		if ($zones === false) {
+			return $data;
+		}
 
-		foreach ($thermalZones as $thermalZone) {
-			$tzone = [];
+		foreach ($zones as $zone) {
 			try {
-				$tzone['hash'] = md5($thermalZone);
-				$tzone['type'] = $this->readContent($thermalZone . '/type');
-				$tzone['temp'] = (float)((int)($this->readContent($thermalZone . '/temp')) / 1000);
-			} catch (RuntimeException $e) {
-				continue;
+				$type = $this->readContent($zone . '/type');
+				$temp = (float)((int)($this->readContent($zone . '/temp')) / 1000);
+				$data[] = new ThermalZone(md5($zone), $type, $temp);
+			} catch (RuntimeException) {
+				// unable to read thermal zone
 			}
-			$result[] = $tzone;
 		}
 
-		return $result;
+		return $data;
 	}
 
 	/**

lib/Resources/ThermalZone.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2023 Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * @author Daniel Kesselberg <mail@danielkesselberg.de>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\ServerInfo\Resources;
+
+class ThermalZone implements \JsonSerializable {
+	public function __construct(
+		private string $zone,
+		private string $type,
+		private float  $temp) {
+	}
+
+	public function getZone(): string {
+		return $this->zone;
+	}
+
+	public function getType(): string {
+		return $this->type;
+	}
+
+	public function getTemp(): float {
+		return $this->temp;
+	}
+
+	public function jsonSerialize(): array {
+		return [
+			'zone' => $this->zone,
+			'type' => $this->type,
+			'temp' => $this->temp,
+		];
+	}
+}

templates/settings-admin.php

@@ -25,6 +25,7 @@
 use OCA\ServerInfo\Resources\Disk;
 use OCA\ServerInfo\Resources\Memory;
 use OCA\ServerInfo\Resources\NetInterface;
+use OCA\ServerInfo\Resources\ThermalZone;
 use OCP\Util;
 
 script('serverinfo', 'script');
@@ -51,6 +52,8 @@ function FormatMegabytes(int $byte): string {
 $disks = $_['diskinfo'];
 /** @var NetInterface[] $interfaces */
 $interfaces = $_['networkinterfaces'];
+/** @var ThermalZone[] $thermalZones */
+$thermalZones = $_['thermalzones'];
 /** @var bool $phpinfo */
 $phpinfo = $_['phpinfo'];
 
@@ -80,6 +83,7 @@ function FormatMegabytes(int $byte): string {
 				<p><?php p($l->t('Uptime:')); ?> <strong id="numFilesStorage"><span class="info" id="uptime"></span></strong></p>
 			</div>
 
+			<?php if (count($thermalZones) > 0): ?>
 			<div class="col col-6 col-l-12">
 				<h2>
 					<img class="infoicon" src="<?php p(image_path('serverinfo', 'app-dark.svg')); ?>">
@@ -90,16 +94,17 @@ function FormatMegabytes(int $byte): string {
 						<thead>
 						</thead>
 						<tbody>
-						<?php foreach ($_['thermalzones'] as $thermalzone): ?>
+						<?php foreach ($thermalZones as $thermalZone): ?>
 						<tr>
-							<td><?php p($thermalzone['type'] . ':') ?></td>
-							<td><span class="info" id="<?php p($thermalzone['hash']) ?>"></span>°C</td>
+							<td><?php p($thermalZone->getType()) ?>:</td>
+							<td>&nbsp;<span class="info" id="<?php p($thermalZone->getZone()) ?>"><?php p($thermalZone->getTemp()) ?></span>°C</td>
 						</tr>
 						<?php endforeach; ?>
 						</tbody>
 					</table>
 				</div>
 			</div>
+			<?php endif; ?>
 		</div>
 	</div>