class IRCClient(basic.LineReceiver): (source)
Known subclasses: twisted.words.im.ircsupport.IRCProto
Internet Relay Chat client protocol, with sprinkles.
In addition to providing an interface for an IRC client protocol, this class also contains reasonable implementations of many common CTCP methods.
TODO
- Limit the length of messages sent (because the IRC server probably does).
- Add flood protection/rate limiting for my CTCP replies.
- NickServ cooperation. (a mix-in?)
Method | __getstate__ |
Undocumented |
Method | action |
Called when I see a user perform an ACTION on a channel. |
Method | alter |
Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration. |
Method | away |
Mark this client as away. |
Method | back |
Clear the away status. |
Method | bad |
When I get a message that's so broken I can't use it. |
Method | bounce |
Called with information about where the client should reconnect. |
Method | connection |
Called when the connection is shut down. |
Method | connection |
Called when a connection is made. |
Method | created |
Called with creation date information about the server, usually at logon. |
Method | ctcp |
Send one or more extended messages as a CTCP query. |
Method | ctcp |
Send one or more extended messages as a CTCP reply. |
Method | ctcp |
Dispatch method for any CTCP queries received. |
Method | ctcp |
Undocumented |
Method | ctcp |
A master index of what CTCP tags this client knows. |
Method | ctcp |
Initiate a Direct Client Connection |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Undocumented |
Method | ctcp |
Dispatch method for any CTCP replies received. |
Method | ctcp |
Undocumented |
Method | ctcp |
Fallback handler for unrecognized CTCP queries. |
Method | ctcp |
Called when a fitting ctcpReply_ method is not found. |
Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc_ |
Undocumented |
Method | dcc |
Send a DCC ACCEPT response to clients who have requested a resume. |
Method | dcc |
Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing. |
Method | dcc |
Undocumented |
Method | dcc |
Called when a client is trying to resume an offered file via DCC send. It should be either replied to with a DCC ACCEPT or ignored (default). |
Method | dcc |
Called when I receive a DCC SEND offer from a client. |
Method | dcc |
Send a DCC RESUME request to another user. |
Method | dcc |
This is supposed to send a user a file directly. This generally doesn't work on any client, and this method is included only for backwards compatibility and completeness. |
Method | describe |
Strike a pose. |
Method | get |
Get channel modes that require parameters for correct parsing. |
Method | get |
Get user modes that require parameters for correct parsing. |
Method | handle |
Determine the function to call for the given command and call it with the given arguments. |
Method | invite |
Attempt to invite user to channel |
Method | irc_ |
Called when we try to register or change to an illegal nickname. |
Method | irc_ |
Called when we try to register or change to a nickname that is already taken. |
Method | irc_ |
Called when the login was incorrect. |
Method | irc_ |
Called when a user joins a channel. |
Method | irc_ |
Called when a user is kicked from a channel. |
Method | irc_ |
Parse a server mode change message. |
Method | irc_ |
Called when a user changes their nickname. |
Method | irc_ |
Called when a user gets a notice. |
Method | irc_ |
Called when a user leaves a channel. |
Method | irc_ |
Called when some has pinged us. |
Method | irc_ |
Called when we get a message. |
Method | irc_ |
Called when a user has quit. |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to receivedMOTD. |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Undocumented |
Method | irc_ |
Called when the topic for a channel is initially reported or when it subsequently changes. |
Method | irc_ |
Called when we have received the welcome from the server. |
Method | irc_ |
Undocumented |
Method | irc_ |
Someone in the channel set the topic. |
Method | irc |
Undocumented |
Method | isupport |
Called with various information about what the server supports. |
Method | join |
Join a channel. |
Method | joined |
Called when I finish joining a channel. |
Method | kick |
Attempt to kick a user from a channel. |
Method | kicked |
Called when I am kicked from a channel. |
Method | leave |
Leave a channel. |
Method | left |
Called when I have left a channel. |
Method | line |
Override this for when each line is received. |
Method | luser |
Called with the number of channels existent on the server. |
Method | luser |
Called with information about the number of connections, usually at logon. |
Method | luser |
Called with information about the server connected to. |
Method | luser |
Called with the number of ops logged on to the server. |
Method | mode |
Change the modes on a user or channel. |
Method | mode |
Called when users or channel's modes are changed. |
Method | msg |
Send a message to a user or channel. |
Method | my |
Called with information about the server, usually at logon. |
Method | nick |
Called when my nick has been changed. |
Method | notice |
Send a notice to a user. |
Method | noticed |
Called when I have a notice from a user to me or a channel. |
Method | ping |
Measure round-trip delay to another IRC client. |
Method | pong |
Called with the results of a CTCP PING query. |
Method | privmsg |
Called when I have a message from a user to me or a channel. |
Method | quirky |
This is called when I receive a message which is peculiar, but not wholly indecipherable. |
Method | quit |
Disconnect from the server |
Method | received |
I received a message-of-the-day banner from the server. |
Method | register |
Login to the server. |
Method | say |
Send a message to a channel |
Method | send |
Sends a line to the other end of the connection. |
Method | set |
Set this client's nickname. |
Method | signed |
Called after successfully signing on to the server. |
Method | start |
Start sending PING messages every IRCClient.heartbeatInterval seconds to keep the connection to the server alive during periods of no activity. |
Method | stop |
Stop sending PING messages to keep the connection to the server alive. |
Method | topic |
Attempt to set the topic of the given channel, or ask what it is. |
Method | topic |
In channel, user changed the topic to newTopic. |
Method | user |
Called when I see another user joining a channel. |
Method | user |
Called when I observe someone else being kicked from a channel. |
Method | user |
Called when I see another user leaving a channel. |
Method | user |
Called when I see another user disconnect from the network. |
Method | user |
A user changed their name from oldname to newname. |
Method | whois |
Retrieve user information about the given nickname. |
Method | your |
Called with daemon information about the server, usually at logon. |
Class Variable | __pychecker__ |
Undocumented |
Class Variable | dcc |
Undocumented |
Class Variable | delimiter |
Undocumented |
Class Variable | perform |
Undocumented |
Instance Variable | dcc |
Undocumented |
Instance Variable | erroneous |
Default nickname assigned when an unregistered client triggers an ERR_ERRONEUSNICKNAME while trying to register with an illegal nickname. |
Instance Variable | finger |
Sent in reply to a FINGER CTCP query. If None , no FINGER reply will be sent. |
Instance Variable | heartbeat |
Interval, in seconds, to send PING messages to the server as a form of keepalive, defaults to 120 seconds. Use None to disable the heartbeat. |
Instance Variable | hostname |
Host name of the IRC server the client is connected to. Initially the host name is None and later is set to the host name from which the RPL_WELCOME message is received. |
Instance Variable | line |
Minimum delay between lines sent to the server. If None , no delay will be imposed. |
Instance Variable | motd |
Either None or, between receipt of RPL_MOTDSTART and RPL_ENDOFMOTD, a list of str , each of which is the content of an RPL_MOTD message. |
Instance Variable | nickname |
Nickname the client will use. |
Instance Variable | password |
Password used to log on to the server. May be None . |
Instance Variable | realname |
Supplied to the server during login as the "Real name" or "ircname". May be None . |
Instance Variable | source |
CTCP SOURCE reply, a URL where the source code of this client may be found. If None , no SOURCE reply will be sent. |
Instance Variable | supported |
Available ISUPPORT features on the server |
Instance Variable | userinfo |
Sent in reply to a USERINFO CTCP query. If None , no USERINFO reply will be sent. "This is used to transmit a string which is settable by the user (and never should be set by the client)." |
Instance Variable | username |
Supplied to the server during login as the "User name". May be None |
Instance Variable | version |
CTCP VERSION reply, environment the client is running in. |
Instance Variable | version |
CTCP VERSION reply, client name. If None , no VERSION reply will be sent. |
Instance Variable | version |
CTCP VERSION reply, client version. |
Method | _create |
Create the heartbeat LoopingCall . |
Method | _really |
Undocumented |
Method | _safe |
Estimate a safe maximum line length for the given command. |
Method | _send |
Send a PING message to the IRC server as a form of keepalive. |
Method | _send |
Undocumented |
Method | _send |
Send a message or notice to a user or channel. |
Constant | _MAX |
Undocumented |
Instance Variable | _attempted |
The nickname that will try to get registered. It may change if it is illegal or already taken. nickname becomes the _attemptedNick that is successfully registered. |
Instance Variable | _heartbeat |
Looping call to perform the keepalive by calling IRCClient._sendHeartbeat every heartbeatInterval seconds, or None if there is no heartbeat. |
Instance Variable | _pings |
Undocumented |
Instance Variable | _queue |
Undocumented |
Instance Variable | _queue |
Undocumented |
Instance Variable | _registered |
Whether or not the user is registered. It becomes True once a welcome has been received from the server. |
Inherited from LineReceiver
:
Method | clear |
Clear buffered data. |
Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Method | raw |
Override this for when raw data is received. |
Method | set |
Sets the line-mode of this receiver. |
Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Constant | MAX |
The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
Instance Variable | line |
Undocumented |
Instance Variable | _buffer |
Undocumented |
Instance Variable | _busy |
Undocumented |
Inherited from Protocol
(via LineReceiver
):
Method | log |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Class Variable | factory |
Undocumented |
Inherited from BaseProtocol
(via LineReceiver
, Protocol
):
Method | make |
Make a connection to a transport and a server. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin
(via LineReceiver
, Protocol
, BaseProtocol
):
Method | pause |
Undocumented |
Method | resume |
Undocumented |
Method | stop |
Undocumented |
Instance Variable | paused |
Undocumented |
twisted.words.im.ircsupport.IRCProto
Called when I see a user perform an ACTION on a channel.
Generate an altered version of a nickname that caused a collision in an effort to create an unused related name for subsequent registration.
Parameters | |
nickname:str | The nickname a user is attempting to register. |
Returns | |
str | A string that is in some way different from the nickname. |
When I get a message that's so broken I can't use it.
Parameters | |
line:bytes | The indecipherable message. |
exctype | The exception type of the exception raised by the message. |
excBaseException | The exception parameter of excType or its associated value(the second argument to raise). |
tb:traceback | The Traceback as a traceback object. |
Called with information about where the client should reconnect.
Parameters | |
info:str | A plaintext description of the address that should be connected to. |
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parameters | |
reason:twisted.python.failure.Failure | Undocumented |
twisted.words.im.ircsupport.IRCProto
Called when a connection is made.
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Called with creation date information about the server, usually at logon.
Parameters | |
when:str | A string describing when the server was created, probably. |
Send one or more extended messages as a CTCP query.
Parameters | |
user | Undocumented |
messages:a list of extended messages. An extended message is a (tag, data) tuple, where 'data' may be None . | Undocumented |
Send one or more extended messages as a CTCP reply.
Parameters | |
user | Undocumented |
messages:a list of extended messages. An extended message is a (tag, data) tuple, where 'data' may be None . | Undocumented |
Dispatch method for any CTCP queries received.
Duplicated CTCP queries are ignored and no dispatch is made. Unrecognized CTCP queries invoke IRCClient.ctcpUnknownQuery
.
A master index of what CTCP tags this client knows.
If no arguments are provided, respond with a list of known tags, sorted in alphabetical order. If an argument is provided, provide human-readable help on the usage of that tag.
Fallback handler for unrecognized CTCP queries.
No CTCP ERRMSG reply is made to remove a potential denial of service avenue.
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Called when a client has verified and accepted a DCC resume request made by us. By default it will do nothing.
Parameters | |
user:bytes | The hostmask of the user who has accepted the DCC resume request. |
file:bytes | The name of the file to resume the transfer of. |
port:int | An integer representing the port of the accepting user. |
resumeint | The position in the file from where the transfer should resume. |
Called when a client is trying to resume an offered file via DCC send. It should be either replied to with a DCC ACCEPT or ignored (default).
Parameters | |
user:bytes | The hostmask of the user who wants to resume the transfer of a file previously offered via DCC send. |
file:bytes | The name of the file to resume the transfer of. |
port:int | An integer representing the port of the requesting user. |
resumeint | The position in the file from where the transfer should resume. |
Called when I receive a DCC SEND offer from a client.
By default, I do nothing here.
Parameters | |
user:bytes | The hostmask of the requesting user. |
address:bytes | The IP address of the requesting user. |
port:int | An integer representing the port of the requesting user. |
filebytes | The name of the file to be transferred. |
size:int | The size of the file to be transferred, which may be -1 if the size of the file was not specified in the DCC SEND request. |
data:list | A 3-list of [fileName, address, port]. |
This is supposed to send a user a file directly. This generally doesn't work on any client, and this method is included only for backwards compatibility and completeness.
Parameters | |
user | str representing the user |
file | an open file (unknown, since this is not implemented) |
Strike a pose.
Parameters | |
channel:str | The name of the channel to have an action on. If it has no prefix, it is sent to the user of that name. |
action:str | The action to preform. |
Present Since | |
9.0 |
Attempt to invite user to channel
Parameters | |
user:str | The user to invite |
channel:str | The channel to invite the user too |
Present Since | |
11.0 |
Called when we try to register or change to an illegal nickname.
The server should send this reply when the nickname contains any disallowed characters. The bot will stall, waiting for RPL_WELCOME, if we don't handle this during sign-on.
Note | |
The method uses the spelling erroneus, as it appears in the RFC, section 6.1. |
RPL_ENDOFMOTD indicates the end of the message of the day messages. Deliver the accumulated lines to receivedMOTD.
twisted.words.im.ircsupport.IRCProto
Called when the topic for a channel is initially reported or when it subsequently changes.
Called with various information about what the server supports.
Parameters | |
options:list of str | Descriptions of features or limits of the server, possibly in the form "NAME=VALUE". |
Join a channel.
Parameters | |
channel:str | The name of the channel to join. If it has no prefix, '#' will be prepended to it. |
key:str | If specified, the key used to join the channel. |
Called when I finish joining a channel.
channel has the starting character ('#', '&', '!', or '+') intact.
Attempt to kick a user from a channel.
Parameters | |
channel:str | The name of the channel to kick the user from. If it has no prefix, '#' will be prepended to it. |
user:str | The nick of the user to kick. |
reason:str | If given, the reason for kicking the user. |
Leave a channel.
Parameters | |
channel:str | The name of the channel to leave. If it has no prefix, '#' will be prepended to it. |
reason:str | If given, the reason for leaving. |
Called when I have left a channel.
channel has the starting character ('#', '&', '!', or '+') intact.
Override this for when each line is received.
Parameters | |
line:bytes | The line which was received with the delimiter removed. |
Called with information about the number of connections, usually at logon.
Parameters | |
info:str | A description of the number of clients and servers connected to the network, probably. |
Called with information about the server connected to.
Parameters | |
info:str | A plaintext string describing the number of users and servers connected to this server. |
Change the modes on a user or channel.
The limit, user, and mask parameters are mutually exclusive.
Parameters | |
chan:str | The name of the channel to operate on. |
set:bool | True to give the user or channel permissions and False to remove them. |
modes:str | The mode flags to set on the user or channel. |
limit:int | In conjunction with the 'l' mode flag, limits the number of users on the channel. |
user:str | The user to change the mode on. |
mask:str | In conjunction with the 'b' mode flag, sets a mask of users to be banned from the channel. |
Called when users or channel's modes are changed.
Parameters | |
user:str | The user and hostmask which instigated this change. |
channel:str | The channel where the modes are changed. If args is empty the channel for which the modes are changing. If the changes are at server level it could be equal to user. |
set:bool or int | True if the mode(s) is being added, False if it is being removed. If some modes are added and others removed at the same time this function will be called twice, the first time with all the added modes, the second with the removed ones. (To change this behaviour override the irc_MODE method) |
modes:str | The mode or modes which are being changed. |
args:tuple | Any additional information required for the mode change. |
Send a message to a user or channel.
The message will be split into multiple commands to the server if:
- The message contains any newline characters
- Any span between newline characters is longer than the given line-length.
Parameters | |
user:str | Username or channel name to which to direct the message. |
message:str | Text to send. |
length:int | Maximum number of octets to send in a single command, including the IRC protocol framing. If None is given then IRCClient._safeMaximumLineLength is used to determine a value. |
Called with information about the server, usually at logon.
Parameters | |
servername:str | The hostname of this server. |
version:str | A description of what software this server runs. |
umodes:str | All the available user modes. |
cmodes:str | All the available channel modes. |
Send a notice to a user.
Notices are like normal message, but should never get automated replies.
Parameters | |
user:str | The user to send a notice to. |
message:str | The contents of the notice to send. |
length:int | Maximum number of octets to send in a single command, including the IRC protocol framing. If None is given then IRCClient._safeMaximumLineLength is used to determine a value. |
twisted.words.im.ircsupport.IRCProto
Called when I have a notice from a user to me or a channel.
If the client makes any automated replies, it must not do so in response to a NOTICE message, per the RFC:
The difference between NOTICE and PRIVMSG is that automatic replies MUST NEVER be sent in response to a NOTICE message. [...] The object of this rule is to avoid loops between clients automatically sending something in response to something it received.
twisted.words.im.ircsupport.IRCProto
Called when I have a message from a user to me or a channel.
This is called when I receive a message which is peculiar, but not wholly indecipherable.
Parameters | |
s:bytes | The peculiar message. |
Disconnect from the server
Parameters | |
message:str | If specified, the message to give when quitting the server. |
I received a message-of-the-day banner from the server.
motd is a list of strings, where each string was sent as a separate message from the server. To display, you might want to use:
'\n'.join(motd)
to get a nicely formatted string.
Login to the server.
Parameters | |
nickname:str | The nickname to register. |
hostname:str | If specified, the hostname to logon as. |
servername:str | If specified, the servername to logon as. |
Send a message to a channel
Parameters | |
channel:str | The channel to say the message on. If it has no prefix, '#' will be prepended to it. |
message:str | The message to say. |
length:int | The maximum number of octets to send at a time. This has the effect of turning a single call to msg() into multiple commands to the server. This is useful when long messages may be sent that would otherwise cause the server to kick us off or silently truncate the text we are sending. If None is passed, the entire message is always send in one command. |
Sends a line to the other end of the connection.
Parameters | |
line:bytes | The line to send, not including the delimiter. |
twisted.words.im.ircsupport.IRCProto
Set this client's nickname.
Parameters | |
nickname:str | The nickname to change to. |
Start sending PING messages every IRCClient.heartbeatInterval
seconds to keep the connection to the server alive during periods of no activity.
Present Since | |
11.1 |
Attempt to set the topic of the given channel, or ask what it is.
If topic is None, then I sent a topic query instead of trying to set the topic. The server should respond with a TOPIC message containing the current topic of the given channel.
Parameters | |
channel:str | The name of the channel to change the topic on. If it has no prefix, '#' will be prepended to it. |
topic:str | If specified, what to set the topic to. |
twisted.words.im.ircsupport.IRCProto
Called when I observe someone else being kicked from a channel.
Retrieve user information about the given nickname.
Parameters | |
nickname:str | The nickname about which to retrieve information. |
server | Undocumented |
Present Since | |
8.2 |
Called with daemon information about the server, usually at logon.
Parameters | |
info:str | A string describing what software the server is running, probably. |
Default nickname assigned when an unregistered client triggers an ERR_ERRONEUSNICKNAME while trying to register with an illegal nickname.
Interval, in seconds, to send PING messages to the server as a form of keepalive, defaults to 120 seconds. Use None
to disable the heartbeat.
Host name of the IRC server the client is connected to. Initially the host name is None
and later is set to the host name from which the RPL_WELCOME message is received.
twisted.words.im.ircsupport.IRCProto
Password used to log on to the server. May be None
.
twisted.words.im.ircsupport.IRCProto
Supplied to the server during login as the "Real name" or "ircname". May be None
.
CTCP SOURCE reply, a URL where the source code of this client may be found. If None
, no SOURCE reply will be sent.
Sent in reply to a USERINFO CTCP query. If None
, no USERINFO reply will be sent. "This is used to transmit a string which is settable by the user (and never should be set by the client)."
Estimate a safe maximum line length for the given command.
This is done by assuming the maximum values for nickname length, realname and hostname combined with the command that needs to be sent and some guessing. A theoretical maximum value is used because it is possible that our nickname, username or hostname changes (on the server side) while the length is still being calculated.
Send a message or notice to a user or channel.
The message will be split into multiple commands to the server if:
- The message contains any newline characters
- Any span between newline characters is longer than the given line-length.
Parameters | |
msg | Whether a PRIVMSG or NOTICE should be sent. |
user:str | Username or channel name to which to direct the message. |
message:str | Text to send. |
length:int | Maximum number of octets to send in a single command, including the IRC protocol framing. If None is given then IRCClient._safeMaximumLineLength is used to determine a value. |
The nickname that will try to get registered. It may change if it is illegal or already taken. nickname
becomes the _attemptedNick
that is successfully registered.
Looping call to perform the keepalive by calling IRCClient._sendHeartbeat
every heartbeatInterval
seconds, or None
if there is no heartbeat.