Fauchi95 hat mich gefragt, ob man nicht ein Whois-Plugin schreiben könnte, da ist es mir wieder eingefallen

Die Bedienung ist so wie man es sich denkt. Man sendet dem Bot ein whois gefolgt von der gewünschten Domain und bekommt das Ergebnis zurück gesendet.

Beispiel:

whois zinformatik.de

Zum Installieren des Plugins kopiert man die Datei Whois.pm in das Verzeichnis plugins im Hauptverzeichnis des zBot und startet dann den Bot neu.

Download:
Whois.pm

Nun wird eine Logdatei unterstützt, in der alle Konversationen mit dem Bot gespeichert werden können. Die Option kann in der Datei modules/Configs.pm ein- und ausgeschaltet werden. Dort kann auch der Ort bestimmt werden, wo die Logdatei gespeichert werden soll. Ein Timestamp wird mit gespeichert. In einem MUC (Chat) wird das gesammte dortige Gespräch mit geloggt, nicht nur die Konversation mit dem Bot.

Des weiteren wurde die Plugin-Schnittstelle erweitert. Nun kann neben der Hilfe auch eine Kurzbeschreibung angegeben werden, die bei der Auflistung der verschiedenen Befehle angezeigt wird. Jetzt kann auch eine Referenz zu einer Idle-Funktion angegeben werden, die alle 15 Sekunden aufgerufen wird. Diese kann genutzt werden um z.B. regelmäßig RSS-Feeds abzurufen (bei einem RSS-Plugin) oder um ähnliche Aufgaben im Hintergrund zu erledigen. Die Vorhandenen Plugins können jedoch auch ohne Änderung weiter verwendet werden. Jedoch habe ich die Plugins hier auf dem Blog entsprechend aktualisiert, so dass sie nun eine Kurzbeschreibung enthalten.

Das Plugin “Say” (Kommando sag), welches den Bot in Chaträumen etwas sagen lässt wurde erweitert. Nun kann er auch in Räumen etwas sagen, die nicht in der Konfigurationsdatei angegeben sind und noch nicht mal auf dem angegebenen Conference-Server liegen müssen (In der modules/Configs.pm lässt sich der Bot jedoch auf den eigenen Conference-Server beschränken). Danach ist er in den entsprechenden Räumen eingeloggt und nimmt dort auch Befehle entgegen. mit dem Befehl

sag ignoriere raumname

kann man ihn im Raum raumname wieder zum schweigen bringen (Befehle aus diesem Raum werden dann ignoriert bis der Bot mit sag erneut etwas in dem Raum sagen soll). Mehr Infos sind in der Hilfe verfügbar (hilfe sag). Eine Funktion um den Bot aus dem Raum wieder abzumelden wird leider nicht von der Bibliothek (Net::Jabber::Bot) unterstützt.

Beim Befehl hilfe wird die Ausgabe der möglichen Befehle nun alphabetisch sortiert.

Eine Updatefunktion gibt es leider nicht. Da sich auch in der Konfigurationsdatei ein paar Änderungen ergeben haben, müssen alle Dateien ersetzt werden und die Daten erneut in die Konfigurationsdatei modules/Configs.pm eingefügt werden.

Die neue Version kann im ursprünglichen Artikel zBot – ein Jabber Bot in Perl herunter geladen werden. Dort findet man auch weitere Informationen zum Bot.

Bedient wird das Plugin genauso wie die normale todo.sh indem man z.B. todo add “aufgabe p:project @context” oder todo ls an den Bot schickt. Weitere Informationen zur Bedienung gibt es auf http://todotxt.com. Eine Liste aller Befehle, die todo kennt erhält man wenn man todo ohne weitere Parameter eingibt.

Download: todo.zip

Installation: Das gesamte Archiv in den Ordner “plugins” entpacken und in der Todo.pm den Pfad “$basedir” in Zeile 15 anpassen (“path_to_zbot” muss der absolute Pfad zum Verzeichnis sein, in dem zbot liegt).

wetter PLZ

wird das aktuelle Wetter für die entsprechende Postleitzahl angezeigt. Als Quelle für die Wetterinformationen dient wetter.com. Daher sollte man das Plugin besser nur für private Zwecke einsetzen. Neben dem Wetter des aktuellen Tages wird auch die Vorhersage für den nächsten Tag mitgeschickt. Das Wetter wird jeweils für Morgens, Mittags, Abends und Nachts angezeigt.

Für das Wetter aus anderen Ländern als Deutschland kann der Name der Stadt eingegeben werden. Jedoch wird kein Ergebnis bei mehreren Möglichkeiten geliefert. Manche EU-Städte können jedoch auch über die PLZ angegeben werden. Am besten ausprobieren.

Damit das Plugin funktioniert müssen die CPAN Module LWP::UserAgent und HTML::Entities installiert sein.

