/usr/lib/python3/dist-packages/twisted/words/protocols/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/words/protocols/__pycache__/irc.cpython-310.pyc (117936B)
o
b @ sz
d Z ddlZddlZddlZddlZddlZddlZddlZddlZddl Z ddl
Z
ddl Z ddl Z ddl
Z
ddlZddlmZ ddlmZ ddlmZ ddlmZmZmZ ddlmZ ddlmZ dd l m Z m Z m Z e dZ!e d
Z"e d Z#e#Z$e d Z%d
Z&dZ'G dd de(Z)G dd de(Z*G dd de+Z,dd Z-d{ddZ.d|ddZ/G d d d e0Z1G d d d Z2d}d!d"Z3G d#d$ d$ej4Z5G d%d& d&e2Z6G d'd( d(ej7Z8d)d* Z9G d+d, d,ej4ej:Z;G d-d. d.ej4ej:Z
d1d2 Z?G d3d4 d4ej7ej:Z@G d5d6 d6ejAZBd7d8 ZCG d9d: d:e;ZDd;ZEdZHd?ZIeJeKg d@eLdAZMdBdC eMN D ZOG dDdE dEe jPZQeQ ZRG dFdG dGe jSZTdHdI ZUG dJdK dKe2ZVdLdM ZWdNdO ZXdPdQ ZYe dRZZdSdT Z[e dAZ\e!e\dU e#e\dV e"e\dW e\e\e\ iZ]i Z^e]N D ] \Z_Z`e_e^e`dX < q[_[`eaebe\ dYejcZddZd[ Zed\d] Zfd^ZgeZegd_ egegeg iZhi ZiehN D ] \Z_Z`e_eie`dX < qeaebeg dYejcZjd`da Zkdbdc Zlddde ZmdfZndgZodhZpdiZqdjZrdkZsdlZtdmZudnZvdoZwdpZxdqZydrZzdsZ{dtZ|duZ}dvZ~dwZdxZdyZdzZd{Zd|Zd}Zd~ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZi ddfddgddhddiddjddkddlddmddnddoddpddqddrddsd dtdduddvi ddwddxddyddzdd{dd|d d}d
d~d dd dd
dddddddddddddi ddddddddddddddddd dd dd dd dd dd!dd"dd#dd$di d%dd&dd'dd(dd)dd*dd+dd,dd-dd.dd/dd0dd1dd2dd3dd4dd5di d6dd7dd8dd9dd:dd;dddd?dd@ddAddBddCddDddEddFdi dGddHddIddJddKddLddMddNddOdÓdPdēdQdœdRdƓdSdǓdTdȓdUdɓdVdʓdWd˓i dXd̓dYd͓dZdΓd[dϓd\dГd]dѓd^dғd_dӓd`dԓdadՓdbd֓dcdדdddؓdedٓdfdړdgdۓdhdܓi didݓdjdޓdkdߓdlddmddnddoddpddqddrddsddtdduddvddwddxddyddddddzZi ZeN D ] \Z_Z`e_ee`< q1dS (~ a*
Internet Relay Chat protocol for client and server.
Future Plans
============
The way the IRCClient class works here encourages people to implement
IRC clients by subclassing the ephemeral protocol class, and it tends
to end up with way more state than it should for an object which will
be destroyed as soon as the TCP transport drops. Someone oughta do
something about that, ya know?
The DCC support needs to have more hooks for the client for it to be
able to ask the user things like "Do you want to accept this session?"
and "Transfer #2 is 67% done." and otherwise manage the DCC sessions.
Test coverage needs to be better.
@var MAX_COMMAND_LENGTH: The maximum length of a command, as defined by RFC
2812 section 2.3.
@var attributes: Singleton instance of L{_CharacterAttributes}, used for
constructing formatted text information.
@author: Kevin Turner
@see: RFC 1459: Internet Relay Chat Protocol
@see: RFC 2812: Internet Relay Chat: Client Protocol
@see: U{The Client-To-Client-Protocol
}
N)reduce)path)Optional)protocolreactortask)styles)basic)_textattributeslogreflect
z&#!+c @ e Zd ZdS )
IRCBadMessageN__name__
__module__ __qualname__ r r =/usr/lib/python3/dist-packages/twisted/words/protocols/irc.pyr H r c @ r )IRCPasswordMismatchNr r r r r r L r r c @ e Zd ZdZdS ) IRCBadModeszS
A malformed mode was encountered while attempting to parse a mode string.
Nr r r __doc__r r r r r P r c C s d}g }| s
t d| dd dkr | dd dd\}} | dd kr7| dd\} }| }|| n| }|d}|||fS )
z
Breaks a message from an IRC server into its prefix, command, and
arguments.
@param s: The message to break.
@type s: L{bytes}
@return: A tuple of (prefix, command, args).
@rtype: L{tuple}
z Empty line.r :N :)r splitfindappendpop)sprefixtrailingargscommandr r r parsemsgV s
r/ P c s fdd| dD S )a
Split a string into multiple lines.
Whitespace near C{str[length]} will be preferred as a breaking point.
C{"\n"} will also be used as a breaking point.
@param str: The string to split.
@type str: C{str}
@param length: The maximum length which will be allowed for any string in
the result.
@type length: C{int}
@return: C{list} of C{str}
c s" g | ]
}t | D ]}|q
qS r )textwrapwrap).0linechunklengthr r
s " zsplit..
r& )strr7 r r6 r r& q s r& c C s, | rzt | W S ttfy Y |S w |S )z
Convert a value to an integer if possible.
@rtype: C{int} or type of L{default}
@return: An integer when C{value} can be converted to an integer,
otherwise return C{default}
)int TypeError
ValueError)valuedefaultr r r
_intOrDefault s
rA c @ r )UnhandledCommandzO
A command dispatcher could not locate an appropriate command handler.
Nr r r r r rB r rB c @ s* e Zd ZU dZdZee ed< dd ZdS )_CommandDispatcherMixina
Dispatch commands to handlers based on their name.
Command handler names should be of the form C{prefix_commandName},
where C{prefix} is the value specified by L{prefix}, and must
accept the parameters as given to L{dispatch}.
Attempting to mix this in more than once for a single class will cause
strange behaviour, due to L{prefix} being overwritten.
@type prefix: C{str}
@ivar prefix: Command handler prefix, used to locate handler attributes
Nr+ c sf fdd fdd}||}|dur|| S |d}|du r+t d |d||g|R S ) z2
Perform actual command dispatch.
c s j d| S )N_)r+ )r. selfr r _getMethodName z8_CommandDispatcherMixin.dispatch.._getMethodNamec s t | d S N)getattr)namerG rF r r
_getMethod rH z4_CommandDispatcherMixin.dispatch.._getMethodNunknownzNo handler for z could be found)rB )rF commandNamer- rM methodr rL r dispatch s z _CommandDispatcherMixin.dispatch) r r r r r+ r r; __annotations__rQ r r r r rC s
rC r r c C s t | dkr
td| d dvrtd| g g f}d}d}| D ]D}|dv r:|dkr2td| d|}d}q!d}||| v rXz|d}W n tyW td|w || ||f |d 7 }q!t |dkrvtd
| d ||dkrtd| |S ) a2
Parse an IRC mode string.
The mode string is parsed into two lists of mode changes (added and
removed), with each mode change represented as C{(mode, param)} where mode
is the mode character, and param is the parameter passed for that mode, or
L{None} if no parameter is required.
@type modes: C{str}
@param modes: Modes string to parse.
@type params: C{list}
@param params: Parameters specified along with L{modes}.
@type paramModes: C{(str, str)}
@param paramModes: A pair of strings (C{(add, remove)}) that indicate which modes take
parameters when added or removed.
@returns: Two lists of mode changes, one for modes added and the other for
modes removed respectively, mode changes in each list are represented as
C{(mode, param)}.
r zEmpty mode stringz+-zMalformed modes string: Nr% zEmpty mode sequence: zNot enough parameters: r! zToo many parameters: r# )lenr indexr)
IndexErrorr( )modesparams
paramModeschanges directioncountchparamr r r
parseModes s6
r_ c @ s e Zd ZU dZdZdZdZee e d< dd Z
dd Z d d
Z d/d d Z
d
d Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zd d Zd0d d Zd!d" Zd#d$ Zd%d& Zd'd( Zd)d* Z d0d+d,Z d-d. Z dS )1IRCz.
Internet Relay Chat server protocol.
r Nencodingc C s" g | _ | jd u rt | _d S d S rI )channelshostnamesocketgetfqdnrE r r r connectionMade s
zIRC.connectionMadec C s@ |t t }t|tr| jr| jnd}||}| j| d S Nutf-8)CRLF
isinstancer; ra encode transportwrite)rF r4 useEncodingr r r sendLine s
z IRC.sendLinec O s |st dd|v s|d dkrt d| d|gt| }d|v r,d|d |}| | t|dkrDtd t||f d
S d
S ) a
Send a line formatted as an IRC message.
First argument is the command, all subsequent arguments are parameters
to that command. If a prefix is desired, it may be specified with the
keyword argument 'prefix'.
The L{sendCommand} method is generally preferred over this one.
Notably, this method does not support sending message tags, while the
L{sendCommand} method does.
IRC message requires a command.r# r r" zDSomebody screwed up, 'cuz this doesn't look like a command to me: %sr+ z:{} {} -Message has %d parameters (RFC allows 15):
%sN)r> joinlistformatrp rT r msg)rF r. parameter_listr+ r4 r r r sendMessage s&
zIRC.sendMessagec C s |st dd|v s|d dkrt d| d|du r i }d|gt| }|r2d| d| }|rA| |}d| d| }| | t|d krYtd
t||f dS dS ) a
Send to the remote peer a line formatted as an IRC message.
@param command: The command or numeric to send.
@type command: L{unicode}
@param parameters: The parameters to send with the command.
@type parameters: A L{tuple} or L{list} of L{unicode} parameters
@param prefix: The prefix to send with the command. If not
given, no prefix is sent.
@type prefix: L{unicode}
@param tags: A dict of message tags. If not given, no message
tags are sent. The dict key should be the name of the tag
to send as a string; the value should be the unescaped value
to send with the tag, or either None or "" if no value is to
be sent with the tag.
@type tags: L{dict} of tags (L{unicode}) => values (L{unicode})
@see: U{https://ircv3.net/specs/core/message-tags-3.2.html}
rq r# r r" zInvalid command: ""N@rr rs )r> rt ru _stringTagsrp rT r rw )rF r.
parametersr+ tagsr4 tagStrr r r sendCommand4 s(
zIRC.sendCommandc C sT | | g }| D ]\}}|r || d| | q || q d|S )z
Converts a tag dictionary to a string.
@param tags: The tag dict passed to sendMsg.
@rtype: L{unicode}
@return: IRCv3-format tag string
=;)
_validateTagsitemsr( _escapeTagValuert )rF r~
tagStringstagr? r r r r| c s
zIRC._stringTagsc C sD | D ]\}}|std|D ]}| s |dvr tdqqdS )z
Checks the tag dict for errors and raises L{ValueError} if an
error is found.
@param tags: The tag dict passed to sendMsg.
zA tag name is required.)-/.z Tag contains invalid characters.N)r r> isalnum)rF r~ r r? charr r r r u s zIRC._validateTagsc C s, | dd dd dd dd d d
S ) a<
Escape the given tag value according to U{escaping rules in IRCv3
}.
@param value: The string value to escape.
@type value: L{str}
@return: The escaped string for sending as a message value
@rtype: L{str}
\z\\r z\:r# z\s
z\rr9 z\n)replace)rF r? r r r r s
zIRC._escapeTagValuec C s t |tr
|d}| j| t}| | _|D ]'}t|dkr"q|d tkr.|dd }t |\}}}|
}| ||| qdS )z
This hack is to support mIRC, which sends LF only, even though the RFC
says CRLF. (Also, the flexibility of LineReceiver to turn "line mode"
on and off was not required.)
rh r% N) rk bytesdecodebufferr& rj r) rT ri r/ upper
handleCommand)rF datalinesr4 r+ r. rX r r r dataReceived s
zIRC.dataReceivedc C Z t | d| d}z|dur||| W dS | ||| W dS ty, t Y dS w a
Determine the function to call for the given command and call it with
the given arguments.
@param command: The IRC command to determine the function for.
@type command: L{bytes}
@param prefix: The prefix of the IRC message (as returned by
L{parsemsg}).
@type prefix: L{bytes}
@param params: A list of parameters to call the function with.
@type params: L{list}
zirc_%sNrJ irc_unknown
BaseExceptionr deferrrF r. r+ rX rP r r r r zIRC.handleCommandc C s t |||)z
Called by L{handleCommand} on a command that doesn't have a defined
handler. Subclasses should override this method.
NotImplementedErrorrF r+ r. rX r r r r zIRC.irc_unknownc C s | d|dt| f| dS )a
Send a message to a channel or user
@type sender: C{str} or C{unicode}
@param sender: Who is sending this message. Should be of the form
username!ident@hostmask (unless you know better!).
@type recip: C{str} or C{unicode}
@param recip: The recipient of this message. If a channel, it must
start with a channel prefix.
@type message: C{str} or C{unicode}
@param message: The message being sent.
PRIVMSGr" N)r lowQuoterF senderrecipmessager r r privmsg z IRC.privmsgc C s | d|d| f| dS )a
Send a "notice" to a channel or user.
Notices differ from privmsgs in that the RFC claims they are different.
Robots are supposed to send notices and not respond to them. Clients
typically display notices differently from privmsgs.
@type sender: C{str} or C{unicode}
@param sender: Who is sending this message. Should be of the form
username!ident@hostmask (unless you know better!).
@type recip: C{str} or C{unicode}
@param recip: The recipient of this message. If a channel, it must
start with a channel prefix.
@type message: C{str} or C{unicode}
@param message: The message being sent.
NOTICEr" N)r r r r r notice s z
IRC.noticec C s | d| d| d| dS )a
Send an action to a channel or user.
@type sender: C{str} or C{unicode}
@param sender: Who is sending this message. Should be of the form
username!ident@hostmask (unless you know better!).
@type recip: C{str} or C{unicode}
@param recip: The recipient of this message. If a channel, it must
start with a channel prefix.
@type message: C{str} or C{unicode}
@param message: The action being sent.
r" z ACTION r$ Nrp r r r r action r z
IRC.actionc C st |du r(|du r| d| jt||df dS | d| jt||t|f dS | d| d| dt| dS )a]
Send the topic to a user.
@type user: C{str} or C{unicode}
@param user: The user receiving the topic. Only their nickname, not
the full hostmask.
@type channel: C{str} or C{unicode}
@param channel: The channel for which this is the topic.
@type topic: C{str} or C{unicode} or L{None}
@param topic: The topic string, unquoted, or None if there is no topic.
@type author: C{str} or C{unicode}
@param author: If the topic is being changed, the full username and
hostmask of the person changing it.
N:%s %s %s %s :%szNo topic is set.r" z TOPIC r$ )rp rc RPL_NOTOPIC RPL_TOPICr )rF userchanneltopicauthorr r r r s $z IRC.topicc C s | d| jd||||f dS )a
Send the author of and time at which a topic was set for the given
channel.
This sends a 333 reply message, which is not part of the IRC RFC.
@type user: C{str} or C{unicode}
@param user: The user receiving the topic. Only their nickname, not
the full hostmask.
@type channel: C{str} or C{unicode}
@param channel: The channel for which this information is relevant.
@type author: C{str} or C{unicode}
@param author: The nickname (without hostmask) of the user who last set
the topic.
@type date: C{int}
@param date: A POSIX timestamp (number of seconds since the epoch) at
which the topic was last set.
z:%s %d %s %s %s %diM Nrp rc )rF r r r dater r r topicAuthor' s zIRC.topicAuthorc C s t |t | d }d| }g }d}|D ]1}|t | d |kr8| d| jt||d|f |g}t |}q|| |t |d 7 }q|rX| d| jt||d|f | d| jt||f dS ) a
Send the names of a channel's participants to a user.
@type user: C{str} or C{unicode}
@param user: The user receiving the name list. Only their nickname,
not the full hostmask.
@type channel: C{str} or C{unicode}
@param channel: The channel for which this is the namelist.
@type names: C{list} of C{str} or C{unicode}
@param names: The names to send.
r r r r! z:%s %s %s = %s :%sr# z :%s %s %s %s :End of /NAMES listN)rT rp rc RPL_NAMREPLYrt r( RPL_ENDOFNAMES) rF r r names prefixLength namesLengthLr\ nr r r r A s4
z IRC.namesc C sj |D ]$}|\}}}}} }
} | dv sJ | d| jt||||||| |
| f q| d| jt||f dS )a
Send a list of users participating in a channel.
@type user: C{str} or C{unicode}
@param user: The user receiving this member information. Only their
nickname, not the full hostmask.
@type channel: C{str} or C{unicode}
@param channel: The channel for which this is the member information.
@type memberInfo: C{list} of C{tuples}
@param memberInfo: For each member of the given channel, a 7-tuple
containing their username, their hostmask, the server to which they
are connected, their nickname, the letter "H" or "G" (standing for
"Here" or "Gone"), the hopcount from C{user} to this member, and
this member's real name.
)HGz":%s %s %s %s %s %s %s %s %s :%d %sz :%s %s %s %s :End of /WHO list.N)rp rc RPL_WHOREPLY RPL_ENDOFWHO) rF r r
memberInfoinfousernamehostmaskservernicknameflaghopsrealNamer r r whoj s0 zIRC.whoc
C s | d| jt|||||f | d| jt||||f |r+| d| jt||f | d| jt||| |
f | d| jt||d| f | d| jt||f dS ) aQ
Send information about the state of a particular user.
@type user: C{str} or C{unicode}
@param user: The user receiving this information. Only their nickname,
not the full hostmask.
@type nick: C{str} or C{unicode}
@param nick: The nickname of the user this information describes.
@type username: C{str} or C{unicode}
@param username: The user's username (eg, ident response)
@type hostname: C{str}
@param hostname: The user's hostmask
@type realName: C{str} or C{unicode}
@param realName: The user's real name
@type server: C{str} or C{unicode}
@param server: The name of the server to which the user is connected
@type serverInfo: C{str} or C{unicode}
@param serverInfo: A descriptive string about that server
@type oper: C{bool}
@param oper: Indicates whether the user is an IRC operator
@type idle: C{int}
@param idle: The number of seconds since the user last sent a message
@type signOn: C{int}
@param signOn: A POSIX timestamp (number of seconds since the epoch)
indicating the time the user signed on
@type channels: C{list} of C{str} or C{unicode}
@param channels: A list of the channels which the user is participating in
z:%s %s %s %s %s %s * :%sz:%s %s %s %s %s :%sz :%s %s %s %s :is an IRC operatorz-:%s %s %s %s %d %d :seconds idle, signon timer r# z :%s %s %s %s :End of WHOIS list.N) rp rc
RPL_WHOISUSERRPL_WHOISSERVERRPL_WHOISOPERATOR
RPL_WHOISIDLERPL_WHOISCHANNELSrt RPL_ENDOFWHOIS) rF r nickr rc r r
serverInfooperidlesignOnrb r r r whois s> 4 z IRC.whoisc C | d| d| dS )a9
Send a join message.
@type who: C{str} or C{unicode}
@param who: The name of the user joining. Should be of the form
username!ident@hostmask (unless you know better!).
@type where: C{str} or C{unicode}
@param where: The channel the user is joining.
r" z JOIN Nr )rF r wherer r r rt s zIRC.joinc C s> |r| d| d| d| dS | d| d| dS )a
Send a part message.
@type who: C{str} or C{unicode}
@param who: The name of the user joining. Should be of the form
username!ident@hostmask (unless you know better!).
@type where: C{str} or C{unicode}
@param where: The channel the user is joining.
@type reason: C{str} or C{unicode}
@param reason: A string describing the misery which caused this poor
soul to depart.
r" z PART r$ Nr )rF r r reasonr r r part s zIRC.partc G s& | d| jt|||d|f dS )a
Send information about the mode of a channel.
@type user: C{str} or C{unicode}
@param user: The user receiving the name list. Only their nickname,
not the full hostmask.
@type channel: C{str} or C{unicode}
@param channel: The channel for which this is the namelist.
@type mode: C{str}
@param mode: A string describing this channel's modes.
@param args: Any additional arguments required by the modes.
z:%s %s %s %s %s %sr# N)rp rc RPL_CHANNELMODEISrt )rF r r moder- r r r channelMode s
zIRC.channelMode)NNrI ) r r r r r rc ra r r; rR rf rp ry r r| r r r r r r r r r r r r r rt r r r r r r r` s4
"/
)+N
r` c @ s e Zd ZdZdZdd Zed:ddZedd Zed
d Z ed d
Z
edd Z d:ddZ dd Z
dd Zdd Zdd Zdd Zd d Zd d Zd d! Zd"d# Zd$d% Zd&d' Zd(d) Zd*d+ Zd,d- Zd.d/ Zd0d1 Z d2d3 Z d4d5 Z d6d7 Z d8d9 Z dS );ServerSupportedFeaturesz
Handle ISUPPORT messages.
Feature names match those in the ISUPPORT RFC draft identically.
Information regarding the specifics of ISUPPORT was gleaned from
.
isupportc C s, dt ddd| d| g dd| _d S )N z#& z(ovh)@+%)br lkr )
CHANNELLEN CHANTYPESMODESNICKLENPREFIX CHANMODES)tuple_parsePrefixParam_parseChanModesParam _featuresrE r r r __init__& s z ServerSupportedFeatures.__init__Nc s( du rdd fdd}t | S )a9
Split ISUPPORT parameter arguments.
Values can optionally be processed by C{valueProcessor}.
For example::
>>> ServerSupportedFeatures._splitParamArgs(['A:1', 'B:2'])
(('A', '1'), ('B', '2'))
@type params: C{iterable} of C{str}
@type valueProcessor: C{callable} taking {str}
@param valueProcessor: Callable to process argument values, or L{None}
to perform no processing
@rtype: C{list} of C{(str, object)}
@return: Sequence of C{(name, processedValue)}
Nc S s | S rI r )xr r r J z9ServerSupportedFeatures._splitParamArgs..c 3 s> D ]} d| vr
| d7 } | dd\}}||fV qd S )Nr" r! r: )r^ ar rX valueProcessorr r _parseL s z7ServerSupportedFeatures._splitParamArgs.._parse)ru )clsrX r r r r r _splitParamArgs4 s
z'ServerSupportedFeatures._splitParamArgsc s$ fdd}d vr S d | S )z
Unescape an ISUPPORT parameter.
The only form of supported escape is C{\xHH}, where HH must be a valid
2-digit hexadecimal number.
@rtype: C{str}
c 3 sz d} | dV | D ],}|d d |dd }}zt|d}W n ty2 td|w t|| V qd S )N\xr r zInvalid hex octet: )r& r) r< r> chr)partsr* octetrestr? r r _unescape` s
z>ServerSupportedFeatures._unescapeParamValue.._unescaper r )rt )r r? r r r r _unescapeParamValueU s z+ServerSupportedFeatures._unescapeParamValuec s< d|vr|d7 }| dd\}}| fdd| dD fS )z
Split an ISUPPORT parameter.
@type param: C{str}
@rtype: C{(str, list)}
@return: C{(key, arguments)}
r r! c s g | ]} |qS r )r )r3 vr r r r8 } z7ServerSupportedFeatures._splitParam..,r: )r r^ keyr? r r r _splitParamp s
z#ServerSupportedFeatures._splitParamc C s` |sdS |d dkrd|vrt d|dd\}}t|tt|}|dd }tt||S )a
Parse the ISUPPORT "PREFIX" parameter.
The order in which the parameter arguments appear is significant, the
earlier a mode appears the more privileges it gives.
@rtype: C{dict} mapping C{str} to C{(str, int)}
@return: A dictionary mapping a mode character to a two-tuple of
C({symbol, priority)}, the lower a priority (the lowest being
C{0}) the more privileges it gives
Nr ()zMalformed PREFIX parameterr! )r> r& ziprangerT dict)r r+ rW symbolsr r r r s
z)ServerSupportedFeatures._parsePrefixParamc C sD d}t |t |krtdt |t |f tdd ||}t|S )z
Parse the ISUPPORT "CHANMODES" parameter.
See L{isupport_CHANMODES} for a detailed explanation of this parameter.
) addressModesr^ setParamnoParamz9Expecting a maximum of %d channel mode parameters, got %dc S s | |pdfS )Nr r )r r? r r r r s z>ServerSupportedFeatures._parseChanModesParam..)rT r> mapr )rF rX r r r r r r s z,ServerSupportedFeatures._parseChanModesParamc C s | j ||S )a
Get a server supported feature's value.
A feature with the value L{None} is equivalent to the feature being
unsupported.
@type feature: C{str}
@param feature: Feature name
@type default: C{object}
@param default: The value to default to, assuming that C{feature}
is not supported
@return: Feature value
)r get)rF featurer@ r r r
getFeature s z"ServerSupportedFeatures.getFeaturec C s | |duS )z[
Determine whether a feature is supported or not.
@rtype: C{bool}
N)r )rF r r r r
hasFeature s z"ServerSupportedFeatures.hasFeaturec C sP |D ]#}| |\}}|dr | j|dd d q| ||| j|< qdS )a2
Parse ISUPPORT parameters.
If an unknown parameter is encountered, it is simply added to the
dictionary, keyed by its name, as a tuple of the parameters provided.
@type params: C{iterable} of C{str}
@param params: Iterable of ISUPPORT parameters to parse
r r! N)r
startswithr r) rQ )rF rX r^ r r? r r r parse s
z ServerSupportedFeatures.parsec C s t |S )z-
Unknown ISUPPORT parameter.
r )rF r. rX r r r isupport_unknown z(ServerSupportedFeatures.isupport_unknownc C | |tS )zJ
The maximum number of each channel type a user may join.
r rA rF rX r r r isupport_CHANLIMIT z*ServerSupportedFeatures.isupport_CHANLIMITc C s* z| |W S ty | d Y S w )aA
Available channel modes.
There are 4 categories of channel mode::
addressModes - Modes that add or remove an address to or from a
list, these modes always take a parameter.
param - Modes that change a setting on a channel, these modes
always take a parameter.
setParam - Modes that change a setting on a channel, these modes
only take a parameter when being set.
noParam - Modes that change a setting on a channel, these modes
never take a parameter.
r )r r> r r" r r r isupport_CHANMODES s
z*ServerSupportedFeatures.isupport_CHANMODESc C t |d | dS )zG
Maximum length of a channel name a client may create.
r r rA r r" r r r isupport_CHANNELLEN z+ServerSupportedFeatures.isupport_CHANNELLENc C t |d S )z)
Valid channel prefixes.
r r r" r r r isupport_CHANTYPES r$ z*ServerSupportedFeatures.isupport_CHANTYPESc C |d pdS )z
Mode character for "ban exceptions".
The presence of this parameter indicates that the server supports
this functionality.
r er r" r r r isupport_EXCEPTS z(ServerSupportedFeatures.isupport_EXCEPTSc C s
| |S )z
Safe channel identifiers.
The presence of this parameter indicates that the server supports
this functionality.
)r r" r r r isupport_IDCHAN s
z'ServerSupportedFeatures.isupport_IDCHANc C r, )z
Mode character for "invite exceptions".
The presence of this parameter indicates that the server supports
this functionality.
r Ir r" r r r isupport_INVEX r/ z&ServerSupportedFeatures.isupport_INVEXc C r* )zH
Maximum length of a kick message a client may provide.
r rA r" r r r isupport_KICKLEN r$ z(ServerSupportedFeatures.isupport_KICKLENc C r )z
Maximum number of "list modes" a client may set on a channel at once.
List modes are identified by the "addressModes" key in CHANMODES.
r! r" r r r isupport_MAXLIST s z(ServerSupportedFeatures.isupport_MAXLISTc C r* )z
Maximum number of modes accepting parameters that may be sent, by a
client, in a single MODE command.
r r3 r" r r r isupport_MODES( r z&ServerSupportedFeatures.isupport_MODESc C |d S )z#
IRC network name.
r r r" r r r isupport_NETWORK/ r z(ServerSupportedFeatures.isupport_NETWORKc C r& )zB
Maximum length of a nickname the client may use.
r r r' r" r r r isupport_NICKLEN5 r) z(ServerSupportedFeatures.isupport_NICKLENc C s. z| |d W S ty | d Y S w )zQ
Mapping of channel modes that clients may have to status flags.
r r )r r> r r" r r r isupport_PREFIX; s
z'ServerSupportedFeatures.isupport_PREFIXc C dS )z
Flag indicating that a client may request a LIST without being
disconnected due to the large amount of data generated.
Tr r" r r r isupport_SAFELISTD s z)ServerSupportedFeatures.isupport_SAFELISTc C r7 )zv
The server supports sending messages to only to clients on a channel
with a specific status.
r r r" r r r isupport_STATUSMSGK s z*ServerSupportedFeatures.isupport_STATUSMSGc C s t | |tS )zh
Maximum number of targets allowable for commands that accept multiple
targets.
)r r rA r" r r r isupport_TARGMAXR s z(ServerSupportedFeatures.isupport_TARGMAXc C r* )z<
Maximum length of a topic that may be set.
r r3 r" r r r isupport_TOPICLENY r$ z)ServerSupportedFeatures.isupport_TOPICLENrI )!r r r r r+ r classmethodr r r r r r r r r r# r% r( r+ r. r0 r2 r4 r5 r6 r8 r9 r: r< r= r> r? r r r r r sF
r c @ sV e Zd ZdZdZdZdZdZdZdZ dZ
dZ dZ dZ
dZdZdZdZdZdZdZdZdZdZd Zd
Zd ZdZd Z d
d Z dd Z dd Z dd Z dd Z!dd Z"dd Z#dd Z$d d Z%d d Z&d!d" Z'd#d$ Z(d%d& Z)d'd( Z*d)d* Z+d+d, Z,d-d. Z-d/d0 Z.d1d2 Z/d3d4 Z0d5d6 Z1d7d8 Z2d9d: Z3d;d< Z4d=d> Z5d?d@ Z6dAdB Z7dCdD Z8dEdF Z9dGdH Z:dIdJ Z;dKdL ZddQdRZ?ddSdTZ@ddUdVZAe@ZBdWdX ZCddYdZZDdd[d\ZEdd]d^ZFd_d` ZGddadbZHdcdd ZId dedfZJdgdh ZKddidjZLddmdnZMdodp ZNd dqdrZOdsdt ZPdZQduZRddvdwZSdxdy ZTdzd{ ZUd|d} ZVd~d ZWdd ZXdd ZYdd ZZdd Z[dd Z\dd Z]dd Z^dd Z_dd Z`dd Zadd Zbdd Zcdd Zddd Zedd Zfdd Zgdd Zhdd Zidd Zjdd Zkdd Zldd Zmdd Zndd Zodd Zpdd Zqdd Zrdd Zsdd Ztdd Zudd Zvdd Zwdd ZxddÄ Zyddń ZzddDŽ Z{ddɄ Z|dd˄ Z}dd̈́ Z~ddτ Zddф Zddӄ ZddՄ Zddׄ Zddل Zddۄ Zdd݄ Zdd߄ Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd Zdd ZdS ( IRCClienta
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?)
@ivar nickname: Nickname the client will use.
@ivar password: Password used to log on to the server. May be L{None}.
@ivar realname: Supplied to the server during login as the "Real name"
or "ircname". May be L{None}.
@ivar username: Supplied to the server during login as the "User name".
May be L{None}
@ivar userinfo: Sent in reply to a C{USERINFO} CTCP query. If L{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)."
@ivar fingerReply: Sent in reply to a C{FINGER} CTCP query. If L{None}, no
FINGER reply will be sent.
@type fingerReply: Callable or String
@ivar versionName: CTCP VERSION reply, client name. If L{None}, no VERSION
reply will be sent.
@type versionName: C{str}, or None.
@ivar versionNum: CTCP VERSION reply, client version.
@type versionNum: C{str}, or None.
@ivar versionEnv: CTCP VERSION reply, environment the client is running in.
@type versionEnv: C{str}, or None.
@ivar sourceURL: CTCP SOURCE reply, a URL where the source code of this
client may be found. If L{None}, no SOURCE reply will be sent.
@ivar lineRate: Minimum delay between lines sent to the server. If
L{None}, no delay will be imposed.
@type lineRate: Number of Seconds.
@ivar motd: Either L{None} or, between receipt of I{RPL_MOTDSTART} and
I{RPL_ENDOFMOTD}, a L{list} of L{str}, each of which is the content
of an I{RPL_MOTD} message.
@ivar erroneousNickFallback: Default nickname assigned when an unregistered
client triggers an C{ERR_ERRONEUSNICKNAME} while trying to register
with an illegal nickname.
@type erroneousNickFallback: C{str}
@ivar _registered: Whether or not the user is registered. It becomes True
once a welcome has been received from the server.
@type _registered: C{bool}
@ivar _attemptedNick: The nickname that will try to get registered. It may
change if it is illegal or already taken. L{nickname} becomes the
L{_attemptedNick} that is successfully registered.
@type _attemptedNick: C{str}
@type supported: L{ServerSupportedFeatures}
@ivar supported: Available ISUPPORT features on the server
@type hostname: C{str}
@ivar hostname: Host name of the IRC server the client is connected to.
Initially the host name is L{None} and later is set to the host name
from which the I{RPL_WELCOME} message is received.
@type _heartbeat: L{task.LoopingCall}
@ivar _heartbeat: Looping call to perform the keepalive by calling
L{IRCClient._sendHeartbeat} every L{heartbeatInterval} seconds, or
L{None} if there is no heartbeat.
@type heartbeatInterval: C{float}
@ivar heartbeatInterval: Interval, in seconds, to send I{PING} messages to
the server as a form of keepalive, defaults to 120 seconds. Use L{None}
to disable the heartbeat.
Nircz#http://twistedmatrix.com/downloads/r r!
z!unusednames=params,prefix,channelFr defaultnickx c C s2 t |}t|tr|d}|d7 }tj| |S )Nrh
)r rk r; rl r LineReceiverrp )rF r4 quoteLiner r r _reallySendLine s
zIRCClient._reallySendLinec C s: | j d u r | | d S | j| | js| d S d S rI )lineRaterI _queuer( _queueEmptying _sendLinerF r4 r r r rp s
zIRCClient.sendLinec C s8 | j r| | j d t| j| j| _d S d | _d S )Nr )rK rI r) r callLaterrJ rM rL rE r r r rM s
zIRCClient._sendLinec C s t j| | | d S rI )r rG connectionLost
stopHeartbeatrF r r r r rP s zIRCClient.connectionLostc C s t | jS )z6
Create the heartbeat L{LoopingCall}.
)r LoopingCall_sendHeartbeatrE r r r _createHeartbeat r$ zIRCClient._createHeartbeatc C s | d| j dS )zR
Send a I{PING} message to the IRC server as a form of keepalive.
zPING Nr rE r r r rT r) zIRCClient._sendHeartbeatc C s" | j dur| j d| _ dS dS )zy
Stop sending I{PING} messages to keep the connection to the server
alive.
@since: 11.1
N)
_heartbeatstoprE r r r rQ s
zIRCClient.stopHeartbeatc C s6 | | jdu r dS | | _| jj| jdd dS )z
Start sending I{PING} messages every L{IRCClient.heartbeatInterval}
seconds to keep the connection to the server alive during periods of no
activity.
@since: 11.1
NF)now)rQ heartbeatIntervalrU rV startrE r r r startHeartbeat
s
zIRCClient.startHeartbeatc C r; )z
Called with creation date information about the server, usually at logon.
@type when: C{str}
@param when: A string describing when the server was created, probably.
Nr )rF whenr r r created r zIRCClient.createdc C r; )z
Called with daemon information about the server, usually at logon.
@type info: C{str}
@param info: A string describing what software the server is running, probably.
Nr rF r r r r yourHost& r zIRCClient.yourHostc C r; )a
Called with information about the server, usually at logon.
@type servername: C{str}
@param servername: The hostname of this server.
@type version: C{str}
@param version: A description of what software this server runs.
@type umodes: C{str}
@param umodes: All the available user modes.
@type cmodes: C{str}
@param cmodes: All the available channel modes.
Nr )rF
servernameversionumodescmodesr r r myInfo. r zIRCClient.myInfoc C r; )z
Called with information about the number of connections, usually at logon.
@type info: C{str}
@param info: A description of the number of clients and servers
connected to the network, probably.
Nr r^ r r r luserClient? r zIRCClient.luserClientc C r; )z
Called with information about where the client should reconnect.
@type info: C{str}
@param info: A plaintext description of the address that should be
connected to.
Nr r^ r r r bounceH r zIRCClient.bouncec C r; )z
Called with various information about what the server supports.
@type options: C{list} of C{str}
@param options: Descriptions of features or limits of the server, possibly
in the form "NAME=VALUE".
Nr )rF optionsr r r r Q r zIRCClient.isupportc C r; )zl
Called with the number of channels existent on the server.
@type channels: C{int}
Nr )rF rb r r r
luserChannelsZ r zIRCClient.luserChannelsc C r; )zc
Called with the number of ops logged on to the server.
@type ops: C{int}
Nr )rF opsr r r luserOpa r zIRCClient.luserOpc C r; )z
Called with information about the server connected to.
@type info: C{str}
@param info: A plaintext string describing the number of users and servers
connected to this server.
Nr r^ r r r luserMeh r zIRCClient.luserMec C r; )zN
Called when I have a message from a user to me or a channel.
Nr rF r r r r r r r s zIRCClient.privmsgc C r; )z
Called when I finish joining a channel.
channel has the starting character (C{'#'}, C{'&'}, C{'!'}, or C{'+'})
intact.
Nr rF r r r r joinedy r zIRCClient.joinedc C r; )z
Called when I have left a channel.
channel has the starting character (C{'#'}, C{'&'}, C{'!'}, or C{'+'})
intact.
Nr rn r r r left r zIRCClient.leftc C r; )a
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.
Nr rl r r r noticed r zIRCClient.noticedc C r; )a
Called when users or channel's modes are changed.
@type user: C{str}
@param user: The user and hostmask which instigated this change.
@type channel: C{str}
@param channel: 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 C{user}.
@type set: C{bool} or C{int}
@param set: 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)
@type modes: C{str}
@param modes: The mode or modes which are being changed.
@type args: C{tuple}
@param args: Any additional information required for the mode
change.
Nr )rF r r setrW r- r r r modeChanged r zIRCClient.modeChangedc C r; )z?
Called with the results of a CTCP PING query.
Nr )rF r secsr r r pong rm zIRCClient.pongc C r; )zE
Called after successfully signing on to the server.
Nr rE r r r signedOn rm zIRCClient.signedOnc C r; )z9
Called when I am kicked from a channel.
Nr )rF r kickerr r r r
kickedFrom rm zIRCClient.kickedFromc C
|| _ dS )z7
Called when my nick has been changed.
N)r )rF r r r r nickChanged s
zIRCClient.nickChangedc C r; )zC
Called when I see another user joining a channel.
Nr rF r r r r r
userJoined rm zIRCClient.userJoinedc C r; )zC
Called when I see another user leaving a channel.
Nr r{ r r r userLeft rm zIRCClient.userLeftc C r; )zM
Called when I see another user disconnect from the network.
Nr )rF r quitMessager r r userQuit rm zIRCClient.userQuitc C r; )zQ
Called when I observe someone else being kicked from a channel.
Nr )rF kickeer rw r r r r
userKicked rm zIRCClient.userKickedc C r; )zJ
Called when I see a user perform an ACTION on a channel.
Nr rF r r r r r r r rm zIRCClient.actionc C r; )zt
In channel, user changed the topic to newTopic.
Also called when first joining a channel.
Nr )rF r r newTopicr r r topicUpdated s zIRCClient.topicUpdatedc C r; )zD
A user changed their name from oldname to newname.
Nr )rF oldnamenewnamer r r userRenamed rm zIRCClient.userRenamedc C r; )a#
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.
Nr )rF motdr r r receivedMOTD s zIRCClient.receivedMOTDc C F |d t vr
d| }|r| d| d| dS | d| dS )a
Join a channel.
@type channel: C{str}
@param channel: The name of the channel to join. If it has no prefix,
C{'#'} will be prepended to it.
@type key: C{str}
@param key: If specified, the key used to join the channel.
r #zJOIN r# NCHANNEL_PREFIXESrp )rF r r r r r rt
zIRCClient.joinc C r )a
Leave a channel.
@type channel: C{str}
@param channel: The name of the channel to leave. If it has no prefix,
C{'#'} will be prepended to it.
@type reason: C{str}
@param reason: If given, the reason for leaving.
r r zPART r$ Nr )rF r r r r r leave r zIRCClient.leavec C sR |d t vr
d| }|r | d| d| d| dS | d| d| dS )a
Attempt to kick a user from a channel.
@type channel: C{str}
@param channel: The name of the channel to kick the user from. If it has
no prefix, C{'#'} will be prepended to it.
@type user: C{str}
@param user: The nick of the user to kick.
@type reason: C{str}
@param reason: If given, the reason for kicking the user.
r r zKICK r# r$ Nr )rF r r r r r r kick, s
zIRCClient.kickc C s. |d t vr
d| }| d| d| dS )z
Attempt to invite user to channel
@type user: C{str}
@param user: The user to invite
@type channel: C{str}
@param channel: The channel to invite the user too
@since: 11.0
r r zINVITE r# Nr r{ r r r inviteA s zIRCClient.invitec C sJ |d t vr
d| }|dkr| d| d| dS | d| dS )a
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.
@type channel: C{str}
@param channel: The name of the channel to change the topic on. If it
has no prefix, C{'#'} will be prepended to it.
@type topic: C{str}
@param topic: If specified, what to set the topic to.
r r NzTOPIC r$ r )rF r r r r r r P s
zIRCClient.topicc C sx |r d| d| }nd| d| }|dur d||f }n|dur*| d| }n |dur5| d| }| | dS )a?
Change the modes on a user or channel.
The C{limit}, C{user}, and C{mask} parameters are mutually exclusive.
@type chan: C{str}
@param chan: The name of the channel to operate on.
@type set: C{bool}
@param set: True to give the user or channel permissions and False to
remove them.
@type modes: C{str}
@param modes: The mode flags to set on the user or channel.
@type limit: C{int}
@param limit: In conjunction with the C{'l'} mode flag, limits the
number of users on the channel.
@type user: C{str}
@param user: The user to change the mode on.
@type mask: C{str}
@param mask: In conjunction with the C{'b'} mode flag, sets a mask of
users to be banned from the channel.
zMODE z +z -Nz%s %dr# r )rF chanrr rW limitr maskr4 r r r r f s zIRCClient.modec C s& |d t vr
d| }| ||| dS )a
Send a message to a channel
@type channel: C{str}
@param channel: The channel to say the message on. If it has no prefix,
C{'#'} will be prepended to it.
@type message: C{str}
@param message: The message to say.
@type length: C{int}
@param length: The maximum number of octets to send at a time. This has
the effect of turning a single call to C{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.
r r N)r rw )rF r r r7 r r r say s z
IRCClient.sayc C s0 d d| jd dd|}d}tt| | S )a
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.
z :{}!{}@{} {}r r
bbbbbbbbbb?cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccr )rv supportedr MAX_COMMAND_LENGTHrT )rF r. theoreticalfudger r r _safeMaximumLineLength s z IRCClient._safeMaximumLineLengthc C sh d| d}|du r| |}t|d }||kr!td||f t||| D ] }| || q(dS )a
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.
@param user: Username or channel name to which to direct the
message.
@type user: C{str}
@param message: Text to send.
@type message: C{str}
@param length: Maximum number of octets to send in a single
command, including the IRC protocol framing. If L{None} is given
then L{IRCClient._safeMaximumLineLength} is used to determine a
value.
@type length: C{int}
zPRIVMSG r$ Nr z/Maximum length must exceed %d for message to %s)r rT r> r& rp )rF r r r7 fmt
minimumLengthr4 r r r rw s
z
IRCClient.msgc C r )a-
Send a notice to a user.
Notices are like normal message, but should never get automated
replies.
@type user: C{str}
@param user: The user to send a notice to.
@type message: C{str}
@param message: The contents of the notice to send.
zNOTICE r$ Nr )rF r r r r r r s zIRCClient.noticec C | d| dS )z
Mark this client as away.
@type message: C{str}
@param message: If specified, the away message.
zAWAY :%sNr rF r r r r away zIRCClient.awayc C s | dS )z(
Clear the away status.
N)r rE r r r back r zIRCClient.backc C s4 |du r
| d| dS | d| d| dS )z
Retrieve user information about the given nickname.
@type nickname: C{str}
@param nickname: The nickname about which to retrieve information.
@since: 8.2
NzWHOIS r# r )rF r r r r r r s zIRCClient.whoisfoobarc C sR | j dur
| d| j | | | jdu r|| _| d| j||| j dS )a?
Login to the server.
@type nickname: C{str}
@param nickname: The nickname to register.
@type hostname: C{str}
@param hostname: If specified, the hostname to logon as.
@type servername: C{str}
@param servername: If specified, the servername to logon as.
NzPASS %szUSER {} {} {} :{})passwordrp setNickr rv realname)rF r rc r` r r r register s
zIRCClient.registerc C s || _ | d| dS )z
Set this client's nickname.
@type nickname: C{str}
@param nickname: The nickname to change to.
zNICK %sN)_attemptedNickrp rF r r r r r s zIRCClient.setNickc C r )z
Disconnect from the server
@type message: C{str}
@param message: If specified, the message to give when quitting the
server.
zQUIT :%sNr r r r r quit% s zIRCClient.quitc C s | |d|fg dS )a*
Strike a pose.
@type channel: C{str}
@param channel: The name of the channel to have an action on. If it
has no prefix, it is sent to the user of that name.
@type action: C{str}
@param action: The action to preform.
@since: 9.0
ACTIONN
ctcpMakeQuery)rF r r r r r describe2 s zIRCClient.describe c s | j du ri | _ |du r$tjtj tj d fddtdD }nt|}t | j ||f< | |d|fg t
| j | j krgdd | j D }|
t
| j | j }t|D ] }| j || d = q\dS dS ) zA
Measure round-trip delay to another IRC client.
Nr c s g | ]}t qS r )randomchoice)r3 icharsr r r8 K r z"IRCClient.ping..r PINGc S s g | ]\}}||fqS r r )r3 kr r r r r8 S s r! )_pingsstring
ascii_lettersdigits punctuationrt r r; timer rT
_MAX_PINGRINGr sort)rF r textr byValueexcessr r r r pingB s
zIRCClient.pingc C t d)aK
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.
@param user: C{str} representing the user
@param file: an open file (unknown, since this is not implemented)
zXXX!!! Help! I need to bind a socket, have it listen, and tell me its address. (and stop accepting once we've made a single connection.)r )rF r filer r r dccSendY s zIRCClient.dccSendc C | |dd|||gfg dS )z<
Send a DCC RESUME request to another user.
DCCRESUMENr rF r fileNameport resumePosr r r dccResumeg zIRCClient.dccResumec C r )zT
Send a DCC ACCEPT response to clients who have requested a resume.
r ACCEPTNr r r r r dccAcceptResumem r zIRCClient.dccAcceptResumec C s | | j| _| | j dS )zg
Called when we try to register or change to a nickname that is already
taken.
N)alterCollidedNickr r rF r+ rX r r r irc_ERR_NICKNAMEINUSEw s z IRCClient.irc_ERR_NICKNAMEINUSEc C s |d S )ar
Generate an altered version of a nickname that caused a collision in an
effort to create an unused related name for subsequent registration.
@param nickname: The nickname a user is attempting to register.
@type nickname: C{str}
@returns: A string that is in some way different from the nickname.
@rtype: C{str}
rD r r r r r r s zIRCClient.alterCollidedNickc C s | j s | | j dS dS )a
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 I{erroneus}, as it appears in
the RFC, section 6.1.
N) _registeredr erroneousNickFallbackr r r r irc_ERR_ERRONEUSNICKNAME s z"IRCClient.irc_ERR_ERRONEUSNICKNAMEc C r )z6
Called when the login was incorrect.
zPassword Incorrect.)r r r r r irc_ERR_PASSWDMISMATCH r z IRCClient.irc_ERR_PASSWDMISMATCHc C s( || _ d| _| j| _| | dS )zK
Called when we have received the welcome from the server.
TN)rc r r r rv r[ r r r r irc_RPL_WELCOME s
zIRCClient.irc_RPL_WELCOMEc C s> | dd }|d }|| jkr| | dS | || dS )z5
Called when a user joins a channel.
!r r% N)r& r ro r| rF r+ rX r r r r r irc_JOIN
zIRCClient.irc_JOINc C s> | dd }|d }|| jkr| | dS | || dS )z6
Called when a user leaves a channel.
r r N)r& r rp r} r r r r irc_PART r zIRCClient.irc_PARTc C s" | dd }| ||d dS )z.
Called when a user has quit.
r r N)r& r rF r+ rX r r r r irc_QUIT s zIRCClient.irc_QUITc
C s |d |d |dd }}}|d dvrd| }|| j kr$| }n| }z
t|||\}}W n tyH tddd|f Y dS w |r]t| \}}| ||d d
|| |rst| \}}| ||d d
|| dS dS ) z5
Parse a server mode change message.
r r! r Nz-++zCAn error occurred while parsing the following MODE message: MODE %sr# Tr F)
r getUserModeParamsgetChannelModeParamsr_ r r errrt r rs ) rF r rX r rW r- rY addedremovedr r r irc_MODE s.
zIRCClient.irc_MODEc C s | d|d dS )z1
Called when some has pinged us.
zPONG %sr% Nr r r r r irc_PING s zIRCClient.irc_PINGc C sv |}|d }|d }|sdS |d t kr2t|}|d r%| |||d |d s+dS d|d }| ||| dS )z/
Called when we get a message.
r r% Nextendednormalr# )X_DELIM ctcpExtract ctcpQueryrt r rF r+ rX r r r mr r r irc_PRIVMSG s zIRCClient.irc_PRIVMSGc C sn |}|d }|d }|d t kr.t|}|d r!| |||d |d s'dS d|d }| ||| dS )z3
Called when a user gets a notice.
r r% r r Nr# )r r ctcpReplyrt rq r r r r
irc_NOTICE s zIRCClient.irc_NOTICEc C s@ | ddd }|| jkr| |d dS | ||d dS )z<
Called when a user changes their nickname.
r r! r N)r& r rz r r r r r irc_NICK s
zIRCClient.irc_NICKc C s^ | dd }|d }|d }|d }| | j kr%| ||| dS | |||| dS )z>
Called when a user is kicked from a channel.
r r r! r% N)r& lowerr rx r )rF r+ rX rw r kickedr r r r irc_KICK$ s zIRCClient.irc_KICKc C s0 | dd }|d }|d }| ||| dS )z7
Someone in the channel set the topic.
r r r! Nr& r rF r+ rX r r newtopicr r r irc_TOPIC2 s zIRCClient.irc_TOPICc C s0 | dd }|d }|d }| ||| dS )zt
Called when the topic for a channel is initially reported or when it
subsequently changes.
r r r! r Nr r r r r
irc_RPL_TOPIC; s zIRCClient.irc_RPL_TOPICc C s, | dd }|d }d}| ||| d S )Nr r r! r r r r r r irc_RPL_NOTOPICE s zIRCClient.irc_RPL_NOTOPICc C s2 |d dr|d dd |d< |d g| _d S Nr% z- r )r r r r r r irc_RPL_MOTDSTARTK s zIRCClient.irc_RPL_MOTDSTARTc C sF |d dr|d dd |d< | jd u rg | _| j|d d S r )r r r( r r r r irc_RPL_MOTDP s
zIRCClient.irc_RPL_MOTDc C s | j }d| _ | | dS )z
I{RPL_ENDOFMOTD} indicates the end of the message of the day
messages. Deliver the accumulated lines to C{receivedMOTD}.
N)r r )rF r+ rX r r r r irc_RPL_ENDOFMOTDW s zIRCClient.irc_RPL_ENDOFMOTDc C | |d d S Nr! )r] r r r r irc_RPL_CREATED` zIRCClient.irc_RPL_CREATEDc C r r )r_ r r r r irc_RPL_YOURHOSTc r zIRCClient.irc_RPL_YOURHOSTc C s@ |d d d}t|dk r|d t|dk s| j| d S )Nr! r )r& rT r( rd )rF r+ rX r r r r irc_RPL_MYINFOf s
zIRCClient.irc_RPL_MYINFOc C r r )rf r r r r irc_RPL_BOUNCEl r zIRCClient.irc_RPL_BOUNCEc C s& |dd }| j | | | d S )Nr! r% )r r r )rF r+ rX r- r r r irc_RPL_ISUPPORTo s zIRCClient.irc_RPL_ISUPPORTc C r r )re r r r r irc_RPL_LUSERCLIENTx r z IRCClient.irc_RPL_LUSERCLIENTc C . z | t|d W d S ty Y d S w r )rj r< r> r r r r irc_RPL_LUSEROP{
zIRCClient.irc_RPL_LUSEROPc C r r )rh r< r> r r r r irc_RPL_LUSERCHANNELS r z IRCClient.irc_RPL_LUSERCHANNELSc C r r )rk r r r r irc_RPL_LUSERME r zIRCClient.irc_RPL_LUSERMEc C d S rI r r r r r r zIRCClient.irc_unknownc C s` t }|D ](\}}t| d| d}||vr(|dur |||| n| |||| || qdS )z
Dispatch method for any CTCP queries received.
Duplicated CTCP queries are ignored and no dispatch is
made. Unrecognized CTCP queries invoke L{IRCClient.ctcpUnknownQuery}.
z ctcpQuery_%sN)rr rJ ctcpUnknownQueryadd)rF r r messagesseenr r rP r r r r s zIRCClient.ctcpQueryc C s t d|d|d| dS )z
Fallback handler for unrecognized CTCP queries.
No CTCP I{ERRMSG} reply is made to remove a potential denial of service
avenue.
zUnknown CTCP query from : r# Nr rw rF r r r r r r r r s zIRCClient.ctcpUnknownQueryc C s | ||| d S rI )r r r r r ctcpQuery_ACTION r zIRCClient.ctcpQuery_ACTIONc C s$ | dd }| |d|fg d S )Nr r r r&
ctcpMakeReplyrF r r r r r r r ctcpQuery_PING s zIRCClient.ctcpQuery_PINGc C sl |d ur| d| d| d | jsd S t| jr | }nt| j}|dd }| |d|fg d S )NWhy did send 'z' with a FINGER query?r r FINGER)
quirkyMessage fingerReplycallabler; r& r )rF r r r replyr r r r ctcpQuery_FINGER s
zIRCClient.ctcpQuery_FINGERc C sf |d ur| d| d| d | jr1|dd }| |dd| j| jp%d| jp)df fg d S d S ) Nr r z' with a VERSION query?r r VERSIONz%s:%s:%sr )r" versionNamer& r
versionNum
versionEnvr r r r ctcpQuery_VERSION s" zIRCClient.ctcpQuery_VERSIONc C sR |d ur| d| d| d | jr'|dd }| |d| jfdg d S d S )Nr r z' with a SOURCE query?r r SOURCE)r, N)r" sourceURLr& r r r r r ctcpQuery_SOURCE s zIRCClient.ctcpQuery_SOURCEc C sP |d ur| d| d| d | jr&|dd }| |d| jfg d S d S )Nr r z' with a USERINFO query?r r USERINFO)r" userinfor& r r r r r ctcpQuery_USERINFO s z IRCClient.ctcpQuery_USERINFOc C s | dd }|s tt| jd}| |dd|fg dS | }t| d|d d}|sB| |dd||d f fg dS t|d d
}| |d|fg dS ) a
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.
r r
ctcpQuery_
CLIENTINFOr# NERRMSGz!CLIENTINFO %s :Unknown query '%s'r r )r& sortedr prefixedMethodNames __class__r rt rJ ) rF r r r r r r- rP docr r r ctcpQuery_CLIENTINFO s" z IRCClient.ctcpQuery_CLIENTINFOc C s( | dd }| |dd| fg d S )Nr r r4 z%s :No error has occurred.r r r r r ctcpQuery_ERRMSG s zIRCClient.ctcpQuery_ERRMSGc C sX |d ur| d| d| d |dd }| |ddttt fg d S )Nr r z' with a TIME query?r r TIMEz:%s)r" r& r r asctime localtimer r r r ctcpQuery_TIME s zIRCClient.ctcpQuery_TIMEc C s |sdS | ddd }t| d| d}|r2| jdu r g | _|t|d d }|||| dS | dd }| |dd| d| d fg | | d
| dS ) a+
Initiate a Direct Client Connection
@param user: The hostmask of the user/client.
@type user: L{bytes}
@param channel: The name of the IRC channel.
@type channel: L{bytes}
@param data: The DCC request message.
@type data: L{bytes}
Nr! r dcc_r r4 zDCC z :Unknown DCC type ''z offered unknown DCC type )r& r rJ dcc_sessionsrT r r" )rF r r r dcctypehandlerr r r r
ctcpQuery_DCC s
zIRCClient.ctcpQuery_DCCc C s t |}t|dk rtd||d d \}}}t|}zt|}W n ty3 td|w d}t|dkrNzt|d }W n tyM Y nw | |||||| d S )Nr z malformed DCC SEND request: Indecipherable port r% r )shlexr& rT r dccParseAddressr< r> dccDoSend)rF r r r filenameaddressr sizer r r dcc_SEND5 s$
zIRCClient.dcc_SENDc C t t |}t|dk rtd||d d \}}}z
t|}t|}W n
ty/ Y d S w | |||| d S )Nr z#malformed DCC SEND ACCEPT request: )rF r& rT r r< r> dccDoAcceptResumerF r r r rI r r r r r
dcc_ACCEPTM
zIRCClient.dcc_ACCEPTc C rM )Nr z#malformed DCC SEND RESUME request: )rF r& rT r r< r> dccDoResumerO r r r
dcc_RESUMEZ rQ zIRCClient.dcc_RESUMEc C s~ t |}t|dk rtd||d d \}}}t|}zt|}W n ty3 td|w | ||||| d S )Nr z malformed DCC CHAT request: rE )rF r& rT r rG r< r> dccDoChat)rF r r r rI rJ r r r r dcc_CHATg s
zIRCClient.dcc_CHATc C r; )a
Called when I receive a DCC SEND offer from a client.
By default, I do nothing here.
@param user: The hostmask of the requesting user.
@type user: L{bytes}
@param address: The IP address of the requesting user.
@type address: L{bytes}
@param port: An integer representing the port of the requesting user.
@type port: L{int}
@param fileName: The name of the file to be transferred.
@type fileName: L{bytes}
@param size: The size of the file to be transferred, which may be C{-1}
if the size of the file was not specified in the DCC SEND request.
@type size: L{int}
@param data: A 3-list of [fileName, address, port].
@type data: L{list}
Nr )rF r rJ r r rK r r r r rH y r zIRCClient.dccDoSendc C r; )a
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).
@param user: The hostmask of the user who wants to resume the transfer
of a file previously offered via DCC send.
@type user: L{bytes}
@param file: The name of the file to resume the transfer of.
@type file: L{bytes}
@param port: An integer representing the port of the requesting user.
@type port: L{int}
@param resumePos: The position in the file from where the transfer
should resume.
@type resumePos: L{int}
Nr rF r r r r r r r rR zIRCClient.dccDoResumec C r; )a]
Called when a client has verified and accepted a DCC resume request
made by us. By default it will do nothing.
@param user: The hostmask of the user who has accepted the DCC resume
request.
@type user: L{bytes}
@param file: The name of the file to resume the transfer of.
@type file: L{bytes}
@param port: An integer representing the port of the accepting user.
@type port: L{int}
@param resumePos: The position in the file from where the transfer
should resume.
@type resumePos: L{int}
Nr rV r r r rN rW zIRCClient.dccDoAcceptResumec C r rI r )rF r r rJ r r r r r rT r zIRCClient.dccDoChatc C | |t| dS )z
Send one or more C{extended messages} as a CTCP reply.
@type messages: a list of extended messages. An extended
message is a (tag, data) tuple, where 'data' may be L{None}.
N)r
ctcpStringifyrF r r r r r r zIRCClient.ctcpMakeReplyc C rX )z
Send one or more C{extended messages} as a CTCP query.
@type messages: a list of extended messages. An extended
message is a (tag, data) tuple, where 'data' may be L{None}.
N)rw rY rZ r r r r r[ zIRCClient.ctcpMakeQueryc C sP |D ]#}t | d|d d}|r||||d q| |||d |d qdS )z@
Dispatch method for any CTCP replies received.
z ctcpReply_%sr Nr! )rJ ctcpUnknownReply)rF r r r r rP r r r r s zIRCClient.ctcpReplyc C s^ | ddd }| jr||f| jvr td| d| | j||f }| |t | d S )Nr r! r zBogus PING response from r )r& r r ru r )rF r r r r t0r r r ctcpReply_PING s
zIRCClient.ctcpReply_PINGc C s" t d| d| d| d dS )a
Called when a fitting ctcpReply_ method is not found.
@param user: The hostmask of the user.
@type user: L{bytes}
@param channel: The name of the IRC channel.
@type channel: L{bytes}
@param tag: The CTCP request tag for which no fitting method is found.
@type tag: L{bytes}
@param data: The CTCP message.
@type data: L{bytes}
zUnknown CTCP reply from r r# r9 Nr r r r r r\ s "zIRCClient.ctcpUnknownReplyc C s( t | t dt||| dS )a
When I get a message that's so broken I can't use it.
@param line: The indecipherable message.
@type line: L{bytes}
@param excType: The exception type of the exception raised by the
message.
@type excType: L{type}
@param excValue: The exception parameter of excType or its associated
value(the second argument to C{raise}).
@type excValue: L{BaseException}
@param tb: The Traceback as a traceback object.
@type tb: L{traceback}
r N)r rw rt tracebackformat_exception)rF r4 excTypeexcValuetbr r r
badMessage
s
zIRCClient.badMessagec C s t |d dS )z
This is called when I receive a message which is peculiar, but not
wholly indecipherable.
@param s: The peculiar message.
@type s: L{bytes}
r9 Nr rF r* r r r r" "
s zIRCClient.quirkyMessagec C s( t | _g | _| jr| | j d S d S rI )r r rK performLoginr r rE r r r rf .
s
zIRCClient.connectionMadec C s2 t |tr
|d}|dd}tj| | d S )Nrh rF )rk r; rl r r rG r rF r r r r r 4
s
zIRCClient.dataReceivedc C s t tkrt|t r|d}t|}zt|\}}}|tv r"t| }| ||| W d S ty@ | j |gt
R Y d S w rg ) r r; rk r
lowDequoter/ numeric_to_symbolicr r rd sysexc_info)rF r4 r+ r. rX r r r lineReceived:
s
zIRCClient.lineReceivedc C s ddgS )z
Get user modes that require parameters for correct parsing.
@rtype: C{[str, str]}
@return: C{[add, remove]}
r r rE r r r r H
s zIRCClient.getUserModeParamsc C s ddg}| j di }d| |d< |d< | j d}|durL|d |dd7 < |d |dd7 < |d |d< |d |d d7 < |S )
z
Get channel modes that require parameters for correct parsing.
@rtype: C{[str, str]}
@return: C{[add, remove]}
r r r r! r Nr r^ r )r r rt keysr )rF rX prefixes chanmodesr r r r Q
s z IRCClient.getChannelModeParamsc C r r r r r r r r f
r zIRCClient.handleCommandc C s | j }d |d< d |d< |S )NrA r )__dict__copy)rF dctr r r __getstate__~
s
zIRCClient.__getstate__rI )NNN)r )r r )r r r r rc r r r r r r0 r# r( r) r* r- dcc_destdirrA rf rJ rK rL delimiter
__pychecker__r r r rV rY rI rp rM rP rU rT rQ r[ r] r_ rd re rf r rh rj rk r ro rp rq rs ru rv rx rz r| r} r r r r r r rt r r r r r r r r rw r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r
r r
r r r r r r r r& r+ r. r1 r9 r: r> rD rL rP rS rU rH rR rN rT r r r r^ r\ rd r" rf r rm r r r rt r r r r rA ` s* Q
"
%
!
"
rA c C st d| v r | S zt | } W n ty td| w | d? d@ | d? d@ | d? d@ | d@ f} dtt| } | S )Nr zIndecipherable address r )r< r> r rt r r; )rJ r r r rG
s
rG c @ s& e Zd ZdZdZdddZdd ZdS ) DccFileReceiveBasica[
Bare protocol to receive a Direct Client Connection SEND stream.
This does enough to keep the other guy talking, but you'll want to extend
my dataReceived method to *do* something with the data I get.
@ivar bytesReceived: An integer representing the number of bytes of data
received.
@type bytesReceived: L{int}
r c C s || _ |dk| _dS )z
@param resumeOffset: An integer representing the amount of bytes from
where the transfer of data should be resumed.
@type resumeOffset: L{int}
r N)
bytesReceivedresume)rF resumeOffsetr r r r
s z DccFileReceiveBasic.__init__c C s* | j t| | _ | jtd| j dS )z
See: L{protocol.Protocol.dataReceived}
Warning: This just acknowledges to the remote host that the data has
been received; it doesn't I{do} anything with the data, so you'll want
to override this.
z!iN)r| rT rm rn structpackrh r r r r
s z DccFileReceiveBasic.dataReceivedN)r )r r r r r| r r r r r r r{
s
r{ c @ sL e Zd ZdZdZdZdZdZdZdd Z dd Z
d d
Z d d Z d
d Z
dS )DccSendProtocola
Protocol for an outgoing Direct Client Connection SEND.
@ivar blocksize: An integer representing the size of an individual block of
data.
@type blocksize: L{int}
@ivar file: The file to be sent. This can be either a file object or
simply the name of the file.
@type file: L{file} or L{bytes}
@ivar bytesSent: An integer representing the number of bytes sent.
@type bytesSent: L{int}
@ivar completed: An integer representing whether the transfer has been
completed or not.
@type completed: L{int}
@ivar connected: An integer representing whether the connection has been
established or not.
@type connected: L{int}
i Nr c C s t |tu r
t|| _d S d S rI )typer; openr rF r r r r r
s zDccSendProtocol.__init__c C s d| _ | d S r ) connected sendBlockrE r r r rf
s z DccSendProtocol.connectionMadec C s> t d|}|| jk r
d S || jkr| j d S | d S )Nz!I)r unpack bytesSentrm loseConnectionr )rF r bytesShesGotr r r r
s
z DccSendProtocol.dataReceivedc C sF | j | j}|r| j| | jt| | _d S | j d| _d S r ) r read blocksizerm rn r rT r completed)rF blockr r r r
s
zDccSendProtocol.sendBlockc C s$ d| _ t| jdr| j d S d S )Nr close)r hasattrr r rR r r r rP
s z DccSendProtocol.connectionLost)r r r r r r r r r r rf r r rP r r r r r
s
r c @ s e Zd ZeZdd Zdd ZdS )DccSendFactoryc C s
|| _ d S rI )r r r r r r s
zDccSendFactory.__init__c C s | | j}| |_|S rI )r r factory)rF
connectionpr r r
buildProtocol
s z DccSendFactory.buildProtocolN)r r r r r r r r r r r r s r c
C s d}t | dr"| }z
t|}|tj }W |S ty! Y nw t | dr@t| j r@z t
| j }W |S ty? Y nw t | drqt | drqz z| dd | }W | dd W |S | dd w typ Y |S w |S )a3
I'll try my damndest to determine the size of this file object.
@param file: The file object to determine the size of.
@type file: L{io.IOBase}
@rtype: L{int} or L{None}
@return: The size of the file object as an integer if it can be determined,
otherwise return L{None}.
NfilenorK seektellr r )
r r osfstatstatST_SIZEr r existsrK getsizer r )r rK r stat_r r r fileSize s<
r c @ sN e Zd ZdZdZeded ZdZ dZ
dZ d ddZ dd Z
d d
ZdS ) DccChataH
Direct Client Connection protocol type CHAT.
DCC CHAT is really just your run o' the mill basic.LineReceiver
protocol. This class only varies from that slightly, accepting
either LF or CR LF for a line delimeter for incoming messages
while always using CR LF for outgoing.
The lineReceived method implemented here uses the DCC connection's
'client' attribute (provided upon construction) to deliver incoming
lines from the DCC chat via IRCClient's normal privmsg interface.
That's something of a spoof, which you may well want to override.
Nasciirg c C s$ || _ |r|| _| jd | _dS dS )aw
Initialize a new DCC CHAT session.
queryData is a 3-tuple of
(fromUser, targetUserOrChannel, data)
as received by the CTCP query.
(To be honest, fromUser is the only thing that's currently
used here. targetUserOrChannel is potentially useful, while
the 'data' argument is solely for informational purposes.)
r N)client queryData remotePartyrF r r r r r r R s
zDccChat.__init__c C sR | j | | _ | j t}| | _ |D ]}|d tkr!|d d }| | qd S )Nr% )r r& rj r) ri rm )rF r r r4 r r r r c s
zDccChat.dataReceivedc C s2 t d| j d| | j| j| jj| d S )Nz DCC CHAT )r rw r r r r rN r r r rm o s zDccChat.lineReceivedrI )r r r r r ri rl NLrv r r r r r rm r r r r r = s
r c @ s4 e Zd ZeZdZdd Zdd Zdd Zdd Z d
S ) DccChatFactoryFc C s || _ || _d S rI r r r r r r r x s
zDccChatFactory.__init__c C s | j | j| jd}| |_|S )Nr )r r r r )rF addrr r r r r | s z DccChatFactory.buildProtocolc C | j j| d S rI r rA removerF unused_connector
unused_reasonr r r clientConnectionFailed r z%DccChatFactory.clientConnectionFailedc C r rI r r r r r clientConnectionLost r z#DccChatFactory.clientConnectionLostN)
r r r r r noisyr r r r r r r r r t s r c
C s | }| } t| dk r|S | dd \}}}}d|v r n,zt|}W n ty, Y n w |d? d@ |d? d@ |d? d@ |d@ f}dtt|}|dkrx|}d }t| d
krnz
t| d }d |f }W n tym Y nw d ||||} | S |d
krd| d| } | S |} | S )z
Given the data chunk from a DCC query, return a descriptive string.
@param data: The data from a DCC query.
@type data: L{bytes}
@rtype: L{bytes}
@return: A descriptive string.
r Nr rx ry r rz SENDr z of size %d bytesz(SEND for file '{}'{} at host {}, port {}CHATzCHAT for host z, port )r& rT r< r> rt r r; rv )
r orig_datarB argrJ r rI size_txtrK dcc_textr r r dccDescribe sP
r c @ s e Zd ZU dZdZdZdZdZdZe e
e d< dZ ddd Z
d
d Zd d
Zdd Zdd Zdd Zdd ZdefddZdefddZdS ) DccFileReceivea
Higher-level coverage for getting a file from DCC SEND.
I allow you to change the file's name and destination directory. I won't
overwrite an existing file unless I've been told it's okay to do so. If
passed the resumeOffset keyword argument I will attempt to resume the file
from that amount of bytes.
XXX: I need to let the client know when I am finished.
XXX: I need to decide how to keep a progress indicator updated.
XXX: Client needs a way to tell me "Do not finish until I say so."
XXX: I need to make sure the client understands if the file cannot be written.
@ivar filename: The name of the file to get.
@type filename: L{bytes}
@ivar fileSize: The size of the file to get, which has a default value of
C{-1} if the size of the file was not specified in the DCC SEND
request.
@type fileSize: L{int}
@ivar destDir: The destination directory for the file to be received.
@type destDir: L{bytes}
@ivar overwrite: An integer representing whether an existing file should be
overwritten or not. This initially is an L{int} but can be modified to
be a L{bool} using the L{set_overwrite} method.
@type overwrite: L{int} or L{bool}
@ivar queryData: queryData is a 3-tuple of (user, channel, data).
@type queryData: L{tuple}
@ivar fromUser: This is the hostmask of the requesting user and is found at
index 0 of L{queryData}.
@type fromUser: L{bytes}
dccr% r r NfromUserc C sD t j| |d || _|| _|| _|| _|r || _| jd | _d S d S )N)r~ r )r{ r rI destDirr
_resumeOffsetr r )rF rI r r r r~ r r r r s zDccFileReceive.__init__c C s\ t |s ttjd|t |sttjd|t|tj tj
B s)ttj d||| _ dS )a
Set the directory where the downloaded file will be placed.
May raise OSError if the supplied directory path is not suitable.
@param directory: The directory where the file to be received will be
placed.
@type directory: L{bytes}
zYou see no directory there.z>You cannot put a file into something which is not a directory.z*This directory is too hard to write in to.N)
r r OSErrorerrnoENOENTisdirENOTDIRr accessX_OKW_OKEACCESr )rF directoryr r r
set_directory s
z DccFileReceive.set_directoryc C ry )z
Change the name of the file being transferred.
This replaces the file name provided by the sender.
@param filename: The new name for the file.
@type filename: L{bytes}
N)rI )rF rI r r r set_filename s
zDccFileReceive.set_filenamec C ry )z
May I overwrite existing files?
@param boolean: A boolean value representing whether existing files
should be overwritten or not.
@type boolean: L{bool}
N) overwrite)rF booleanr r r
set_overwrite s
z DccFileReceive.set_overwritec C s t t | j| j}t |}| jr6|r6t|d| _| j | j
| j t
d| j| j f d S | jrB|sBttjd|| jsG|sOt|d| _d S ttjd|)Nzrb+z0Attempting to resume %s - starting from %d bytesz8You cannot resume writing to a file that does not exist!wbzBThere's a file in the way. Perhaps that's why you cannot open it.)r abspathrt r rI r r} r r r r truncater rw r r r r r EEXIST)rF dstr r r r rf , s0
z DccFileReceive.connectionMadec C s | j | t| | d S rI )r rn r{ r rh r r r r H s zDccFileReceive.dataReceivedc C s d| _ | d}| jdkr4d|| j| jf }| j| jkr n | j| jk r.d|| j| j f }n
| d}nd|| jf }t| drW| d| jj d }t| jd
rY| j d S d S d S ) z
When the connection is lost, I close the file.
@param reason: The reason why the connection was lost.
@type reason: L{Failure}
r z closed.z%s %d/%d bytes receivedz %s (Warning: %d bytes short)z (file larger than expected)z%s %d bytes receivedr z and written to z.
r N)r r r| r r rK r )rF r logmsgr r r rP N s.
z DccFileReceive.connectionLostreturnc C sh | j s dt| ddS | j}|d usJ t| }| jd ur)| jd| d}d| j d| }|S )Nz&z (r zDCC transfer of 'z' from )r idrm r; getPeerr rI )rF rm from_r* r r r __str__p s
zDccFileReceive.__str__c C s& d| j dt| dd| j d}|S )N r r c @ s8 e Zd ZdZeejeZeej eZ
e e e
dZdS )_CharacterAttributesa
Factory for character attributes, including foreground and background color
and non-color attributes such as bold, reverse video and underline.
Character attributes are applied to actual text by using object
indexing-syntax (C{obj['abc']}) after accessing a factory attribute, for
example::
attributes.bold['Some text']
These can be nested to mix attributes::
attributes.bold[attributes.underline['Some text']]
And multiple values can be passed::
attributes.normal[attributes.bold['Some'], ' text']
Non-color attributes can be accessed by attribute name, available
attributes are:
- bold
- reverseVideo
- underline
Available colors are:
0. white
1. black
2. blue
3. green
4. light red
5. red
6. magenta
7. orange
8. yellow
9. light green
10. cyan
11. light cyan
12. light blue
13. light magenta
14. gray
15. light gray
@ivar fg: Foreground colors accessed by attribute name, see above
for possible names.
@ivar bg: Background colors accessed by attribute name, see above
for possible names.
@since: 13.1
)bold reverseVideo underlineN)r r r r r
_ColorAttribute_ForegroundColorAttr _IRC_COLORSfg_BackgroundColorAttrbg_BOLD_REVERSE_VIDEO
_UNDERLINEattrsr r r r r s 5r c @ s2 e Zd ZdZdZ d ddZdd ZdS )
_FormattingStatez
Formatting state/attributes of a single character.
Attributes include:
- Formatting nullifier
- Bold
- Underline
- Reverse video
- Foreground color
- Background color
@since: 13.1
offr r r
foreground
backgroundFNc C s( || _ || _|| _|| _|| _|| _d S rI r )rF r r r r r r r r r r s
z_FormattingState.__init__c C s g }| j r
|t | jr|t | jr|t | jdus$| jdurGd}| jdur3|d| jf 7 }| jdur@|d| jf 7 }|t | t
d t t
| S )z
Emit a mIRC control sequence that will set up all the attributes this
formatting state has set.
@return: A string containing mIRC control sequences that mimic this
formatting state.
Nr z%02dz,%02d)r r( r r r r r r r _COLOR_OFFrt r r; )rF r cr r r toMIRCControlCodes
s
z#_FormattingState.toMIRCControlCodes)FFFFNN)r r r r compareAttributesr r r r r r r s
r c s t fddt||S )aI
Apply a function of two arguments cumulatively to the items of
a sequence, from right to left, so as to reduce the sequence to
a single value.
@type f: C{callable} taking 2 arguments
@param z: Initial value.
@param xs: Sequence to reduce.
@return: Single value resulting from reducing C{xs}.
c s
|| S rI r )r yfr r r 6
s
z_foldr..)r reversed)r zxsr r r _foldr(
s r c
@ sd e Zd ZdZdZedededede diZ
dd Z d
d Z d d
Z
dd Zdd Zdd Zdd ZdS )_FormattingParsera
A finite-state machine that parses formatted IRC text.
Currently handled formatting includes: bold, reverse, underline,
mIRC color codes and the ability to remove all current formatting.
@see: U{http://www.mirc.co.uk/help/color.txt}
@type _formatCodes: C{dict} mapping C{str} to C{str}
@cvar _formatCodes: Mapping of format code values to names.
@type state: C{str}
@ivar state: Current state of the finite-state machine.
@type _buffer: C{str}
@ivar _buffer: Buffer, containing the text content, of the formatting
sequence currently being parsed, the buffer is used as the content for
L{_attrs} before being added to L{_result} and emptied upon calling
L{emit}.
@type _attrs: C{set}
@ivar _attrs: Set of the applicable formatting states (bold, underline,
etc.) for the current L{_buffer}, these are applied to L{_buffer} when
calling L{emit}.
@type foreground: L{_ForegroundColorAttr}
@ivar foreground: Current foreground color attribute, or L{None}.
@type background: L{_BackgroundColorAttr}
@ivar background: Current background color attribute, or L{None}.
@ivar _result: Current parse result.
stater r colorr r c C s* d| _ d| _t | _d | _d | _d | _d S )NTEXTr )r _bufferrr _attrs_resultr r rE r r r r f
s
z_FormattingParser.__init__c C s | | j| dS )zs
Handle input.
@type ch: C{str}
@param ch: A single character of input to process
N)rQ r )rF r] r r r processn
r z_FormattingParser.processc C s | | jdu r
tj| _| jS )z
Flush the current buffer and return the final parsed result.
@return: Structured text and attributes.
N)emitr
attributesr rE r r r completew
s
z_FormattingParser.completec C s | j rAdd | jD }|td| j| jg |s |tj || j t t
j | |}| j
du r7|| _
n| j
| d| _ dS dS )z?
Add the currently parsed input to the result.
c S s g | ]}t t|qS r )rJ r )r3 rK r r r r8
r z*_FormattingParser.emit..Nr )r r extendfilterr r r( r r r operatorgetitemr) r )rF r attrr r r r
s
z_FormattingParser.emitc C sz | j |}|dkr| d| _dS |du r | j|7 _dS | |dkr4t | _d | _| _dS | j |g dS )z
Handle the "text" state.
Along with regular text, single token formatting codes are handled
in this state too.
@param ch: The character being processed.
r COLOR_FOREGROUNDNr )
_formatCodesr r r r rr r r r symmetric_difference_update)rF r]
formatNamer r r
state_TEXT
s
z _FormattingParser.state_TEXTc C s | rt| jdk r| j|7 _dS | jr*t| jtt }ttjt| | _ nd | _ | _
|dkr?| jr?d| _d| _ dS d| _d| _ | |
| dS )aF
Handle the foreground color state.
Foreground colors can consist of up to two digits and may optionally
end in a I{,}. Any non-digit or non-comma characters are treated as
invalid input and result in the state being reset to "text".
@param ch: The character being processed.
r Nr
r COLOR_BACKGROUNDr )isdigitrT r r< r rJ r r _IRC_COLOR_NAMESr r r r r rF r] colr r r state_COLOR_FOREGROUND
s
z(_FormattingParser.state_COLOR_FOREGROUNDc C st | rt| jdk r| j|7 _dS | jr,t| jtt }ttjt| | _ d| _|
d| _ | | dS )ad
Handle the background color state.
Background colors can consist of up to two digits and must occur after
a foreground color and must be preceded by a I{,}. Any non-digit
character is treated as invalid input and results in the state being
set to "text".
@param ch: The character being processed.
r r r N)
r* rT r r< r rJ r r r+ r r r r r, r r r state_COLOR_BACKGROUND
s z(_FormattingParser.state_COLOR_BACKGROUNDN)r r r r r+ r r r r r r% r r r r r( r. r/ r r r r r 9
s " $r c C s" t }| D ]}|| q| S )a
Parse text containing IRC formatting codes into structured information.
Color codes are mapped from 0 to 15 and wrap around if greater than 15.
@type text: C{str}
@param text: Formatted text to parse.
@return: Structured text and attributes.
@since: 13.1
)r r r )r r r] r r r parseFormattedText
s
r0 c C s t | t dS )aE
Assemble formatted text from structured information.
Currently handled formatting includes: bold, reverse, underline,
mIRC color codes and the ability to remove all current formatting.
It is worth noting that assembled text will always begin with the control
code to disable other attributes for the sake of correctness.
For example::
from twisted.words.protocols.irc import attributes as A
assembleFormattedText(
A.normal[A.bold['Time: '], A.fg.lightRed['Now!']])
Would produce "Time: " in bold formatting, followed by "Now!" with a
foreground color of light red and without any additional formatting.
Available attributes are:
- bold
- reverseVideo
- underline
Available colors are:
0. white
1. black
2. blue
3. green
4. light red
5. red
6. magenta
7. orange
8. yellow
9. light green
10. cyan
11. light cyan
12. light blue
13. light magenta
14. gray
15. light gray
@see: U{http://www.mirc.co.uk/help/color.txt}
@param formatted: Structured text and attributes.
@rtype: C{str}
@return: String containing mIRC control sequences that mimic those
specified by I{formatted}.
@since: 13.1
r )r
flattenr ) formattedr r r assembleFormattedText
s 4r3 c C s t | }t|t S )z
Remove all formatting codes from C{text}, leaving only the text.
@type text: C{str}
@param text: Formatted text to parse.
@rtype: C{str}
@return: Plain text without any control sequences.
@since: 13.1
)r0 r
r1 DefaultFormattingState)r r2 r r r stripFormatting5 s r5 r! c
C s g }g }||d}| t}d}|r*|r ||d n||d | }|sttd||dd< ttd||dd< ttt||dd< tt |D ]!}|| t
d}|d }t |dkrj|d } nd} || f||< qQ|S )z
Extract CTCP data from a string.
@return: A C{dict} containing two keys:
- C{'extended'}: A list of CTCP (tag, data) tuples.
- C{'normal'}: A list of strings which were not inside a CTCP delimiter.
)r r r Nr! ) r& r r( r) ru r r ctcpDequoter rT SPC)
r extended_messagesnormal_messagesretvalr oddr r r r r r r r J s,
r 0r rr% r c C s& t tttfD ]
}| |t| } q| S rI )M_QUOTENULr ri r mQuoteTabler* r
r r r r s r c C t fdd}t|| S )Nc S 4 | d }z|| }W |S ty |}Y |S w r groupKeyError)matchobj
mDequoteTabler* r r r sub
zlowDequote..sub)rH
mEscape_rerI r* rI r r r ri ri r r c C s" t tfD ]
}| |t| } q| S rI )X_QUOTEr r xQuoteTablerA r r r ctcpQuote s rP c C rB )Nc S rC r rD )rG
xDequoteTabler* r r r rI rJ zctcpDequote..sub)rQ
xEscape_rerI rL r r r r6 rM r6 c C s g }| D ]<\}}|r+t |ts#z
dtt|}W n ty" Y nw | d| }nt|}t|}t | t }|| qd|}|S )z
@type messages: a list of extended messages. An extended
message is a (tag, data) tuple, where 'data' may be L{None}, a
string, or a list of strings to be joined with whitespace.
@returns: String
r# r )rk r; rt r r= rP r r( )r coded_messagesr r r r4 r r r rY s
rY 001002003004005010302303301305306311312313317318319314369321322323325324331332341342346347348349351352315353366364365367368371374375372376381382383391392393394395200201202203204205206207208209210261262211212219242243221234235251252253254255256257258259263401402403404405406407408409411412413414415416421422423424431432433436437441442443444445446451461462463464465466467471472473474475476477478481482483484485491492501502 RPL_WELCOME RPL_YOURHOST RPL_CREATED
RPL_MYINFO RPL_ISUPPORT
RPL_BOUNCE RPL_USERHOSTRPL_ISONRPL_AWAY
RPL_UNAWAY RPL_NOWAWAYr r r r r r RPL_WHOWASUSERRPL_ENDOFWHOWAS
RPL_LISTSTARTRPL_LIST RPL_LISTEND RPL_UNIQOPISr r r RPL_INVITING
RPL_SUMMONINGRPL_INVITELISTRPL_ENDOFINVITELISTRPL_EXCEPTLISTRPL_ENDOFEXCEPTLIST RPL_VERSIONr r r r RPL_LINKSRPL_ENDOFLINKS RPL_BANLISTRPL_ENDOFBANLISTRPL_INFO
RPL_ENDOFINFO
RPL_MOTDSTARTRPL_MOTD
RPL_ENDOFMOTD
RPL_YOUREOPER
RPL_REHASHINGRPL_YOURESERVICERPL_TIMERPL_USERSSTART RPL_USERSRPL_ENDOFUSERS RPL_NOUSERS
RPL_TRACELINKRPL_TRACECONNECTINGRPL_TRACEHANDSHAKERPL_TRACEUNKNOWNRPL_TRACEOPERATOR
RPL_TRACEUSERRPL_TRACESERVERRPL_TRACESERVICERPL_TRACENEWTYPERPL_TRACECLASSRPL_TRACERECONNECT RPL_TRACELOG RPL_TRACEENDRPL_STATSLINKINFORPL_STATSCOMMANDSRPL_ENDOFSTATSRPL_STATSUPTIMERPL_STATSOLINE RPL_UMODEIS RPL_SERVLISTRPL_SERVLISTENDRPL_LUSERCLIENT RPL_LUSEROPRPL_LUSERUNKNOWNRPL_LUSERCHANNELS RPL_LUSERME RPL_ADMINME
RPL_ADMINLOC1
RPL_ADMINLOC2RPL_ADMINEMAIL RPL_TRYAGAINERR_NOSUCHNICKERR_NOSUCHSERVERERR_NOSUCHCHANNELERR_CANNOTSENDTOCHANERR_TOOMANYCHANNELSERR_WASNOSUCHNICKERR_TOOMANYTARGETSERR_NOSUCHSERVICE ERR_NOORIGINERR_NORECIPIENTERR_NOTEXTTOSENDERR_NOTOPLEVELERR_WILDTOPLEVEL ERR_BADMASKERR_TOOMANYMATCHESERR_UNKNOWNCOMMAND
ERR_NOMOTDERR_NOADMININFO
ERR_FILEERRORERR_NONICKNAMEGIVENERR_ERRONEUSNICKNAMEERR_NICKNAMEINUSEERR_NICKCOLLISIONERR_UNAVAILRESOURCEERR_USERNOTINCHANNELERR_NOTONCHANNELERR_USERONCHANNEL ERR_NOLOGINERR_SUMMONDISABLEDERR_USERSDISABLEDERR_NOTREGISTEREDERR_NEEDMOREPARAMSERR_ALREADYREGISTREDERR_NOPERMFORHOSTERR_PASSWDMISMATCHERR_YOUREBANNEDCREEPERR_YOUWILLBEBANNED
ERR_KEYSETERR_CHANNELISFULLERR_UNKNOWNMODEERR_INVITEONLYCHANERR_BANNEDFROMCHANERR_BADCHANNELKEYERR_BADCHANMASKERR_NOCHANMODESERR_BANLISTFULLERR_NOPRIVILEGESERR_CHANOPRIVSNEEDEDERR_CANTKILLSERVERERR_RESTRICTEDERR_UNIQOPPRIVSNEEDED)ERR_NOOPERHOSTERR_NOSERVICEHOSTERR_UMODEUNKNOWNFLAGERR_USERSDONTMATCH)r0 rI )rS )r r r! r r rerF rd r r r rk r1 r r_ functoolsr r typingr twisted.internetr r r twisted.persistedr twisted.protocolsr twisted.pythonr
r r r r? ri r rj r7 r r Exceptionr r r> r r/ r& rA RuntimeErrorrB rC r_ Protocolr` r rG rA rG Ephemeralr{ r Factoryr r r
ClientFactoryr r r r r r r r r r r r r r+ CharacterAttributesMixinr r _FormattingStateMixinr r r r0 r3 r5 r r r> r@ rH r r compileescapeDOTALLrK r ri rN rO rQ rR rP r6 rY r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r r
r r r
r r r r r r r r r r r r r r r r r r r r! r" r# r$ r% r& r' r( r) r* r+ r, r- r. r/ r0 r1 r2 r3 r4 r5 r6 r7 r8 r9 r: r; r< r= r> r? r@ rA rB rC rD rE rF rG rH rI rJ rK rL rM rN rO rP rQ rR rS rT rU rV rW rX rY rZ r[ r\ r] r^ symbolic_to_numericrj r r r r sZ (: " H 1#I -7; ?@A 37*
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~