Maiden-Irc

About

This is a client that enables using Maiden as a client for IRC networks. It does its best to provide all possible IRC commands and replies, but may still be missing a few exotic ones. With a bit of work, it could also be used as the basis for an IRC server.

How To

In order to use this client, simply create an instance of irc-client, add it to a core, and start it. You can use add-to-core to do so quickly. Upon construction, you will probably be interested in the following initargs:

:nickname The nickname to use on the server. The client's name defaults to the hostname. If you need to retrieve it from the core easily, or want to maintain multiple connections to the same host, you should also provide :name.
:username The IRC username. Defaults to (machine-instance).
:realname The IRC realname. Defaults to (machine-instance).
:password The password for use upon connection. Defaults to NIL. Most networks don't use this feature anyway.
:host The hostname of the server to connect to.
:port The port of the server to connect to. Defaults to 6667.
:services-password The password to use to identify with the NickServ on the servers.

All the IRC replies and commands are present as events, and functions for the latter, in the org.shirakumo.maiden.clients.irc.events package, which is nicknamed to irc.

Copyright

maiden-irc is licensed under the Artistic license. © Nicolas Hafner <shinmera@tymoon.eu> . This library can be obtained on https://github.com/Shinmera/maiden.

Package Index

MAIDEN-IRC (ORG.SHIRAKUMO.MAIDEN.CLIENTS.IRC)

class

`IRC-CLIENT`

This client offers a connection to an IRC server.

The client will attempt to keep a properly consistent
view of the server. It will track all users and channels
and their relationships to the best of its ability.
It will also attempt to automatically reconnect and
correct potentially incorrect nicknames and all of these
kinds of problems that plague IRC networks.

See NICKNAME
See USERNAME
See PASSWORD
See REALNAME
See INTENDED-NICKNAME
See SERVICES
See SERVICES-PASSWORD
See MAIDEN-NETWORKING:TEXT-TCP-CLIENT
See MAIDEN-NETWORKING:RECONNECTING-CLIENT
See MAIDEN-NETWORKING:TIMEOUT-CLIENT
See MAIDEN-NETWORKING:SIMPLE-USER-CHANNEL-CLIENT

class

`IRC-EVENT`

Superclass for all IRC events.

See MAIDEN:CLIENT-EVENT

class

`REPLY-EVENT`

Superclass for all events that are a reply from the server.

See IRC-EVENT
See MAIDEN-CLIENT-ENTITIES:USER-EVENT
See MAIDEN-NETWORKING:INCOMING-EVENT
See MAIDEN:PASSIVE-EVENT

class

`SEND-EVENT`

Superclass for all IRC events that are outgoing.

See IRC-EVENT
See MAIDEN-NETWORKING:OUTGOING-EVENT
See MAIDEN:ACTIVE-EVENT

class

`UNKNOWN-EVENT`

Base container event for all replies that are unknown and not handled by a specific class.

See REPLY-EVENT

class

`USER`

Object representing a user on a remote system somewhere.

Users have a name and may be authenticated. Additional properties
are not guaranteed, but may be provided by a client.

See CLIENT-ENTITY
See AUTHENTICATE
See AUTHENTICATED-P
See USERNAME

accessor (

`INTENDED-NICKNAME`

OBJECT)

Holds the intended nickname, which may be different from the actual nickname.

This is used to try and automatically change NICK to
the intended nickname when possible.

See IRC-CLIENT

accessor (

`MESSAGE`

OBJECT)

Accessor to the message string carried by the event.

See MESSAGE-EVENT

accessor (

`NICKNAME`

OBJECT)

The current nickname of the client.

Unlike a user, where the NAME is the nickname of the
user, in order to keep the name of a client instance
consistent and unchanging, the client's nickname is
kept separate.

This is another accessor to the same field as MAIDEN-
CLIENT-ENTITIES:USERNAME

See IRC-CLIENT
See MAIDEN-CLIENT-ENTITIES:USERNAME

accessor (

`PASSWORD`

OBJECT)

The password that is used during connection to the server.

See SERVICES-PASSWORD
See IRC-CLIENT

accessor (

`REALNAME`

OBJECT)

The realname that is passed to the server upon connection.

See IRC-CLIENT

accessor (

`SERVICES`

OBJECT)

Holds the type of services the server uses.

The client library must have specific support for each
services network. Currently the following types of
services are explicitly supported:

- :FREENODE
- :ANOPE
- :RIZON

This is in part used to be able to authenticate the
nicknames of users and check if they aren't impostors.

See IRC-CLIENT

accessor (

`USER`

OBJECT)

Reader for the user object the event relates to.

See USER-EVENT

accessor (

`USERNAME`

OBJECT)

The username that is passed to the server upon connection.

Note that this is /not/ the same as MAIDEN-CLIENT-ENTITIES:
USERNAME, which instead corresponds to NICKNAME.

See IRC-CLIENT

macro (

`DEFINE-IRC-COMMAND`

&REST ARGS)

Define an IRC server command.

This will do the following:
- It defines an event of the same name whose MESSAGE
  method contains the BODY and whose slots are parsed
  from the arglist.
- It defines a function of the same name that will
  issue said event onto a core.

The even is always a subclass of INSTRUCTION-EVENT and
SEND-EVENT. The name is re-interned in the ORG.
SHIRAKUMO.MAIDEN.CLIENTS.IRC.EVENTS package to avoid
clashing.

You can specify additional superclasses with the
:SUPERCLASSES body option.

See MESSAGE
See MAIDEN:INSTRUCTION-EVENT
See SEND-EVENT

macro (

`DEFINE-IRC-REPLY`

&REST ARGS)

Define a new IRC reply command and how it is parsed.

NAME  -- The name of the event class. Will be interned
         into ORG.SHIRAKUMO.MAIDEN.CLIENTS.IRC.EVENTS.
CODE  -- The string or code that identifies the event
         on the IRC reply line.
REGEX -- A regular expression to destructure the reply
         line body into usable slots.
SLOTS -- The slots of the event. Must correspond to
         REGEX capture groups.

This defines an event class according to the slots
and the defined superclasses. It always injects the
REPLY-EVENT superclass. It also defines a MAKE-REPLY-
EVENTS method which will create the event instances as
necessary. It will even take care of parsing multi-
target fields and splitting them up into multiple events.

See MAKE-REPLY-EVENTS
See CL-PPCRE:REGISTER-GROUPS-BIND