| XchatPython | UserPreferences

CncMoin | FrontPage | RecentChanges | SiteNavigation | HelpContents | ComoTerConta

## 1. Contents

1. Contents
2. About
3. Features
4. Commands
5. Autoloading modules
6. Module development
7. Context theory
8. Hello world
9. xchat module

1. Generic functions

1. xchat.prnt(string)
2. xchat.command(string)
3. xchat.nickcmp(s1, s2)

2. Information retreiving functions

1. xchat.get_info(type)
2. xchat.get_list(type)

1. channels
2. users
3. dcc

3. Hook functions

1. Priorities
2. Parameters word and word_eol
3. Parameter userdata
4. Callback return constants (EAT_*)
5. xchat.hook_command(name, callback, userdata=None, priority=PRI_NORM, help=None)
6. xchat.hook_print(name, callback, userdata=None, priority=PRI_NORM)
7. xchat.hook_server(name, callback, userdata=None, priority=PRI_NORM)
8. xchat.hook_timer(timeout, callback, userdata=None)
9. xchat.hook_unload(timeout, callback, userdata=None)
10. xchat.unhook(handler)

4. Context handling

1. Context objects
2. xchat.get_context()
3. xchat.find_context(server=None, channel=None)

10. Download
11. Author

## 2. About

That's the XChat 2.0 Python plugin interface page. This interface allows one to use the Python language to develop extension scripts for the XChat IRC client.

## 3. Features

Here are some of the features of the XChat 2.0 Python plugin interface:

- Comprehensive, consistent and straightforward API;
- Load, unload, reload, and autoload support;
- Per plugin independend interpreter state;
- Python interactive console;
- Python interactive command execution;
- Full thread support;
- Stdout and stderr redirected to XChat console;
- Dynamic list management;
- Nice context treatment;

## 4. Commands

The following commands will be intercepted by the Python Plugin interface module, when it is loaded.

/py load <filename>
  Load module with given filename.

/py unload <filename|module name>
  Unload module with given filename, or module name.

/py reload <filename|module name>
  Reload module with given filename, or module name.

/load <filename>
  Does the same as /py load, but works only if filename has a .py extension (which is advised).

/unload <filename>
  Does the same as /py unload, but works only with filenames and it must have a .py extension

/py list
  List Python modules loaded.

/py exec <command>
  Execute given Python command interactively. For example,

`/py exec import xchat`
`/py exec print xchat.get_info('channel')`

/py console
  Open the Python interactive console. This "console" is indeed a query with a special name (>>python<<). Every message you send to this query will be intercepted by the Python plugin interface, and interpreted interactively. Notice that the console and /py exec commands live in the same interpreter state.

/py about
  Show some information about the Python plugin interface.

## 5. Autoloading modules

If you want some module to be autoloaded together with the Python plugin interface (which usually loads at startup time), just make sure it has a `.py` extension and put it in your xchat directory (probably something like `~/.xchat2`).

## 6. Module development

## 7. Context theory

Before starting to explain what the API offers, I'll do a short introduction to the XChat context concept. Not because it's something hard to understand, but because you'll understand better the API explanations if you know what I'm talking about.

You can think about a context as an XChat channel, server, or query tab. Each of these tabs, has its own context, and is related to a given server and channel (queries are a special kind of channel).

The current context is the one where XChat passes control to the module. For example, when XChat receives a command in a specific channel, and you have asked XChat to tell you about this event, the current context will be set to this channel before your module is called.

## 8. Hello world

Here is the traditional Hello world example.

    __module_name__ = "helloworld"
    __module_version__ = "1.0"
    __module_description__ = "Python module example"

    print "Hello world!"

This module will print "Hello world!" in the XChat console, and sleep forever until it's unloaded. It's a simple module, but already introduces some concepts. Notice how the module information is set. This information is obligatory, and will be shown when listing the loaded XChat modules.

## 9. xchat module

The xchat module is your passport to every XChat functionality offered by the Python plugin interface. Here's a simple example:

    import xchat
    xchat.prnt("Hi everyone!")

The following functions are available in the xchat module.

### 9.1. Generic functions

#### 9.1.1. xchat.prnt(string)

This function will print string in the current context. It's mainly useful as a parameter to pass to some other function, since the usual print statement will have the same results. You have a usage example above.

This function is badly named because `"print"` is a reserved keyword of the Python language.

#### 9.1.2. xchat.command(string)

Execute the given command in the current context. This has the same results as executing a command in the xchat window, but notice that the `/` prefix is not used. Here is an example:

    xchat.command("server irc.openprojects.net")

#### 9.1.3. xchat.nickcmp(s1, s2)

