Previous: irc variables, Up: irc Analyzer
irc
event handlersThe standard script handles the following events:
irc_privmsg_message (c: connection, source: string, target: string, message: string)
'IRC
command: PRIVMSG
The source is the user who sent the message to the target user/channel.
Message contains the data sent to the target.
irc_notice_message (c: connection, source: string, target: string, message: string)
'IRC
command: NOTICE
The source is the user who sent the message to the target user/channel.
Message contains the data sent to the target.
irc_squery_message (c: connection, source: string, target: string, message: string)
'IRC
command: SQUERY
The source is the user who sent the message to the target service.
Message contains the data sent to the target.
irc_enter_message (c: connection, nick: string, realname: string)
'IRC
command: USER
Nick contains the selected nick name of the user and realname the user's
name in real life.
irc_quit_message (c: connection, nick: string, message: string)
'IRC
command: QUIT
Nick contains the nick name of the sender. An optional quit message is included in message.
irc_join_message (c: connection, infoList: irc_join_list)
'IRC
command: JOIN
The infoList contains a list of joined channel names and - if provided by
user - the passwords for them.
irc_part_message (c: connection, nick: string, channels: string_set, message: string)
'IRC
command: PART
Nick contains the nick name of the user.
Channels is a set of channel names.
If the user supplies a quit message it is included in message.
irc_nick_message (c: connection, who: string, newnick: string)
'IRC
command: NICK
Who contains the IRC message prefix which includes the user nick and host.
Newnick is the new nick name of this user.
irc_invalid_nick (c: connection)
'IRC
response to: NICK
irc_network_info (c: connection, users: count, services: count, servers: count)
'IRC
response to: LUSERS
Users, services and servers are the total number of users, services and IRC servers connected to the IRC network.
irc_server_info (c: connection, users: count, services: count, servers: count)
'IRC
response to: LUSERS
Users, services and servers are the total number of users, services and IRC servers connected with this IRC server.
irc_channel_info (c: connection, channels: count)
'IRC
response to: LUSERS
Channels is the number of IRC channels formed on this server (local + global).
irc_who_message (c: connection, mask: string, oper: bool)
'IRC
command: WHO
Mask is the target of the search. This can be a channel or user name,
wildcards are allowed. If oper is true then the user asks only for operator
user results.
irc_who_line (c: connection, target_nick: string, channel:
This includes several information about an IRC user.
IRC
response to: WHO
Target_nick
is the nick name of the IRC user who sent the WHO request.
The username of the returned IRC user is included in user
, his nick
name in nick
and real name in realname
. The client DNS/IP
address is host
. Params
includes the channel parameters for
this user (e.g. "@" for channel operators). The user is connected to IRC
server server
and the number of servers between him and the requester
is hops
. Channel
includes the channel name which was target
for the request.
irc_whois_message (c: connection, server: string, users: string)
'IRC
command: WHOIS
If server is given then the user wants this specific server to answer.
Users is comma separated list of nick names for which information is
requested.
irc_whois_user_line (c: connection, nick: string, user: string, host: string, realName: string)
'IRC
response to: WHOIS
The user with nick name nick has the user name user and his real name is realname. The IRC client runs on host.
irc_whois_operator_line (c: connection, nick: string)
'IRC
response to: WHOIS
The IRC user with nick name nick has operator status.
irc_whois_channel_line (c: connection, nick: string, channels: string_set)
'IRC
response to: WHOIS
The IRC user with nick name nick is member in all IRC channels of the
variable channels.
irc_oper_message (c: connection, user: string, password: string)
'IRC
command: OPER
The user and password parameters are used to authenticate the possible
operator. They must fit to the IRCD server settings.
irc_oper_response (c: connection, got_oper: bool)
'IRC
response to: OPER
If the IRC user got operator status the got_oper variable is true.
irc_kick_message (c: connection, prefix: string, channels: string, users: string, comment: string)
'IRC
command: KICK
Prefix includes the requesters nick name and host. The user requested to
remove the users (comma separated list) from the channels (comma separated
list). If the requester provided an optional kick message it is included
in comment.
irc_error_message (c: connection, prefix: string, message: string)
'IRC
command: ERROR
Prefix includes the server name and message contains the error message.
irc_invite_message (c: connection, prefix: string, nickname: string, channel: string)
'IRC
command: INVITE
Prefix includes the senders nick and host. The IRC user with the nick name
nickname is invited to the channel with name channel.
irc_mode_message (c: connection, prefix: string, params: string)
'IRC
command: MODE
irc_squit_message (c: connection, prefix: string, server: string, message: string)
'IRC
command: SQUIT
Prefix includes the requesters nick and host. Server is the host name of
the server to disconnect and message contains an optional comment.
irc_names_info (c: connection, c_type: string, channel: string, users: string_set)
'IRC
response to: NAMES
C_type is "@" for secret, "*" for private and "=" for public channels.
Channel contains the channel name. Users is a list of nick names that are
member of this channel.
irc_dcc_message (c: connection, prefix: string, target: string, dcc_type: string,
An user sent a DCC request to another user to setup a direct connection between these users.
IRC
command: PRIVMSG DCC
Prefix contains the requesters nick and host. Target contains the target
user's nick name. Dcc_type can be "CHAT" for chat connections or "SEND"
for file transfers. Argument contains the file name for file transfers
or "chat" for chat connections. Address and dest_port specify where the
target user should connect. Size is only given for file transfers and
contains the file size in bytes.
irc_request (c: connection, prefix: string, command: string, arguments: string)
'Prefix is usually formated like this: <nickname>!<user>@<hostname>.
Command contains the command string which was sent and arguments the
corresponding argument values.
irc_message (c: connection, prefix: string, command: string, message: string)
'Prefix is usually the server name. Command contains the command string
which was sent and message contains additional parameters.
irc_response (c: connection, prefix: string, code: count, params: string)
'Prefix is usually the server name. Code is the numeric reply code and params contains any additional parameters.