Funktionen für den Umgang mit der Captive-Portal-Software für offene WLAN-Knoten. Mehr ...

Funktionen
	configure_free_network ()
	Erzeuge das free-Netzwerk-Interface, falls es noch nicht existiert. Mehr ...

	captive_portal_get_or_create_config ()
	Liefere die uci-captive-Portal-Konfigurationssektion zurück. Mehr ...

	get_on_captive_portal_default (key)
	Liefere einen der default-Werte der aktuellen Firmware zurück (Paket on-captive-portal). Mehr ...

	captive_portal_set_property (key, value)
	Setze ein Attribut der Captive-Portal-Funktion. Mehr ...

	captive_portal_get_property (key)
	Hole ein Attribut der Captive-Portal-Funktion. Mehr ...

	_captive_portal_get_mapped_attribute (attribute)
	Liefere den UCI-Attribut-Namen für eine Captive-Portal-Eigenschaft zurück. Mehr ...

	captive_portal_restart ()
	Führe einen Neustart der Captive-Portal-Software mit minimalen Seiteneffekten durch. Mehr ...

	captive_portal_reload ()
	Neukonfiguration der Captive-Portal-Software, falls Änderungen aufgetreten sind. Mehr ...

	captive_portal_has_devices ()
	Prüfe, ob dem Captive Portal mindestens ein physisches Netzwerk-Gerät zugeordnet ist. Mehr ...

	captive_portail_repair_empty_network_bridge ()
	Reduziere Konstruktionen wie beispielsweise "bridge(None, wlan0)" zu "wlan0". Mehr ...

	sync_captive_portal_state_with_mig_connections ()
	Synchronisiere den Zustand (up/down) des free-Interface mit dem des VPN-Tunnel-Interface. Mehr ...

	is_captive_portal_running ()
	Prüfe ob der Captive-Portal-Dienst läuft. Mehr ...

	get_captive_portal_client_count ()
	Ermittle die Anzahl der verbundenen Clients. Mehr ...

	get_captive_portal_clients ()
	Zeilenweise aller aktuellen Clients inklusive ihrer relevanten Kenngrößen. Mehr ...

Ausführliche Beschreibung

Funktionen für den Umgang mit der Captive-Portal-Software für offene WLAN-Knoten.

Dokumentation der Funktionen

_captive_portal_get_mapped_attribute ( attribute )

Liefere den UCI-Attribut-Namen für eine Captive-Portal-Eigenschaft zurück.

Parameter

attribute Eins der Captive-Portal-Attribute: name / url

Dies ist lediglich eine Abstraktionsschicht.

Definiert in Zeile 33 der Datei on-captive-portal.sh.

captive_portail_repair_empty_network_bridge ( )

Reduziere Konstruktionen wie beispielsweise "bridge(None, wlan0)" zu "wlan0".

Brücken mit "none"-Elementen verwirren das nodogsplash-Start-Skript.

Definiert in Zeile 49 der Datei on-captive-portal.sh.

captive_portal_get_or_create_config ( )

Liefere die uci-captive-Portal-Konfigurationssektion zurück.

Typischerweise ist dies so etwas wie nodogsplash.cfgXXXX. Falls die uci-Sektion noch nicht existieren sollte, dann wird sie erzeugt und zurückgeliefert.

Definiert in Zeile 12 der Datei on-captive-portal.sh.

captive_portal_get_property ( key )

Hole ein Attribut der Captive-Portal-Funktion.

Parameter

key	Eins der Captive-Portal-Attribute: name / url

Definiert in Zeile 28 der Datei on-captive-portal.sh.

captive_portal_has_devices ( )

Prüfe, ob dem Captive Portal mindestens ein physisches Netzwerk-Gerät zugeordnet ist.

Sobald ein Netzwerk-Gerät konfiguriert ist, gilt der Captive-Portal-Dienst als aktiv.

Definiert in Zeile 45 der Datei on-captive-portal.sh.

captive_portal_reload ( )

Neukonfiguration der Captive-Portal-Software, falls Änderungen aufgetreten sind.

Bestehende Verbindungen bleiben erhalten.

Definiert in Zeile 41 der Datei on-captive-portal.sh.

captive_portal_restart ( )

Führe einen Neustart der Captive-Portal-Software mit minimalen Seiteneffekten durch.

Aktuelle Verbindungen bleiben nach Möglichkeit erhalten.

Definiert in Zeile 37 der Datei on-captive-portal.sh.

captive_portal_set_property	(	key	,
		value
	)

Setze ein Attribut der Captive-Portal-Funktion.

Parameter

key	Eins der Captive-Portal-Attribute: name / url
value	Der gewünschte neue Inhalt des Attributs

Achtung: Anschließend ist 'apply_changes on-captive-portal' aufzurufen, um die Änderungen wirksam werden zu lassen.

Definiert in Zeile 24 der Datei on-captive-portal.sh.

configure_free_network ( )

Erzeuge das free-Netzwerk-Interface, falls es noch nicht existiert.

Definiert in Zeile 7 der Datei on-captive-portal.sh.

get_captive_portal_client_count ( )

Ermittle die Anzahl der verbundenen Clients.

Definiert in Zeile 60 der Datei on-captive-portal.sh.

get_captive_portal_clients ( )

Zeilenweise aller aktuellen Clients inklusive ihrer relevanten Kenngrößen.

In jeder Zeile wird ein Client beschrieben, wobei die folgenden Detailinformationen durch Tabulatoren getrennt sind:

IP-Adresse
MAC-Adresse
Zeitpunkt des Verbindungsaufbaus (seit epoch)
Zeitpunkt der letzten Aktivität (seit epoch)
Download-Verkehrsvolumen (kByte)
Upload-Verkehrsvolumen (kByte)

Definiert in Zeile 70 der Datei on-captive-portal.sh.

get_on_captive_portal_default ( key )

Liefere einen der default-Werte der aktuellen Firmware zurück (Paket on-captive-portal).

Parameter

key	Name des Schlüssels

Die default-Werte werden nicht von der Konfigurationsverwaltung uci verwaltet. Somit sind nach jedem Upgrade imer die neuesten Standard-Werte verfügbar.

Definiert in Zeile 18 der Datei on-captive-portal.sh.

is_captive_portal_running ( )

Prüfe ob der Captive-Portal-Dienst läuft.

Definiert in Zeile 57 der Datei on-captive-portal.sh.

sync_captive_portal_state_with_mig_connections ( )

Synchronisiere den Zustand (up/down) des free-Interface mit dem des VPN-Tunnel-Interface.

Diese Funktion wird nach Statusänderungen des VPN-Interface, sowie innerhalb eines regelmäßigen cronjobs ausgeführt.

Definiert in Zeile 54 der Datei on-captive-portal.sh.