Unifi-Voucher-Tool/includes/UniFiController.php
Friederich Loheide a36dcbba27
All checks were successful
CI / PHP Lint (push) Successful in 37s
CI / PHP Lint-1 (push) Successful in 53s
CI / Unit Tests & Static Analysis (push) Successful in 40s
CI / PHP Lint (pull_request) Successful in 39s
CI / PHP Lint-1 (pull_request) Successful in 44s
CI / Unit Tests & Static Analysis (pull_request) Successful in 44s
Tests für Anmeldung und Controller, PHP 8.1, Sprach-Fallback
Bisher deckten die Tests nur Hilfsklassen ab. Neu sind die beiden
Stellen, an denen ein Fehler richtig weh tut:

- AuthTest (12 Fälle): richtige und falsche Anmeldung, Rate-Limit greift
  vor der Passwortprüfung, 2FA-Nutzer gilt vor dem Code ausdrücklich
  nicht als angemeldet, CSRF-Prüfung, und die Client-IP hinter einem
  Proxy – inklusive der Fälle, in denen X-Forwarded-For ignoriert werden
  muss
- UniFiControllerTest (8 Fälle): die Auswahl des eigenen Vouchers. Der
  Controller liefert Voucher unsortiert; wer den ersten nimmt, gibt bei
  parallelen Anfragen den Code eines anderen Gastes aus. Dazu QoS-Payload
  und die Fehlerfälle.

Dafür nötig: Auth nimmt die Datenbank optional über den Konstruktor
entgegen (ohne Argument unverändert), und UniFiController::apiRequest()
ist protected statt private, damit Tests aufgezeichnete Antworten
einspielen können. Beide Tests brauchen weder Datenbank noch Netz.

PHP-Anforderung von 7.4 auf 8.1 gehoben: Composer, CI-Matrix (8.1/8.3),
Docker-Image (8.3) und README. Die 7.4-Angabe war ohnehin ungeprüft.

I18n: fehlt ein Schlüssel in der gewählten Sprache, erscheint jetzt der
deutsche Text statt des technischen Schlüssels.

PHPStan deckt zusätzlich VoucherService und I18n ab.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-24 11:13:01 +00:00

