XChat 2.0 Plugin Interface

Information:

Introduction
Sample plugin
What is word and word_eol?
Lists and fields
Plugins on Windows (Win32)
Controlling the GUI

Functions:

xchat_hook_command
xchat_hook_fd
xchat_hook_print
xchat_hook_server
xchat_hook_timer
xchat_unhook

xchat_command
xchat_commandf
xchat_print
xchat_printf
xchat_emit_print

xchat_find_context
xchat_get_context
xchat_get_info
xchat_get_prefs
xchat_set_context

xchat_nickcmp

xchat_list_get
xchat_list_free
xchat_list_fields (not documented yet)
xchat_list_next
xchat_list_str
xchat_list_int
xchat_list_time

xchat_plugingui_add (not documented yet)
xchat_plugingui_remove (not documented yet)

Introduction

	gcc -Wall -O1 -shared myplugin.c -o myplugin.so

All strings passed to and from plugins are encoded in UTF-8, regardless of locale.

Sample plugin

#include "xchat-plugin.h"

static xchat_plugin *ph;   /* plugin handle */
static int enable = 1;

static int join_cb(char *word[], void *userdata)
{
   if (enable)
      /* Op ANYONE who joins */
      xchat_commandf(ph, "OP %s", word[1]);
   /* word[1] is the nickname, as in the Settings->Lists->EventTexts window in xchat */

   return XCHAT_EAT_NONE;  /* don't eat this event, xchat needs to see it! */
}

static int autooptoggle_cb(char *word[], char *word_eol[], void *userdata)
{
   if (!enable)
   {
      enable = 1;
      xchat_print(ph, "AutoOping now enabled!\n");
   } else
   {
      enable = 0;
      xchat_print(ph, "AutoOping now disabled!\n");
   }

   return XCHAT_EAT_ALL;   /* eat this command so xchat and other plugins can't process it */
}

int xchat_plugin_init(xchat_plugin *plugin_handle,
                      char **plugin_name,
                      char **plugin_desc,
                      char **plugin_version,
                      char *arg)
{
   /* we need to save this for use with any xchat_* functions */
   ph = plugin_handle;

   *plugin_name = "AutoOp";
   *plugin_desc = "Auto Ops anyone that joins";
   *plugin_version = "0.1";

   xchat_hook_command(ph, "AutoOpToggle", XCHAT_PRI_NORM, autooptoggle_cb,
                      "Usage: AUTOOPTOGGLE, Turns OFF/ON Auto Oping", 0);
   xchat_hook_print(ph, "Join", XCHAT_PRI_NORM, join_cb, 0);

   xchat_print(ph, "AutoOpPlugin loaded successfully!\n");

   return 1;       /* return 1 for success */
}

What's word and word_eol?

/command NICK hi there

word[1] is command
word[2] is NICK
word[3] is hi
word[4] is there

word_eol[1] is command NICK hi there
word_eol[2] is NICK hi there
word_eol[3] is hi there
word_eol[4] is there

Lists and Fields

"channels" - list of channels, querys and their servers.

Name	Description	Type
channel	Channel or query name	string
context	(xchat_context *) pointer. Can be used with xchat_set_context	string
network	Network name to which this channel belongs (Added in version 2.0.2. Older versions will return NULL)	string
server	Server name to which this channel belongs	string
type	Type of context this is: 1-Server 2-Channel 3-Dialog (Added in version 2.0.2. Older versions will return -1)	int

"dcc" - list of DCC file transfers. Fields:

Name	Description	Type
address32	Address of the remote user (ipv4 address)	int
cps	Bytes per second (speed)	int
destfile	Destination full pathname	string
file	File name	string
nick	Nickname of person who the file is from/to	string
port	TCP port number	int
pos	Bytes sent/received	int
resume	Point at which this file was resumed (or zero if it was not resumed)	int
size	File size in bytes	int
status	DCC Status: 0-Queued 1-Active 2-Failed 3-Done 4-Connecting 5-Aborted	int
type	DCC Type: 0-Send 1-Receive 2-ChatRecv 3-ChatSend	int

"ignore" - current ignore list.

Name	Description	Type
mask	Ignore mask. .e.g: *!*@*.aol.com	string
flags	Bit field of flags. 0=Private 1=Notice 2=Channel 3=Ctcp 4=Invite 5=UnIgnore 6=NoSave 7=DCC	int

"notify" - list of people on notify.

Name	Description	Type
nick	Nickname	string
flags	0=Is online.	int
on	Time when user came online.	time_t
off	Time when user went offline.	time_t
seen	Time when user the user was last verified still online.	time_t

