翻訳者:
-
Ryuunosuke Ayanokouzi <i38w7i3@yahoo.co.jp>, 2014-2019
1. はじめに
この文書は weechat リレープロトコルについて述べたものです: リレープロトコルとは、WeeChat データをクライアントに中継するためのもので、多くの場合クライアントはリモートインターフェースを指します。
1.1. 用語
この文書では以下の用語を利用します:
-
リレー: これは relay プラグインを備えた WeeChat を指し、"サーバ" のように振る舞い、クライアント からの接続を受け付けます
-
クライアント: これは他のソフトウェアのことを指し、ネットワークを介して リレー に接続します; 多くの場合、クライアント はリモートインターフェースのことを指します。
1.2. ネットワーク図
以下の図に示すように クライアント は リレー に接続しています:
┌────────────────┐ ワークステーション
┌────────┐ ┌───┤ クライアント 1 │ (Linux、Windows、
│ irc │◄──┐ ╔═══════════╤════════╗ │ └────────────────┘ BSD、macOS, …)
└────────┘ └──╢ │ ║◄───┘ ┌────────────────┐
...... ║ WeeChat │ リレー ║◄───────┤ クライアント 2 │ 携帯デバイス
┌────────┐ ┌──╢ │ ║◄───┐ └────────────────┘ (Android、iPhone, …)
│ jabber │◄──┘ ╚═══════════╧════════╝ │ ......
└────────┘ │ ┌────────────────┐
...... └───┤ クライアント N │ その他のデバイス
└────────────────┘
└────────────┘ └────────────────────┘╘══════╛└──────────────────────────────────────┘
ネットワーク ncurses リレー リモートインターフェース
サーバ インターフェース
|
注記
|
All clients here are clients using weechat protocol in relay plugin. The relay plugin also allows api and irc protocols (not described in this document). |
2. プロトコルの一般的説明
-
リレー プラグインは新しい接続を受け入れるために IP/port をリッスンし、クライアント は TCP ソケットを使って リレー に接続します。
-
クライアント の数はオプション relay.network.max_clients で制限されています。
-
それぞれの クライアント が自分以外のクライアントと協調して動くことはできません。
-
クライアント から リレー へのメッセージを コマンド と呼び、これはテキスト形式 (文字列) で送信されます。
-
リレー から クライアント へのメッセージを メッセージ と呼び、これはバイナリデータとして送信されます。
3. コマンド (クライアント → リレー)
コマンドの書式は以下です:
(id) command arguments\n
フィールドは:
-
id: リレー からの応答に含まれる任意指定のメッセージ識別子; 識別子は必ず括弧で括り、アンダースコアを最初につけるのは禁止されています (アンダースコアが最初についている識別子は WeeChat event メッセージ用に予約されています)
-
command: コマンド (以下のテーブルを参照)
-
arguments: コマンドに対する任意指定の引数 (複数の引数を渡す場合は空白で区切ってください)。
利用可能なコマンドのリスト (詳しくは次の章を参照):
| コマンド | 説明 |
|---|---|
|
Handshake: prepare client authentication and set options, before init command. |
|
リレー 接続を初期化 |
|
hdata を要求 |
|
インフォ を要求 |
|
インフォリスト を要求 |
|
ニックネームリスト を要求 |
|
バッファにデータを送信 (テキストまたはコマンド) |
|
Request completion of a string. |
|
バッファを同期: バッファの最新情報を取得 |
|
バッファを非同期: バッファの更新を止める |
|
リレー から切断 |
3.1. handshake
WeeChat ≥ 2.9, updated in versions 3.5, 4.0.0.
Perform an handshake between the client and WeeChat: this is required in most cases to know the session settings and prepare the authentication with the init command.
Only one handshake is allowed before the init command.
Syntax:
(id) handshake [<option>=<value>,[<option>=<value>,...]]
Arguments:
-
option: one of following options:
-
password_hash_algo: list of hash algorithms supported by the client (separated by colons), allowed values are:
-
plain: plain text password (no hash)
-
sha256: password salted and hashed with SHA256 algorithm
-
sha512: password salted and hashed with SHA512 algorithm
-
pbkdf2+sha256: password salted and hashed with PBKDF2 algorithm (using SHA256 hash)
-
pbkdf2+sha512: password salted and hashed with PBKDF2 algorithm (using SHA512 hash)
-
-
compression: list of supported compression types supported by the client (separated by colons and sorted from most important to the fallback value); if compression is enabled, messages from relay to client are compressed to save bandwidth; allowed values are:
-
off: no compression (default if option is not given)
-
zlib: compress with zlib ↗ (WeeChat ≥ 0.3.7)
-
zstd: compress with Zstandard ↗: better compression and much faster than zlib for both compression and decompression (WeeChat ≥ 3.5)
-
-
escape_commands: commands sent by the client to relay must be escaped: all backslashes are interpreted and a single backslash must be escaped (
\\); this allows for example the client to send multiline messages (chars\nare converted to newlines, see input command) (WeeChat ≥ 4.0.0)
-
Notes about option password_hash_algo:
-
If the option is not given (or if the handshake command is not sent by the client), relay uses automatically plain authentication (if allowed on relay side).
-
Relay chooses the more secure algorithm available on both client and relay, by order of priority from first (most secure) to last used:
-
pbkdf2+sha512
-
pbkdf2+sha256
-
sha512
-
sha256
-
plain
-
WeeChat replies with a hashtable containing the following keys and values:
-
password_hash_algo: the password authentication negotiated: supported by both the client and relay:
-
(empty value): negotiation failed, password authentication is NOT possible; in this case the connection with the client is immediately closed
-
plain
-
sha256
-
sha512
-
pbkdf2+sha256
-
pbkdf2+sha512
-
-
password_hash_iterations: number of iterations for hash (for the PBKDF2 algorithm only)
-
totp:
-
on: Time-based One-Time Password (TOTP) is configured and expected in the init command
-
off: Time-based One-Time Password (TOTP) is not enabled and not needed in the init command
-
-
nonce: a buffer of unpredictable bytes, sent as hexadecimal, to prevent replay attacks; if password_hash_algo is a hash algorithm, the client must compute the hash of password on this nonce, concatenated with a client nonce and the user password (the relay nonce + the client nonce is the salt used in the password hash algorithm)
-
compression: compression type:
-
off: messages are not compressed
-
zlib: messages are compressed with zlib ↗
-
zstd: messages are compressed with Zstandard ↗
-
-
escape_commands:
-
on: all backslashes are interpreted in the client messages
-
off: backslashes are NOT interpreted in the client messages and used as-is
-
|
ヒント
|
With WeeChat ≤ 2.8, the command handshake is not implemented, WeeChat silently
ignores this command, even if it is sent before the init command. So it is safe to send this command to any WeeChat version. |
Examples:
-
Nothing offered by the client, authentication password "plain" will be used if allowed on relay side:
(handshake) handshake
Response:
id: 'handshake'
htb: {
'password_hash_algo': 'plain',
'password_hash_iterations': '100000',
'totp': 'on',
'nonce': '85B1EE00695A5B254E14F4885538DF0D',
'compression': 'off',
'escape_commands': 'off',
}-
Escape of commands enabled by the client (WeeChat ≥ 4.0.0):
(handshake) handshake escape_commands=on
Response:
id: 'handshake'
htb: {
'password_hash_algo': 'plain',
'password_hash_iterations': '100000',
'totp': 'on',
'nonce': '85B1EE00695A5B254E14F4885538DF0D',
'compression': 'off',
'escape_commands': 'on',
}-
Only "plain" is supported by the client:
(handshake) handshake password_hash_algo=plain
Response:
id: 'handshake'
htb: {
'password_hash_algo': 'plain',
'password_hash_iterations': '100000',
'totp': 'on',
'nonce': '85B1EE00695A5B254E14F4885538DF0D',
'compression': 'off',
'escape_commands': 'off',
}-
Only "plain", "sha256" and "pbkdf2+sha256" are supported by the client:
(handshake) handshake password_hash_algo=plain:sha256:pbkdf2+sha256
Response:
id: 'handshake'
htb: {
'password_hash_algo': 'pbkdf2+sha256',
'password_hash_iterations': '100000',
'totp': 'on',
'nonce': '85B1EE00695A5B254E14F4885538DF0D',
'compression': 'off',
'escape_commands': 'off',
}The client can authenticate with this command (see init command), the salt is the relay nonce + client nonce ("A4B73207F5AAE4" in hexadecimal), the password is "test" in this example:
init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440
-
Only "sha256" and "sha512" are supported by the client, enable zstd (preferred) or zlib compression:
(handshake) handshake password_hash_algo=sha256:sha512,compression=zstd:zlib
Response:
id: 'handshake'
htb: {
'password_hash_algo': 'sha512',
'password_hash_iterations': '100000',
'totp': 'on',
'nonce': '85B1EE00695A5B254E14F4885538DF0D',
'compression': 'zstd',
'escape_commands': 'off',
}3.2. init
Updated in versions 2.4, 2.8, 2.9, 3.5.
Authenticate with relay.
This must be first command sent to relay (only handshake command can be sent
before init).
If not sent, relay will close connection on first command received (except
handshake), without warning.
構文:
(id) init [<option>=<value>,[<option>=<value>,...]]
引数:
-
option: 以下のうちの 1 つ:
-
password: リレー の認証用パスワード (WeeChat の relay.network.password オプション)
-
password_hash: hash of password used to authenticate on relay (option relay.network.password in WeeChat), see below for the format (WeeChat バージョン 2.8 で利用可能)
-
totp: パスワードに加えた二要素認証で利用する時間ベースのワンタイムパスワード (TOTP) (WeeChat の relay.network.totp_secret オプション) (WeeChat バージョン 2.4 で利用可能)
-
|
注記
|
WeeChat バージョン 1.6 以上の場合、コンマをエスケープすることで value にコンマを設定可能です。例えば
"foo,bar" というパスワードを送信するには init password=foo\,bar のように設定してください。
|
Format of hashed password is one of the following, where hash is the hashed password as hexadecimal:
-
sha256:salt:hashwith:-
salt: salt (hexadecimal), which must start with the server nonce, concatenated to the client nonce
-
hash: the hashed salt + password (hexadecimal)
-
-
sha512:salt:hashwith:-
salt: salt (hexadecimal), which must start with the server nonce, concatenated to the client nonce
-
hash: the hashed salt + password (hexadecimal)
-
-
pbkdf2+sha256:salt:iterations:hashwith:-
salt: salt (hexadecimal), which must start with the server nonce, concatenated to the client nonce
-
iterations: number of iterations
-
hash: the hashed salt + password with SHA256 algorithm (hexadecimal)
-
-
pbkdf2+sha512:salt:iterations:hashwith:-
salt: salt (hexadecimal), which must start with the server nonce, concatenated to the client nonce
-
iterations: number of iterations
-
hash: the hashed salt + password with SHA512 algorithm (hexadecimal)
-
|
注記
|
Hexadecimal strings can be lower or upper case, relay can decode both. |
Examples:
-
Initialize with password:
init password=mypass
-
Initialize with commas in the password (WeeChat ≥ 1.6):
init password=mypass\,with\,commas
-
Initialize with password and TOTP (WeeChat ≥ 2.4):
init password=mypass,totp=123456
-
Initialize with hashed password "test" (SHA256: salt=relay nonce + client nonce) (WeeChat ≥ 2.9):
init password_hash=sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:2c6ed12eb0109fca3aedc03bf03d9b6e804cd60a23e1731fd17794da423e21db
-
Initialize with hashed password "test" (SHA512: salt=relay nonce + client nonce) (WeeChat ≥ 2.9):
init password_hash=sha512:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:0a1f0172a542916bd86e0cbceebc1c38ed791f6be246120452825f0d74ef1078c79e9812de8b0ab3dfaf598b6ca14522374ec6a8653a46df3f96a6b54ac1f0f8
-
Initialize with hashed password "test" (PBKDF2: SHA256, salt=relay nonce + client nonce, 100000 iterations) (WeeChat ≥ 2.9):
init password_hash=pbkdf2+sha256:85b1ee00695a5b254e14f4885538df0da4b73207f5aae4:100000:ba7facc3edb89cd06ae810e29ced85980ff36de2bb596fcf513aaab626876440
3.3. hdata
hdata を要求。
構文:
(id) hdata <path> [<keys>]
引数:
-
path: hdata へのパス、書式: "hdata:pointer/var/var/…/var"、最後の var に対応する hdata が返されます:
-
hdata: hdata の名前
-
pointer: ポインタ (eg: "0x1234abcd") またはリスト名 (例: "gui_buffers") (番号も可能、以下を参照)
-
var: 親 hdata に含まれる変数名 (パスで言う 1 つ前の名前) (番号も可能、以下を参照)
-
-
keys: hdata で返すキーのコンマ区切りリスト (指定しなかった場合、全てのキーが返されます。強大な hdata 構造体の場合全てのキーを返すことはお勧めしません)
ポインタと変数の後に番号を指定することができます。書式は "(N)"。可能な値は:
-
正数: N 回次の要素への反復を繰り返す
-
負数: N 回前の要素への反復を繰り返す
-
*: 最後の要素まで、次の要素への反復を繰り返す
|
注記
|
WeeChat バージョン 1.6 以上では、hdata へのパスが無効または NULL ポインタが見つかった場合、空の
hdata が返されます (hdata オブジェクトの例を参照してください)。 1.6 よりも古いバージョンでは、何も返されません。 |
Examples:
-
Request "number" and "full_name" of all buffers:
(hdata_buffers) hdata buffer:gui_buffers(*) number,full_name
Response:
id: 'hdata_buffers'
hda:
keys: {
'number': 'int',
'full_name': 'str',
}
path: ['buffer']
item 1:
__path: ['0x558d61ea3e60']
number: 1
full_name: 'core.weechat'
item 2:
__path: ['0x558d62840ea0']
number: 1
full_name: 'irc.server.libera'
item 3:
__path: ['0x558d62a9cea0']
number: 2
full_name: 'irc.libera.#weechat'-
Request all lines of first buffer:
(hdata_lines) hdata buffer:gui_buffers/own_lines/first_line(*)/data
Response:
id: 'hdata_lines'
hda:
keys: {
'buffer': 'ptr',
'y': 'int',
'date': 'tim',
'date_usec': 'int',
'date_printed': 'tim',
'date_usec_printed', 'int',
'str_time': 'str',
'tags_count': 'int',
'tags_array': 'arr',
'displayed': 'chr',
'notify_level': 'chr',
'highlight': 'chr',
'refresh_needed': 'chr',
'prefix': 'str',
'prefix_length': 'int',
'message': 'str',
}
path: ['buffer', 'lines', 'line', 'line_data']
item 1:
__path: ['0x558d61ea3e60', '0x558d61ea40e0', '0x558d62920d80', '0x558d62abf040']
buffer: '0x558d61ea3e60'
y: -1
date: 1588404926
date_usec: 118712
date_printed: 1588404926
date_usec_printed: 118712
str_time: 'F@0025209F@0024535F@0024026'
tags_count: 0
tags_array: []
displayed: 1
notify_level: 0
highlight: 0
refresh_needed: 0
prefix: ''
prefix_length: 0
message: 'this is the first line'
item 2:
__path: ['0x558d61ea3e60', '0x558d61ea40e0', '0x558d626779f0', '0x558d62af9700']
buffer: '0x558d61ea3e60'
y: -1
date: 1588404930
date_usec: 25
date_printed: 1588404930
date_usec_printed: 25
str_time: 'F@0025209F@0024535F@0024030'
tags_count: 0
tags_array: []
displayed: 1
notify_level: 0
highlight: 0
refresh_needed: 0
prefix: ''
prefix_length: 0
message: 'this is the second line'-
Request the hotlist content:
(hdata_hotlist) hdata hotlist:gui_hotlist(*)
Response:
id: 'hdata_hotlist'
hda:
keys: {
'priority': 'int',
'creation_time.tv_sec': 'tim',
'creation_time.tv_usec': 'lon',
'buffer': 'ptr',
'count': 'arr',
'prev_hotlist': 'ptr',
'next_hotlist': 'ptr',
}
path: ['hotlist']
item 1:
__path: ['0x558d629601b0']
priority: 3
creation_time.tv_sec: 1588405398
creation_time.tv_usec: 355383
buffer: '0x558d62a9cea0'
count: [1, 1, 0, 1]
prev_hotlist: '0x0'
next_hotlist: '0x0'3.4. info
インフォ を要求。
構文:
(id) info <name> [<arguments>]
引数:
-
name: 読み出すインフォの名前
-
arguments: 引数 (任意)
Examples:
-
Request WeeChat version:
(info_version) info version
Response:
id: 'info_version'
inf: ('version', '2.9-dev')-
Request WeeChat version as number:
(info_version_number) info version_number
Response:
id: 'info_version_number'
inf: ('version_number', '34144256')-
Request WeeChat directory:
(info_weechat_config_dir) info weechat_config_dir
Response:
id: 'info_weechat_config_dir'
inf: ('weechat_config_dir', '/home/user/.config/weechat')3.5. infolist
インフォリスト を要求。
|
重要
|
インフォリストの内容は実際のデータの複製です。可能な限り hdata コマンドを使ってください、このコマンドはデータを直接読み出すことが可能です (高速、省メモリ、メッセージで返すオブジェクトのサイズが小さいです)。 |
構文:
(id) infolist <name> [<pointer> [<arguments>]]
引数:
-
name: 取得するインフォリストの名前
-
pointer: ポインタ (任意)
-
arguments: 引数 (任意)
Examples:
-
Request infolist "buffer":
(infolist_buffer) infolist buffer
Response:
id: 'infolist_buffer'
inl:
name: buffer
item 1:
pointer: '0x558d61ea3e60'
current_buffer: 1
plugin: '0x0'
plugin_name: 'core'
number: 1
layout_number: 1
layout_number_merge_order: 0
name: 'weechat'
full_name: 'core.weechat'
old_full_name: None
short_name: 'weechat'
type: 0
notify: 3
num_displayed: 1
active: 1
hidden: 0
zoomed: 0
print_hooks_enabled: 1
day_change: 1
clear: 1
filter: 1
closing: 0
first_line_not_read: 0
lines_hidden: 0
prefix_max_length: 0
time_for_each_line: 1
nicklist_case_sensitive: 0
nicklist_display_groups: 1
nicklist_max_length: 0
nicklist_count: 0
nicklist_groups_count: 0
nicklist_nicks_count: 0
nicklist_visible_count: 0
title: 'WeeChat 2.9-dev (C) 2003-2020 - https://weechat.org/'
input: 1
input_get_any_user_data: 0
input_get_unknown_commands: 0
input_get_empty: 0
input_multiline: 0
input_buffer: ''
input_buffer_alloc: 256
input_buffer_size: 0
input_buffer_length: 0
input_buffer_pos: 0
input_buffer_1st_display: 0
num_history: 0
text_search: 0
text_search_direction: 0
text_search_exact: 0
text_search_regex: 0
text_search_regex_compiled: '0x0'
text_search_where: 0
text_search_history: 0
text_search_found: 0
text_search_ptr_history: '0x0'
text_search_input: None
highlight_words: None
highlight_disable_regex: None
highlight_disable_regex_compiled: '0x0'
highlight_regex: None
highlight_regex_compiled: '0x0'
highlight_tags_restrict: None
highlight_tags: None
hotlist_max_level_nicks: None
keys_count: 0
localvar_name_00000: 'plugin'
localvar_value_00000: 'core'
localvar_name_00001: 'name'
localvar_value_00001: 'weechat'-
Request infolist "window":
(infolist_window) infolist window
Response:
id: 'infolist_window'
inl:
name: window
item 1:
pointer: '0x558d61ddc800'
current_window: 1
number: 1
x: 14
y: 0
width: 259
height: 71
width_pct: 100
height_pct: 100
chat_x: 14
chat_y: 1
chat_width: 259
chat_height: 68
buffer: '0x558d61ea3e60'
start_line_y: 03.6. nicklist
1 つまたは全てのバッファから ニックネームリスト を要求。
構文:
(id) nicklist [<buffer>]
引数:
-
buffer: ポインタ (eg: "0x1234abcd") またはバッファの完全な名前 (例: core.weechat または irc.libera.#weechat)
Examples:
-
Request nicklist for all buffers:
(nicklist_all) nicklist
Response:
id: 'nicklist_all'
hda:
keys: {
'group': 'chr',
'visible': 'chr',
'level': 'int',
'name': 'str',
'color': 'str',
'prefix': 'str',
'prefix_color': 'str',
}
path: ['buffer', 'nicklist_item']
item 1:
__path: ['0x558d61ea3e60', '0x558d61ea4120']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None
item 2:
__path: ['0x558d62840ea0', '0x558d61e75f90']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None
item 3:
__path: ['0x558d62a9cea0', '0x558d62abf2e0']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None
item 4:
__path: ['0x558d62a9cea0', '0x558d62afb9d0']
group: 1
visible: 1
level: 1
name: '000|o'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 5:
__path: ['0x558d62a9cea0', '0x558d62aff930']
group: 0
visible: 1
level: 0
name: 'FlashCode'
color: 'weechat.color.chat_nick_self'
prefix: '@'
prefix_color: 'lightgreen'
item 6:
__path: ['0x558d62a9cea0', '0x558d62af9930']
group: 1
visible: 1
level: 1
name: '001|v'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 7:
__path: ['0x558d62a9cea0', '0x558d62afc510']
group: 1
visible: 1
level: 1
name: '999|...'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 8:
__path: ['0x558d62a9cea0', '0x558d6292c290']
group: 0
visible: 1
level: 0
name: 'flashy'
color: '142'
prefix: ' '
prefix_color: 'lightblue'
item 9:
__path: ['0x558d62914680', '0x558d62afc4b0']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None-
Request nicklist for buffer "irc.libera.#weechat":
(nicklist_weechat) nicklist irc.libera.#weechat
Response:
id: 'nicklist_weechat'
hda:
keys: {
'group': 'chr',
'visible': 'chr',
'level': 'int',
'name': 'str',
'color': 'str',
'prefix': 'str',
'prefix_color': 'str',
}
path: ['buffer', 'nicklist_item']
item 1:
__path: ['0x558d62a9cea0', '0x558d62abf2e0']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None
item 2:
__path: ['0x558d62a9cea0', '0x558d62afb9d0']
group: 1
visible: 1
level: 1
name: '000|o'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 3:
__path: ['0x558d62a9cea0', '0x558d62aff930']
group: 0
visible: 1
level: 0
name: 'FlashCode'
color: 'weechat.color.chat_nick_self'
prefix: '@'
prefix_color: 'lightgreen'
item 4:
__path: ['0x558d62a9cea0', '0x558d62af9930']
group: 1
visible: 1
level: 1
name: '001|v'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 5:
__path: ['0x558d62a9cea0', '0x558d62afc510']
group: 1
visible: 1
level: 1
name: '999|...'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 6:
__path: ['0x558d62a9cea0', '0x558d6292c290']
group: 0
visible: 1
level: 0
name: 'flashy'
color: '142'
prefix: ' '
prefix_color: 'lightblue'3.7. input
バッファにデータを送信。
構文:
(id) input <buffer> <data>
引数:
-
buffer: ポインタ (eg: "0x1234abcd") またはバッファの完全な名前 (例: core.weechat または irc.libera.#weechat)
-
data: バッファに送信するデータ:
/で始まる場合、バッファ内でコマンドとして実行されます、それ以外の場合、テキストはバッファの入力として送信されます。
Examples:
-
Send command "/help filter" on WeeChat core bufer:
input core.weechat /help filter
-
Send message "hello!" to #weechat channel:
input irc.libera.#weechat hello!
-
Send multiline message to #test channel (option escape_commands must have been enabled in handshake command and requires WeeChat ≥ 4.0.0):
input irc.ergo.#test this message has\n2 lines
3.8. completion
WeeChat ≥ 2.9.
Request completion of a string: list of possible words at a given position in a string for a given buffer.
構文:
(id) completion <buffer> <position> [<data>]
引数:
-
buffer: pointer (eg: "0x1234abcd") or full name of buffer (for example: core.weechat or irc.libera.#weechat)
-
position: position for completion in string (starts to 0); if the value is -1, the position is the length of data (so the completion is made at the end of data)
-
data: the input string; if not given, completion is performed on an empty string
WeeChat replies with a hdata:
| Name | Type | Description |
|---|---|---|
|
string |
Completion context: "null" (no completion), "command", "command_arg", "auto". |
|
string |
The base word used for completion. |
|
integer |
Index of first char to replace (starts to 0). |
|
integer |
Index of last char to replace (starts to 0). |
|
integer |
1 if a space must be added after words, 0 otherwise. |
|
array of strings |
List of words found; empty if nothing was found to complete at asked position. |
|
注記
|
In case of error, for example invalid buffer or internal error on WeeChat side, an empty hdata is returned. |
Examples:
-
Completion of a command argument:
(completion_help) completion core.weechat -1 /help fi
Response:
id: 'completion_help'
hda:
keys: {
'context': 'str',
'base_word': 'str',
'pos_start': 'int',
'pos_end': 'int',
'add_space': 'int',
'list': 'arr',
}
path: ['completion']
item 1:
__path: ['0x55d0ccc842c0']
context: 'command_arg'
base_word: 'fi'
pos_start: 6
pos_end: 7
add_space: 0
list: [
'fifo',
'fifo.file.enabled',
'fifo.file.path',
'filter',
]-
Completion of a command in the middle of a word:
(completion_query) completion core.weechat 5 /quernick
Response:
id: 'completion_query'
hda:
keys: {
'context': 'str',
'base_word': 'str',
'pos_start': 'int',
'pos_end': 'int',
'add_space': 'int',
'list': 'arr',
}
path: ['completion']
item 1:
__path: ['0x55d0ccc88470']
context: 'command'
base_word: 'quer'
pos_start: 1
pos_end: 4
add_space: 1
list: ['query']-
Nothing to complete:
(completion_abcdefghijkl) completion core.weechat -1 abcdefghijkl
Response:
id: 'completion_abcdefghijkl'
hda:
keys: {
'context': 'str',
'base_word': 'str',
'pos_start': 'int',
'pos_end': 'int',
'add_space': 'int',
'list': 'arr',
}
path: ['completion']
item 1:
__path: ['0x55d0ccc88470']
context: 'auto'
base_word: 'abcdefghijkl'
pos_start: 0
pos_end: 11
add_space: 1
list: []-
Completion on an invalid buffer:
(completion_help) completion buffer.does.not.exist -1 /help fi
Response:
id: 'completion_help'
hda:
keys: {}
path: ['completion']3.9. sync
WeeChat バージョン 0.4.1 で更新。
更新を取得して 1 つまたは複数のバッファを同期。
|
重要
|
バッファのデータ (行、…) を要求した直後にこのコマンドを送信することをお勧めします。1 つのメッセージの中にこのコマンドを含める (改行文字 "\n" で区切る) ことで同時に送信できます。 |
構文:
(id) sync [<buffer>[,<buffer>...] <option>[,<option>...]]
引数:
-
buffer: ポインタ (eg: "0x1234abcd") またはバッファの完全な名前 (例: core.weechat または irc.libera.#weechat); 全てのバッファを指定するには "*" を使ってください
-
options: 以下に挙げるキーワード、コンマ区切り ("*" に対するデフォルトは buffers,upgrade,buffer,nicklist、バッファに対するデフォルトは buffer,nicklist):
-
buffers: バッファに関するシグナルを受け取る (オープン/クローズ、移動、リネーム、マージ/アンマージ、隠す/隠さない); これは名前が "*" の場合のみ利用可能 (WeeChat バージョン 0.4.1 以上で利用可)
-
upgrade: WeeChat アップグレードに関するシグナルを受信 (アップグレード、アップグレードの終了); 名前が "*" のバッファに対してのみ利用可能 (WeeChat バージョン 0.4.1 以上で利用可)
-
buffer: バッファに関するシグナルを受信 (新しい行、型の変更、タイトルの変更、ローカル変数の追加/削除、buffers と同じバッファに関するシグナル) (WeeChat バージョン 0.4.1 で更新)
-
nicklist: 変更後にニックネームリストを受信
-
Examples:
-
Synchronize all buffers with nicklist (the 3 commands are equivalent, but the first one is recommended for compatibility with future versions):
sync sync * sync * buffers,upgrade,buffer,nicklist
-
Synchronize WeeChat core buffer:
sync core.buffer
-
Synchronize #weechat channel, without nicklist:
sync irc.libera.#weechat buffer
-
Get general signals + all signals for #weechat channel:
sync * buffers,upgrade sync irc.libera.#weechat
3.10. desync
WeeChat バージョン 0.4.1 で更新。
更新を中止して 1 つまたは複数のバッファの同期を中止。
|
注記
|
バッファの オプション を削除します。バッファに対する一部のオプションがまだ有効な場合、クライアントはバッファに対するアップデートを受け取ります。 |
構文:
(id) desync [<buffer>[,<buffer>...] <option>[,<option>...]]
引数:
-
buffer: ポインタ (eg: "0x1234abcd") またはバッファの完全な名前 (例: core.weechat または irc.libera.#weechat); 全てのバッファを指定するには "*" を使ってください
-
options: 以下に挙げるキーワード、コンマ区切り ("*" に対するデフォルトは buffers,upgrade,buffer,nicklist、バッファに対するデフォルトは buffer,nicklist): 値に関する詳しい情報は sync コマンドを参照してください
|
注記
|
buffer に "*" を指定した場合、(名前を使って) 同期されている他のバッファは同期状態が保存されます。 このため "sync *"、"sync irc.libera.#weechat"、"desync *" の順に送信した場合、WeeChat は #weechat チャンネルに対するアップデートを送信し続けます (アップデートを止めるには、明示してこれを中止しなければいけません)。 |
Examples:
-
Desynchronize all buffers (the 3 commands are equivalent, but the first one is recommended for compatibility with future versions):
desync desync * desync * buffers,upgrade,buffer,nicklist
-
Desynchronize nicklist for #weechat channel (keep buffer updates):
desync irc.libera.#weechat nicklist
-
Desynchronize #weechat channel:
desync irc.libera.#weechat
3.11. test
テストコマンド: WeeChat は様々な種類のオブジェクトを返します。
このコマンドは WeeChat が返すバイナリオブジェクトのデコーディングをテストする際に便利です。
構文:
(id) test
返されるオブジェクト (以下の順番):
| 型 | Description | 値 |
|---|---|---|
|
char |
|
|
integer |
|
|
integer |
|
|
long |
|
|
long |
|
|
string |
|
|
string |
|
|
string |
|
|
buffer |
|
|
buffer |
|
|
pointer |
|
|
pointer |
|
|
time |
|
|
string の配列 |
|
|
integer の配列 |
|
|
重要
|
このコマンドが返したポインタ値を絶対に使ってはいけません、ポインタ値は無効です。このコマンドを WeeChat が返すメッセージのデコーディングをテストする場合以外に使わないでください。 |
例:
(test) test
Response:
id: 'test' chr: 65 int: 123456 int: -123456 lon: 1234567890 lon: -1234567890 str: 'a string' str: '' str: None buf: 'buffer' buf: None ptr: '0x1234abcd' ptr: '0x0' tim: 1321993456 arr: ['abc', 'de'] arr: [123, 456, 789]
4. メッセージ (リレー → クライアント)
メッセージは以下の書式でバイナリデータとして送信されます (サイズはバイト単位):
┌────────╥─────────────╥─────────╥────────┬──────────╥───────╥────────┬──────────┐
│ length ║ compression ║ id ║ type 1 │ object 1 ║ ... ║ type N │ object N │
└────────╨─────────────╨─────────╨────────┴──────────╨───────╨────────┴──────────┘
└──────┘ └───────────┘ └───────┘ └──────┘ └────────┘ └──────┘ └────────┘
4 1 4 + str 3 ?? 3 ??
└────────────────────┘ └───────────────────────────────────────────────────────┘
ヘッダ (5) 圧縮されたデータ (??)
└──────────────────────────────────────────────────────────────────────────────┘
'length' バイト
-
length (符号なし整数型、4 バイト): メッセージ全体のバイト数 (このフィールドを含む)
-
compression (バイト型): フラグ:
-
0x00: これ以降のデータは圧縮されていません
-
0x01: これ以降のデータは zlib ↗ で圧縮されています
-
0x02: これ以降のデータは Zstandard ↗ で圧縮されています
-
-
id (文字列型、4 バイト + 内容): クライアントが送信した識別子 (コマンド名の前につけられる); コマンドに識別子が含まれない場合は空文字列でも可 (内容を含まない長さゼロの文字列)
-
type (3 文字): 型の種類: 3 文字 (以下の表を参照)
-
object: オブジェクト (以下の表を参照)
4.1. 圧縮
If flag compression is equal to 0x01 or 0x02, then all data after is compressed with zlib ↗ or Zstandard ↗, and therefore must be uncompressed before being processed.
4.2. 識別子
識別子 (id) には 2 種類あります:
-
クライアント が送信する id: リレー は id を含む受信メッセージに対して同じ id を付けて応答します。
-
イベントの id: 一部のイベントで、リレー は クライアント に向けて特別な、アンダースコアで始まる、id を含むメッセージを送信します (以下の表を参照)
WeeChat の予約識別子:
| 識別子 | sync で受信 | 送信されるデータ | 説明 | 推奨するクライアントの挙動 |
|---|---|---|---|---|
|
buffers / buffer |
hdata: buffer |
バッファのオープン |
バッファを開く |
|
buffers / buffer |
hdata: buffer |
バッファの種類変更 |
バッファの種類を変更 |
|
buffers / buffer |
hdata: buffer |
バッファの移動 |
バッファを移動 |
|
buffers / buffer |
hdata: buffer |
バッファのマージ |
バッファをマージ |
|
buffers / buffer |
hdata: buffer |
バッファのアンマージ |
バッファをアンマージ |
|
buffers / buffer |
hdata: buffer |
バッファを隠す |
バッファを隠す |
|
buffers / buffer |
hdata: buffer |
バッファを隠すことを止める |
バッファを隠すことを止める |
|
buffers / buffer |
hdata: buffer |
バッファのリネーム |
バッファをリネーム |
|
buffers / buffer |
hdata: buffer |
バッファのタイトル変更 |
バッファのタイトルを変更 |
|
buffers / buffer |
hdata: buffer |
ローカル変数の追加 |
バッファに対するローカル変数を追加 |
|
buffers / buffer |
hdata: buffer |
ローカル変数の変更 |
バッファに対するローカル変数を変更 |
|
buffers / buffer |
hdata: buffer |
ローカル変数を削除 |
バッファからローカル変数を削除 |
|
buffers / buffer |
hdata: buffer |
バッファのクローズ |
バッファを閉じる |
|
buffer |
hdata: buffer |
バッファのクリア |
バッファをクリア |
|
buffer |
hdata: line |
バッファへの行追加 |
バッファに行を表示 |
|
buffer |
hdata: line |
Line changed in buffer. |
Update line displayed in buffer. |
|
nicklist |
hdata: nicklist_item |
バッファのニックネームリスト |
ニックネームリストを置換 |
|
nicklist |
hdata: nicklist_item |
バッファに対するニックネームの差分 |
ニックネームリストを更新 |
|
(常に) |
string: ping arguments |
"ping" に対する応答 |
応答時間の測定 |
|
upgrade |
(空) |
WeeChat のアップグレード中 |
WeeChat との同期を中止 (または切断) |
|
upgrade |
(空) |
WeeChat のアップグレード終了 |
WeeChat との同期および再同期 |
_buffer_opened
このメッセージは WeeChat が "buffer_opened" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
string |
短い名前 (例: #weechat) |
|
integer |
バッファがニックネームリストを持つ場合 1、それ以外は 0 |
|
string |
バッファのタイトル |
|
hashtable |
ローカル変数 |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: libera の #weechat チャンネルに参加、新しいバッファは irc.libera.#weechat:
id: '_buffer_opened'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'short_name': 'str',
'nicklist': 'int',
'title': 'str',
'local_variables': 'htb',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x35a8a60']
number: 3
full_name: 'irc.libera.#weechat'
short_name: None
nicklist: 0
title: None
local_variables: {
'plugin': 'irc',
'name': 'libera.#weechat',
}
prev_buffer: '0x34e7400'
next_buffer: '0x0'_buffer_moved
このメッセージは WeeChat が "buffer_moved" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: バッファ irc.libera.#weechat を番号 2 に移動:
id: '_buffer_moved'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x34588c0']
number: 2
full_name: 'irc.libera.#weechat'
prev_buffer: '0x347b9f0'
next_buffer: '0x3471bc0'_buffer_merged
このメッセージは WeeChat が "buffer_merged" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: バッファ irc.libera.#weechat をバッファ #2 とマージ:
id: '_buffer_merged'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x4db4c00']
number: 2
full_name: 'irc.libera.#weechat'
prev_buffer: '0x4cef9b0'
next_buffer: '0x0'_buffer_unmerged
このメッセージは WeeChat が "buffer_unmerged" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: バッファ irc.libera.#weechat をアンマージ:
id: '_buffer_unmerged'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x4db4c00']
number: 3
full_name: 'irc.libera.#weechat'
prev_buffer: '0x4cef9b0'
next_buffer: '0x0'_buffer_hidden
WeeChat バージョン 1.0 以上で利用可。
このメッセージは WeeChat が "buffer_hidden" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: バッファ irc.libera.#weechat を隠す:
id: '_buffer_hidden'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x4db4c00']
number: 2
full_name: 'irc.libera.#weechat'
prev_buffer: '0x4cef9b0'
next_buffer: '0x0'_buffer_unhidden
WeeChat バージョン 1.0 以上で利用可。
このメッセージは WeeChat が "buffer_unhidden" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
pointer |
前のバッファへのポインタ |
|
pointer |
次のバッファへのポインタ |
例: バッファ irc.libera.#weechat を隠すことを止める:
id: '_buffer_unhidden'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'prev_buffer': 'ptr',
'next_buffer': 'ptr',
}
path: ['buffer']
item 1:
__path: ['0x4db4c00']
number: 3
full_name: 'irc.libera.#weechat'
prev_buffer: '0x4cef9b0'
next_buffer: '0x0'_buffer_renamed
このメッセージは WeeChat が "buffer_renamed" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
string |
短い名前 (例: #weechat) |
|
hashtable |
ローカル変数 |
例: プライベートバッファを FlashCode から Flash2 にリネーム:
id: '_buffer_renamed'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'short_name': 'str',
'local_variables': 'htb',
}
path: ['buffer']
item 1:
__path: ['0x4df7b80']
number: 5
full_name: 'irc.libera.Flash2'
short_name: 'Flash2'
local_variables: {
'server': 'libera',
'plugin': 'irc',
'type': 'private',
'channel': 'FlashCode',
'nick': 'test',
'name': 'libera.Flash2',
}_buffer_title_changed
このメッセージは WeeChat が "buffer_title_changed" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
string |
バッファのタイトル |
例: チャンネル #weechat のトピックを変更:
id: '_buffer_title_changed'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'title': 'str',
}
path: ['buffer']
item 1:
__path: ['0x4a715d0']
number: 3
full_name: 'irc.libera.#weechat'
title: 'Welcome on #weechat! https://weechat.org/'_buffer_cleared
WeeChat バージョン 1.0 以上で利用可。
このメッセージは WeeChat が "buffer_cleared" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
例: バッファ irc.libera.#weechat をクリア:
id: '_buffer_cleared'
hda:
keys: {
'number': 'int',
'full_name': 'str',
}
path: ['buffer']
item 1:
__path: ['0x4a715d0']
number: 3
full_name: 'irc.libera.#weechat'_buffer_type_changed
このメッセージは WeeChat が "buffer_type_changed" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
integer |
バッファの種類: 0 = 書式あり (デフォルト)、1 = 自由内容 |
例: バッファ script.scripts の種類を書式あり (0) から自由内容 (1) に変更:
id: '_buffer_type_changed'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'type': 'int',
}
path: ['buffer']
item 1:
__path: ['0x27c9a70']
number: 4
full_name: 'script.scripts'
type: 1_buffer_localvar_added
このメッセージは WeeChat が "buffer_localvar_added" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
hashtable |
ローカル変数 |
例: irc.libera.#weechat にローカル変数 test を追加:
id='_buffer_localvar_added', objects:
hda:
keys: {
'number': 'int',
'full_name': 'str',
'local_variables': 'htb',
}
path: ['buffer']
item 1:
__path: ['0x4a73de0']
number: 3
full_name: 'irc.libera.#weechat'
local_variables: {
'server': 'libera',
'test': 'value',
'plugin': 'irc',
'type': 'channel',
'channel': '#weechat',
'nick': 'test',
'name': 'libera.#weechat',
}_buffer_localvar_changed
このメッセージは WeeChat が "buffer_localvar_changed" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
hashtable |
ローカル変数 |
例: irc.libera.#weechat に含まれるローカル変数 test を更新:
id='_buffer_localvar_changed', objects:
hda:
keys: {
'number': 'int',
'full_name': 'str',
'local_variables': 'htb',
}
path: ['buffer']
item 1:
__path: ['0x4a73de0']
number: 3
full_name: 'irc.libera.#weechat'
local_variables: {
'server': 'local',
'test': 'value2',
'plugin': 'irc',
'type': 'channel',
'channel': '#weechat',
'nick': 'test',
'name': 'libera.#weechat',
}_buffer_localvar_removed
このメッセージは WeeChat が "buffer_localvar_removed" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
|
hashtable |
ローカル変数 |
例: irc.libera.#weechat からローカル変数 test を削除:
id: '_buffer_localvar_removed'
hda:
keys: {
'number': 'int',
'full_name': 'str',
'local_variables': 'htb',
}
path: ['buffer']
item 1:
__path: ['0x4a73de0']
number: 3
full_name: 'irc.libera.#prout'
local_variables: {
'server': 'local',
'plugin': 'irc',
'type': 'channel',
'channel': '#weechat',
'nick': 'test',
'name': 'libera.#weechat',
}_buffer_line_added
このメッセージは WeeChat が "buffer_line_added" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
pointer |
バッファへのポインタ |
|
integer |
Line identifier. |
|
time |
メッセージの日付 |
|
integer |
Microseconds of date. |
|
time |
WeeChat メッセージを表示した日付 |
|
integer |
Microseconds of date when WeeChat displayed message. |
|
char |
メッセージが表示される場合は 1、メッセージがフィルタされる (隠される) 場合は 0 |
|
char |
Notify level: -1 = notify disabled, 0 = low, 1 = message, 2 = private, 3 = highlight. |
|
char |
行がハイライト部分を含む場合は 1、それ以外は 0 |
|
string の配列 |
行に対するタグのリスト |
|
string |
プレフィックス |
|
string |
メッセージ |
例: バッファ irc.libera.#weechat でニックネーム FlashCode からの新しいメッセージ hello!:
id: '_buffer_line_added'
hda:
keys: {
'buffer': 'ptr',
'id': 'int',
'date': 'tim',
'date_used': 'int',
'date_printed': 'tim',
'date_usec_printed': 'int',
'displayed': 'chr',
'notify_level': 'chr',
'highlight': 'chr',
'tags_array': 'arr',
'prefix': 'str',
'message': 'str',
}
path: ['line_data']
item 1:
__path: ['0x4a49600']
buffer: '0x4a715d0'
id: 12
date: 1362728993
date_usec: 902765
date_printed: 1362728993
date_usec_printed: 902765
displayed: 1
notify_level: 1
highlight: 0
tags_array: [
'irc_privmsg',
'notify_message',
'prefix_nick_142',
'nick_FlashCode',
'log1',
]
prefix: 'F06@F@00142FlashCode'
message: 'hello!'_buffer_line_changed
This message is sent to the client when the signal "buffer_line_data_changed" is sent by WeeChat.
Data sent as hdata: same data as _buffer_line_added.
Example: message hello! from nick FlashCode on buffer irc.libera.#weechat has been updated:
id: '_buffer_line_data_changed'
hda:
keys: {
'buffer': 'ptr',
'id': 'int',
'date': 'tim',
'date_used': 'int',
'date_printed': 'tim',
'date_usec_printed': 'int',
'displayed': 'chr',
'notify_level': 'chr',
'highlight': 'chr',
'tags_array': 'arr',
'prefix': 'str',
'message': 'str',
}
path: ['line_data']
item 1:
__path: ['0x4a49600']
buffer: '0x4a715d0'
id: 12
date: 1362728993
date_usec: 902765
date_printed: 1362728993
date_usec_printed: 902765
displayed: 1
notify_level: 1
highlight: 0
tags_array: [
'irc_privmsg',
'notify_message',
'prefix_nick_142',
'nick_FlashCode',
'log1',
]
prefix: 'F06@F@00142FlashCode'
message: 'hello!'_buffer_closing
このメッセージは WeeChat が "buffer_closing" シグナルを送信する際にクライアントに送られます。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
integer |
バッファ番号 (1 以上) |
|
string |
完全な名前 (例: irc.libera.#weechat) |
例: WeeChat がバッファ irc.libera.#weechat を閉じる:
id: '_buffer_closing'
hda:
keys: {
'number': 'int',
'full_name': 'str',
}
path: ['buffer']
item 1:
__path: ['0x4a715d0']
number: 3
full_name: 'irc.libera.#weechat'_nicklist
このメッセージはニックネームリストに対して巨大な更新 (グループおよびニックネームの追加/更新/変更) が行われた場合にクライアントに送られます。このメッセージには完全なニックネームリストが含まれます。
ニックネームリストに対して小さな更新が行われた場合 (例えばニックネームを 1 つだけ追加)、識別子 _nicklist_diff を含むメッセージが送信されます (以下を参照)。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
char |
グループの場合 1、ニックネームの場合 0 |
|
char |
グループおよびニックネームが表示される場合 1、それ以外は 0 |
|
integer |
グループのレベル (ニックネームの場合 0) |
|
string |
グループおよびニックネームの名前 |
|
string |
名前の色 |
|
string |
プレフィックス (ニックネーム専用) |
|
string |
プレフィックスの色 (ニックネーム専用) |
例: バッファ irc.libera.#weechat のニックネームリスト:
id: '_nicklist'
hda:
keys: {
'group': 'chr',
'visible': 'chr',
'level': 'int',
'name': 'str',
'color': 'str',
'prefix': 'str',
'prefix_color': 'str',
}
path: ['buffer', 'nicklist_item']
item 1:
__path: ['0x4a75cd0', '0x31e95d0']
group: 1
visible: 0
level: 0
name: 'root'
color: None
prefix: None
prefix_color: None
item 2:
__path: ['0x4a75cd0', '0x41247b0']
group: 1
visible: 1
level: 1
name: '000|o'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 3:
__path: ['0x4a75cd0', '0x4a60d20']
group: 0
visible: 1
level: 0
name: 'FlashCode'
color: '142'
prefix: '@'
prefix_color: 'lightgreen'
item 4:
__path: ['0x4a75cd0', '0x4aafaf0']
group: 1
visible: 1
level: 1
name: '001|v'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 5:
__path: ['0x4a75cd0', '0x4a48d80']
group: 1
visible: 1
level: 1
name: '999|...'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 6:
__path: ['0x4a75cd0', '0x4a5f560']
group: 0
visible: 1
level: 0
name: 'test'
color: 'weechat.color.chat_nick_self'
prefix: ' '
prefix_color: ''_nicklist_diff
WeeChat バージョン 0.4.1 以上で利用可。
このメッセージはニックネームリストに対して小さな更新 (グループおよびニックネームの追加/更新/変更) が行われた場合にクライアントに送られます。このメッセージにはニックネームリストの差分が含まれます (古いニックネームリストと新しいニックネームリストの差分)。
hdata として送られるデータ:
| 名前 | 型 | 説明 |
|---|---|---|
|
char |
差分の種類 (下を参照) |
|
char |
グループの場合 1、ニックネームの場合 0 |
|
char |
グループおよびニックネームが表示される場合 1、それ以外は 0 |
|
integer |
グループのレベル (ニックネームの場合 0) |
|
string |
グループおよびニックネームの名前 |
|
string |
名前の色 |
|
string |
プレフィックス (ニックネーム専用) |
|
string |
プレフィックスの色 (ニックネーム専用) |
_diff のとりうる値:
-
^: 親グループ: これの後に続くグループまたはニックネームに関する操作はこのグループに対して行う -
+: このグループおよびニックネームを親グループに追加 -
-: このグループおよびニックネームを親グループから削除 -
*: このグループおよびニックネームを親グループで更新
例: ニックネーム master を 000|o (IRC チャンネルのチャンネルオペレータ) グループに追加、ニックネーム nick1 と nick2 を 999|… に追加 (IRC チャンネルの一般ユーザ):
id: '_nicklist_diff'
hda:
keys: {
'_diff': 'chr',
'group': 'chr',
'visible': 'chr',
'level': 'int',
'name': 'str',
'color': 'str',
'prefix': 'str',
'prefix_color': 'str',
}
path: ['buffer', 'nicklist_item']
item 1:
__path: ['0x46f2ee0', '0x343c9b0']
_diff: 94 ('^')
group: 1
visible: 1
level: 1
name: '000|o'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 2:
__path: ['0x46f2ee0', '0x47e7f60']
_diff: 43 ('+')
group: 0
visible: 1
level: 0
name: 'master'
color: 'magenta'
prefix: '@'
prefix_color: 'lightgreen'
item 3:
__path: ['0x46f2ee0', '0x46b8e70']
_diff: 94 ('^')
group: 1
visible: 1
level: 1
name: '999|...'
color: 'weechat.color.nicklist_group'
prefix: None
prefix_color: None
item 4:
__path: ['0x46f2ee0', '0x3dba240']
_diff: 43 ('+')
group: 0
visible: 1
level: 0
name: 'nick1'
color: 'green'
prefix: ' '
prefix_color: ''
item 5:
__path: ['0x46f2ee0', '0x3c379d0']
_diff: 43 ('+')
group: 0
visible: 1
level: 0
name: 'nick2'
color: 'lightblue'
prefix: ' '
prefix_color: ''_pong
WeeChat バージョン 0.4.2 以上で利用可。
このメッセージは リレー が "ping" メッセージを受信する際にクライアントに送られます。
文字列として送られるデータ: "ping" メッセージで受信した引数。
クライアントは応答時間を測定し、応答時間が長い場合は切断することを推奨します。
4.3. オブジェクト
オブジェクトは type と呼ばれる 3 文字で特定されます。以下の種類が使われます:
| 型 | 値 | 長さ |
|---|---|---|
|
符号付文字 |
1 バイト |
|
符号付整数 |
4 バイト |
|
符号付長整数 |
1 バイト + 文字列で表現した整数の長さ |
|
文字列 |
4 バイト + 文字列の長さ (最後の |
|
バッファのバイト数 |
4 バイト + データの長さ |
|
ポインタ |
1 バイト + 文字列で表現したポインタの長さ |
|
時間 |
1 バイト + 文字列で表現した時間の長さ |
|
ハッシュテーブル |
可変 |
|
hdata の内容 |
可変 |
|
インフォ: 名前 + 内容 |
可変 |
|
インフォリストの内容 |
可変 |
|
オブジェクトの配列 |
3 バイト (型) + オブジェクトの数 + データ |
符号付整数
1 つの符号付整数は 4 バイトとして保存され、ビッグエンディアン書式でエンコードされています (データは上位バイトを先頭にして並べられています)。
範囲: -2147483648 から 2147483647。
例:
┌────┬────┬────┬────┐ │ 00 │ 01 │ E2 │ 40 │ ────► 123456 └────┴────┴────┴────┘ ┌────┬────┬────┬────┐ │ FF │ FE │ 1D │ C0 │ ────► -123456 └────┴────┴────┴────┘
符号付長整数
1 つの符号付長整数は文字列としてエンコードされています、文字列の長さは 1 バイトで表現されています。
範囲: -9223372036854775808 から 9223372036854775807。
例:
┌────╥────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐ │ 0A ║ 31 │ 32 │ 33 │ 34 │ 35 │ 36 │ 37 │ 38 │ 39 │ 30 │ ────► 1234567890 └────╨────┴────┴────┴────┴────┴────┴────┴────┴────┴────┘ └──┘ └───────────────────────────────────────────────┘ length '1' '2' '3' '4' '5' '6' '7' '8' '9' '0' ┌────╥────┬────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐ │ 0B ║ 2D │ 31 │ 32 │ 33 │ 34 │ 35 │ 36 │ 37 │ 38 │ 39 │ 30 │ ────► -1234567890 └────╨────┴────┴────┴────┴────┴────┴────┴────┴────┴────┴────┘ └──┘ └────────────────────────────────────────────────────┘ length '-' '1' '2' '3' '4' '5' '6' '7' '8' '9' '0'
文字列
1 つの文字列はその長さ (4 バイト表現した整数) + 文字列の内容 (最後の \0 を除く) で表現されています。
例:
┌────┬────┬────┬────╥────┬────┬────┬────┬────┐
│ 00 │ 00 │ 00 │ 05 ║ 68 │ 65 │ 6C │ 6C │ 6F │ ────► "hello"
└────┴────┴────┴────╨────┴────┴────┴────┴────┘
└─────────────────┘ └──────────────────────┘
length 'h' 'e' 'l' 'l' 'o'
空文字列を表現するには長さをゼロにしてください:
┌────┬────┬────┬────┐
│ 00 │ 00 │ 00 │ 00 │ ────► ""
└────┴────┴────┴────┘
└─────────────────┘
length
NULL 文字列 (C 言語の NULL ポインタ) を表現するにはの長さを -1 にしてください:
┌────┬────┬────┬────┐
│ FF │ FF │ FF │ FF │ ────► NULL
└────┴────┴────┴────┘
└─────────────────┘
length
バッファ
文字列と同じ書式; 内容は単純なバイトの配列。
ポインタ
1 つのポインタは文字列 (16 進数) としてエンコードされています、文字列の長さは 1 バイトで表現されています。
例:
┌────╥────┬────┬────┬────┬────┬────┬────┬────┬────┐ │ 09 ║ 31 │ 61 │ 32 │ 62 │ 33 │ 63 │ 34 │ 64 │ 35 │ ────► 0x1a2b3c4d5 └────╨────┴────┴────┴────┴────┴────┴────┴────┴────┘ └──┘ └──────────────────────────────────────────┘ length '1' 'a' '2' 'b' '3' 'c' '4' 'd' '5'
NULL ポインタを表現するには長さを 1 で値を 0 にしてください:
┌────╥────┐ │ 01 ║ 30 │ ────► NULL (0x0) └────╨────┘ └──┘ └──┘ length '0'
時間
1 つの時間 (秒数) は文字列としてエンコードされています、文字列の長さは 1 バイトで表現されています。
例:
┌────╥────┬────┬────┬────┬────┬────┬────┬────┬────┬────┐ │ 0A ║ 31 │ 33 │ 32 │ 31 │ 39 │ 39 │ 33 │ 34 │ 35 │ 36 │ ────► 1321993456 └────╨────┴────┴────┴────┴────┴────┴────┴────┴────┴────┘ └──┘ └───────────────────────────────────────────────┘ length '1' '3' '2' '1' '9' '9' '3' '4' '5' '6'
ハッシュテーブル
1 つのハッシュテーブルにはキーの種類、値の種類、ハッシュテーブルに含まれる要素の数 (1 バイト表現の整数)、要素のキーと値が含まれています。
┌───────────┬─────────────┬───────╥───────┬─────────╥─────╥───────┬─────────┐ │ type_keys │ type_values │ count ║ key 1 │ value 1 ║ ... ║ key N │ value N │ └───────────┴─────────────┴───────╨───────┴─────────╨─────╨───────┴─────────┘
例:
┌─────┬─────┬───╥──────┬─────╥──────┬─────┐
│ str │ str │ 2 ║ key1 │ abc ║ key2 │ def │ ────► { 'key1' => 'abc',
└─────┴─────┴───╨──────┴─────╨──────┴─────┘ 'key2' => 'def' }
└───┘ └───┘ └─┘ └──────────┘ └──────────┘
type type count item 1 item 2
keys values
hdata
1 つの hdata には hdata 名を含むパス、キーのリスト、オブジェクトセットの数、オブジェクトセット (ポインタのパス、オブジェクト) が含まれています。
┌────────┬──────┬───────╥────────┬─────────────────────╥─────╥────────┬─────────────────────╥─────┐ │ h-path │ keys │ count ║ p-path │ value 1 ... value N ║ ... ║ p-path │ value 1 ... value N ║ ... │ └────────┴──────┴───────╨────────┴─────────────────────╨─────╨────────┴─────────────────────╨─────┘
-
h-path (文字列): hdata にアクセスする際に使うパス (例: buffer/lines/line/line_data); 返される hdata はパスの最後の要素です
-
keys (文字列): key:type のリスト (コンマ区切り) を含む文字列、例: number:int,name:str
-
count (文字列): オブジェクトセットの数
-
p-path: オブジェクトへのポインタを含むパス (ポインタの数はパスに含まれる要素の数)
-
values: 値のリスト (値の数は hdata で返されるキーの数)
2 つのバッファ (weechat コアと libera サーバ) と 2 つのキー (number と full_name) を持つ hdata の例:
# コマンド hdata buffer:gui_buffers(*) number,full_name # 応答 ┌────────┬──────────────────────────┬───╥─────────┬───┬──────────────╥─────────┬───┬───────────────────┐ │ buffer │ number:int,full_name:str │ 2 ║ 0x12345 │ 1 │ core.weechat ║ 0x6789a │ 2 │ irc.server.libera │ └────────┴──────────────────────────┴───╨─────────┴───┴──────────────╨─────────┴───┴───────────────────┘ └──────┘ └────────────────────────┘ └─┘ └──────────────────────────┘ └───────────────────────────────┘ h-path keys count buffer 1 buffer 2
コアバッファの行を含む hdata の例:
# コマンド
hdata buffer:gui_buffers(*)/lines/first_line(*)/data
# 応答
┌─────────────────────────────┬─────┬────╥──
│ buffer/lines/line/line_data │ ... │ 50 ║ ...
└─────────────────────────────┴─────┴────╨──
└───────────────────────────┘ └───┘ └──┘
h-path (hdata names) keys count
──╥───────────┬───────────┬───────────┬───────────┬───────╥──
... ║ 0x23cf970 │ 0x23cfb60 │ 0x23d5f40 │ 0x23d8a10 │ ..... ║ ...
──╨───────────┴───────────┴───────────┴───────────┴───────╨──
└─────────────────────────────────────────────┘ └─────┘
p-path (pointers) objects
└─────────────────────────────────────────────────────┘
line 1
──╥───────────┬───────────┬───────────┬───────────┬───────╥──────────────┐
... ║ 0x23cf970 │ 0x23cfb60 │ 0x23d6110 │ 0x23d9420 │ ..... ║ ............ │
──╨───────────┴───────────┴───────────┴───────────┴───────╨──────────────┘
└─────────────────────────────────────────────┘ └─────┘
p-path (pointers) objects
└─────────────────────────────────────────────────────┘ └────────────┘
line 2 lines 3-50
ニックネームリストを含む hdata の例:
# コマンド
nicklist
# 応答
┌───────────────────┬──
│ buffer/nick_group │ ...
└───────────────────┴──
└─────────────────┘
h-path
──╥───────────────────────────────────────────────────────────┬────╥──
... ║ group:chr,visible:chr,name:str,color:str,prefix:str,(...) │ 12 ║ ...
──╨───────────────────────────────────────────────────────────┴────╨──
└─────────────────────────────────────────────────────────┘ └──┘
keys count
──╥─────────┬─────────┬───┬───┬──────┬─┬─┬─┬───╥──
... ║ 0x12345 │ 0x6789a │ 1 │ 0 │ root │ │ │ │ 0 ║ ...
──╨─────────┴─────────┴───┴───┴──────┴─┴─┴─┴───╨──
└─────────────────┘ └──────────────────────┘
p-path objects
└──────────────────────────────────────────┘
group (nicklist root)
──╥─────────┬─────────┬───┬───┬───────┬─┬─┬─┬───╥──
... ║ 0x123cf │ 0x678d4 │ 1 │ 0 │ 000|o │ │ │ │ 1 ║ ...
──╨─────────┴─────────┴───┴───┴───────┴─┴─┴─┴───╨──
└─────────────────┘ └───────────────────────┘
p-path objects
└───────────────────────────────────────────┘
group (channel ops)
──╥─────────┬─────────┬───┬───┬──────────┬──────┬───┬────────────┬───╥──
... ║ 0x128a7 │ 0x67ab2 │ 0 │ 1 │ ChanServ │ blue │ @ │ lightgreen │ 0 ║ ...
──╨─────────┴─────────┴───┴───┴──────────┴──────┴───┴────────────┴───╨──
└─────────────────┘ └────────────────────────────────────────────┘
p-path objects
└────────────────────────────────────────────────────────────────┘
nick (@ChanServ)
空の hdata の例 (WeeChat のホットリストが空の場合):
# コマンド hdata hotlist:gui_hotlist(*) # 応答 ┌────────┬────────┬───┐ │ (NULL) │ (NULL) │ 0 │ └────────┴────────┴───┘ └──────┘ └──────┘ └─┘ h-path keys count
インフォ
1 つの インフォ は名前と値を含んでいます (両方とも文字列)。
┌──────┬───────┐ │ name │ value │ └──────┴───────┘
-
name (文字列): インフォの名前
-
value (文字列): 値
version インフォの例:
┌─────────┬───────────────────┐ │ version │ WeeChat 0.3.7-dev │ └─────────┴───────────────────┘
インフォリスト
1 つの インフォリスト は名前、要素の数、要素 (変数のセット) を含んでいます。
┌──────┬───────╥────────╥─────╥────────┐ │ name │ count ║ item 1 ║ ... ║ item N │ └──────┴───────╨────────╨─────╨────────┘
要素とは:
┌───────╥────────┬────────┬─────────╥─────╥────────┬────────┬─────────┐ │ count ║ name 1 │ type 1 │ value 1 ║ ... ║ name N │ type N │ value N │ └───────╨────────┴────────┴─────────╨─────╨────────┴────────┴─────────┘
-
name (文字列): インフォリストの名前 (buffer、window、bar、…)
-
count (整数): 要素の数
-
item:
-
count: 要素に含まれる変数の数
-
name: 変数の名前
-
type: 変数の型 (int、str、…)
-
value: 変数の値
-
2 つのバッファ (weechat コアと libera サーバ) を持つインフォリストの例:
# コマンド infolist buffer # 応答 ┌────────┬───╥────┬─────────┬─────┬─────────┬─────╥────┬─────────┬─────┬─────────┬─────┐ │ buffer │ 2 ║ 42 │ pointer │ ptr │ 0x12345 │ ... ║ 42 │ pointer │ ptr │ 0x6789a │ ... │ └────────┴───╨────┴─────────┴─────┴─────────┴─────╨────┴─────────┴─────┴─────────┴─────┘ └──────┘ └─┘ └──────────────────────────────────┘ └──────────────────────────────────┘ name count item 1 item 2
配列
1 つの配列は型 (3 バイト) + オブジェクトの数 (4 バイト表現の整数) + データからなります。
2 つの文字列を持つ配列の例:
┌─────╥────┬────┬────┬────╥────┬────┬────┬────╥────┬────┬────╥────┬────┬────┬────╥────┬────┐ │ str ║ 00 │ 00 │ 00 │ 02 ║ 00 │ 00 │ 00 │ 03 ║ 61 │ 62 │ 63 ║ 00 │ 00 │ 00 │ 02 ║ 64 │ 65 │ ────► [ "abc", "de" ] └─────╨────┴────┴────┴────╨────┴────┴────┴────╨────┴────┴────╨────┴────┴────┴────╨────┴────┘ └───┘ └─────────────────┘ └─────────────────┘ └────────────┘ └─────────────────┘ └───────┘ type number of strings length 'a' 'b' 'c' length 'd' 'e'
3 つの整数を持つ配列の例:
┌─────╥────┬────┬────┬────╥────┬────┬────┬────╥────┬────┬────┬────╥────┬────┬────┬────┐ │ int ║ 00 │ 00 │ 00 │ 03 ║ 00 │ 00 │ 00 │ 7B ║ 00 │ 00 │ 01 │ C8 ║ 00 │ 00 │ 03 │ 15 │ ────► [ 123, 456, 789 ] └─────╨────┴────┴────┴────╨────┴────┴────┴────╨────┴────┴────┴────╨────┴────┴────┴────┘ └───┘ └─────────────────┘ └─────────────────┘ └─────────────────┘ └─────────────────┘ type number of integers 123 (0x7B) 456 (0x1C8) 789 (0x315)
NULL 配列:
┌─────╥────┬────┬────┬────┐ │ str ║ 00 │ 00 │ 00 │ 00 │ ────► NULL └─────╨────┴────┴────┴────┘ └───┘ └─────────────────┘ type number of strings
5. 典型的なセッション
┌──────────────┐ ┌────────┐ ┌─────────┐
│ クライアント ├ ─(ネットワーク)─ ┤ リレー ├──────────────────┤ WeeChat │
└──────────────┘ └────────┘ └─────────┘
║ ║ ║
╟───────────────────────────────► ║ ║
║ ソケットをオープン ║ クライアントを追加 ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: handshake ... ║ negotiate algos ║
║ ║ and options ║
║ ◄───────────────────────────────╢ ║
║ msg: id: "handshake" ... ║ ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: init password=xxx,... ║ クライアントを初期化/許可 ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: hdata buffer ... ╟─────────────────────────► ║
║ sync ... ║ hdata の要求 ║ hdata
║ ║ ║ の値を読み出し
║ ║ ◄─────────────────────────╢
║ ◄───────────────────────────────╢ hdata ║
バッファ ║ msg: hda buffer ║ ║
を作成 ║ ║ ║
║ ........ ║ ........ ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: input ... ╟─────────────────────────► ║
║ ║ バッファにデータを送信 ║ バッファに
║ ║ ║ データを送信
║ ........ ║ ........ ║
║ ║ ║ シグナル
║ ║ ◄─────────────────────────╢ の受信
║ ◄───────────────────────────────╢ シグナル XXX ║ (リレー
バッファ ║ msg: id: "_buffer_..." ║ ║ がフック)
を更新 ║ ║ ║
║ ........ ║ ........ ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: ping ... ║ ║
║ ║ ║
║ ◄───────────────────────────────╢ ║
応答 ║ msg: id: "_pong" ... ║ ║
時間 ║ ║ ║
を計測 ║ ........ ║ ........ ║
║ ║ ║
╟───────────────────────────────► ║ ║
║ cmd: quit ║ クライアントを切断 ║
║ ║ ║