This function will do an RFC1459 compliant string comparing between `s1` and `s2`, and is useful to compare channels and nicknames. It returns an integer less than, equal to, or greater than zero if `s1` is found, respectively, to be less than, to match, or be greater than `s2`. For example:

    if xchat.nickcmp(nick, "mynick") == 0:
        print "They are the same!"

### 9.2. Information retreiving functions

#### 9.2.1. xchat.get_info(type)

Retrieve the information specified by the `type` string in the current context. At the moment of this writing, the following information types are available to be queried:

host
  Real hostname of the server you connected to.

server
  Current server name (what the server claims to be), or None if you are not connected.

channel
  Channel of the current context.

topic
  Current channel topic.

nick
  Your current nick name.

away
  Away reason or None if you are not away.

xchatdir
  XChat config directory, e.g.: "/home/user/.xchat2".

version
  XChat version number.

This information was taken from XChat's plugin documentation. You may find any types not listed here, if they exist at all, in an updated XChat documentation. Any info types accepted by XChat should be dynamically accepted by the Python plugin interface.

Example:

    if xchat.get_info("server") is None:
        print "Not connected!"

#### 9.2.2. xchat.get_list(type)

With this function you may retrieve a list containing the selected information from the current context, like a DCC list, a channel list, a user list, etc. Each list item will have its attributes set dynamically depending on the information provided by the list type.

The example below is a rewrite of the example provided with XChat's plugin API documentation. It prints a list of every DCC transfer happening at the moment. Notice how similar the interface is to the C API provided by XChat.

    list = xchat.get_list("dcc")
    if list:
        print "--- DCC LIST ------------------"
        print "File  To/From   KB/s   Position"
        for i in list:
            print "%6s %10s %.2f  %d" % (i.file, i.nick, i.cps/1024, i.pos)

Below you will find what each list type has to offer.

This information was taken from XChat's plugin documentation. You may find any types not listed here, if they exist at all, in an updated XChat documentation. Any list types accepted by XChat should be dynamically accepted by the Python plugin interface.

##### 9.2.2.1. channels

The channels list type gives you access to the channels, queries and their servers. The folloing attributes are available in each list item:

channel
  Channel or query name.

server
  Server name to which this channel belongs.

context
  A context object, giving access to that channel/server.

##### 9.2.2.2. users

The users list type gives you access to a list of users in the current channel. The following attributes are available in each list item:

nick
  Nick name.

host
  Host name in the form user@host (or None, if not known).

prefix
  Prefix character, .e.g: @ or +. Points to a single char.

##### 9.2.2.3. dcc

The dcc list type gives you access to a list of DCC file transfers. The following attributes are available in each list item:

cps
  Bytes per second (speed).

destfile
  Destination full pathname.

file
  Filename.

nick
  Nickname of person who the file is from/to.

pos
  Bytes sent/received.

resume
  Point at which this file was resumed (or zero if it was not resumed).

size
  File size in bytes.

status
  DCC status (queued=0, active=1, failed=2, done=3, connecting=4 aborted=5).

type
  DCC type (send=0, receive=1, chatrecv=2, chatsend=3).

### 9.3. Hook functions

These functions allow one to hook into XChat events.

#### 9.3.1. Priorities

When a priority keyword parameter is accepted, it means that this callback may be hooked with five different priorities: PRI_HIGHEST, PRI_HIGH, PRI_NORM, PRI_LOW, and PRI_LOWEST. The usage of these constants, which are available in the xchat module, will define the order in which your plugin will be called. Most of the time, you won't want to change its default value (PRI_NORM).

#### 9.3.2. Parameters word and word_eol

These parameters, when available in a callback, are lists of strings which contain the parameters the user entered for the particular command. For example, if you executed:

    /command NICK Hi there!

- word[0] is `command`
- word[1] is `NICK`
- word[2] is `Hi`
- word[3] is `there!`
- word_eol[0] is `command NICK Hi there!`
- word_eol[1] is `NICK Hi there!`
- word_eol[2] is `Hi there!`
- word_eol[3] is `there!`

#### 9.3.3. Parameter userdata

The parameter userdata, if given, allows you to pass a custom object to your callback.

#### 9.3.4. Callback return constants (EAT_*)

When a callback is supposed to return one of the EAT_* macros, it is able control how XChat will proceed after the callback returns. These are the available constants, and their meanings:

EAT_PLUGIN
  Don't let any other plugin receive this event.

EAT_XCHAT
  Don't let XChat treat this event as usual.

EAT_ALL
  Eat the event completely.

EAT_NONE
  Let everything happen as usual.

Returning `None` is the same as returning `EAT_NONE`.

#### 9.3.5. xchat.hook_command(name, callback, userdata=None, priority=PRI_NORM, help=None)

