Diese Anleitung beschreibt den WeeChat Chat Client und ist Teil von WeeChat.
Die aktuelle Version dieser Anleitung finden Sie auf: https://weechat.org/doc
1. Einleitung
WeeChat (Wee Enhanced Environment for Chat) ist ein freier, schneller und schlanker Chat-Client der für viele Betriebssysteme entwickelt wird.
Dieses Handbuch beschreibt wie man Skripten für WeeChat schreiben kann. Dabei werden folgende Programmiersprachen unterstützt:
-
python
-
perl
-
ruby
-
lua
-
tcl
-
guile (scheme)
Anmerkung
|
Beinahe alle Beispiele in dieser Dokumentation beziehen sich auf Python. Allerdings ist die API für alle Skriptsprachen nahezu identisch. |
2. Skripten in WeeChat
2.1. Besonderheiten der einzelnen Skriptsprachen
2.1.1. Python
-
WeeChat muss als Modul eingebunden werden:
import weechat
-
Um die WeeChat Funktion
print*
nutzen zu können mussprnt*
genutzt werden (print ist ein reservierter Befehl von Python!) -
Funktionen werden im Format
weechat.xxx(arg1, arg2, ...)
ausgeführt
2.1.2. Perl
-
Funktionen werden im Format
weechat::xxx(arg1, arg2, ...);
ausgeführt
2.1.3. Ruby
-
Es muss weechat_init definiert und darin die Funktion register ausgeführt werden
-
Funktionen werden im Format
Weechat.xxx(arg1, arg2, ...)
ausgeführt -
Aufgrund einer Limitierung, seitens Ruby (maximal 15 Argumente pro Funktion), empfängt die Funktion
Weechat.config_new_option
den Callback in einem Array von 6 Strings (3 Callbacks + 3 Data Strings), somit sieht ein Aufruf der Funktion folgendermaßen aus:
2.1.4. Lua
-
Funktionen werden im Format
weechat.xxx(arg1, arg2, ...)
ausgeführt
2.1.5. Tcl
-
Funktionen werden im Format
weechat::xxx arg1 arg2 ...
ausgeführt
2.1.6. Guile (scheme)
-
Funktionen werden im Format
(weechat:xxx arg1 arg2 ...)
ausgeführt -
folgende Funktionen nutzen eine Liste von Argumente (anstelle von vielen Argumenten für andere Funktionen), dies liegt daran das Guile die Anzahl der Argumente eingeschränkt ist:
-
config_new_section
-
config_new_option
-
bar_new
-
2.2. Die "Register" Funktion
Jedes WeeChat Skript muss sich bei WeeChat "registrieren". Die "register" Funktion muss deshalb der erste WeeChat Befehl sein der durch das Skript genutzt wird.
Prototyp:
Argumente:
-
name: interner Name des Skripts (String)
-
author: Name des Authors (String)
-
version: Version des Skripts (String)
-
license: Lizenz für das Skripts (String)
-
description: kurze Beschreibung des Skripts (String)
-
shutdown_function: Name der Funktion die beim Beenden des Skripts aufgerufen werden soll (String, kann auch eine leere Zeichenkette sein)
-
charset: Skript Zeichensatz (optional, liegt das Skript im UTF-8 Format vor kann dieser Wert leer bleiben. UTF-8 ist der Standardzeichensatz) (String)
Beispielskripten, für jede Sprache:
-
python:
-
perl:
-
ruby:
-
lua:
-
tcl:
-
guile (scheme):
2.3. Laden von Skripten
Es wird empfohlen die "script" Erweiterung zum Laden von Skripten zu nutzen, zum Beispiel:
/script load script.py
/script load script.pl
/script load script.rb
/script load script.lua
/script load script.tcl
/script load script.scm
Es besteht natürlich weiterhin die Möglichkeit, individuell für jede Skriptsprache, den entsprechenden Befehl zu nutzen:
/python load python/skript.py
/perl load perl/skript.pl
/ruby load ruby/skript.rb
/lua load lua/skript.lua
/tcl load tcl/skript.tcl
/guile load guile/skript.scm
Um Skripten automatisch beim Start von WeeChat zu laden sollte man einen Link anlegen, der in das Verzeichnis Skriptsprache/autoload zeigt.
Ein Beispiel für ein Python-Skript:
$ cd ~/.weechat/python/autoload
$ ln -s ../script.py
Anmerkung
|
Installiert man mittels /script install ein Skript, dann wird automatisch
ein Link in das entsprechende autoload Verzeichnis erzeugt. |
3. Unterschiede zur C API
Die Skripten API ist nahezu identisch mit der API der C Erweiterung.
Um einen Überblick über alle API Funktionen (Prototyp, Argumente,
Rückgabe werte, Beispiele) zu erhalten werfen Sie einen Blick in
die WeeChat Plugin API Reference.
Es ist wichtig dass man zwischen einer Erweiterung und einem Skript
unterscheidet: Eine Erweiterung ist eine Binärdatei die kompiliert wurde
und mittels /plugin
geladen wird. Ein Skript ist eine Textdatei welche
durch eine Erweiterung z.B. python mittels dem Befehl /python
geladen
wird.
Falls Ihr Skript test.py eine WeeChat API Funktion aufruft wird der Aufruf
wie folgt abgearbeitet:
┌──────────────────────┐ ╔══════════════════╗
│ python Erweiterung │ ║ WeeChat "core" ║
├────────────┬─────────┤ ╟─────────┐ ║
test.py ─────► │ Skript API │ C API │ ─────► ║ C API │ ║
└────────────┴─────────┘ ╚═════════╧════════╝
Gibt WeeChat einen Rückgabewert an Ihr Skript test.py zurück wird der Aufruf in umgekehrter Reihenfolge abgearbeitet:
╔══════════════════╗ ┌──────────────────────┐
║ WeeChat "core" ║ │ python Erweiterung │
║ ┌─────────╢ ├─────────┬────────────┤
║ │ C API ║ ─────► │ C API │ Skript API │ ─────► test.py
╚════════╧═════════╝ └─────────┴────────────┘
3.1. Pointer
Wie Sie vermutlich wissen existieren in Skripten keine "Pointer". Sendet nun die API Funktion einen Pointer als Rückgabewert an das Skript, dann wird der Pointer in einen String konvertiert.
Beispiel: Falls eine Funktion den Pointer 0x1234ab56 zurück gibt erhält das Skript einen String in der Form "0x1234ab56".
Erwartet die API Funktion als Argument einen Pointer, dann muss das Skript diesen Pointer als String übergeben. Die C Erweiterung konvertiert den String in einen echten Pointer bevor die C API Funktion ausgeführt wird.
Ein leerer String oder "0x0" sind hierbei erlaubt. Beides wird in C als NULL interpretiert. Im folgenden ein Beispiel um Daten im Core Buffer (WeeChat Hauptbuffer) auszugeben:
Warnung
|
Aus Gründen der Geschwindigkeit wird in vielen Funktionen darauf verzichtet die Pointer auf ihre Korrektheit zu überprüfen. Es obliegt Ihrer Verantwortung einen gültigen Pointer zu übergeben. Sollten Sie dies nicht beachten dann werden Sie mit einem netten Crash-Report belohnt ;) |
3.2. Callbacks
Beinahe alle WeeChat Callbacks müssen entweder WEECHAT_RC_OK oder WEECHAT_RC_ERROR als Ergebnis zurück liefern. Eine Ausnahme bildet das modifier Callback, hier wird ein String als Rückgabewert erwartet.
C Callbacks nutzen ein "Data" Argument welches ein Pointer ist. In der Skript API ist "Data" ein String der jeden Wert haben darf (es handelt sich nicht um einen Pointer).
callback Beispiele, für jede Skriptsprache:
-
python:
-
perl:
-
ruby:
-
lua:
-
tcl:
-
guile (scheme):
4. Skript API
Um weiterführende Informationen zu den API Funktionen zu erhalten lesen Sie bitte WeeChat Plugin API Reference.
4.1. Funktionen
Liste der Skript API Funktionen:
Kategorie | Funktionen |
---|---|
Allgemein |
register |
Erweiterungen |
plugin_get_name |
Strings |
charset_set, iconv_to_internal, iconv_from_internal, gettext, ngettext, |
Verzeichnisse |
mkdir_home, mkdir, mkdir_parents |
sortierte Listen |
list_new, list_add, list_search, list_search_pos, list_casesearch, list_casesearch_pos, list_get, list_set, list_next, list_prev, list_string, list_size, list_remove, list_remove_all, list_free |
Konfigurationsdatei |
config_new, config_new_section, config_search_section, config_new_option,
config_search_option, |
Tastenbelegung |
key_bind, key_unbind |
Ausgabe |
prefix, color, print (für Python: prnt), print_date_tags (für Python: prnt_date_tags), print_y (für Python: prnt_y), log_print |
Hooks |
hook_command, hook_command_run, hook_timer, hook_fd, hook_process, hook_process_hashtable, hook_connect, hook_print, hook_signal, hook_signal_send, hook_hsignal, hook_hsignal_send, hook_config, hook_completion, hook_completion_list_add, hook_modifier, hook_modifier_exec, hook_info, hook_info_hashtable, hook_infolist, hook_focus, hook_set, unhook, unhook_all |
Buffer |
buffer_new, current_buffer, buffer_search, buffer_search_main, buffer_clear, buffer_close, buffer_merge, buffer_unmerge, buffer_get_integer, buffer_get_string, buffer_get_pointer, buffer_set, buffer_string_replace_local_var, buffer_match_list |
Fenster |
current_window, window_search_with_buffer, window_get_integer, window_get_string, window_get_pointer, window_set_title |
Nickliste |
nicklist_add_group, nicklist_search_group, nicklist_add_nick, nicklist_search_nick, nicklist_remove_group, nicklist_remove_nick, nicklist_remove_all, nicklist_group_get_integer, nicklist_group_get_string, nicklist_group_get_pointer, nicklist_group_set, nicklist_nick_get_integer, nicklist_nick_get_string, nicklist_nick_get_pointer, nicklist_nick_set |
Bars |
bar_item_search, bar_item_new, bar_item_update, bar_item_remove, bar_search, bar_new, bar_set, bar_update, bar_remove |
Befehle |
command |
Informationen |
info_get, info_get_hashtable |
Infolisten |
infolist_new, infolist_new_item, infolist_new_var_integer,
infolist_new_var_string, infolist_new_var_pointer, infolist_new_var_time, |
hdata |
hdata_get, hdata_get_var_offset, hdata_get_var_type_string, hdata_get_var_array_size, hdata_get_var_array_size_string, hdata_get_var_hdata, hdata_get_list, hdata_check_pointer, hdata_move, hdata_search, hdata_char, hdata_integer, hdata_long, hdata_string, hdata_pointer, hdata_time, hdata_hashtable, hdata_update, hdata_get_string |
Upgrade |
upgrade_new, upgrade_write_object, upgrade_read, upgrade_close |
4.2. Konstanten
Liste der Konstanten in Skript API:
Kategorie | Konstanten |
---|---|
return codes |
WEECHAT_RC_OK, WEECHAT_RC_OK_EAT, WEECHAT_RC_ERROR |
Konfigurationsdatei |
WEECHAT_CONFIG_READ_OK, WEECHAT_CONFIG_READ_MEMORY_ERROR,
WEECHAT_CONFIG_READ_FILE_NOT_FOUND, WEECHAT_CONFIG_WRITE_OK,
WEECHAT_CONFIG_WRITE_ERROR, WEECHAT_CONFIG_WRITE_MEMORY_ERROR, |
sortierte Listen |
WEECHAT_LIST_POS_SORT, WEECHAT_LIST_POS_BEGINNING, WEECHAT_LIST_POS_END |
Hotlist |
WEECHAT_HOTLIST_LOW, WEECHAT_HOTLIST_MESSAGE, WEECHAT_HOTLIST_PRIVATE, WEECHAT_HOTLIST_HIGHLIGHT |
hook Prozesse |
WEECHAT_HOOK_PROCESS_RUNNING, WEECHAT_HOOK_PROCESS_ERROR |
hook Connect |
WEECHAT_HOOK_CONNECT_OK, WEECHAT_HOOK_CONNECT_ADDRESS_NOT_FOUND, WEECHAT_HOOK_CONNECT_IP_ADDRESS_NOT_FOUND, WEECHAT_HOOK_CONNECT_CONNECTION_REFUSED, WEECHAT_HOOK_CONNECT_PROXY_ERROR, WEECHAT_HOOK_CONNECT_LOCAL_HOSTNAME_ERROR, WEECHAT_HOOK_CONNECT_GNUTLS_INIT_ERROR, WEECHAT_HOOK_CONNECT_GNUTLS_HANDSHAKE_ERROR, WEECHAT_HOOK_CONNECT_MEMORY_ERROR, WEECHAT_HOOK_CONNECT_TIMEOUT, WEECHAT_HOOK_CONNECT_SOCKET_ERROR |
hook Signal |
WEECHAT_HOOK_SIGNAL_STRING, WEECHAT_HOOK_SIGNAL_INT, WEECHAT_HOOK_SIGNAL_POINTER |
5. Gemeinschaftsaufgabe
Dieses Kapitel beinhaltet einige Aufgaben mit Lösungsbeispielen. Die Skript API wird dabei nur sehr oberflächlich besprochen.Um eine vollständige Übersicht aller Befehle zu erhalten nutzen Sie bitte die WeeChat Plugin API Reference.
5.1. Buffer
5.1.1. Nachrichten anzeigen
Eine leere Zeichenkette wird häufig verwendet um den WeeChat Core Buffer zu nutzen. Möchten Sie einen anderen Buffer nutzen dann muss der Pointer dieses Buffers verwendet werden (Übergabe als String, siehe Pointer).
Beispiele:
Anmerkung
|
Die print Funktion heißt in Perl/Ruby/Lua/Tcl print . In Python lautet die Funktion prnt . |
5.1.2. Text in einen Buffer senden
Sie können einen Text oder einen Befehl in einen Buffer senden. Dies entspricht exakt dem Verhalten als ob Sie einen Text oder einen Befehl in die Befehlszeile eingeben und selbigen mit der [Eingabe] Taste bestätigen.
Beispiele:
5.1.3. neuen Buffer öffnen
Sie können aus Ihrem Skript einen neuen Buffer öffnen um dort Nachrichten auszugeben.
Zwei Callbacks können aufgerufen werden (diese sind optional): der erste Callback dient dazu
eine Routine aufzurufen sobald ein Text eingegeben und mit [Enter] bestätigt wird. Der zweite
Callback ruft eine Routine auf die beim Schließen des Buffers ausgeführt wird (zum Beispiel
wenn /buffer close
genutzt wurde).
Beispiele:
5.1.4. Eigenschaften von Buffern
Die verschiedenen Eigenschaften von Buffern können in Form eines Strings, Integer oder als Pointer vorliegen und gelesen werden.
Beispiele:
Es ist möglich lokale Variablen eines Buffers hinzuzufügen, zu lesen oder zu löschen:
Um zu sehen welche lokalen Variablen für einen Buffer gesetzt sind führen Sie bitte in WeeChat folgenden Befehl aus:
/buffer localvar
5.2. Hooks
5.2.1. neuen Befehl hinzufügen
Erstellt mittels hook_command
einen benutzerdefinierten Befehl. Dabei kann
eine benutzerdefinierte Vervollständigung der Argumente genutzt werden.
Beispiel:
Der Befehl wird dann in WeeChat wie folgt genutzt:
/help meinfilter
/meinfilter Argumente...
5.2.2. Nutzung des Timers
Mittels hook_timer
wird eine Zeitfunktion implementiert.
Beispiele:
5.2.3. Hintergrundprozesse
Mit der Funktion hook_process
kann ein Hintergrundprozess gestartet werden.
Der Callback wird aufgerufen sobald der Hintergrundprozess abgearbeitet wurde.
Dies kann auch mehrfach der Fall sein.
Für den letzten Aufruf des Callback wird rc auf 0 oder einen positiven Wert gesetzt. Dies ist der Return Code des Befehls.
Beispiele:
5.2.4. URL Übertragung
Neu seit Version 0.3.7.
Um URLs herunterzuladen (oder um etwas zu einer URL zu senden), muss die Funktion
hook_process
genutzt werden. Müssen zusätzliche Optionen gesetzt werden, für
einen URL Transfer, kommt die Funktion hook_process_hashtable
zum Einsatz.
Beispiel eines URL Transfers, ohne zusätzliche Optionen: Die HTML Seite wird dabei in der Callback-Variable "out" gesichert (Standardausgabe des Prozesses):
Tipp
|
Alle Informationen die WeeChat betreffen findet man auf: https://weechat.org/dev/info |
Beispiel eines URL Transfers, mit zusätzliche Optionen: Es wird das neuste WeeChat Entwicklerpaket in die Datei /tmp/weechat-devel.tar.gz gesichert:
Für weiterführende Informationen zum URL Transfer und für die verfügbaren Optionen,
siehe hook_process
und hook_process_hashtable
in der API Erweiterung Anleitung.
5.3. Konfiguration / Optionen
5.3.1. Optionen von Skripten setzen
Die Funktion config_is_set_plugin
wird dazu benutzt um zu testen ob eine Option
gesetzt ist oder nicht. Mit der Funktion config_set_plugin
wird eine Option gesetzt.
Beispiele:
5.3.2. Veränderungen bemerken
Die Funktion hook_config
wird dazu benutzt um festzustellen falls ein Anwender
eine Option des Skripts verändert hat.
Beispiele:
5.3.3. WeeChat Optionen lesen
Die Funktion config_get
gibt einen Pointer zu einer Option zurück. Abhängig vom Typ der Option
muss entweder config_string
, config_boolean
, config_integer
oder config_color
genutzt werden.
5.4. IRC
5.4.1. Nachrichten abfangen
Die IRC Erweiterung sendet zwei Signale wenn eine Nachricht empfangen wurde.
xxx
ist der interne IRC Servername, yyy
ist der IRC Befehl der empfangen
wurde (JOIN, QUIT, PRIVMSG, 301, ..):
- xxxx,irc_in_yyy
-
Signal wird gesendet bevor die Nachricht verarbeitet wurde.
- xxx,irc_in2_yyy
-
Signal wird gesendet nachdem die Nachricht verarbeitet wurde.
5.4.2. Modify messages
Die IRC Erweiterung verschickt einen "modifier" mit Namen "irc_in_xxx" ("xxx" steht für den Namen des IRC Befehls) um eine Nachricht zu empfangen die dann modifiziert werden kann.
Warnung
|
Eine fehlerhafte Nachricht kann WeeChat zum Absturz bringen oder andere ernsthafte Probleme erzeugen! |
5.4.3. Nachrichten parsen
Neu seit Version 0.3.4.
Man kann IRC Nachrichten mittels einer info_hashtable mit dem Namen "irc_message_parse" parsen.
5.5. Infos
5.5.1. WeeChat Version
Die sinnvollste Methode um die Version abzufragen ist die Nutzung von "version_number". Das Ergebnis sollte mit einem hexadezimalen Integer-Wert verglichen werden.
Beispiele:
Anmerkung
|
Versionen ≤ 0.3.1.1 geben einen leeren String zurück wenn man info_get("version_number") aufruft. Deshalb müssen Sie prüfen ob der Rückgabe wert nicht leer ist. |
Um die Version als String zu erhalten:
5.5.2. andere Informationen
5.6. Infolisten
5.6.1. Infoliste einlesen
Es können Infolisten eingelesen werden die entweder von WeeChat oder von Erweiterungen erstellt wurden.
Beispiele:
Wichtig
|
Vergessen Sie bitte nicht infolist_free aufzurufen um den Speicher wieder
frei zu geben der durch die Infoliste belegt wurde. WeeChat gibt diesen Speicher
nicht von sich aus frei. |