JUNe/Helga-HTTP
Aus RWTH Jabber
| Dieser Artikel wird von den am Jabber University Network beteiligten Universitäten gemeinsam verwendet. Aus diesem Grund ist der Artikel allgemein gehalten und nicht spezifisch für eine bestimmte Universität. Dadurch sparen wir eine Menge Arbeit und können euch insgesamt eine umfangreichere Dokumentation bieten. |
Inhaltsverzeichnis |
[Bearbeiten] Hinweis
Über die hier beschriebenen HTTP-Anfragen ist es möglich, den Online-Status eines Benutzers abzufragen, ohne dass man ihn auf seiner Kontaktliste hat. Daher ist es aus Sicherheitsgründen erforderlich, dass man sich bei Helga registriert und die Veröffentlichung des eigenen Status explizit erlaubt.
Du kannst Helga mit folgendem Kommando erlauben deinen Status zu veröffentlichen. Wie alle Kommandos an Helga muss dies als normale Chat-Nachricht geschickt werden.
set public true
Mit dem folgenden Kommando kann man das ganze, falls gewünscht, wieder rückgängig machen.
set public false
[Bearbeiten] URL und Parameter
Der aktuelle Status eines Benutzers kann über eine URL angezeigt werden. Diese URL hängt natürlich vom Jabber-Server ab:
| Universität | URL |
| RWTH Aachen | http://jabber.rwth-aachen.de/helga/user |
| Fachhochschule Bonn-Rhein-Sieg | http://jabber.fslab.de:9090/plugins/helga/user |
Über verschiedene Parameter wird gesteuert was Helga ausgeben soll.
| Name | Beschreibung | |
| jid | benötigt | Die JabberID oder der Benutzername des Benutzers dessen Status ausgegeben werden soll. |
| type | optional | Der Typ der Ausgabe. Möglich sind 'image', 'text' und 'xml'. Wird dieser Parameter nicht angegeben, so wird 'image' angenommen, welches ein kleines Bild passend zum Status anzeigt. 'text' gibt den Status-Text des Nutzers zurück, oder einen leeren Text, wenn der Nutzer keinen Text angegeben hat. 'xml' gibt eine XML-Repräsentation des Status zurück. |
| images | optional | Diese Paramter erlaubt es eigene Bilder für den Status zu benutzen. Die angegebene URL sollte den Token '--IMAGE--' enthalten. Dieser wird durch 'available', 'chat', 'away', 'xa', 'dnd', 'offline' bzw. 'forbidden' ersetzt. Beispiel: http://www.example.com/images/--IMAGE--.gif |
| [image_type] | optional | Anstatt eine einzige URL anzugeben kann man auch für jeden Status eine einzelne vollständige URL angeben. Der Parameter sollte 'available', 'chat','away', 'xa', 'dnd', 'offline' oder 'forbidden' sein. Diese Parameter können auch in Kombination mit 'images' benutzt werden um gezielt einzelne Bilder zu überschreiben. |
[Bearbeiten] Bespiele
Die folgenden Beispiele zeigen am Beispiel der RWTH Aachen wie man die HTTP-Anfragen an Helga nutzen kann. Das erste HTML-Beispiel zeigt den Status des Benutzers 'Hans.Wurst@jabber.rwth-aachen.de' als Bild an:
<img src="http://jabber.rwth-aachen.de/helga/user?jid=Hans.Wurst@jabber.rwth-aachen.de" style="border: none;">
alternativ würde auch folgendes funktionieren:
<img src="http://jabber.rwth-aachen.de/helga/user?jid=Hans.Wurst" style="border: none;">
Nun ein Beispiel zur Benutzung von eigenen Bildern. (natürlich ohne den Zeilenumbruch verwenden...)
<img src="http://jabber.rwth-aachen.de/helga/user?jid=Hans.Wurst@jabber.rwth-aachen.de
&images=http://www.example.com/images/--IMAGE--.gif" style="border: none;">
Status eines Benutzer im XML-Format.
http://jabber.rwth-aachen.de/helga/user?jid=Hans.Wurst@jabber.rwth-aachen.de&type=xml
Status-Text eines Benutzers.
http://jabber.rwth-aachen.de/helga/user?jid=Hans.Wurst@jabber.rwth-aachen.de&type=text
[Bearbeiten] Skripte
- Ein PHP Script von Harald Reuter, welches die Status-Daten eines Benutzers im XML-Format ausliest und in ein assoziatives Array wirft: helga.php
- ...weitere hilfreiche Skripte bitte hier verlinken...
