Tc @sDdZddlZddlZddlZddlZddlZddlZddlZddlZej ddfkrddl Z ndddfZ dZ defd YZd fd YZejd Zd fdYZdefdYZdefdYZejdZdefdYZdefdYZdefdYZdfdYZdfdYZdZdZd Zid!d"6d#d$6d%d&6ee6Zejed'Z d(Z!d)Z"ej#ej$e"Z%ej&ej'd*ej(d+Z)d,Z*d-Z+d.Z,d/Z-d0Z.d1Z/d2Z0d3Z1d4Z2d5Z3d6Z4d7d8Z5d9Z6id:d;6d<d=6d>d?6d@dA6dBdC6dDdE6dFdG6dHdI6dJdK6dLdM6dNdO6dPdQ6dRdS6dTdU6dVdW6dXdY6dZd[6d\d]6d^d_6d`da6dbdc6ddde6dfdg6dhdi6djdk6dldm6dndo6dpdq6drds6dtdu6dvdw6dxdy6dzd{6d|d}6d~d6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd6dd 6d d 6d d 6dd6dd6dd6dd6dd6dd6dd6dd6dd6d d!6d"d#6d$d%6d&d'6d(d)6d*d+6d,d-6d.d/6d0d16d2d36d4d56d6d76d8d96d:d;6d<d=6d>d?6d@dA6dBdC6dDdE6dFdG6dHdI6dJdK6dLdM6dNdO6dPdQ6dRdS6dTdU6dVdW6dXdY6dZd[6d\d]6d^d_6d`da6dbdc6ddde6dfdg6dhdi6djdk6dldm6dndo6dpdq6drds6dtdu6Z7dvdwdxdydzd{gZ8d|d}d~ddddddddddg Z9e8e9e7j:Z;dS(s!irclib -- Internet Relay Chat (IRC) protocol client library. This library is intended to encapsulate the IRC protocol at a quite low level. It provides an event-driven IRC client framework. It has a fairly thorough support for the basic IRC protocol, CTCP, DCC chat, but DCC file transfers is not yet supported. In order to understand how to make an IRC client, I'm afraid you more or less must understand the IRC specifications. They are available here: [IRC specifications]. The main features of the IRC client framework are: * Abstraction of the IRC protocol. * Handles multiple simultaneous IRC server connections. * Handles server PONGing transparently. * Messages to the IRC server are done by calling methods on an IRC connection object. * Messages from an IRC server triggers events, which can be caught by event handlers. * Reading from and writing to IRC server sockets are normally done by an internal select() loop, but the select()ing may be done by an external main loop. * Functions can be registered to execute at specified times by the event-loop. * Decodes CTCP tagging correctly (hopefully); I haven't seen any other IRC client implementation that handles the CTCP specification subtilties. * A kind of simple, single-server, object-oriented IRC client class that dispatches events to instance methods is included. Current limitations: * The IRC protocol shines through the abstraction a bit too much. * Data is not written asynchronously to the server, i.e. the write() may block if the TCP buffers are stuffed. * There are no support for DCC file transfers. * The author haven't even read RFC 2810, 2811, 2812 and 2813. * Like most projects, documentation is lacking... .. [IRC specifications] http://www.irchelp.org/irchelp/rfc/ iNiiiiitIRCErrorcBseZdZRS(sRepresents an IRC exception.(t__name__t __module__t__doc__(((s!/home/thedrx/pywhatauto/irclib.pyR]stIRCcBseZdZddddZdZdZdZddZddZ d d Z dd Z d Z dd Z ddZddZdZdZRS(s6Class that handles one or several IRC server connections. When an IRC object has been instantiated, it can be used to create Connection objects that represent the IRC connections. The responsibility of the IRC object is to provide an event-driven framework for the connections and to keep the connections alive. It runs a select loop to poll each connection's TCP socket and hands over the sockets with incoming data for processing by the corresponding connection. The methods of most interest for an IRC client writer are server, add_global_handler, remove_global_handler, execute_at, execute_delayed, process_once and process_forever. Here is an example: irc = irclib.IRC() server = irc.server() server.connect("irc.some.where", 6667, "my_nickname") server.privmsg("a_nickname", "Hi there!") irc.process_forever() This will connect to the IRC server irc.some.where on port 6667 using the nickname my_nickname and send the message "Hi there!" to the nickname a_nickname. cCsn|r!|r!||_||_nd|_d|_||_g|_i|_g|_|jdtddS(sEConstructor for IRC objects. Optional arguments are fn_to_add_socket, fn_to_remove_socket and fn_to_add_timeout. The first two specify functions that will be called with a socket object as argument when the IRC object wants to be notified (or stop being notified) of data coming on a new socket. When new data arrives, the method process_data should be called. Similarly, fn_to_add_timeout is called with a number of seconds (a floating point number) as first argument when the IRC object wants to receive a notification (by calling the process_timeout method). So, if e.g. the argument is 42.17, the object wants the process_timeout method to be called after 42 seconds and 170 milliseconds. The three arguments mainly exist to be able to use an external main loop (for example Tkinter's or PyGTK's main app loop) instead of calling the process_forever method. An alternative is to just call ServerConnection.process_once() once in a while. tpingiN( tfn_to_add_sockettfn_to_remove_sockettNonetfn_to_add_timeoutt connectionsthandlerstdelayed_commandstadd_global_handlert _ping_ponger(tselfRRR ((s!/home/thedrx/pywhatauto/irclib.pyt__init__~s         cCs t|}|jj||S(s.Creates and returns a ServerConnection object.(tServerConnectionR tappend(Rtc((s!/home/thedrx/pywhatauto/irclib.pytservers cCsHxA|D]9}x0|jD]%}||jkr|jqqWqWdS(sCalled when there is more data to read on connection sockets. Arguments: sockets -- A list of socket objects. See documentation for IRC.__init__. N(R t _get_sockett process_data(RtsocketstsR((s!/home/thedrx/pywhatauto/irclib.pyRs cCsetj}xR|jr`||jddkr\|jdd|jdd|jd=qPqWdS(s`Called when a timeout notification is due. See documentation for IRC.__init__. iiiN(ttimeR (Rtt((s!/home/thedrx/pywhatauto/irclib.pytprocess_timeouts     icCsttd|j}td|}|rYtj|gg|d}|j|n tj||jdS(scProcess data from connections once. Arguments: timeout -- How long the select() call should wait if no data is available. This method should be called periodically to check and process incoming data, if there are any. If that seems boring, look at the process_forever method. cSs |jS(N(R(tx((s!/home/thedrx/pywhatauto/irclib.pytscSs |dkS(N(R(R((s!/home/thedrx/pywhatauto/irclib.pyRsiN(tmapR tfiltertselectRRtsleepR(RttimeoutRti((s!/home/thedrx/pywhatauto/irclib.pyt process_onces  g?cCsx|j|qdS(sRun an infinite loop, processing data from connections. This method repeatedly calls process_once. Arguments: timeout -- Parameter to pass to process_once. N(R$(RR"((s!/home/thedrx/pywhatauto/irclib.pytprocess_forevers tcCs%x|jD]}|j|q WdS(sDisconnects all connections.N(R t disconnect(RtmessageR((s!/home/thedrx/pywhatauto/irclib.pytdisconnect_allscCs@||jkrg|j|[^ ]+) +)?(?P[^ ]+)( *(?P .+))?t ConnectioncBs8eZdZdZdZddZddZRS(s=Base class for IRC connections. Must be overridden. cCs ||_dS(N(t irclibobj(RRC((s!/home/thedrx/pywhatauto/irclib.pyRWscCs tddS(NsNot overridden(R(R((s!/home/thedrx/pywhatauto/irclib.pyRZscCs|jj|||dS(N(RCR6(RR3R4R5((s!/home/thedrx/pywhatauto/irclib.pyR6`scCs|jj|||dS(N(RCR2(RR7R4R5((s!/home/thedrx/pywhatauto/irclib.pyR2cs(((RRRRRR6R2(((s!/home/thedrx/pywhatauto/irclib.pyRBRs    tServerConnectionErrorcBseZRS((RR(((s!/home/thedrx/pywhatauto/irclib.pyRDgstServerNotConnectedErrorcBseZRS((RR(((s!/home/thedrx/pywhatauto/irclib.pyREjss ? RcBsKeZdZdZd7d7d7ddeedZdZdZdZ dZ d Z d Z d Z d Zd ZdZddZddZdZddZdZddZdZdZddZddZdddZd7ddZddZdZddZd7dZ dZ!d Z"d!Z#dd"Z$d#Z%dd$Z&dd%Z'd&Z(d'Z)dd(Z*d)Z+dd*Z,dd+Z-dd,Z.d7d-Z/dd.Z0d/Z1d0Z2dd1Z3dd2Z4d3Z5ddd4Z6d5Z7ddd6Z8RS(8sThis class represents an IRC server connection. ServerConnection objects are instantiated by calling the server method on an IRC object. cCs/tj||d|_d|_d|_dS(Ni(RBRt connectedRtsockettssl(RRC((s!/home/thedrx/pywhatauto/irclib.pyRys  R&ic Cs |jr|jdnd|_i|_d|_||_||_||_||_|pa||_ |pp||_ ||_ ||_ ||_ tj|_| rtjtjtj|_ntjtjtj|_y|jj|j |j f|jj|j|jf| r_tjdkrGtj|j|_q_tj|j|_nWn9tjk r} |jjd|_td| nXd|_|jj r|jj |jn|j r|j!|j n|j"|j|j#|j |j |S( sConnect/reconnect to a server. Arguments: server -- Server name. port -- Port number. nickname -- The nickname. password -- Password (if any). username -- The username. ircname -- The IRC name ("realname"). localaddress -- Bind the connection to a specific local IP address. localport -- Bind the connection to a specific local port. ssl -- Enable support for ssl. ipv6 -- Enable support for ipv6. This function can be called to reconnect a closed connection. Returns the ServerConnection object. sChanging serversR&iisCouldn't connect to socket: %si(iiN($RFR'tprevious_bufferR treal_server_namet real_nicknameRtporttnicknametusernametircnametpasswordt localaddresst localportRGt gethostnamet localhosttAF_INET6t SOCK_STREAMtAF_INETtbindtconnecttsyst version_infotSSLt wrap_socketRHterrortcloseRRDRCRtpass_tnicktuser( RRRLRMRPRNRORQRRRHtipv6R((s!/home/thedrx/pywhatauto/irclib.pyRYsJ                cCs!|jd|jj|dS(sClose the connection. This method closes the connection permanently; after it has been called, the object is unusable. sClosing objectN(R'RCRA(R((s!/home/thedrx/pywhatauto/irclib.pyR_s cCs|jS(s [Internal](RG(R((s!/home/thedrx/pywhatauto/irclib.pyRscCs|jr|jSdSdS(sGet the (real) server name. This method returns the (real) server name, or, more specifically, what the server calls itself. R&N(RJ(R((s!/home/thedrx/pywhatauto/irclib.pytget_server_names cCs|jS(sGet the (real) nick name. This method returns the (real) nickname. The library keeps track of nick changes, so it might not be the nick name that was passed to the connect() method. (RK(R((s!/home/thedrx/pywhatauto/irclib.pyt get_nicknamesc Cs\y4|jr!|jjd}n|jjd}Wn"tjk rX|jddSX|sp|jddStj|j|}|j |_x|D]}t rdG|GHn|sqnd}d}d}|j t d|jd|gtj|}|jdr<|jd}|js<||_q<n|jdrc|jdj}n|jd r|jd jd d }|d j}t|dkr|j|d qn|tkrt|}n|d krt||jkr/|d |_q/n|dkr/|d |_n|dkr|d |d } } t| } |dkrt| rd}qnt| rd}nd}x| D]}t|tjkr`|d krd}nd}t|}t rd||| |fGHn|j t ||| ||dkr|d dkr|j t d|| |d qqt rd||| |gfGHn|j t ||| |gqWqd} |dkr|d g}n-|dkr|d } n|d } |d }|dkrt| sd}qnt r8d||| |fGHn|j t ||| |qWdS(!s [Internal]iisConnection reset by peerNs FROM SERVER:tall_raw_messagestprefixtcommandtarguments :iiRatwelcometprivmsgtnoticetpubmsgt pubnoticet privnoticetctcpt ctcpreplys2command: %s, source: %s, target: %s, arguments: %stACTIONtactiontquitRtmodetumodei@i@(sprivmsgsnotice(sprivmsgspubmsg(RHtreadRGtrecvR^R't_linesep_regexptsplitRItpoptDEBUGRR@tEventRdt_rfc_1459_command_regexptmatchtgroupRJtlowertlenRtnumeric_eventstnm_to_nRKt _ctcp_dequotet is_channelttypettypest TupleTypetlist( Rtnew_datatlinestlineRgRhR5tmtattargetR(tmessages((s!/home/thedrx/pywhatauto/irclib.pyRs                        &&        cCsZ|jj|||j|jkrVx+|j|jD]}|||q<WndS(s [Internal]N(RCR@R>R (RR,tfn((s!/home/thedrx/pywhatauto/irclib.pyR@_scCs|jS(sWReturn connection status. Returns true if connected, otherwise false. (RF(R((s!/home/thedrx/pywhatauto/irclib.pyt is_connectedfscGs|jj|dS(sSAdd global handler. See documentation for IRC.add_global_handler. N(RCR (Rtargs((s!/home/thedrx/pywhatauto/irclib.pyR mscGs|jj|dS(sYRemove global handler. See documentation for IRC.remove_global_handler. N(RCR1(RR((s!/home/thedrx/pywhatauto/irclib.pyR1tscCs|jd||dS(sSend a CTCP ACTION command.RrN(Rp(RRRs((s!/home/thedrx/pywhatauto/irclib.pyRs{scCs&|jdjd|gjdS(sSend an ADMIN command.t tADMINN(tsend_rawtjointstrip(RR((s!/home/thedrx/pywhatauto/irclib.pytadminscCs:|j}|j|d||r+d|p.dfdS(sSend a CTCP command.s%s%sRR&N(tupperRk(RtctcptypeRt parameter((s!/home/thedrx/pywhatauto/irclib.pyRps cCs|j|d|dS(sSend a CTCP REPLY command.s%sN(Rl(RRR((s!/home/thedrx/pywhatauto/irclib.pyt ctcp_replyscCsz|js dSd|_|j|y|jjWntjk rJnXd|_|jtd|jd|gdS(sZHang up the connection. Arguments: message -- Quit message. NiR'R&( RFRtRGR_R^RR@R}R(RR(((s!/home/thedrx/pywhatauto/irclib.pyR's    cCs|jd|dS(sSend a GLOBOPS command.s GLOBOPS :N(R(Rttext((s!/home/thedrx/pywhatauto/irclib.pytglobopsscCs&|jdjd|gjdS(sSend an INFO command.RtINFON(RRR(RR((s!/home/thedrx/pywhatauto/irclib.pytinfoscCs)|jdjd||gjdS(sSend an INVITE command.RtINVITEN(RRR(RRatchannel((s!/home/thedrx/pywhatauto/irclib.pytinvitescCs|jddj|dS(sWSend an ISON command. Arguments: nicks -- List of nicks. sISON RN(RR(Rtnicks((s!/home/thedrx/pywhatauto/irclib.pytisonscCs%|jd||od|fdS(sSend a JOIN command.s JOIN %s%sRN(R(RRtkey((s!/home/thedrx/pywhatauto/irclib.pyRscCs(|jd|||od|fdS(sSend a KICK command.s KICK %s %s%ss :N(R(RRRatcomment((s!/home/thedrx/pywhatauto/irclib.pytkickscCsEd}|r|d|}n|r4|d|}n|j|dS(sSend a LINKS command.tLINKSRN(R(Rt remote_servert server_maskRh((s!/home/thedrx/pywhatauto/irclib.pytlinkss cCsNd}|r&|ddj|}n|r=|d|}n|j|dS(sSend a LIST command.tLISTRt,N(RR(RtchannelsRRh((s!/home/thedrx/pywhatauto/irclib.pyRs cCs|jd|od|dS(sSend a LUSERS command.tLUSERSRN(R(RR((s!/home/thedrx/pywhatauto/irclib.pytlusersscCs|jd||fdS(sSend a MODE command.s MODE %s %sN(R(RRRh((s!/home/thedrx/pywhatauto/irclib.pyRuscCs|jd|od|dS(sSend an MOTD command.tMOTDRN(R(RR((s!/home/thedrx/pywhatauto/irclib.pytmotdscCs.|jd|r"ddj|p%ddS(sSend a NAMES command.tNAMESRRR&N(RR(RR((s!/home/thedrx/pywhatauto/irclib.pytnamesscCs|jd|dS(sSend a NICK command.sNICK N(R(Rtnewnick((s!/home/thedrx/pywhatauto/irclib.pyRascCs|jd||fdS(sSend a NOTICE command.s NOTICE %s :%sN(R(RRR((s!/home/thedrx/pywhatauto/irclib.pyRlscCs|jd||fdS(sSend an OPER command.s OPER %s %sN(R(RRaRP((s!/home/thedrx/pywhatauto/irclib.pytoperscCsct|tjkr7|jd||o/d|n(|jddj||oZd|dS(sSend a PART command.sPART RRN(RRt StringTypeRR(RRR(((s!/home/thedrx/pywhatauto/irclib.pytparts"cCs|jd|dS(sSend a PASS command.sPASS N(R(RRP((s!/home/thedrx/pywhatauto/irclib.pyR`scCs%|jd||od|fdS(sSend a PING command.s PING %s%sRN(R(RRttarget2((s!/home/thedrx/pywhatauto/irclib.pyRscCs%|jd||od|fdS(sSend a PONG command.s PONG %s%sRN(R(RRR((s!/home/thedrx/pywhatauto/irclib.pytpongscCs|jd||fdS(sSend a PRIVMSG command.sPRIVMSG %s :%sN(R(RRR((s!/home/thedrx/pywhatauto/irclib.pyRkscCs$|jddj||fdS(s+Send a PRIVMSG command to multiple targets.sPRIVMSG %s :%sRN(RR(RttargetsR((s!/home/thedrx/pywhatauto/irclib.pyt privmsg_manyscCs|jd|od|dS(sSend a QUIT command.tQUITs :N(R(RR(((s!/home/thedrx/pywhatauto/irclib.pyRt scCs|jdkrtdnyJ|jr>|jj|dn|jj|dtrddG|GHnWn!tjk r|jdnXdS(sbSend raw string to the server. The string will be padded with appropriate CR LF. sNot connected.s s TO SERVER:sConnection reset by peer.N( RGRRERHtwritetsendR|R^R'(Rtstring((s!/home/thedrx/pywhatauto/irclib.pyRs  cCs%|jd||od|fdS(sSend an SQUIT command.s SQUIT %s%ss :N(R(RRR((s!/home/thedrx/pywhatauto/irclib.pytsquit"scCs%|jd||od|fdS(sSend a STATS command.s STATS %s%sRN(R(Rt statstypeR((s!/home/thedrx/pywhatauto/irclib.pytstats&scCs|jd|od|dS(sSend a TIME command.tTIMERN(R(RR((s!/home/thedrx/pywhatauto/irclib.pyR*scCs;|dkr |jd|n|jd||fdS(sSend a TOPIC command.sTOPIC s TOPIC %s :%sN(RR(RRt new_topic((s!/home/thedrx/pywhatauto/irclib.pyttopic.s cCs|jd|od|dS(sSend a TRACE command.tTRACERN(R(RR((s!/home/thedrx/pywhatauto/irclib.pyttrace5scCs|jd||fdS(sSend a USER command.sUSER %s 0 * :%sN(R(RRNtrealname((s!/home/thedrx/pywhatauto/irclib.pyRb9scCs|jddj|dS(sSend a USERHOST command.s USERHOST RN(RR(RR((s!/home/thedrx/pywhatauto/irclib.pytuserhost=scCs|jd|od|dS(sSend a USERS command.tUSERSRN(R(RR((s!/home/thedrx/pywhatauto/irclib.pytusersAscCs|jd|od|dS(sSend a VERSION command.tVERSIONRN(R(RR((s!/home/thedrx/pywhatauto/irclib.pytversionEscCs|jd|dS(sSend a WALLOPS command.s WALLOPS :N(R(RR((s!/home/thedrx/pywhatauto/irclib.pytwallopsIscCs+|jd|od||odfdS(sSend a WHO command.sWHO%s%sRs oN(R(RRtop((s!/home/thedrx/pywhatauto/irclib.pytwhoMscCs|jddj|dS(sSend a WHOIS command.sWHOIS RN(RR(RR((s!/home/thedrx/pywhatauto/irclib.pytwhoisQscCs2|jd||od||o&d|fdS(sSend a WHOWAS command.s WHOWAS %s%s%sRN(R(RRatmaxR((s!/home/thedrx/pywhatauto/irclib.pytwhowasUs  N(9RRRRRtFalseRYR_RRdReRR@RR R1RsRRpRR'RRRRRRRRRRuRRRaRlRRR`RRRkRRtRRRRRRRbRRRRRRR(((s!/home/thedrx/pywhatauto/irclib.pyRrsl H  t                                         tDCCConnectionErrorcBseZRS((RR(((s!/home/thedrx/pywhatauto/irclib.pyR[sR9cBsPeZdZdZdZdZddZdZdZdZ RS( sThis class represents a DCC connection. DCCConnection objects are instantiated by calling the dcc method on an IRC object. cCsAtj||d|_d|_||_d|_d|_dS(Ni(RBRRFtpassiveR:Rt peeraddresstpeerport(RRCR:((s!/home/thedrx/pywhatauto/irclib.pyRes     cCstj||_||_d|_d|_i|_tjtjtj|_d|_ y |jj |j|jfWn#tj k r}t d|nXd|_ |jjr|jj|jn|S(sConnect/reconnect to a DCC peer. Arguments: address -- Host/IP address of the peer. port -- The port number to connect to. Returns the DCCConnection object. R&isCouldn't connect to socket: %siN(RGt gethostbynameRRRRIR RWRVRRYR^RRFRCR(RtaddressRLR((s!/home/thedrx/pywhatauto/irclib.pyRYms         cCsd|_i|_tjtjtj|_d|_yT|jjtjtjdf|jj \|_ |_ |jj dWn#tj k r}td|nX|S(sKWait for a connection/reconnection from a DCC peer. Returns the DCCConnection object. The local IP address and port are available as self.localaddress and self.localport. After connection from a peer, the peer address and port are available as self.peeraddress and self.peerport. R&iii sCouldn't bind socket: %s(RIR RGRWRVRRXRRSt getsocknameRQRRtlistenR^R(RR((s!/home/thedrx/pywhatauto/irclib.pyRs   %R&cCs|js dSd|_y|jjWntjk r=nXd|_|jj|td|jd|g|jj |dS(soHang up the connection and close the object. Arguments: message -- Quit message. Nitdcc_disconnectR&( RFRGR_R^RRCR@R}RRA(RR(((s!/home/thedrx/pywhatauto/irclib.pyR's    c Cs|jr|j r|jj\}\|_|_|jj||_d|_trqd|j|jfGHn|jj |t d|jdddSy|jj d }Wn"tj k r|jddSX|s|jddS|jdkrNtj|j|}|d |_t|jdkrA|jdS|d }n |g}d }|j}d}xi|D]a}trd G|GHn|g}trd ||||fGHn|jj |t ||||qsWdS(s [Internal]isDCC connection from %s:%dt dcc_connectNiisConnection reset by peerR8itdccmsgs FROM PEER:s2command: %s, source: %s, target: %s, arguments: %si@i@(RRFRGtacceptRRR_R|RCR@R}RRxR^R'R:RyRzRIR( RtconnRtchunksRhRgRtchunkR5((s!/home/thedrx/pywhatauto/irclib.pyRsR!               cCs|jS(s [Internal](RG(R((s!/home/thedrx/pywhatauto/irclib.pyRscCspyH|jj||jdkr5|jjdntrGd|GHnWn!tjk rk|jdnXdS(szSend data to DCC peer. The string will be padded with appropriate LF if it's a DCC CHAT session. R8s s TO PEER: %s sConnection reset by peer.N(RGRR:R|R^R'(RR((s!/home/thedrx/pywhatauto/irclib.pyRks( RRRRRYRR'RRRk(((s!/home/thedrx/pywhatauto/irclib.pyR9_s     8 tSimpleIRCClientcBsheZdZdZdZdZd d d ddeedZddZ dd Z d Z RS( sA simple single-server IRC client class. This is an example of an object-oriented wrapper of the IRC framework. A real IRC client can be made by subclassing this class and adding appropriate methods. The method on_join will be called when a "join" event is created (which is done when the server sends a JOIN messsage/command), on_privmsg will be called for "privmsg" events, and so on. The handler methods get two arguments: the connection object (same as self.connection) and the event object. Instance attributes that can be used by sub classes: ircobj -- The IRC instance. connection -- The ServerConnection instance. dcc_connections -- A list of DCCConnection instances. cCs]t|_|jj|_g|_|jjd|jd|jjd|jddS(NR<iR(RtircobjRR?tdcc_connectionsR t _dispatchert_dcc_disconnect(R((s!/home/thedrx/pywhatauto/irclib.pyRs   cCs<d|j}t||r8t||||ndS(s [Internal]ton_N(R>thasattrtgetattr(RRteR((s!/home/thedrx/pywhatauto/irclib.pyRscCs|jj|dS(N(RR/(RRR((s!/home/thedrx/pywhatauto/irclib.pyR sR&ic Cs/|jj||||||||| | dS(s[Connect/reconnect to a server. Arguments: server -- Server name. port -- Port number. nickname -- The nickname. password -- Password (if any). username -- The username. ircname -- The IRC name. localaddress -- Bind the connection to a specific local IP address. localport -- Bind the connection to a specific local port. ssl -- Enable support for ssl. ipv6 -- Enable support for ipv6. This function can be called to reconnect a closed connection. N(R?RY( RRRLRMRPRNRORQRRRHRc((s!/home/thedrx/pywhatauto/irclib.pyRY#s R8cCs6|jj|}|jj||j|||S(sConnect to a DCC peer. Arguments: address -- IP address of the peer. port -- Port to connect to. Returns a DCCConnection instance. (RR;RRRY(RRRLR:R;((s!/home/thedrx/pywhatauto/irclib.pyRCs cCs0|jj|}|jj||j|S(s[Listen for connections from a DCC peer. Returns a DCCConnection instance. (RR;RRR(RR:R;((s!/home/thedrx/pywhatauto/irclib.pyt dcc_listenSs cCs|jjdS(sStart the IRC client.N(RR%(R((s!/home/thedrx/pywhatauto/irclib.pytstart]sN( RRRRRRRRRYRRR(((s!/home/thedrx/pywhatauto/irclib.pyRs     R}cBs>eZdZddZdZdZdZdZRS(s Class representing an IRC event.cCs:||_||_||_|r-||_n g|_dS(s?Constructor of Event objects. Arguments: eventtype -- A string describing the event. source -- The originator of the event (a nick mask or a server). target -- The target of the event (a nick or a channel). arguments -- Any event specific arguments. N(t _eventtypet_sourcet_targett _arguments(RR>tsourceRR5((s!/home/thedrx/pywhatauto/irclib.pyRds    cCs|jS(sGet the event type.(R(R((s!/home/thedrx/pywhatauto/irclib.pyR>yscCs|jS(sGet the event source.(R(R((s!/home/thedrx/pywhatauto/irclib.pyR}scCs|jS(sGet the event target.(R(R((s!/home/thedrx/pywhatauto/irclib.pyRscCs|jS(sGet the event arguments.(R(R((s!/home/thedrx/pywhatauto/irclib.pyR5sN( RRRRRR>RRR5(((s!/home/thedrx/pywhatauto/irclib.pyR}bs     ss\stt0s tns trs(.)cCst|}t|}|jdd}x$dD]}|j|d|}q1W|jdd}|jdd}tj|tj}|j|S(s\Check if a nick matches a mask. Returns true if the nick matches, otherwise false. s\s\\s .$|[](){}+t?t.t*s.*(t irc_lowertreplacetretcompilet IGNORECASER(RatmasktchR((s!/home/thedrx/pywhatauto/irclib.pyt mask_matchess   s-[]\`^{}s[]\^s{}|~cCs |jtS(stReturns a lowercased string. The definition of lowercased comes from the IRC specification (RFC 1459). (t translatet_ircstring_translation(R((s!/home/thedrx/pywhatauto/irclib.pyRscCsd}t|kr*tj||}nt|kr=|gS|jt}g}d}x|t|dkrt||dkr|j||n|t|dkr|jt||djddn|d}q[Wt|ddkr|jt|dn|SdS(s[Internal] Dequote a message according to CTCP specifications. The function returns a list where each element can be either a string (normal message) or a tuple of one or two strings (tagged messages). If a tuple has only one element (ie is a singleton), that element is the tag; otherwise the tuple has two elements: the tag and the data. Arguments: message -- The message to be decoded. cSs|jd}tj||S(Ni(Rt_low_level_mappingR=(t match_objR((s!/home/thedrx/pywhatauto/irclib.pyt_low_level_replacesiiiRiN(t_LOW_LEVEL_QUOTEt_low_level_regexptsubt_CTCP_DELIMITERRzRRttuple(R(R RRR#((s!/home/thedrx/pywhatauto/irclib.pyRs"   *cCs|o|ddkS(soCheck if a string is a channel name. Returns true if the argument is a channel name, otherwise false. is#&+!((R((s!/home/thedrx/pywhatauto/irclib.pyRsc CsYt|}tttt|d?d@|d?d@|d?d@|d@g}dj|S(sConvert an IP number as an integer given in ASCII representation (e.g. '3232235521') to an IP address string (e.g. '192.168.0.1').iiiiR(tlongRtstrtintR(tnumRtp((s!/home/thedrx/pywhatauto/irclib.pytip_numstr_to_quads "cCsmtt|jd}t|dd>|dd>B|dd>B|dB}|d d kri|d }n|S( sConvert an IP address string (e.g. '192.168.0.1') to an IP number as an integer given in ASCII representation (e.g. '3232235521').RiiiiiiiitL(RRRzR(tquadRR((s!/home/thedrx/pywhatauto/irclib.pytip_quad_to_numstrs 4 cCs|jddS(sRGet the nick part of a nickmask. (The source of an Event is a nickmask.) t!i(Rz(R((s!/home/thedrx/pywhatauto/irclib.pyRscCs|jddS(sVGet the userhost part of a nickmask. (The source of an Event is a nickmask.) Ri(Rz(R((s!/home/thedrx/pywhatauto/irclib.pytnm_to_uh scCs|jddS(sRGet the host part of a nickmask. (The source of an Event is a nickmask.) t@i(Rz(R((s!/home/thedrx/pywhatauto/irclib.pytnm_to_hscCs$|jdd}|jddS(sRGet the user part of a nickmask. (The source of an Event is a nickmask.) RiRi(Rz(R((s!/home/thedrx/pywhatauto/irclib.pytnm_to_uscCs t|dS(s'Parse a nick mode string. The function returns a list of lists with three members: sign, mode and argument. The sign is "+" or "-". The argument is always None. Example: >>> irclib.parse_nick_modes("+ab-c") [['+', 'a', None], ['+', 'b', None], ['-', 'c', None]] R&(t _parse_modes(t mode_string((s!/home/thedrx/pywhatauto/irclib.pytparse_nick_modess cCs t|dS(sZParse a channel mode string. The function returns a list of lists with three members: sign, mode and argument. The sign is "+" or "-". The argument is None if mode isn't one of "b", "k", "l", "v" or "o". Example: >>> irclib.parse_channel_modes("+ab-c foo") [['+', 'a', None], ['+', 'b', 'foo'], ['-', 'c', None]] tbklvo(R(R ((s!/home/thedrx/pywhatauto/irclib.pytparse_channel_modes.s R&c Csg}d}d}|j}t|dkr4gS|d|d}}|ddkr]gSx|D]}|dkr|}qd|dkrqd||krt||dkr|j||||g|d}q|j||dgqd|j||dgqdW|S(s [Internal]iR&is+-RN(RzRRR( R t unary_modestmodest arg_counttsignRt mode_partRR((s!/home/thedrx/pywhatauto/irclib.pyR=s*       cCs|j|jdS(s [Internal]N(RR(R?R,((s!/home/thedrx/pywhatauto/irclib.pyR]sRjt001tyourhostt002tcreatedt003tmyinfot004t featurelistt005t tracelinkt200ttraceconnectingt201ttracehandshaket202t traceunknownt203t traceoperatort204t traceusert205t traceservert206t traceservicet207t tracenewtypet208t traceclasst209ttracereconnectt210t statslinkinfot211t statscommandst212t statsclinet213t statsnlinet214t statsilinet215t statsklinet216t statsqlinet217t statsylinet218t endofstatst219tumodeist221t serviceinfot231t endofservicest232tservicet233tservlistt234t servlistendt235t statsllinet241t statsuptimet242t statsolinet243t statshlinet244t luserconnst250t luserclientt251tluseropt252t luserunknownt253t luserchannelst254tlusermet255tadminmet256t adminloc1t257t adminloc2t258t adminemailt259ttracelogt261t endoftracet262ttryagaint263tn_localt265tn_globalt266tnonet300tawayt301Rt302Rt303tunawayt305tnowawayt306t whoisusert311t whoisservert312t whoisoperatort313t whowasusert314tendofwhot315t whoischanopt316t whoisidlet317t endofwhoist318t whoischannelst319t liststartt321Rt322tlistendt323t channelmodeist324t channelcreatet329tnotopict331t currenttopict332t topicinfot333tinvitingt341t summoningt342t invitelistt346tendofinvitelistt347t exceptlistt348tendofexceptlistt349Rt351twhoreplyt352tnamreplyt353tkilldonet361tclosingt362tcloseendt363Rt364t endoflinkst365t endofnamest366tbanlistt367t endofbanlistt368t endofwhowast369Rt371Rt372t infostartt373t endofinfot374t motdstartt375t endofmotdt376tmotd2t377t youreopert381t rehashingt382tmyportist384Rt391t usersstartt392Rt393t endofuserst394tnouserst395t nosuchnickt401t nosuchservert402t nosuchchannelt403tcannotsendtochant404ttoomanychannelst405t wasnosuchnickt406ttoomanytargetst407tnoorigint409t norecipientt411t notexttosendt412t notoplevelt413t wildtoplevelt414tunknowncommandt421tnomotdt422t noadmininfot423t fileerrort424tnonicknamegivent431terroneusnicknamet432t nicknameinuset433t nickcollisiont436tunavailresourcet437tusernotinchannelt441t notonchannelt442t useronchannelt443tnologint444tsummondisabledt445t usersdisabledt446t notregisteredt451tneedmoreparamst461talreadyregisteredt462t nopermforhostt463tpasswdmismatcht464tyourebannedcreept465tyouwillbebannedt466tkeysett467t channelisfullt471t unknownmodet472tinviteonlychant473tbannedfromchant474t badchannelkeyt475t badchanmaskt476t nochanmodest477t banlistfullt478t noprivilegest481tchanoprivsneededt482tcantkillservert483t restrictedt484tuniqopprivsneededt485t nooperhostt491t noservicehostt492tumodeunknownflagt501tusersdontmatcht502RRRR'RpRqR^RRRuRRRkRoRmRnRtRR(<RR*RR RGRRZRRR[RHR\RR|t ExceptionRRRR~RBRDRERyRRR9RR}R t_CTCP_LEVEL_QUOTERR R Rt_specialt ascii_letterstdigitstnick_characterst maketranstascii_uppercasetascii_lowercaseRRRRRRRRRRR!R#RRRtgenerated_eventstprotocol_eventstvaluesR<(((s!/home/thedrx/pywhatauto/irclib.pyt>s        d'    6