453 lines
No EOL
16 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?php
require_once __DIR__ . '/Crypto.php';
class UniFiController {
private $controllerUrl;
private $username;
private $password;
private $siteId;
private $cookieFile;
private $csrfToken = null;
private $sessionCookie = null;
private $loggedIn = false;
public function __construct($controllerUrl, $username, $password, $siteId) {
$this->controllerUrl = rtrim($controllerUrl, '/');
$this->username = $username;
$this->password = $password;
$this->siteId = $siteId;
$this->cookieFile = tempnam(sys_get_temp_dir(), 'UNIFI_');
}
public function __destruct() {
if (file_exists($this->cookieFile)) {
unlink($this->cookieFile);
}
}
// Login zum Controller
private function login() {
if ($this->loggedIn) {
return true;
}
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => $this->controllerUrl . "/api/auth/login",
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode([
'username' => $this->username,
'password' => $this->password
]),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_COOKIEJAR => $this->cookieFile,
CURLOPT_COOKIEFILE => $this->cookieFile,
CURLOPT_TIMEOUT => 10,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'Origin: ' . $this->controllerUrl,
'Referer: ' . $this->controllerUrl . '/login',
],
CURLOPT_HEADERFUNCTION => function($ch, $header) {
$parts = explode(':', $header, 2);
if (count($parts) === 2) {
$name = strtolower(trim($parts[0]));
$value = trim($parts[1]);
if ($name === 'x-csrf-token') {
$this->csrfToken = $value;
} elseif ($name === 'set-cookie') {
// Extract TOKEN value directly — cookie jar may not persist
// cookies with the 'Partitioned' attribute on some libcurl versions
$cookieParts = explode(';', $value);
$first = trim($cookieParts[0]);
if (strpos($first, 'TOKEN=') === 0) {
$this->sessionCookie = $first;
}
}
}
return strlen($header);
}
]);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
if ($httpCode !== 200) {
$body = json_decode($response, true);
$detail = $body['meta']['msg'] ?? $body['errors'][0] ?? substr(strip_tags($response), 0, 120);
throw new Exception("Login fehlgeschlagen: HTTP $httpCode" . ($detail ? " – $detail" : ''));
}
$data = json_decode($response, true);
// Expliziter Fehler vom Controller abfangen (meta.rc = error)
if (isset($data['meta']['rc']) && $data['meta']['rc'] !== 'ok') {
$msg = $data['meta']['msg'] ?? 'Zugangsdaten abgelehnt';
throw new Exception("Login fehlgeschlagen: $msg");
}
// HTTP 200 ohne expliziten Fehler = Erfolg
// UniFi OS liefert X-CSRF-Token im Response-Header (bereits via CURLOPT_HEADERFUNCTION extrahiert)
// Fallback: TOKEN-Cookie aus der Cookie-Datei lesen
if ($this->csrfToken === null) {
$this->csrfToken = $this->readCsrfFromCookieFile();
}
$this->loggedIn = true;
return true;
}
// API-Request ausführen
/**
* Ein Aufruf gegen die Controller-API.
*
* `protected`, damit Tests die Antworten des Controllers einspielen
* koennen, ohne dass ein echter Controller erreichbar sein muss.
*/
protected function apiRequest($endpoint, $data = null, $method = 'POST') {
$this->login();
$ch = curl_init();
$url = $this->controllerUrl . $endpoint;
$headers = ['Content-Type: application/json'];
if ($method !== 'GET' && $this->csrfToken !== null) {
$headers[] = 'X-CSRF-Token: ' . $this->csrfToken;
}
$options = [
CURLOPT_URL => $url,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_TIMEOUT => 10,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_HTTPHEADER => $headers
];
// Prefer manually extracted cookie over file-based jar — the Partitioned
// attribute on the TOKEN cookie prevents some libcurl versions from writing it
if ($this->sessionCookie !== null) {
$options[CURLOPT_COOKIE] = $this->sessionCookie;
} else {
$options[CURLOPT_COOKIEFILE] = $this->cookieFile;
}
if ($method === 'GET') {
$options[CURLOPT_HTTPGET] = true;
} elseif ($method === 'POST') {
$options[CURLOPT_POST] = true;
$options[CURLOPT_POSTFIELDS] = json_encode($data ?? (object)[]);
}
curl_setopt_array($ch, $options);
$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$error = curl_error($ch);
curl_close($ch);
if ($error) {
throw new Exception("cURL Fehler: $error");
}
if ($httpCode !== 200) {
throw new Exception("API Request fehlgeschlagen: HTTP $httpCode");
}
return json_decode($response, true);
}
// Voucher erstellen
// $options: optionale QoS-Limits ['down' => kbps, 'up' => kbps, 'quota_mb' => MB]
public function createVoucher($voucherName, $maxUses, $expireMinutes = 480, $options = []) {
$data = [
'cmd' => 'create-voucher',
'expire' => (int)$expireMinutes,
'n' => 1,
'note' => $voucherName,
'quota' => (int)$maxUses
];
// Bandbreiten-/Datenlimits (UniFi QoS) optional setzen
$down = isset($options['down']) ? (int)$options['down'] : 0;
$up = isset($options['up']) ? (int)$options['up'] : 0;
$bytes = isset($options['quota_mb']) ? (int)$options['quota_mb'] : 0;
if ($down > 0 || $up > 0 || $bytes > 0) {
$data['qos_overwrite'] = true;
if ($down > 0) $data['down'] = $down; // kbit/s
if ($up > 0) $data['up'] = $up; // kbit/s
if ($bytes > 0) $data['bytes'] = $bytes; // Megabyte
}
$response = $this->apiRequest("/proxy/network/api/s/{$this->siteId}/cmd/hotspot", $data);
if (!isset($response['data'][0]['create_time'])) {
throw new Exception("Voucher konnte nicht erstellt werden");
}
// Voucher-Code abrufen. WICHTIG: getVouchers() liefert die Voucher
// unsortiert zurueck – ein blindes reset() kann bei parallelen
// Erstellungen den falschen (fremden) Code liefern. Daher gezielt
// nach dem soeben erstellten Voucher suchen: gleiche note + neueste
// create_time.
$vouchers = $this->getVouchers();
if (empty($vouchers)) {
throw new Exception("Voucher-Code konnte nicht abgerufen werden");
}
$latestVoucher = null;
foreach ($vouchers as $voucher) {
// Nur Voucher mit passender Notiz beruecksichtigen
if (($voucher['note'] ?? null) !== $voucherName) {
continue;
}
if ($latestVoucher === null
|| ($voucher['create_time'] ?? 0) > ($latestVoucher['create_time'] ?? 0)) {
$latestVoucher = $voucher;
}
}
// Fallback: falls keine note-Uebereinstimmung (z.B. Sonderzeichen),
// den global neuesten Voucher nehmen.
if ($latestVoucher === null) {
foreach ($vouchers as $voucher) {
if ($latestVoucher === null
|| ($voucher['create_time'] ?? 0) > ($latestVoucher['create_time'] ?? 0)) {
$latestVoucher = $voucher;
}
}
}
if ($latestVoucher === null || empty($latestVoucher['code'])) {
throw new Exception("Voucher-Code konnte nicht abgerufen werden");
}
return [
'code' => $latestVoucher['code'],
'formatted_code' => $this->formatVoucherCode($latestVoucher['code']),
'unifi_id' => $latestVoucher['_id'] ?? null,
'create_time' => $latestVoucher['create_time'] ?? null
];
}
// Alle Voucher abrufen
public function getVouchers() {
$response = $this->apiRequest("/proxy/network/api/s/{$this->siteId}/stat/voucher", null, 'GET');
return $response['data'] ?? [];
}
// Voucher mit formatierten Details abrufen
public function getVouchersWithDetails() {
$vouchers = $this->getVouchers();
$result = [];
foreach ($vouchers as $voucher) {
$createTime = isset($voucher['create_time']) ? $voucher['create_time'] : 0;
$duration = isset($voucher['duration']) ? $voucher['duration'] : 0; // in Minuten
$expireTime = $createTime + ($duration * 60);
$now = time();
// Status bestimmen
$status = 'valid';
$usedCount = isset($voucher['used']) ? $voucher['used'] : 0;
$quota = isset($voucher['quota']) ? $voucher['quota'] : 0;
if ($now > $expireTime) {
$status = 'expired';
} elseif ($quota > 0 && $usedCount >= $quota) {
$status = 'used';
}
$result[] = [
'_id' => $voucher['_id'] ?? '',
'code' => $voucher['code'] ?? '',
'formatted_code' => $this->formatVoucherCode($voucher['code'] ?? ''),
'note' => $voucher['note'] ?? '',
'quota' => $quota,
'used' => $usedCount,
'duration' => $duration,
'create_time' => $createTime,
'expire_time' => $expireTime,
'status' => $status,
'status_expires' => isset($voucher['status_expires']) ? $voucher['status_expires'] : null,
'for_hotspot' => isset($voucher['for_hotspot']) ? $voucher['for_hotspot'] : false,
'qos_overwrite' => isset($voucher['qos_overwrite']) ? $voucher['qos_overwrite'] : false,
'qos_usage_quota' => isset($voucher['qos_usage_quota']) ? $voucher['qos_usage_quota'] : null,
'qos_rate_max_up' => isset($voucher['qos_rate_max_up']) ? $voucher['qos_rate_max_up'] : null,
'qos_rate_max_down' => isset($voucher['qos_rate_max_down']) ? $voucher['qos_rate_max_down'] : null
];
}
// Nach Erstellungsdatum sortieren (neueste zuerst)
usort($result, function($a, $b) {
return $b['create_time'] - $a['create_time'];
});
return $result;
}
// CSRF-Token aus Netscape-Cookie-Datei lesen (Fallback wenn Header nicht gesetzt)
private function readCsrfFromCookieFile() {
if (!file_exists($this->cookieFile)) {
return null;
}
foreach (file($this->cookieFile) as $line) {
$line = trim($line);
if ($line === '' || $line[0] === '#') continue;
$parts = explode("\t", $line);
if (count($parts) >= 7 && strtoupper($parts[5]) === 'TOKEN') {
return $parts[6];
}
}
return null;
}
// Voucher-Code formatieren (xxxxx-xxxxx-xxxxx)
private function formatVoucherCode($code) {
$chunks = str_split($code, 5);
return implode('-', $chunks);
}
// Voucher löschen
public function deleteVoucher($voucherId) {
$data = [
'cmd' => 'delete-voucher',
'_id' => $voucherId
];
$response = $this->apiRequest("/proxy/network/api/s/{$this->siteId}/cmd/hotspot", $data);
return isset($response['meta']['rc']) && $response['meta']['rc'] === 'ok';
}
// Verbindung testen
public static function testConnection($controllerUrl, $username, $password, $siteId) {
try {
$controller = new self($controllerUrl, $username, $password, $siteId);
$controller->login();
return true;
} catch (Exception $e) {
return $e->getMessage();
}
}
/**
* Synchronisiert alle Voucher vom UniFi Controller in die Datenbank
* @param Database $db Datenbank-Instanz
* @param int $dbSiteId Die Site-ID in der lokalen Datenbank
* @return array Statistiken über die Synchronisation
*/
public function syncVouchersToDatabase($db, $dbSiteId) {
$vouchers = $this->getVouchersWithDetails();
$stats = [
'total' => count($vouchers),
'new' => 0,
'updated' => 0,
'deleted' => 0,
'valid' => 0,
'used' => 0,
'expired' => 0
];
// Alle aktuellen UniFi-IDs sammeln
$unifiIds = [];
foreach ($vouchers as $voucher) {
$unifiIds[] = $voucher['_id'];
// Status zählen
$stats[$voucher['status']]++;
// Prüfen ob Voucher bereits existiert
$existing = $db->fetchOne(
"SELECT id, status, used_count FROM vouchers WHERE unifi_voucher_id = ? AND site_id = ?",
[$voucher['_id'], $dbSiteId]
);
$expiresAt = date('Y-m-d H:i:s', $voucher['expire_time']);
$createdAt = date('Y-m-d H:i:s', $voucher['create_time']);
if ($existing) {
// Voucher aktualisieren
$db->execute(
"UPDATE vouchers SET
status = ?,
used_count = ?,
expires_at = ?,
last_sync = NOW()
WHERE id = ?",
[$voucher['status'], $voucher['used'], $expiresAt, $existing['id']]
);
$stats['updated']++;
} else {
// Neuen Voucher einfügen
$db->execute(
"INSERT INTO vouchers
(site_id, voucher_code, voucher_name, max_uses, expire_minutes,
unifi_voucher_id, status, used_count, expires_at, created_at,
synced_from_unifi, last_sync)
VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, 1, NOW())",
[
$dbSiteId,
$voucher['formatted_code'],
$voucher['note'] ?: 'Importiert aus UniFi',
$voucher['quota'],
$voucher['duration'],
$voucher['_id'],
$voucher['status'],
$voucher['used'],
$expiresAt,
$createdAt
]
);
$stats['new']++;
}
}
// Voucher die nicht mehr im Controller existieren als gelöscht markieren
if (!empty($unifiIds)) {
$placeholders = implode(',', array_fill(0, count($unifiIds), '?'));
$params = array_merge($unifiIds, [$dbSiteId]);
// Alle Voucher mit UniFi-ID die nicht mehr existieren auf "expired" setzen
$deleted = $db->execute(
"UPDATE vouchers SET status = 'expired', last_sync = NOW()
WHERE unifi_voucher_id IS NOT NULL
AND unifi_voucher_id NOT IN ($placeholders)
AND site_id = ?
AND status != 'expired'",
$params
);
$stats['deleted'] = $deleted;
}
return $stats;
}
/**
* Holt Live-Statistiken für das Dashboard
* @return array
*/
public function getLiveStats() {
$vouchers = $this->getVouchersWithDetails();
$stats = [
'total' => count($vouchers),
'valid' => 0,
'used' => 0,
'expired' => 0,
'vouchers' => $vouchers
];
foreach ($vouchers as $voucher) {
$stats[$voucher['status']]++;
}
return $stats;
}
}