The entire "notify" list was added in xchat 2.0.8. Fields are only valid for the context when xchat_list_get() was called (i.e. you get information about the user ON THAT ONE SERVER ONLY). You may cycle through the "channels" list to find notify information for every server.

"users" - list of users in the current channel.

Name	Description	Type
away	Away status (boolean) (Added in version 2.0.6. Older versions will return -1)	int
nick	Nick name	string
host	Host name in the form: user@host (or NULL if not known).	string
prefix	Prefix character, .e.g: @ or +. Points to a single char.	string

   list = xchat_list_get(ph, "dcc");
   if(list)
   {
      xchat_print(ph, "--- DCC LIST ------------------\n"
                      "File  To/From   KB/s   Position\n");

      while(xchat_list_next(ph, list))
      {
         xchat_printf(ph, "%6s %10s %.2f  %d\n",
             xchat_list_str(ph, list, "file"),
             xchat_list_str(ph, list, "nick"),
             xchat_list_int(ph, list, "cps") / 1024,
             xchat_list_int(ph, list, "pos"));
      }

      xchat_list_free(ph, list);
   }

Plugins on Windows (Win32)

• xchat-plugin.h - Main Plugin header
• plugin.c - Your plugin, you need to write this one :)
• plugin.def - A simple text file containing the following:

	cl -O1 -MD -G5 -DWIN32 -c plugin.c
	link /DLL /out:plugin.dll /SUBSYSTEM:WINDOWS plugin.obj /def:plugin.def

Controlling the GUI

A simple way to perform basic GUI functions is to use the /GUI command. You can execute this command through the input-box, or by calling xchat_command(ph, "GUI .....");.

GUI HIDE	Hide the main xchat window completely (this is used by the Systray plugin).
GUI SHOW	Show it again.
GUI FOCUS	Focus the current window or tab.
GUI FLASH	Flash the taskbar button (win32 only). It will flash only if the window isn't focused and will stop when it is focused by the user.
GUI COLOR n	Change the tab color of the current context, where n is a number from 0 to 3.

Functions

 xchat_hook_command() 

ph: Plugin handle (as given to xchat_plugin_init).
name: Name of the command (without the forward slash).
pri: Priority of this command. Use XCHAT_PRI_NORM.
callb: Callback function. This will be called when the user executes the given command name.
help_text: String of text to display when the user executes /help for this command. May be NULL if you're lazy.
userdata: Pointer passed to the callback function.

static int onotice_cb(char *word[], char *word_eol[], void *userdata)
{
	if(word_eol[2][0] == 0)
	{
		xchat_printf(ph, "Second arg must be the message!\n");
		return XCHAT_EAT_ALL;
	}

	xchat_commandf(ph, "NOTICE @%s :%s", xchat_get_info(ph, "channel"), word_eol[2]);
	return XCHAT_EAT_ALL;
}

xchat_hook_command(ph, "ONOTICE", XCHAT_PRI_NORM, onotice_cb,
                   "Usage: ONOTICE <message> Sends a notice to all ops", NULL);

 xchat_hook_fd() 

ph: Plugin handle (as given to xchat_plugin_init).
fd: The file descriptor or socket.
flags: One or more of XCHAT_FD_READ, XCHAT_FD_WRITE, XCHAT_FD_EXCEPTION, XCHAT_FD_NOTSOCKET. Use bitwise OR to combine them. XCHAT_FD_NOTSOCKET tells xchat that the provided fd is not a socket, but a file descriptor. This is only relevant on Windows, where network sockets are distinguished from file descriptors (such as pipes).
callb: Callback function. This will be called when the socket is available for reading/writing or exception (depending on your chosen flags)
userdata: Pointer passed to the callback function.

 xchat_hook_print() 

"Open Context" - Called when a new xchat_context is created.
"Close Context" - Called when a xchat_context pointer is closed.
"Focus Tab" - Called when a tab is brought to front.
"Focus Window" - Called a toplevel window is focused, or the main tab-window is focused by the window manager.
"DCC Chat Text" - Called when some text from a DCC Chat arrives. It provides these elements in the word[] array:

word[1] Address
word[2] Port
word[3] Nick
word[4] The Message

ph: Plugin handle (as given to xchat_plugin_init).
name: Name of the print event (as in Edit Event Texts Window).
pri: Priority of this command. Use XCHAT_PRI_NORM.
callb: Callback function. This will be called when this event name is printed.
userdata: Pointer passed to the callback function.

