This is the Perl interface for HexChat. If there are any problems, questions, comments or suggestions please email them to the address on the bottom of this page.
This is the first thing to call in every script.
Xchat::hook_server( $message, $callback, [\%options] )
Xchat::hook_command( $command, $callback, [\%options] )
Xchat::hook_print( $event,$callback, [\%options] )
Xchat::hook_timer( $timeout,$callback, [\%options | $data] )
Xchat::hook_fd( $handle, $callback, [ \%options ] )
These functions can be to intercept various events. hook_server can be used to intercept any incoming message from the IRC server. hook_command can be used to intercept any command, if the command doesn’t currently exist then a new one is created. hook_print can be used to intercept any of the events listed in Setttings -> Text Events. hook_timer can be used to create a new timer
Valid keys for %options:
data | Additional data that is to be associated with the hook. For timer hooks this value can be provided either as Xchat::hook_timer( $timeout, cb,{data=> data}) or Xchat::hook_timer( $timeout, $cb, $data ). However, this means that hook_timer cannot be provided with a hash reference containing data as a key. example: my $options = { data => [@arrayOfStuff] }; Xchat::hook_timer( $timeout, $cb, $options ); In this example, the timer’s data will be [@arrayOfStuff] and not { data => [@arrayOfStuff] } This key is valid for all of the hook functions. Default is undef. |
priority | Sets the priority for the hook. It can be set to one of the Xchat::PRI_* constants. This key only applies to server, command and print hooks. Default is Xchat::PRI_NORM. |
help_text | Text displayed for /help $command. This key only applies to command hooks. Default is “”. |
flags | Specify the flags for a fd hook. See hook fd flags section for valid values. On Windows if the handle is a pipe you specify Xchat::FD_NOTSOCKET in addition to any other flags you might be using. This key only applies to fd hooks. Default is Xchat::FD_READ |
Each of the hooks will be triggered at different times depending on the type of hook.
Hook Type | When the callback will be invoked |
---|---|
server hooks | a $message message is received from the server |
command hooks | the $command command is executed, either by the user or from a script |
print hooks | X-Chat is about to print the message for the $event event |
timer hooks | called every $timeout milliseconds (1000 millisecond is 1 second) the callback will be executed in the same context where the hook_timer was called, if the context no longer exists then it will execute in a random context |
fd hooks | depends on the flags that were passed to hook_fd See hook_fd flags section above. |
The value return from these hook functions can be passed to Xchat::unhook to remove the hook.
All callback functions will receive their arguments in @_ like every other Perl subroutine.
Server and command callbacks
$_[0] - array reference containing the IRC message or command and arguments broken into words example: /command arg1 arg2 arg3 $_[0][0] - command $_[0][1] - arg1 $_[0][2] - arg2 $_[0][3] - arg3
$_[1] - array reference containing the Nth word to the last word example: /command arg1 arg2 arg3 $_[1][0] - command arg1 arg2 arg3 $_[1][1] - arg1 arg2 arg3 $_[1][2] - arg2 arg3 $_[1][3] - arg3
$_[2] - the data that was passed to the hook function
Print callbacks
$_[0] - array reference containing the values for the text event, see Settings -> Text Events $_[1] - the data that was passed to the hook function
Timer callbacks
$_[0] - the data that was passed to the hook function
fd callbacks
$_[0] - the handle that was passed to hook_fd $_[1] - flags indicating why the callback was called $_[2] - the data that was passed to the hook function
All server, command and print callbacks should return one of the Xchat::EAT_* constants. Timer callbacks can return Xchat::REMOVE to remove the timer or Xchat::KEEP to keep it going.
This function is used to removed a hook previously added with one of the Xchat::hook_* functions.
It returns the data that was passed to the Xchat::hook_* function when the hook was added.
The first argument can either be a string or an array reference of strings. Either or both of $channel and $server can be undef.
If called as Xchat::print( $text ), it will always return true. If called with either the channel or the channel and the server specified then it will return true if a context is found and false otherwise. The text will not be printed if the context is not found. The meaning of setting $channel or $server to undef is the same as find_context.
The first argument can either be a string or an array reference of strings. Either or both of $channel and $server can be undef.
If called as Xchat::command( $command ), it will always return true. If called with either the channel or the channel and the server specified then it will return true if a context is found and false otherwise. The command will not be executed if the context is not found. The meaning of setting $channel or $server to undef is the same as find_context.
Either or both of $channel and $server can be undef. Calling Xchat::find_context() is the same as calling Xchat::find_context( undef, undef) and Xchat::find_context( $channel ) is the same as Xchat::find_context( $channel, undef ).
If $server is undef, find any channel named $channel. If $channel is undef, find the front most window or tab named $server.If both $channel and $server are undef, find the currently focused tab or window.
Return the context found for one of the above situations or undef if such a context cannot be found.
Returns the current context.
See find_context for more details on $channel and $server.
Returns true on success, false on failure.
ID | Return value | Associated Command(s) |
---|---|---|
away | away reason or undef if you are not away | AWAY, BACK |
channel | current channel name | SETTAB |
charset | character-set used in the current context | CHARSET |
configdir | HexChat config directory encoded in UTF-8. Examples: /home/user/.config/hexchat C:UsersuserAppdataRoamingHexChat | |
event_text <Event Name> | text event format string for <Event name> Example:
|
|
host | real hostname of the current server | |
id | connection id | |
inputbox | contents of the inputbox | SETTEXT |
libdirfs | the system wide directory where xchat will look for plugins. this string is in the same encoding as the local file system | |
modes | the current channels modes or undef if not known | MODE |
network | current network name or undef, this value is taken from the Network List | |
nick | current nick | NICK |
nickserv | nickserv password for this network or undef, this value is taken from the Network List | |
server | current server name (what the server claims to be) undef if not connected | |
state_cursor | current inputbox cursor position in characters | SETCURSOR |
topic | current channel topic | TOPIC |
version | xchat version number | |
win_status | status of the xchat window, possible values are “active”, “hidden” and “normal” | GUI |
win_ptr | native window pointer, GtkWindow * on Unix, HWND on Win32. On Unix if you have the Glib module installed you can use my $window = Glib::Object->new_from_pointer( Xchat::get_info( “win_ptr” ) ); to get a Gtk2::Window object. Additionally when you have detached tabs, each of the windows will return a different win_ptr for the different Gtk2::Window objects. See char_count.pl for a longer example of a script that uses this to show how many characters you currently have in your input box. | |
gtkwin_ptr | similar to win_ptr except it will always be a GtkWindow * |
This function is used to retrieve certain information about the current context. If there is an associated command then that command can be used to change the value for a particular ID.
This function provides a way to retrieve HexChat’s setting information.
Returns undef if there is no setting called called $name.
This functions is used to generate one of the events listed under Settings -> Text Events.
Note: when using this function you must return Xchat::EAT_ALL otherwise you will end up with duplicate events. One is the original and the second is the one you emit.
Returns true on success, false on failure.
Send multiple mode changes for the current channel. It may send multiple MODE lines if the request doesn’t fit on one.
Example:
use strict;
use warnings;
use Xchat qw(:all);
hook_command( "MODES", sub {
my (undef, $who, $sign, $mode) = @{$_[0]};
my @targets = split /,/, $who;
if( @targets > 1 ) {
send_modes( \@targets, $sign, $mode, 1 );
} else {
send_modes( $who, $sign, $mode );
}
return EAT_XCHAT;
});
The comparsion is based on the current server. Either an RFC1459 compliant string compare or plain ascii will be using depending on the server. The comparison is case insensitive.
Returns a number less than, equal to or greater than zero if $nick1 is found respectively, to be less than, to match, or be greater than $nick2.
This function will return a list of hash references. The hash references will have different keys depend on the list. An empty list is returned if there is no such list.
“channels” - list of channels, querys and their server
Key | Description |
---|---|
channel | tab name |
chantypes | channel types supported by the server, typically “#&” |
context | can be used with set_context |
flags | Server Bits:
The following correspond to the /chanopt command
Example of checking if the current context has Hide Join/Part messages set:
} |
id | Unique server ID |
lag | lag in milliseconds |
maxmodes | Maximum modes per line |
network | network name to which this channel belongs |
nickprefixes | Nickname prefixes e.g. “+@” |
nickmodes | Nickname mode chars e.g. “vo” |
queue | number of bytes in the send queue |
server | server name to which this channel belongs |
type | the type of this context - 1 server - 2 channel - 3 dialog - 4 notices - 5 server notices |
users | Number of users in this channel |
“dcc” - list of DCC file transfers
Key | Value |
---|---|
address32 | address of the remote user(ipv4 address) |
cps | bytes per second(speed) |
destfile | destination full pathname |
file | file name |
nick | nick of the person this DCC connection is connected to |
port | TCP port number |
pos | bytes sent/received |
poshigh | bytes sent/received, high order 32 bits |
resume | point at which this file was resumed (zero if it was not resumed) |
resumehigh | point at which this file was resumed, high order 32 bits |
size | file size in bytes low order 32 bits |
sizehigh | file size in bytes, high order 32 bits (when the files is > 4GB) |
status | DCC Status:
|
type | DCC Type:
|
“ignore” - current ignore list
Key | Value |
---|---|
mask | ignore mask. e.g: !*@.aol.com |
flags | Bit field of flags.
|
“notify” - list of people on notify
Key | Value |
---|---|
networks | comma separated list of networks where you will be notfified about this user’s online/offline statusor undef if you will be notificed on every network you are connected to |
nick | nickname |
flags | 0 = is online |
on | time when user came online |
off | time when user went offline |
seen | time when user was last verified still online |
The values indexed by on, off and seen can be passed to localtime and gmtime, see perldoc -f localtime and perldoc -f gmtime for more details.
“users” - list of users in the current channel
Key | Value |
---|---|
account | account name or undef (2.9.6+) |
away | away status(boolean) |
lasttalk | last time a user was seen talking, this is the an epoch time(number of seconds since a certain date, that date depends on the OS) |
nick | nick name |
host | host name in the form: user@host or undef if not known |
prefix | prefix character, .e.g: @ or + |
realname | Real name or undef |
selected | selected status in the user list, only works when retrieving the user list of the focused tab. You can use the /USELECT command to select the nicks |
“networks” - list of networks and the associated settings from network list
Key | Value |
---|---|
autojoins | An object with the following methods:
|
connect_commands | An array reference containing the connect commands for a network. An empty array if there aren’t any |
encoding | the encoding for the network |
flags | a hash reference corresponding to the checkboxes in the network edit window
|
irc_nick1 | Corresponds with the “Nick name” field in the network edit window |
irc_nick2 | Corresponds with the “Second choice” field in the network edit window |
irc_real_name | Corresponds with the “Real name” field in the network edit window |
irc_user_name | Corresponds with the “User name” field in the network edit window |
network | Name of the network |
nickserv_password | Corresponds with the “Nickserv password” field in the network edit window |
selected | Index into the list of servers in the “servers” key, this is used if the “cycle” flag is false |
server_password | Corresponds with the “Server password” field in the network edit window |
servers | An array reference of hash references with a “host” and “port” key. If a port is not specified then 6667 will be used. |
This function is mainly intended to be used as a shortcut for when you need to retrieve some information about only one user in a channel. Otherwise it is better to use get_list. If $nick is found a hash reference containing the same keys as those in the “users” list of get_list is returned otherwise undef is returned. Since it relies on get_list this function can only be used in a channel context.
This function will return the information normally retrieved with get_info, except this is for the context that is passed in. The information will be returned in the form of a hash. The keys of the hash are the $id you would normally supply to get_info as well as all the keys that are valid for the items in the “channels” list from get_list. Use of this function is more efficient than calling get_list( “channels” ) and searching through the result.
Example:
use strict;
use warnings;
use Xchat qw(:all); # imports all the functions documented on this page
register( "User Count", "0.1",
"Print out the number of users on the current channel" );
hook_command( "UCOUNT", \&display_count );
sub display_count {
prnt "There are " . context_info()->{users} . " users in this channel.";
return EAT_XCHAT;
}
This function will remove bold, color, beep, reset, reverse and underline codes from $string. It will also remove ANSI escape codes which might get used by certain terminal based clients. If it is called in void context $string will be modified otherwise a modified copy of $string is returned.
use strict;
use warnings;
use Xchat qw(:all);
use Net::DNS;
hook_command( "BGDNS", sub {
my $host = $_[0][1];
my $resolver = Net::DNS::Resolver->new;
my $sock = $resolver->bgsend( $host );
hook_fd( $sock, sub {
my $ready_sock = $_[0];
my $packet = $resolver->bgread( $ready_sock );
if( $packet->authority && (my @answers = $packet->answer ) ) {
if( @answers ) {
prnt "$host:";
my $padding = " " x (length( $host ) + 2);
for my $answer ( @answers ) {
prnt $padding . $answer->rdatastr . ' ' . $answer->type;
}
}
} else {
prnt "Unable to resolve $host";
}
return REMOVE;
},
{
flags => FD_READ,
});
return EAT_XCHAT;
});
Contact Lian Wan Situ at <atmcmnky [at] yahoo.com> for questions, comments and corrections about this page or the Perl plugin itself. You can also find me in #xchat on freenode under the nick Khisanth.