Download: Weather.pm

Installation: Einfach die Datei “Weather.pm” ins Verzeichnis “plugins” kopieren.

Nachdem man die Datei in den “plugins” Ordner kopiert hat kann man z.B. mit dem Befehl

leo beispiel

das Wort “beispiel” übersetzen lassen. Das Plugin benötigt das CPAN Modul LWP::UserAgent. Wer noch Fragen hat, kann gerne einen Kommentar hinterlassen.

Download: Leo.pm

Zum Laden des Wikipedia Artikels wird das CPAN Modul LWP::UserAgent verwendet, welches also installiert sein muss, damit das Plugin funktioniert. Des Weiteren werden noch die CPAN Module HTML::Entities und HTML::TreeBuilder benötigt.

Die Datei “Wikipedia.pm” braucht nur ins Verzeichnis “plugins” kopiert zu werden. Dann kann z.B. man mit dem Befehl

wiki jabber

die Definition von Jabber abrufen (wenn die benötigten CPAN Module installiert sind).

Download: Wikipedia.pm

Update: Nun werden alle Wörter automatisch groß geschrieben. Ansonsten werden nicht alle Artikel gefunden (z.B. brownsche bewegung). Ansonsten wurde nur der Code etwas verschönert. Das Problem mit den Umlauten konnte ich jedoch noch nicht lösen (siehe unten).

Leider habe ich auch hier Probleme mit den Umlauten. Die meisten Artikel von Wikipedia werden richtig angezeigt. Bei wenigen Artikeln wie z.B. Thinkpad oder Schweiz werden die Umlaute jedoch nicht als utf8 interpretiert. Weder utf8::encode/utf8::decode noch die CPAN Module Encode oder HTML::Encoding haben geholfen (oder ich hab da was falsch gemacht). Falls jemand weis, woran das liegt, wäre ich über einen Hinweis dankbar. Weitere Infos in den Kommentaren.

Im Unterschied zu den anderen Plugins wird dieses immer aufgerufen, wenn der Bot seinen Namen hört: Bruno. Egal wo im Satz das Wort auftaucht. (Um den Bot umzubenennen muss der Name des Bots in der modules/Configs.pm geändert werden)

Es gibt eine Reihe von Wörtern, auf die Bruno reagiert, wenn man sie in einer Nachricht zusammen mit seinem Namen schreibt.  Diese kann man sich entweder aus der Datei fischen oder durch ausprobieren heraus finden.

Hier die Datei: Chatbot.pm (Datei ins Verzeichnis “plugins” kopieren)

Nachdem ich mich nun etwas mit Jabber beschäftigt habe, war es an der Zeit, einen eigenen Jabber Bot zu schreiben.

Ich hatte bereits einen ChatBot in Perl geschrieben, der in unserem http-Chat lief. Mit der CPAN Bibliothek Net::Jabber::Bot lies sich daraus mit wenigen Handgriffen ein einfacher Jabber Bot basteln.

Der Bot ist noch nicht sehr ausgereift. Aber er funktioniert.

Der Bot hat ein Pluginsystem um einfach neue Funktionen hinzufügen zu können. Um neue Plugins zu schreiben am besten mal ins Helloworld Plugin schauen (plugins/Helloworld.pm). Wichtig ist, das Plugin mit der Funktion Plugins::registerPlugin zu registrieren. Das fertige Plugin kann man ins Verzeichnis “plugins” kopieren. Jeder Befehl ist ein Plugin.

zBot läuft im Multi User Chat (MUC) und man kann ihn genauso gut als Kontakt hinzufügen.

Die Installation ist recht einfach. Man legt einen neuen User für den Bot auf dem Server seiner Wahl an. Dann editiert man die Datei modules/Configs.pm entsprechend (Passwort, Username… setzen). Danach kann man (wenn das CPAN Modul installiert ist) die zbot.pl starten. Am besten natürlich auf einem Server, damit der Bot auch online ist, wenn man den PC ausschaltet. Den Prozess kann man direkt in den Hintergrund schieben um sich wieder abmelden zu können:

./zbot.pl &

Nun kann man den Bot zu seiner Kontaktliste hinzufügen. Nach dem Start braucht der Bot 20 Sekunden zur Initialisierung, bis er antwortet.

Durch das Senden des Befehls “hilfe” werden alle Befehle angezeigt. Mit “hilfe <befehl>” bekommt man die Beschreibung des Plugins angezeigt (z.B. “hilfe helloworld”).

Das Programm habe ich unter der GPL veröffentlicht. Eine Dokumentation ist auch vorhanden.

Über Verbesserungen des Codes oder neue Plugins würde ich mich sehr freuen.

Bei Fragen oder Problemen kann man mich natürlich auch gerne anschreiben (oder einfach hier als Kommentar).