static int youpart_cb(char *word[], void *userdata)
{
	xchat_printf(ph, "You have left channel %s\n", word[3]);
	return XCHAT_EAT_XCHAT;	/* dont let xchat do its normal printing */
}

xchat_hook_print(ph, "You Part", XCHAT_PRI_NORM, youpart_cb, NULL);

 xchat_hook_server() 

ph: Plugin handle (as given to xchat_plugin_init).
name: Name of the server event.
pri: Priority of this command. Use XCHAT_PRI_NORM.
callb: Callback function. This will be called when this event is received from the server.
userdata: Pointer passed to the callback function.

static int kick_cb(char *word[], char *word_eol[], void *userdata)
{
	xchat_printf(ph, "%s was kicked from %s (reason=%s)\n", word[4], word[3], word_eol[5]);
	return XCHAT_EAT_NONE;	/* don't eat this event, let other plugins and xchat see it too */
}

xchat_hook_server(ph, "KICK", XCHAT_PRI_NORM, kick_cb, NULL);

 xchat_hook_timer() 

ph: Plugin handle (as given to xchat_plugin_init).
timeout: Timeout in milliseconds (1000 is 1 second).
callb: Callback function. This will be called every "timeout" milliseconds.
userdata: Pointer passed to the callback function.

static xchat_hook *myhook;

static int stop_cb(char *word[], char *word_eol[], void *userdata)
{
	if(myhook != NULL)
	{
		xchat_unhook(ph, myhook);
		myhook = NULL;
		xchat_print(ph, "Timeout removed!\n");
	}

	return XCHAT_EAT_ALL;
}

static int timeout_cb(void *userdata)
{
	xchat_print(ph, "Annoying message every 5 seconds! Type /STOP to stop it.\n");
	return 1;	/* return 1 to keep the timeout going */
}

myhook = xchat_hook_timer(ph, 5000, timeout_cb, NULL);
xchat_hook_command(ph, "STOP", XCHAT_PRI_NORM, stop_cb, NULL, NULL);

 xchat_unhook() 

ph: Plugin handle (as given to xchat_plugin_init).
hook: Pointer to the hook, as returned by xchat_hook_*.

 xchat_command() 

ph: Plugin handle (as given to xchat_plugin_init).
command: Command to execute, without the forward slash "/".

 xchat_commandf() 

ph: Plugin handle (as given to xchat_plugin_init).
format: The format string.

 xchat_print() 

ph: Plugin handle (as given to xchat_plugin_init).
text: Text to print. May contain mIRC color codes.

 xchat_printf() 

ph: Plugin handle (as given to xchat_plugin_init).
format: The format string.

 xchat_emit_print() 

ph: Plugin handle (as given to xchat_plugin_init).
event_name: Text event to print.

xchat_emit_print(ph, "Channel Message", "John", "Hi there", "@", NULL);

 xchat_find_context() 

ph: Plugin handle (as given to xchat_plugin_init).
servname: Servername or NULL.
channel: Channelname or NULL.

 xchat_get_context() 

ph: Plugin handle (as given to xchat_plugin_init).

 xchat_get_info() 

ph: Plugin handle (as given to xchat_plugin_init).
id: ID of the information you want. Currently supported IDs are (case sensitive):

away	away reason or NULL if you are not away.
channel	current channel name.
host	real hostname of the server you connected to.
network	current network name or NULL.
nick	your current nick name.
server	current server name (what the server claims to be). NULL if you are not connected.
topic	current channel topic.
version	xchat version number.
xchatdir	xchat config directory, e.g.: /home/user/.xchat.

 xchat_get_prefs() 

ph: Plugin handle (as given to xchat_plugin_init).
name: Setting name required.
string: Pointer-pointer which to set.
integer: Pointer to an integer to set, if setting is a Boolean or Integer type.

{
	int i;
	const char *str;

	if (xchat_get_prefs (ph, "irc_nick1", &str, &i) == 1)
	{
		xchat_printf (ph, "Current nickname setting: %s\n", str);
	}
}

 xchat_set_context() 

ph: Plugin handle (as given to xchat_plugin_init).
ctx: Context to change to (obtained with xchat_get_context or xchat_find_context).

 xchat_nickcmp() 

ph: Plugin handle (as given to xchat_plugin_init).
s1: String to compare.
s2: String to compare s1 to.

Because of IRC's scandanavian origin, the characters {}| are considered to be the lower case equivalents of the characters []\, respectively. This is a critical issue when determining the equivalence of two nicknames.