Zum Inhalt springen

Extension:APData: Unterschied zwischen den Versionen

Aus Opennet
← Zum vorherigen Versionsunterschied
Inhalt gelöscht Inhalt hinzugefügt
VisuellWikitext
Ap46rene (Diskussion | Beiträge)
Bürokraten, restrict, Administratoren, viewrestrict
808 Bearbeitungen
Keine Bearbeitungszusammenfassung
Ap46rene (Diskussion | Beiträge)
Bürokraten, restrict, Administratoren, viewrestrict
808 Bearbeitungen
Keine Bearbeitungszusammenfassung
 
(10 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
= proof of concept =
= proof of concept =
hier wird noch dran gearbeitet, mal schauen was draus wird.
hier wird noch dran gearbeitet, mal schauen was draus wird.

Und nun Version 0.2, das ganze als dynamische Funktion. So lässt sich das auch in die Vorlagen einbinden.
== Erweiterung ==
== Erweiterung ==


Die Erweiterung APData greift auf eine Datanbank zu, die Daten aller AccessPoints des Opennets enthält. Zur Zeit stehen nur Daten der APs mit alter Firmware zur Verfügung. Ausserdem wurden persönliche Daten wie Email, Telefon und Ort entfernt, da diese Seiten bisher nicht ausserhalb vom Opennet zugänglich waren. Und vielleicht sollte es auch so bleiben. Die Datenbank wird zur ZEit nicht aktualisiert, aber ist ja auch ok so für nen Test.
Die Erweiterung APData greift auf eine Datanbank zu, die Daten aller AccessPoints des Opennets enthält. Zur Zeit stehen nur Daten der APs mit alter Firmware zur Verfügung. Ausserdem wurden persönliche Daten wie Email, Telefon und Ort entfernt, da diese Seiten bisher nicht ausserhalb vom Opennet zugänglich waren. Und vielleicht sollte es auch so bleiben. Die Datenbank wird zur Zeit nicht aktualisiert, aber ist ja auch ok so für nen Test.


Die notwendigen Dateien liegen auf www.on-i.de unter on-v6:/var/www/mediawiki-1.16.5/extensions/APData
Die notwendigen Dateien liegen auf www.on-i.de unter on-v6:/var/www/mediawiki-1.16.5/extensions/APData
Zeile 9: Zeile 11:
* [https://wiki.opennet-initiative.de/extensions/APData/APData.php APData.php] - die eigentliche Erweiterung, sucht nach dem entsprechenden Eintrag für die angegebene ID und reicht alle Werte weiter an ein Template
* [https://wiki.opennet-initiative.de/extensions/APData/APData.php APData.php] - die eigentliche Erweiterung, sucht nach dem entsprechenden Eintrag für die angegebene ID und reicht alle Werte weiter an ein Template
* [https://wiki.opennet-initiative.de/extensions/APData/database database] - die Datenbank, zur Zeit mit im Verzeichnis der Erweiterung (hardcoded in APData.php). Es handelt sich um eine SQlite3-Datenbank, eine Tabelle für die AP-Config und eine für die aktuellen Daten aller Interfaces.
* [https://wiki.opennet-initiative.de/extensions/APData/database database] - die Datenbank, zur Zeit mit im Verzeichnis der Erweiterung (hardcoded in APData.php). Es handelt sich um eine SQlite3-Datenbank, eine Tabelle für die AP-Config und eine für die aktuellen Daten aller Interfaces.
* [https://wiki.opennet-initiative.de/extensions/APData/get_ap_data.py get_ap_data.py] - python-script zur Erstellung der Datenbank und zum parsen der Verfügbaren Werte aller APs mit alter Openet-Firmware
* [https://wiki.opennet-initiative.de/extensions/APData/get_ap_data.py get_ap_data.py] - python-script zur Erstellung der Datenbank und zum parsen der verfügbaren Werte aller APs mit alter Openet-Firmware


=== Nutzung der Erweiterung ===
=== Nutzung der Erweiterung ===
Folgende Funtionen stehen zur Verfügung:
Zur Einbindng in den Code einfach
# OnApDataQuery - bekommt als Parameter die Opennet-ID und muss als erstes aufgerufen werden
<pre><apdata id="1.48" template="Accesspoint"></pre>
# OnApDataGetValue - bekommt als Parameter den Namen des gesuchten Wertes (Kopf der Nodes-Spalte)
Die übergebene id wird gegen die Datenbankspalte "id" geparst, alle Werte werden dem Template "template" übergeben. Weitere Werte können direkt übergeben werden:
# OnApDataGetIfacesRow - liefert die ZeilenNummer der Interfaces-Tabelle für die angefragte ID
<pre><apdata id="1.48" template="Accesspoint" nachname="Mustermann"></pre>
# OnApDataNextIfacesRow - setzt den internen Zeiger auf die nächste Interfaces-Zeile und gibt die Nummer zurück, wenn noch vorhanden
# OnApDataGetIfacesValue - bekommt als Parameter den Namen des gesuchten Wertes (Kopf der Ifaces-Spalte) und liefert den Wert für die ausgewählte Zeile zurück
# OnApDataSQLQuery - bekommt als Parameter eine komplette SQL-Anfrage (vgl. auch [[Ondataservice#Tabellen-Übersicht]])
# OnApDataGetSQLQueryValue - liefert die ZeilenNummer der Ergebnis-Tabelle für die SQL-Anfrage
# OnApDataNextSQLQueryRow- setzt den internen Zeiger auf die nächste Interfaces-Zeile und gibt die Nummer zurück, wenn noch vorhanden
# OnApDataGetSQLQueryRow - bekommt als Parameter den Namen des gesuchten Wertes und liefert den Wert für die ausgewählte Zeile zurück


=== Erstellung/Aktualiserung der Datenbank ===
=== Erstellung/Aktualiserung der Datenbank ===
Die Verbreitung der Daten im Opennet erfolgt durch das olsr-plugin [[ondataservice]]. Daten der AccessPoints mit alter Firmware werden durch ein script "get_ap_data.py" gelesen, welches täglich auf inez.on-i.de läuft und ebenso per olsr verbreitet.
das script "get_ap_data.py" erwartet zwei Parameter. Als erstes den Pfad einer vorhandenen oder zu erstellenden Datanbank. Als zweites die Liste der zu prüfenden IP-Adressen, bspw. die Ausgabe von "ip route" mit jeweils der zu prüfenden IP am Anfang jeder Zeile.


=== praktische Beispiele ===
=== praktische Beispiele ===
(anzuschauen im Quellcode)
(anzuschauen im Quellcode)
==== normaler Aufruf für Accesspoint-Template ====
==== normaler Aufruf ====
<pre>{{#OnApDataQuery:2.19}}
<pre><apdata id="1.48" template="Accesspoint" /></pre>
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
<apdata id="1.48" template="Accesspoint" />
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br />
==== normaler Aufruf für angepasstes Accesspoint-Template ====
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br />
<pre><apdata id="1.48" template="AccesspointRene" /></pre>
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br /></pre>
<apdata id="1.48" template="AccesspointRene" />
==== Aufruf für Accesspoint-Template mit Variablen-Überschreibung ====
{{#OnApDataQuery:2.19}}
<pre><apdata id="1.48" template="Accesspoint" nummer="1.48" typ="Linksys" besitzer="Max" betreuer="Anja" email="user@home.de" kommentar="Vereins-AP" /></pre>
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
<apdata id="1.48" template="Accesspoint" nummer="1.48" typ="Linksys" besitzer="Max" betreuer="Anja" email="user@home.de" kommentar="Vereins-AP" />
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
==== Anzeige aller vorhandenen Daten ====
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
<pre><apdata id="1.48" /></pre>
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
<apdata id="1.48" />
==== Aufruf mit Nutzung der Loops-Erweiterung ====
Die OnData-Erweiterung ist für die gemeinsame Nutzung mit der [http://www.mediawiki.org/wiki/Extension:Loops Loops-Erweiterung] optimiert.
<pre>{{#OnApDataQuery:2.19}}
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{#OnApDataGetIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
}}</pre>
{{#OnApDataQuery:2.19}}
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{#OnApDataGetIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
}}

==== Aufruf mit angepassten Templates ====
Na und so könnte der Aufruf dann später mit angepassten Templates (siehe [[Vorlage:AccesspointRene]] und [[Vorlage:AccesspointIfacesRene]] aussehen (das zweite Template bekommt die Zeile als Parameter, da es so jedesmal neu gerendert wird:
<pre>{{#OnApDataQuery:2.19}}
{{AccesspointRene}}
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{AccesspointIfacesRene|row={{#OnApDataGetIfacesRow:}}}}
}}</pre>
{{#OnApDataQuery:2.19}}
{{AccesspointRene}}
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{AccesspointIfacesRene|row={{#OnApDataGetIfacesRow:}}}}
}}

==== Überblick über aktuell gespeicherte Werte ====
(Beispiel einer SQL-Abfrage auf die gesamte Datenbank)
<pre>
{| {{Prettytable}}
!Opennet ID
!Quell-IP
!Datenherkunft
!letzte Aktualisierung
|-
{{#OnApDataSQLQuery:SELECT mainip.originator,on_id,db_time FROM nodes ORDER BY mainip ASC}}
{{#while:
|{{#OnApDataNextSQLQueryRow:}}
|{{AccesspointOverview|row={{#OnApDataGetSQLQueryRow:}}}}
}}
|}
</pre>

{| {{Prettytable}}
!Opennet ID
!Quell-IP
!Datenherkunft
!letzte Aktualisierung
|-
{{#OnApDataSQLQuery:SELECT mainip,originator,on_id,db_time FROM nodes ORDER BY mainip ASC}}
{{#while:
|{{#OnApDataNextSQLQueryRow:}}
|{{AccesspointOverview|row={{#OnApDataGetSQLQueryRow:}}}}
}}
|}

Aktuelle Version vom 5. November 2013, 16:58 Uhr

proof of concept

hier wird noch dran gearbeitet, mal schauen was draus wird.

Und nun Version 0.2, das ganze als dynamische Funktion. So lässt sich das auch in die Vorlagen einbinden.

Erweiterung

Die Erweiterung APData greift auf eine Datanbank zu, die Daten aller AccessPoints des Opennets enthält. Zur Zeit stehen nur Daten der APs mit alter Firmware zur Verfügung. Ausserdem wurden persönliche Daten wie Email, Telefon und Ort entfernt, da diese Seiten bisher nicht ausserhalb vom Opennet zugänglich waren. Und vielleicht sollte es auch so bleiben. Die Datenbank wird zur Zeit nicht aktualisiert, aber ist ja auch ok so für nen Test.

Die notwendigen Dateien liegen auf www.on-i.de unter on-v6:/var/www/mediawiki-1.16.5/extensions/APData

  • APData.php - die eigentliche Erweiterung, sucht nach dem entsprechenden Eintrag für die angegebene ID und reicht alle Werte weiter an ein Template
  • database - die Datenbank, zur Zeit mit im Verzeichnis der Erweiterung (hardcoded in APData.php). Es handelt sich um eine SQlite3-Datenbank, eine Tabelle für die AP-Config und eine für die aktuellen Daten aller Interfaces.
  • get_ap_data.py - python-script zur Erstellung der Datenbank und zum parsen der verfügbaren Werte aller APs mit alter Openet-Firmware

Nutzung der Erweiterung

Folgende Funtionen stehen zur Verfügung:

  1. OnApDataQuery - bekommt als Parameter die Opennet-ID und muss als erstes aufgerufen werden
  2. OnApDataGetValue - bekommt als Parameter den Namen des gesuchten Wertes (Kopf der Nodes-Spalte)
  3. OnApDataGetIfacesRow - liefert die ZeilenNummer der Interfaces-Tabelle für die angefragte ID
  4. OnApDataNextIfacesRow - setzt den internen Zeiger auf die nächste Interfaces-Zeile und gibt die Nummer zurück, wenn noch vorhanden
  5. OnApDataGetIfacesValue - bekommt als Parameter den Namen des gesuchten Wertes (Kopf der Ifaces-Spalte) und liefert den Wert für die ausgewählte Zeile zurück
  6. OnApDataSQLQuery - bekommt als Parameter eine komplette SQL-Anfrage (vgl. auch Ondataservice#Tabellen-Übersicht)
  7. OnApDataGetSQLQueryValue - liefert die ZeilenNummer der Ergebnis-Tabelle für die SQL-Anfrage
  8. OnApDataNextSQLQueryRow- setzt den internen Zeiger auf die nächste Interfaces-Zeile und gibt die Nummer zurück, wenn noch vorhanden
  9. OnApDataGetSQLQueryRow - bekommt als Parameter den Namen des gesuchten Wertes und liefert den Wert für die ausgewählte Zeile zurück

Erstellung/Aktualiserung der Datenbank

Die Verbreitung der Daten im Opennet erfolgt durch das olsr-plugin ondataservice. Daten der AccessPoints mit alter Firmware werden durch ein script "get_ap_data.py" gelesen, welches täglich auf inez.on-i.de läuft und ebenso per olsr verbreitet.

praktische Beispiele

(anzuschauen im Quellcode)

normaler Aufruf

{{#OnApDataQuery:2.19}}
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br />
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br />
{{#OnApDataNextIfacesRow:}}. IP-Addresse: {{#OnApDataGetIfacesValue:ip_addr}}<br />

{{#OnApDataQuery:2.19}} IP-Addresse:{{#OnApDataGetValue:mainip}}
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}
{{#OnApDataNextIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}

Aufruf mit Nutzung der Loops-Erweiterung

Die OnData-Erweiterung ist für die gemeinsame Nutzung mit der Loops-Erweiterung optimiert. 

{{#OnApDataQuery:2.19}}
IP-Addresse:{{#OnApDataGetValue:mainip}}<br />
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{#OnApDataGetIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}<br />
}}

{{#OnApDataQuery:2.19}} IP-Addresse:{{#OnApDataGetValue:mainip}}
{{#while: |{{#OnApDataNextIfacesRow:}} |{{#OnApDataGetIfacesRow:}}. Interface: {{#OnApDataGetIfacesValue:ip_addr}}
}}

Aufruf mit angepassten Templates

Na und so könnte der Aufruf dann später mit angepassten Templates (siehe Vorlage:AccesspointRene und Vorlage:AccesspointIfacesRene aussehen (das zweite Template bekommt die Zeile als Parameter, da es so jedesmal neu gerendert wird: 

{{#OnApDataQuery:2.19}}
{{AccesspointRene}}
{{#while:
|{{#OnApDataNextIfacesRow:}}
|<nowiki/>{{AccesspointIfacesRene|row={{#OnApDataGetIfacesRow:}}}}
}}

{{#OnApDataQuery:2.19}}

http://wiki.opennet-initiative.de/ap_button_{{#OnApDataGetValue:on_id}}.png
opennet ID / OLSR Main IP {{#OnApDataGetValue:on_id}} / {{#OnApDataGetValue:mainip}}
Typ / Hersteller {{#OnApDataGetValue:sys_board}}
Firmware {{#OnApDataGetValue:sys_os_type}} {{#OnApDataGetValue:sys_os_name}} {{#OnApDataGetValue:sys_os_ver}} / {{#OnApDataGetValue:on_core_ver}}
VPN-Gateway {{#OnApDataGetValue:on_vpn_gw}}|nicht aktiv}}
verbundene Usergateways {{#OnApDataGetValue:on_ugws}}|nicht aktiv}}
Wifidog-ID {{#OnApDataGetValue:on_wifidog_id}}|nicht aktiv}}
uptime / load / mem / free {{#OnApDataGetValue:sys_uptime}} / {{#OnApDataGetValue:sys_load}}/ {{#OnApDataGetValue:sys_mem}}/ {{#OnApDataGetValue:sys_free}}
letzte Aktualisierung {{#OnApDataGetValue:db_time}}

{{#while: |{{#OnApDataNextIfacesRow:}} |

Interface {{#OnApDataGetIfacesValue:if_name}} / {{#OnApDataGetIfacesValue:if_label}}
IP-Addresse / Netzmaske {{#OnApDataGetIfacesValue:ip_addr}} / {{#OnApDataGetIfacesValue:ip_broadcast}}
MAC-Adresse {{#OnApDataGetIfacesValue:if_hwaddr}}
TX-Bytes/ RX-Bytes {{#OnApDataGetIfacesValue:ifstat_tx_bytes}} / {{#OnApDataGetIfacesValue:ifstat_rx_bytes}}
WLAN-SSID/ WLAN-Channel {{#OnApDataGetIfacesValue:wlan_essid}} / {{#OnApDataGetIfacesValue:wlan_channel}}

}}

Überblick über aktuell gespeicherte Werte

(Beispiel einer SQL-Abfrage auf die gesamte Datenbank) 

{| {{Prettytable}}
!Opennet ID
!Quell-IP
!Datenherkunft
!letzte Aktualisierung
|-
{{#OnApDataSQLQuery:SELECT mainip.originator,on_id,db_time FROM nodes ORDER BY mainip ASC}}
{{#while:
|{{#OnApDataNextSQLQueryRow:}}
|{{AccesspointOverview|row={{#OnApDataGetSQLQueryRow:}}}}
}}
|}
{{#OnApDataSQLQuery:SELECT mainip,originator,on_id,db_time FROM nodes ORDER BY mainip ASC}} {{#while: }}
Opennet ID Quell-IP Datenherkunft letzte Aktualisierung
{{#OnApDataNextSQLQueryRow:}} - {{#OnApDataGetSQLQueryValue:on_id}} {{#OnApDataGetSQLQueryValue:mainip}} {{#OnApDataGetSQLQueryValue:originator}} {{#OnApDataGetSQLQueryValue:db_time}}
Abgerufen von „https://docs.opennet-initiative.de/index.php?title=Extension:APData&oldid=24092“