This function allows you to hook into the name XChat command. It means that everytime you type `/name ...`, `callback` will be called. Parameters `userdata` and `priority` have their meanings explained above, and the parameter help, if given, allows you to pass a help text which will be shown when `/help name` is executed. This function returns a hook handler which may be used in the `xchat.unhook()` function. For example:

    def onotice_cb(word, word_eol, userdata):
        if len(word) < 2:
            print "Second arg must be the message!"
        else:
            xchat.command("NOTICE @%s %s", xchat.get_info("channel"), word_eol[1])
        return xchat.EAT_ALL

    xchat.hook_command("ONOTICE", onotice_cb, help="/ONOTICE <message> Sends a notice to all ops")

You may return one of `EAT_*` constants in the callback, to control XChat's behavior, as explained above.

#### 9.3.6. xchat.hook_print(name, callback, userdata=None, priority=PRI_NORM)

This function allows you to register a callback to trap any print events. The event names are available in the Edit Event Texts window. Parameters `userdata` and `priority` have their meanings explained above. This function returns a hook handler which may be used in the `xchat.unhook()` function. For example:

    def youpart_cb(word, word_eol, userdata):
        print "You have left channel", word[2]
        return xchat.EAT_XCHAT # Don't let xchat do its normal printing

    xchat.hook_print("You Part", youpart_cb)

You may return one of `EAT_*` constants in the callback, to control XChat's behavior, as explained above.

#### 9.3.7. xchat.hook_server(name, callback, userdata=None, priority=PRI_NORM)

This function allows you to register a callback to be called when a certain server event occurs. You can use this to trap `PRIVMSG`, `NOTICE`, `PART`, a server numeric, etc. Parameters `userdata` and `priority` have their meanings explained above. This function returns a hook handler which may be used in the `xchat.unhook()` function. For example:

    def kick_cb(word, word_eol, userdata):
        print "%s was kicked from %s (%s)" % (word[3], word[2], word_eol[4])
        # Don't eat this event, let other plugins and xchat see it too
        return xchat.EAT_NONE

    xchat.hook_server("KICK", kick_cb)

You may return one of `EAT_*` constants in the callback, to control XChat's behavior, as explained above.

#### 9.3.8. xchat.hook_timer(timeout, callback, userdata=None)

This function allows you to register a callback to be called every timeout milliseconds. Parameters userdata and priority have their meanings explained above. This function returns a hook handler which may be used in the `xchat.unhook()` function. For example:

    myhook = None

    def stop_cb(word, word_eol, userdata):
        global myhook
        if myhook is not None:
            xchat.unhook(myhook)
            myhook = None
            print "Timeout removed!"

    def timeout_cb(userdata):
        print "Annoying message every 5 seconds! Type /STOP to stop it."
        return 1 # Keep the timeout going

    myhook = xchat.hook_timer(5000, timeout_cb)
    xchat.hook_command("STOP", stop_cb)

If you return a true value from the callback, the timer will be keeped, otherwise it is removed.

#### 9.3.9. xchat.hook_unload(timeout, callback, userdata=None)

This function allows you to register a callback to be called when the plugin is going to be unloaded. Parameters `userdata` and `priority` have their meanings explained above. This function returns a hook handler which may be used in the `xchat.unhook()` function. For example:

    def unload_cb(userdata):
        print "We're being unloaded!"

    xchat.hook_unload(unload_cb)

#### 9.3.10. xchat.unhook(handler)

Unhooks any hook registered with the hook functions above.

### 9.4. Context handling

Below you will find information about how to work with contexts.

#### 9.4.1. Context objects

As explained in the Context theory session above, contexts give access to a specific channel/query/server tab of XChat. Every function available in the xchat module will be evaluated in the current context, which will be specified by XChat itself before passing control to the module. Sometimes you may want to work in a specific context, and that's where context objects come into play.

You may create a context object using the `xchat.get_context()` or `xchat.find_context()`, functions as explained below, or trough the `xchat.get_list()` function, as explained in its respective session.

Each context object offers the following methods:

context.set()
  Changes the current context to be the one represented by this context object.

context.prnt(string)
  Does the same as the xchat.prnt() function, but in the given context.

context.command(string)
  Does the same as the xchat.command() function, but in the given context.

context.get_info(type)
  Does the same as the xchat.get_info() function, but in the given context.

context.get_list(type)
  Does the same as the xchat.get_list() function, but in the given context.

#### 9.4.2. xchat.get_context()

Returns a context object corresponding the the current context.

#### 9.4.3. xchat.find_context(server=None, channel=None)

Finds a context based on a channel and servername. If `server` is `None`, it finds any channel (or query) by the given name. If `channel` is `None`, it finds the front-most tab/window of the given server. For example:

    cnc = xchat.find_context(channel='#conectiva')
    cnc.command('whois niemeyer')

## 10. Download

You can find this plugin with XChat 2.0+.

## 11. Author

GustavoNiemeyer <niemeyer@conectiva.com>