Update: Das Problem mit den Sonderzeichen konnte ich lösen. Es lag daran, dass die Sonderzeichen in der CPAN Bibliothek durch einen regulären Ausdruck ausgefiltert wurden (der dazu gedacht war, nicht druckbare Zeichen auszufiltern). Daher habe ich die entsprechende Datei ins Verzeichnis “modules” kopiert, entsprechend editiert und von dort eingebunden.

Update: Version 0.2 ist nun verfügbar. Informationen über die Änderungen findet man im zugehörigen Blogeintrag.

[UPDATE] Es gibt ein Problem ab ejabberd Version 2.0.3, da diese eine digest-uri zur Verifikation des Clients erwartet. Die einzige Möglichkeit das Problem zu lösen besteht anscheinend darin, diese Verifikation im Quelltext abzuschalten und neu zu kompilieren. Mehr Infos gibt es in diesem Forenthread (englisch).

Des weiteren gibt es ein Problem mit manchen User- bzw. Domainnamen. Der Bot bricht dann mit der Meldung:

Can't call method "isa" without a package or object reference at /usr/local/share/perl/5.8.8/Net/XMPP/Protocol.pm line 2471.

ab. (Die Zeile kann variieren)
Abhilfe schafft das entfernen des “problematischen” Users aus der Liste des Bots. Der User kann den Bot danach immer nocht nutzen (so weit mir berichtet wurde). Anscheinend tritt das Problem auf, wenn der Username mit einer Ziffer beginnt (oder eine Ziffer enthält, das weis ich nicht).
Vielen Dank an Daniel für die Hinweise und die Hilfe bei der Fehlersuche [/UPDATE]

[UPDATE]Ich habe den Bot jetzt mal auf GitHub hochgeladen: http://github.com/zimon/zBot. In der dortigen Version ist er auch an die neue Version von Net::Jabber::Bot angepasst. Leider funktionieren dadurch einige Plugins nicht mehr richtig, aber ich habe im Moment keine Zeit sie zu fixen. Vielleicht hat ja jemand Lust zu forken [/UPDATE]

Man kann den Bot gerne testen, indem man ihn zu seiner Kontaktliste hinzufügt: bruno@jey-key.de

Die Dokumentation ist nun auch online Verfügbar: Dokumenation Version 0.2

Dateien

• zbot_0.2.zip – Das Programm (the program)
• zbot_0.2_doc.zip – Die Dokumentation (the documentation)

Plugins

• Chatbot Plugin – erweitert den zBot um die Möglichkeit “Unterhaltungen” mit dem Bot zu führen.
• Wikipedia Plugin – fügt den Befehl “wiki” hinzu, mit dem die Definition (der erste Abschnitt des Artikels) zu einem Begriff angezeigt werden kann.
• Leo Dictionary Plugin – Deutsch <-> Englisch Übersetzungsplugin
• Wetter Plugin – macht eine Wettervorhersage für eine angegebene Postleitzahl
• Todo Plugin – verwaltet für jeden User eine Todoliste mittels todo.sh
• Whois Plugin – Macht eine Whois-Abfrage zu einer gewünschten Domain und liefert das Ergebnis zurück.

.

English

Here is my Jabber Bot “zBot” written in Perl using the CPAN Module Net::Jabber::Bot.

It is easily extendable with plugins. If you want to write a plugin just look at the modules/Helloworld.pm (I commented this example Plugin better than the other ones). Its important to register your Plugin by calling the function Plugins::registerPlugin in your module. When it’s finished just copy it to the plugins directory. Every command is a plugin.

zBot runs in multi user chats (MUC) and you can add it to your contact list.

I started writing the bot yesterday, so it is not tested well but it works.

To install and start the bot, register a new account for the bot. Then edit the modules/Configs.pm to your needs (password, username,…) and start the zbot.pl (don’t forget to install the CPAN module first). It’s a good idea to start it on a server with

./zbot &

so it stays online when you shut down your own computer. Now you can add the bot to your contact list. After the start the bot needs 20 seconds for initializing before it answers.

By sending “hilfe” to the bot it sends a list of available commands. With “hilfe <command>” you get the description of the plugin (for example: “hilfe helloworld”).

The bot is licenced under GPL. An english documentation is available.

All strings in the Code are in german language but the comments and documentation is english. I wrote an english translation as comment after (or below) each string, so it should be easy to translate.

It would be grate if you send me your plugins and enhancements of the code if you create some.

[UPDATE]I have uploaded the bot on GitHub: http://github.com/zimon/zBot. There it is adapted to the new Net::Jabber::Bot version. By doing this some of the Plugins broke and I don’t have time to fix them. Maybe someone wants to fork it [/UPDATE]

For questions or problems you may contact me.