commit 5c347d82f796e79adfccf5cf90846cc068e66b46 Author: Jeff Balogh Date: Tue Feb 24 16:39:35 2009 -0800 python-irclib from http://sourceforge.net/projects/python-irclib/ diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..cf9b6b9 --- /dev/null +++ b/COPYING @@ -0,0 +1,510 @@ + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations +below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. +^L + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it +becomes a de-facto standard. To achieve this, non-free programs must +be allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. +^L + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control +compilation and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. +^L + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. +^L + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at least + three years, to give the same user the materials specified in + Subsection 6a, above, for a charge no more than the cost of + performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. +^L + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. +^L + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply, and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License +may add an explicit geographical distribution limitation excluding those +countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. +^L + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS +^L + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms +of the ordinary General Public License). + + To apply these terms, attach the following notices to the library. +It is safest to attach them to the start of each source file to most +effectively convey the exclusion of warranty; and each file should +have at least the "copyright" line and a pointer to where the full +notice is found. + + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or +your school, if any, to sign a "copyright disclaimer" for the library, +if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James + Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! + + diff --git a/ChangeLog b/ChangeLog new file mode 100644 index 0000000..ba3675c --- /dev/null +++ b/ChangeLog @@ -0,0 +1,432 @@ +2008-09-11 Keltus + * ircbot.py: Reverted a leftover testing fragment that broke ircbot.py + +2008-08-29 Keltus + * irclib.py: Reverted changes in irclib that don't really belong in the core lib + * irclib.py: Add support for ssl + * irclib.py: Add support for ipv6 + * python-irclib now requires python 2.3 and above (for ssl and ipv6) + +2006-03-09 Keltus + * README: Minor update + +2005-12-24 Keltus + * Released version 0.4.6. + + * irclib.py (VERSION): + * python-irclib.spec.in: + Preparations for version 0.4.6. + +2005-12-23 Keltus + * dccsend: + * dccreceive: + * irclib.py: + * ircbot.py: + * irccat: + * irccat2: + * servermap: + * testbot.py: + Code modernization - String methods used instead of deprecated + string functions, keyword 'in' used for membership testing instead + of 'has_key' method, etc. + +2005-12-06 Keltus + * irclib.py (ServerConnection.process_data): Reversed fix from + 2005-05-28. This is strange because there was a bug before and + now it's gone. Either python changed something, or the IRC + networks changed something. Confirmed by peter. + +2005-11-03 Keltus + * irclib.py (numeric_events): Renamed numeric code 332 from topic + to currenttopic (the message when "/topic " is sent), so it + doesn't collide with TOPIC (the message when the topic is set). + +2005-08-27 Keltus + * irclib.py (ServerConnection.disconnect): Fixed infinitely + recursive calls when disconnecting with a failed connection. Bug + reported by Erik Max Francis. + +2005-08-18 Keltus + * irclib.py: Made ServerConnection.disconnect more consistant and + changed some functions to use it instead of quit. Previously, + disconnect would ignore the quit message, but now it sends a quit + message and disconnect. Suggestion by Erik Max Francis. + * ircbot.py: Changed to use ServerConnection.disconnect instead of + ServerConnection.quit as well. + +2005-05-28 Keltus + * irclib.py (ServerConnection.process_data): Fixed quit arguments + to return a list rather than a list of a list. Patch from peter. + +2005-05-18 Keltus + * Released version 0.4.5. + + * irclib.py (ServerConnection.__init__): Added self.socket = None + to be able to process events when ServerConnection is not + connected to a socket. Patch from alst. + + * irclib.py (VERSION): + * python-irclib.spec.in: + Preparations for version 0.4.5. + +2005-04-26 Keltus + * irclib.py (IRC.__doc__): Corrected server.process_forever() to + irc.process_forever(). Suggestion by olecom. + +2005-04-17 Keltus + * irclib.py (ServerConnection.process_data): Moved event + translation code. + * irclib.py (ServerConnection): Reverted the 2005-01-28 change + because it breaks jump_server(). + * irclib.py: minor comment changes + +2005-04-03 Keltus + * irclib.py (protocol_events): Added "pong" and "invite" events. + Patch from Adam Mikuta. + * irclib.py (ServerConnection.part): Added message parameter. + Patch from Adam Mikuta. + +2005-02-23 Keltus + * Released version 0.4.4. + + * irclib.py (VERSION): + * python-irclib.spec.in: + Preparations for version 0.4.4. + +2005-01-28 Keltus + * irclib.py: (ServerConnection): Moved + self.irclibobj._remove_connection call from close() to + disconnect(). Patch from Alexey Nezhdanov. + +2005-01-25 Keltus + * irclib.py (ServerConnection.connect): closes socket if a + connection does not occur + * irclib.py (ServerConnection.connect): "Changing server" -> + "Changing servers" (more ubiquitous quit phrase) + +2005-01-23 Keltus + + * irclib.py: Removed depreciated apply functions. python-irclib is + now compatible with Python 1.6 and above. + * testbot.py: Removed redundant extra start() call + +2005-01-20 Joel Rosdahl + + * Released version 0.4.3. + * Makefile: Removed more GNU make specific constructs. + +2005-01-19 Joel Rosdahl + + * Makefile: Don't require GNU make. + +2005-01-19 Keltus + + * ircbot.py (IRCDict.__iter__): Added __iter__ method for IRCDict. + +2005-01-17 Joel Rosdahl + + * ircbot.py (IRCDict.__contains__): Added __contains__method for + IRCDict. Patch from Keltus. + (SingleServerIRCBot.on_ctcp): Corrected default decoding of CTCP + DCC CHAT. Patch from Keltus. + + * irclib.py (VERSION): + * python-irclib.spec.in: + Preparations for version 0.4.3. + + * debian: Removed Debian package directory since python-irclib is + in Debian now. + + * ircbot.py (SingleServerIRCBot._on_namreply): Improved comment + about arguments to the function. Patch from Keltus. + (Channel.has_allow_external_messages): Renamed from + has_message_from_outside_protection. Patch from Keltus. + + * irclib.py (ServerConnection.quit): Added comment about how some + IRC servers' treat QUIT messages. Patch from Keltus. + + * ircbot.py (SingleServerIRCBot.jump_server): Improved jump_server + behaviour. Patch from Keltus. + +2004-08-04 Joel Rosdahl + + * irclib.py (ServerConnection.process_data): Added "bonus" action + event that is triggered on CTCP ACTION messages. + +2004-07-09 Joel Rosdahl + + * Released version 0.4.2. + + * debian/rules: Remove built *.pyc files before making package. + + * irclib.py (DEBUG): + * debian/changelog: + * python-irclib.spec.in: + Preparations for version 0.4.2. + + * irclib.py (ServerNotConnectedError): New exception. + (ServerConnection.send_raw): Fix bug #922446, "Raise + IllegalStateException in send_raw when disconnected". + +2003-10-30 Joel Rosdahl + + * Released version 0.4.1. + + * debian/examples: Added dccreceive and dccsend as example files + in Debian. + + * python-irclib.spec.in: Likewise. + +2003-10-29 Joel Rosdahl + + * debian: Added Debian packaging files. + + * setup.py.in: Create setup.py from setup.py.in. + + * python-irclib.spec.in: RPM spec file from Gary Benson. + + * testbot.py (TestBot.on_nicknameinuse): New method. + + * irclib.py (ServerConnection.process_data): Record nickname when + welcome message is sent to trap nickname change triggered in a + nicknameinuse callback. + + * ircbot.py (SingleServerIRCBot._on_join): Use + Connection.get_nickname instead of relying on self._nickname. + (SingleServerIRCBot._on_kick): Likewise. + (SingleServerIRCBot._on_part): And here too. + (SingleServerIRCBot._on_nick): No need to remember nickname change + here. + +2003-08-31 Joel Rosdahl + + * Released version 0.4.0. + + Implemented DCC support (based on patches from Adam Langley and + Marco Bettio): + + * irclib.py (IRC.dcc): New method. + (DCCConnectionError): New class. + (DCCConnection): New class. + (SimpleIRCClient.__init__): Added dcc_connections attribute. + (SimpleIRCClient._dcc_disconnect): New method. + (SimpleIRCClient.connect): Added localaddress and + localport parameters. The socket will be bound accordingly before + connecting. + (SimpleIRCClient.dcc_connect): New method. + (SimpleIRCClient.dcc_listen): New method. + (ip_numstr_to_quad): New function. + (ip_quad_to_numstr): New function. + + * ircbot.py (SingleServerIRCBot.on_ctcp): Relay DCC CHAT CTCPs to + the on_dccchat method. + + * testbot.py: Added support for accepting DCC chats and for + initiating DCC chats via a "dcc" command. + + * dccreceive: New example program. + + * dccsend: New example program. + + * Makefile: Added dccreceive and dccsend to dist files. + + Other changes: + + * setup.py: Added. + + * irclib.py (ServerConnection.connect, ServerConnection.user): + Send USER command according to RFC 2812. + (ServerConnection.connect): Added localaddress and + localport parameters. The socket will be bound accordingly before + connecting. + (ServerConnection.process_data): Ignore empty lines from the + server. (Patch by Jason Wies.) + (ServerConnection._get_socket): Simplified. + (ServerConnection.remove_global_handler): Added. (Patch from + Brandon Beck.) + + * ircbot.py (SingleServerIRCBot.on_ctcp): Prepend VERSION reply + with VERSION. (Patch from Andrew Gaul.) + + * Makefile: Added setup.py to dist files. Also create zip archive. + + * README: Added requirements and installation sections. + +2002-03-01 Joel Rosdahl + + * Released version 0.3.4. + + Corrected problems spotted by Markku Hänninen : + + * irccat2 (IRCCat.on_welcome): Added missing connection argument. + (IRCCat.on_join): Likewise. + (IRCCat.on_disconnect): Likewise. + + * irclib.py (ServerConnection.ison): Bug fix: Join nicks by space + instead of commas. + + * irclib.py (ServerConnection.whowas): Bug fix: Let the max + argument default to the empty string. + + * irclib.py (numeric_events): Added new events: traceservice, + tracereconnect, tryagain, invitelist, endofinvitelist, exceptlist, + endofexceptlist, unavailresource, nochanmodes, banlistfull, + restricted and uniqopprivsneeded. + +2002-02-17 Joel Rosdahl + + * Released version 0.3.3. + + * Makefile, README, .cvsignore: Removed documentation generated by + pythondoc. Use pydoc instead. + + * servermap: Removed some excess whitespace. + + * README: Mention http://python-irclib.sourceforge.net. + + * Makefile (dist): Changed archive name from irclib-* to + python-irclib-*. + + Changed license from GPL 2 to LGPL 2.1: + + * COPYING: New license text. + + * irclib.py, ircbot.py, servermap: New license header. + +2001-10-21 Joel Rosdahl + + * Released version 0.3.2. + + * irclib.py (_parse_modes): Fixed problem found by Tom Morton: the + mode parsing code bailed out if a unary mode character didn't have + a corresponding argument. + + * irclib.py (_alpha): Fixed bug found by Tom Morton: w was missing + in the alphabet used by irc_lower(). + + * ircbot.py: Removed redundant import of is_channel. + + * servermap: Clarified copyright and license. + + * irccat: Ditto. + + * irccat2: Ditto. + +2000-12-11 Joel Rosdahl + + * Released version 0.3.1. + + * irclib.py (IRC.process_once): Work-around for platform-dependent + select() on Windows systems. + + * ircbot.py: Clarification of SingleServerIRCBot doc string. + +2000-11-26 Joel Rosdahl + + * Released version 0.3.0. + + * Makefile (dist): Include ircbot.py again. + + * README: Updated. + + * irclib.py (ServerConnection.get_nickname): Renamed from + get_nick_name. + (ServerConnection._get_socket): Return None if not connected. + +2000-11-25 Joel Rosdahl + + * irclib.py (ServerConnection.process_data): all_raw_messages + instead of allrawmessages. + (IRC._handle_event): Added "all_events" event type. + (nm_to_n): Renamed from nick_from_nickmask. + (nm_to_uh): Renamed from userhost_from_nickmask. + (nm_to_h): Renamed from host_from_nickmask. + (nm_to_u): Renamed from user_from_nickmask. + (SimpleIRCClient): Created. + +2000-11-22 Joel Rosdahl + + * irclib.py (lower_irc_string): Use translation instead. + (ServerConnection.process_data): Split non-RFC-compliant lines a + bit more intelligently. + (ServerConnection.process_data): Removed unnecessary try/except + block. + (ServerConnection.get_server_name): Return empty server if + unknown. + (_rfc_1459_command_regexp): Tweaked a bit. + + * ircbot.py: Rewritten. + +2000-11-21 Joel Rosdahl + + * irclib.py (IRC.process_forever): Default to processing a bit + more often. + +2000-10-29 Joel Rosdahl + + * Released version 0.2.4. + + * Makefile (dist): Include generated documentation in + distribution. + + * Makefile (doc): Make documentation. + + * irclib.py: Updated documentation. + + * irclib.py (is_channel): Included "!" as channel prefix. + +2000-10-02 Joel Rosdahl + + * Released version 0.2.3. + + * irclib.py (ServerConnection.connect): Make socket.connect() work + for Python >= 1.6. + +2000-09-26 Joel Rosdahl + + * Released version 0.2.2. + + * irclib.py (ServerConnection.user): Fixed erroneous format + string. + +2000-09-24 Joel Rosdahl + + * Released version 0.2.1. + + * irclib.py (ServerConnection.process_data): Bug fix (didn't keep + track of nick name). + (IRC.process_once): New method. + (ServerConnection.process_data): Bug fix. + (IRC.disconnect_all): Created. + (IRC.exit): Removed. + (ServerConnection.exit): Removed. + (ServerConnection.connect): Follow RFC closer. + (ServerConnection.user): Follow RFC closer. + + * ircbot.py: Removed. + + * irccat (on_disconnect): Just sys.exit(0). + + * servermap (on_disconnect): Just sys.exit(0). + + * irclib.py: Various documentation and some clean-ups. + +1999-08-21 Joel Rosdahl + + * Released version 0.2.0. + + * servermap: Updated to work with irclib 0.2.0. + + * irccat: Updated to work with irclib 0.2.0. + + * ircbot.py: Updated to work with irclib 0.2.0. The bot now + checks every minute that it is connected. If it's not, it + reconnects. + + * irclib.py: Changes in how to create a ServerConnection object. + Made the code for handling disconnection hopefully more robust. + Renamed connect() to sconnect(). + +1999-06-19 Joel Rosdahl + + * irclib.py: Released 0.1.0. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..0409ec3 --- /dev/null +++ b/Makefile @@ -0,0 +1,42 @@ +VERSION := `sed -n -e '/VERSION = /{s/VERSION = \(.*\), \(.*\), \(.*\)/\1.\2.\3/;p;}' setup.py + +python-irclib.spec: python-irclib.spec.in + sed 's/%%VERSION%%/'$(VERSION)'/g' python-irclib.spec.in >python-irclib.spec + +dist: $(DISTFILES) + mkdir $(PACKAGENAME) + cp -r $(DISTFILES) $(PACKAGENAME) + tar cvzf $(PACKAGENAME).tar.gz $(PACKAGENAME) + zip -r9yq $(PACKAGENAME).zip $(PACKAGENAME) + rm -rf $(PACKAGENAME) + +cvstag: + ver=$(VERSION); echo cvs tag version_`echo $$ver | sed 's/\./_/g'` + +clean: + rm -rf *~ *.pyc build python-irclib.spec setup.py + +.PHONY: all doc dist cvstag clean diff --git a/README b/README new file mode 100644 index 0000000..7fecc66 --- /dev/null +++ b/README @@ -0,0 +1,110 @@ +irclib -- Internet Relay Chat (IRC) protocol client library +----------------------------------------------------------- + +The home of irclib.py is now: + + http://python-irclib.sourceforge.net + +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 and DCC +connections. + +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: + + http://www.irchelp.org/irchelp/rfc/ + +Requirements: + + * Python 2.2 or newer. + +Installation: + + * Run "python setup.py install" or copy irclib.py and/or ircbot.py + to an appropriate Python module directory. + +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. + * DCC connection support. + +Current limitations: + + * The IRC protocol shines through the abstraction a bit too much. + * Data is not written asynchronously to the server (and DCC peers), + i.e. the write() may block if the TCP buffers are stuffed. + * Like most projects, documentation is lacking... + +Unfortunately, this library isn't as well-documented as I would like +it to be. I think the best way to get started is to read and +understand the example program irccat, which is included in the +distribution. + +The following files might be of interest: + + * irclib.py + + The library itself. Read the code along with comments and + docstrings to get a grip of what it does. Use it at your own risk + and read the source, Luke! + + * irccat + + A simple example of how to use irclib.py. irccat reads text from + stdin and writes it to a specified user or channel on an IRC + server. + + * irccat2 + + The same as above, but using the SimpleIRCClient class. + + * servermap + + Another simple example. servermap connects to an IRC server, + finds out what other IRC servers there are in the net and prints + a tree-like map of their interconnections. + + * testbot.py + + An example bot that uses the SingleServerIRCBot class from + ircbot.py. The bot enters a channel and listens for commands in + private messages or channel traffic. It also accepts DCC + invitations and echos back sent DCC chat messages. + + * dccreceive + + Receives a file over DCC. + + * dccsend + + Sends a file over DCC. + + +NOTE: If you're running one of the examples on a unix command line, you need to escape the # symbol in the channel. For example, use \#test instead of #test. + + +Enjoy. + +Maintainer: +keltus + +Original Author: +Joel Rosdahl diff --git a/dccreceive b/dccreceive new file mode 100755 index 0000000..5383dbb --- /dev/null +++ b/dccreceive @@ -0,0 +1,77 @@ +#! /usr/bin/env python +# +# Example program using irclib.py. +# +# This program is free without restrictions; do anything you like with +# it. +# +# Joel Rosdahl + +import irclib +import os +import struct +import sys + +class DCCReceive(irclib.SimpleIRCClient): + def __init__(self): + irclib.SimpleIRCClient.__init__(self) + self.received_bytes = 0 + + def on_ctcp(self, connection, event): + args = event.arguments()[1].split() + if args[0] != "SEND": + return + self.filename = os.path.basename(args[1]) + if os.path.exists(self.filename): + print "A file named", self.filename, + print "already exists. Refusing to save it." + self.connection.quit() + self.file = open(self.filename, "w") + peeraddress = irclib.ip_numstr_to_quad(args[2]) + peerport = int(args[3]) + self.dcc = self.dcc_connect(peeraddress, peerport, "raw") + + def on_dccmsg(self, connection, event): + data = event.arguments()[0] + self.file.write(data) + self.received_bytes = self.received_bytes + len(data) + self.dcc.privmsg(struct.pack("!I", self.received_bytes)) + + def on_dcc_disconnect(self, connection, event): + self.file.close() + print "Received file %s (%d bytes)." % (self.filename, + self.received_bytes) + self.connection.quit() + + def on_disconnect(self, connection, event): + sys.exit(0) + +def main(): + if len(sys.argv) != 3: + print "Usage: dccreceive " + print "\nReceives one file via DCC and then exits. The file is stored in the" + print "current directory." + sys.exit(1) + + s = sys.argv[1].split(":", 1) + server = s[0] + if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) + else: + port = 6667 + nickname = sys.argv[2] + + c = DCCReceive() + try: + c.connect(server, port, nickname) + except irclib.ServerConnectionError, x: + print x + sys.exit(1) + c.start() + +if __name__ == "__main__": + main() diff --git a/dccsend b/dccsend new file mode 100755 index 0000000..9debec1 --- /dev/null +++ b/dccsend @@ -0,0 +1,91 @@ +#! /usr/bin/env python +# +# Example program using irclib.py. +# +# This program is free without restrictions; do anything you like with +# it. +# +# Joel Rosdahl + +import irclib +import os +import struct +import sys + +class DCCSend(irclib.SimpleIRCClient): + def __init__(self, receiver, filename): + irclib.SimpleIRCClient.__init__(self) + self.receiver = receiver + self.filename = filename + self.filesize = os.path.getsize(self.filename) + self.file = open(filename) + self.sent_bytes = 0 + + def on_welcome(self, connection, event): + self.dcc = self.dcc_listen("raw") + self.connection.ctcp("DCC", self.receiver, "SEND %s %s %d %d" % ( + os.path.basename(self.filename), + irclib.ip_quad_to_numstr(self.dcc.localaddress), + self.dcc.localport, + self.filesize)) + + def on_dcc_connect(self, connection, event): + if self.filesize == 0: + self.dcc.disconnect() + return + self.send_chunk() + + def on_dcc_disconnect(self, connection, event): + print "Sent file %s (%d bytes)." % (self.filename, self.filesize) + self.connection.quit() + + def on_dccmsg(self, connection, event): + acked = struct.unpack("!I", event.arguments()[0])[0] + if acked == self.filesize: + self.dcc.disconnect() + self.connection.quit() + elif acked == self.sent_bytes: + self.send_chunk() + + def on_disconnect(self, connection, event): + sys.exit(0) + + def on_nosuchnick(self, connection, event): + print "No such nickname:", event.arguments()[0] + self.connection.quit() + + def send_chunk(self): + data = self.file.read(1024) + self.dcc.privmsg(data) + self.sent_bytes = self.sent_bytes + len(data) + +def main(): + if len(sys.argv) != 5: + print "Usage: dccsend " + print "\nSends to via DCC and then exits." + sys.exit(1) + + s = sys.argv[1].split(":", 1) + server = s[0] + if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) + else: + port = 6667 + nickname = sys.argv[2] + receiver = sys.argv[3] + filename = sys.argv[4] + + c = DCCSend(receiver, filename) + try: + c.connect(server, port, nickname) + except irclib.ServerConnectionError, x: + print x + sys.exit(1) + c.start() + +if __name__ == "__main__": + main() diff --git a/ircbot.py b/ircbot.py new file mode 100644 index 0000000..6f29a65 --- /dev/null +++ b/ircbot.py @@ -0,0 +1,438 @@ +# Copyright (C) 1999--2002 Joel Rosdahl +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# Joel Rosdahl +# +# $Id: ircbot.py,v 1.23 2008/09/11 07:38:30 keltus Exp $ + +"""ircbot -- Simple IRC bot library. + +This module contains a single-server IRC bot class that can be used to +write simpler bots. +""" + +import sys +from UserDict import UserDict + +from irclib import SimpleIRCClient +from irclib import nm_to_n, irc_lower, all_events +from irclib import parse_channel_modes, is_channel +from irclib import ServerConnectionError + +class SingleServerIRCBot(SimpleIRCClient): + """A single-server IRC bot class. + + The bot tries to reconnect if it is disconnected. + + The bot keeps track of the channels it has joined, the other + clients that are present in the channels and which of those that + have operator or voice modes. The "database" is kept in the + self.channels attribute, which is an IRCDict of Channels. + """ + def __init__(self, server_list, nickname, realname, reconnection_interval=60): + """Constructor for SingleServerIRCBot objects. + + Arguments: + + server_list -- A list of tuples (server, port) that + defines which servers the bot should try to + connect to. + + nickname -- The bot's nickname. + + realname -- The bot's realname. + + reconnection_interval -- How long the bot should wait + before trying to reconnect. + + dcc_connections -- A list of initiated/accepted DCC + connections. + """ + + SimpleIRCClient.__init__(self) + self.channels = IRCDict() + self.server_list = server_list + if not reconnection_interval or reconnection_interval < 0: + reconnection_interval = 2**31 + self.reconnection_interval = reconnection_interval + + self._nickname = nickname + self._realname = realname + for i in ["disconnect", "join", "kick", "mode", + "namreply", "nick", "part", "quit"]: + self.connection.add_global_handler(i, + getattr(self, "_on_" + i), + -10) + def _connected_checker(self): + """[Internal]""" + if not self.connection.is_connected(): + self.connection.execute_delayed(self.reconnection_interval, + self._connected_checker) + self.jump_server() + + def _connect(self): + """[Internal]""" + password = None + if len(self.server_list[0]) > 2: + password = self.server_list[0][2] + try: + self.connect(self.server_list[0][0], + self.server_list[0][1], + self._nickname, + password, + ircname=self._realname) + except ServerConnectionError: + pass + + def _on_disconnect(self, c, e): + """[Internal]""" + self.channels = IRCDict() + self.connection.execute_delayed(self.reconnection_interval, + self._connected_checker) + + def _on_join(self, c, e): + """[Internal]""" + ch = e.target() + nick = nm_to_n(e.source()) + if nick == c.get_nickname(): + self.channels[ch] = Channel() + self.channels[ch].add_user(nick) + + def _on_kick(self, c, e): + """[Internal]""" + nick = e.arguments()[0] + channel = e.target() + + if nick == c.get_nickname(): + del self.channels[channel] + else: + self.channels[channel].remove_user(nick) + + def _on_mode(self, c, e): + """[Internal]""" + modes = parse_channel_modes(" ".join(e.arguments())) + t = e.target() + if is_channel(t): + ch = self.channels[t] + for mode in modes: + if mode[0] == "+": + f = ch.set_mode + else: + f = ch.clear_mode + f(mode[1], mode[2]) + else: + # Mode on self... XXX + pass + + def _on_namreply(self, c, e): + """[Internal]""" + + # e.arguments()[0] == "@" for secret channels, + # "*" for private channels, + # "=" for others (public channels) + # e.arguments()[1] == channel + # e.arguments()[2] == nick list + + ch = e.arguments()[1] + for nick in e.arguments()[2].split(): + if nick[0] == "@": + nick = nick[1:] + self.channels[ch].set_mode("o", nick) + elif nick[0] == "+": + nick = nick[1:] + self.channels[ch].set_mode("v", nick) + self.channels[ch].add_user(nick) + + def _on_nick(self, c, e): + """[Internal]""" + before = nm_to_n(e.source()) + after = e.target() + for ch in self.channels.values(): + if ch.has_user(before): + ch.change_nick(before, after) + + def _on_part(self, c, e): + """[Internal]""" + nick = nm_to_n(e.source()) + channel = e.target() + + if nick == c.get_nickname(): + del self.channels[channel] + else: + self.channels[channel].remove_user(nick) + + def _on_quit(self, c, e): + """[Internal]""" + nick = nm_to_n(e.source()) + for ch in self.channels.values(): + if ch.has_user(nick): + ch.remove_user(nick) + + def die(self, msg="Bye, cruel world!"): + """Let the bot die. + + Arguments: + + msg -- Quit message. + """ + + self.connection.disconnect(msg) + sys.exit(0) + + def disconnect(self, msg="I'll be back!"): + """Disconnect the bot. + + The bot will try to reconnect after a while. + + Arguments: + + msg -- Quit message. + """ + self.connection.disconnect(msg) + + def get_version(self): + """Returns the bot version. + + Used when answering a CTCP VERSION request. + """ + return "ircbot.py by Joel Rosdahl " + + def jump_server(self, msg="Changing servers"): + """Connect to a new server, possibly disconnecting from the current. + + The bot will skip to next server in the server_list each time + jump_server is called. + """ + if self.connection.is_connected(): + self.connection.disconnect(msg) + + self.server_list.append(self.server_list.pop(0)) + self._connect() + + def on_ctcp(self, c, e): + """Default handler for ctcp events. + + Replies to VERSION and PING requests and relays DCC requests + to the on_dccchat method. + """ + if e.arguments()[0] == "VERSION": + c.ctcp_reply(nm_to_n(e.source()), + "VERSION " + self.get_version()) + elif e.arguments()[0] == "PING": + if len(e.arguments()) > 1: + c.ctcp_reply(nm_to_n(e.source()), + "PING " + e.arguments()[1]) + elif e.arguments()[0] == "DCC" and e.arguments()[1].split(" ", 1)[0] == "CHAT": + self.on_dccchat(c, e) + + def on_dccchat(self, c, e): + pass + + def start(self): + """Start the bot.""" + self._connect() + SimpleIRCClient.start(self) + + +class IRCDict: + """A dictionary suitable for storing IRC-related things. + + Dictionary keys a and b are considered equal if and only if + irc_lower(a) == irc_lower(b) + + Otherwise, it should behave exactly as a normal dictionary. + """ + + def __init__(self, dict=None): + self.data = {} + self.canon_keys = {} # Canonical keys + if dict is not None: + self.update(dict) + def __repr__(self): + return repr(self.data) + def __cmp__(self, dict): + if isinstance(dict, IRCDict): + return cmp(self.data, dict.data) + else: + return cmp(self.data, dict) + def __len__(self): + return len(self.data) + def __getitem__(self, key): + return self.data[self.canon_keys[irc_lower(key)]] + def __setitem__(self, key, item): + if key in self: + del self[key] + self.data[key] = item + self.canon_keys[irc_lower(key)] = key + def __delitem__(self, key): + ck = irc_lower(key) + del self.data[self.canon_keys[ck]] + del self.canon_keys[ck] + def __iter__(self): + return iter(self.data) + def __contains__(self, key): + return self.has_key(key) + def clear(self): + self.data.clear() + self.canon_keys.clear() + def copy(self): + if self.__class__ is UserDict: + return UserDict(self.data) + import copy + return copy.copy(self) + def keys(self): + return self.data.keys() + def items(self): + return self.data.items() + def values(self): + return self.data.values() + def has_key(self, key): + return irc_lower(key) in self.canon_keys + def update(self, dict): + for k, v in dict.items(): + self.data[k] = v + def get(self, key, failobj=None): + return self.data.get(key, failobj) + + +class Channel: + """A class for keeping information about an IRC channel. + + This class can be improved a lot. + """ + + def __init__(self): + self.userdict = IRCDict() + self.operdict = IRCDict() + self.voiceddict = IRCDict() + self.modes = {} + + def users(self): + """Returns an unsorted list of the channel's users.""" + return self.userdict.keys() + + def opers(self): + """Returns an unsorted list of the channel's operators.""" + return self.operdict.keys() + + def voiced(self): + """Returns an unsorted list of the persons that have voice + mode set in the channel.""" + return self.voiceddict.keys() + + def has_user(self, nick): + """Check whether the channel has a user.""" + return nick in self.userdict + + def is_oper(self, nick): + """Check whether a user has operator status in the channel.""" + return nick in self.operdict + + def is_voiced(self, nick): + """Check whether a user has voice mode set in the channel.""" + return nick in self.voiceddict + + def add_user(self, nick): + self.userdict[nick] = 1 + + def remove_user(self, nick): + for d in self.userdict, self.operdict, self.voiceddict: + if nick in d: + del d[nick] + + def change_nick(self, before, after): + self.userdict[after] = 1 + del self.userdict[before] + if before in self.operdict: + self.operdict[after] = 1 + del self.operdict[before] + if before in self.voiceddict: + self.voiceddict[after] = 1 + del self.voiceddict[before] + + def set_mode(self, mode, value=None): + """Set mode on the channel. + + Arguments: + + mode -- The mode (a single-character string). + + value -- Value + """ + if mode == "o": + self.operdict[value] = 1 + elif mode == "v": + self.voiceddict[value] = 1 + else: + self.modes[mode] = value + + def clear_mode(self, mode, value=None): + """Clear mode on the channel. + + Arguments: + + mode -- The mode (a single-character string). + + value -- Value + """ + try: + if mode == "o": + del self.operdict[value] + elif mode == "v": + del self.voiceddict[value] + else: + del self.modes[mode] + except KeyError: + pass + + def has_mode(self, mode): + return mode in self.modes + + def is_moderated(self): + return self.has_mode("m") + + def is_secret(self): + return self.has_mode("s") + + def is_protected(self): + return self.has_mode("p") + + def has_topic_lock(self): + return self.has_mode("t") + + def is_invite_only(self): + return self.has_mode("i") + + def has_allow_external_messages(self): + return self.has_mode("n") + + def has_limit(self): + return self.has_mode("l") + + def limit(self): + if self.has_limit(): + return self.modes[l] + else: + return None + + def has_key(self): + return self.has_mode("k") + + def key(self): + if self.has_key(): + return self.modes["k"] + else: + return None diff --git a/irccat b/irccat new file mode 100644 index 0000000..6398ae3 --- /dev/null +++ b/irccat @@ -0,0 +1,64 @@ +#! /usr/bin/env python +# +# Example program using irclib.py. +# +# This program is free without restrictions; do anything you like with +# it. +# +# Joel Rosdahl + +import irclib +import sys + +def on_connect(connection, event): + if irclib.is_channel(target): + connection.join(target) + else: + while 1: + line = sys.stdin.readline() + if not line: + break + connection.privmsg(target, line) + connection.quit("Using irclib.py") + +def on_join(connection, event): + while 1: + line = sys.stdin.readline() + if not line: + break + connection.privmsg(target, line) + connection.quit("Using irclib.py") + +if len(sys.argv) != 4: + print "Usage: irccat " + print "\ntarget is a nickname or a channel." + sys.exit(1) + +def on_disconnect(connection, event): + sys.exit(0) + +s = sys.argv[1].split(":", 1) +server = s[0] +if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) +else: + port = 6667 +nickname = sys.argv[2] +target = sys.argv[3] + +irc = irclib.IRC() +try: + c = irc.server().connect(server, port, nickname) +except irclib.ServerConnectionError, x: + print x + sys.exit(1) + +c.add_global_handler("welcome", on_connect) +c.add_global_handler("join", on_join) +c.add_global_handler("disconnect", on_disconnect) + +irc.process_forever() diff --git a/irccat2 b/irccat2 new file mode 100755 index 0000000..fff4458 --- /dev/null +++ b/irccat2 @@ -0,0 +1,66 @@ +#! /usr/bin/env python +# +# Example program using irclib.py. +# +# This program is free without restrictions; do anything you like with +# it. +# +# Joel Rosdahl + +import irclib +import sys + +class IRCCat(irclib.SimpleIRCClient): + def __init__(self, target): + irclib.SimpleIRCClient.__init__(self) + self.target = target + + def on_welcome(self, connection, event): + if irclib.is_channel(self.target): + connection.join(self.target) + else: + self.send_it() + + def on_join(self, connection, event): + self.send_it() + + def on_disconnect(self, connection, event): + sys.exit(0) + + def send_it(self): + while 1: + line = sys.stdin.readline() + if not line: + break + self.connection.privmsg(self.target, line) + self.connection.quit("Using irclib.py") + +def main(): + if len(sys.argv) != 4: + print "Usage: irccat2 " + print "\ntarget is a nickname or a channel." + sys.exit(1) + + s = sys.argv[1].split(":", 1) + server = s[0] + if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) + else: + port = 6667 + nickname = sys.argv[2] + target = sys.argv[3] + + c = IRCCat(target) + try: + c.connect(server, port, nickname) + except irclib.ServerConnectionError, x: + print x + sys.exit(1) + c.start() + +if __name__ == "__main__": + main() diff --git a/irclib.py b/irclib.py new file mode 100644 index 0000000..5f7141c --- /dev/null +++ b/irclib.py @@ -0,0 +1,1560 @@ +# Copyright (C) 1999--2002 Joel Rosdahl +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# keltus +# +# $Id: irclib.py,v 1.47 2008/09/25 22:00:59 keltus Exp $ + +"""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/ +""" + +import bisect +import re +import select +import socket +import string +import sys +import time +import types + +VERSION = 0, 4, 8 +DEBUG = 0 + +# TODO +# ---- +# (maybe) thread safety +# (maybe) color parser convenience functions +# documentation (including all event types) +# (maybe) add awareness of different types of ircds +# send data asynchronously to the server (and DCC connections) +# (maybe) automatically close unused, passive DCC connections after a while + +# NOTES +# ----- +# connection.quit() only sends QUIT to the server. +# ERROR from the server triggers the error event and the disconnect event. +# dropping of the connection triggers the disconnect event. + +class IRCError(Exception): + """Represents an IRC exception.""" + pass + + +class IRC: + """Class 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. + """ + + def __init__(self, fn_to_add_socket=None, + fn_to_remove_socket=None, + fn_to_add_timeout=None): + """Constructor 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. + """ + + if fn_to_add_socket and fn_to_remove_socket: + self.fn_to_add_socket = fn_to_add_socket + self.fn_to_remove_socket = fn_to_remove_socket + else: + self.fn_to_add_socket = None + self.fn_to_remove_socket = None + + self.fn_to_add_timeout = fn_to_add_timeout + self.connections = [] + self.handlers = {} + self.delayed_commands = [] # list of tuples in the format (time, function, arguments) + + self.add_global_handler("ping", _ping_ponger, -42) + + def server(self): + """Creates and returns a ServerConnection object.""" + + c = ServerConnection(self) + self.connections.append(c) + return c + + def process_data(self, sockets): + """Called when there is more data to read on connection sockets. + + Arguments: + + sockets -- A list of socket objects. + + See documentation for IRC.__init__. + """ + for s in sockets: + for c in self.connections: + if s == c._get_socket(): + c.process_data() + + def process_timeout(self): + """Called when a timeout notification is due. + + See documentation for IRC.__init__. + """ + t = time.time() + while self.delayed_commands: + if t >= self.delayed_commands[0][0]: + self.delayed_commands[0][1](*self.delayed_commands[0][2]) + del self.delayed_commands[0] + else: + break + + def process_once(self, timeout=0): + """Process 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. + """ + sockets = map(lambda x: x._get_socket(), self.connections) + sockets = filter(lambda x: x != None, sockets) + if sockets: + (i, o, e) = select.select(sockets, [], [], timeout) + self.process_data(i) + else: + time.sleep(timeout) + self.process_timeout() + + def process_forever(self, timeout=0.2): + """Run an infinite loop, processing data from connections. + + This method repeatedly calls process_once. + + Arguments: + + timeout -- Parameter to pass to process_once. + """ + while 1: + self.process_once(timeout) + + def disconnect_all(self, message=""): + """Disconnects all connections.""" + for c in self.connections: + c.disconnect(message) + + def add_global_handler(self, event, handler, priority=0): + """Adds a global handler function for a specific event type. + + Arguments: + + event -- Event type (a string). Check the values of the + numeric_events dictionary in irclib.py for possible event + types. + + handler -- Callback function. + + priority -- A number (the lower number, the higher priority). + + The handler function is called whenever the specified event is + triggered in any of the connections. See documentation for + the Event class. + + The handler functions are called in priority order (lowest + number is highest priority). If a handler function returns + \"NO MORE\", no more handlers will be called. + """ + if not event in self.handlers: + self.handlers[event] = [] + bisect.insort(self.handlers[event], ((priority, handler))) + + def remove_global_handler(self, event, handler): + """Removes a global handler function. + + Arguments: + + event -- Event type (a string). + + handler -- Callback function. + + Returns 1 on success, otherwise 0. + """ + if not event in self.handlers: + return 0 + for h in self.handlers[event]: + if handler == h[1]: + self.handlers[event].remove(h) + return 1 + + def execute_at(self, at, function, arguments=()): + """Execute a function at a specified time. + + Arguments: + + at -- Execute at this time (standard \"time_t\" time). + + function -- Function to call. + + arguments -- Arguments to give the function. + """ + self.execute_delayed(at-time.time(), function, arguments) + + def execute_delayed(self, delay, function, arguments=()): + """Execute a function after a specified time. + + Arguments: + + delay -- How many seconds to wait. + + function -- Function to call. + + arguments -- Arguments to give the function. + """ + bisect.insort(self.delayed_commands, (delay+time.time(), function, arguments)) + if self.fn_to_add_timeout: + self.fn_to_add_timeout(delay) + + def dcc(self, dcctype="chat"): + """Creates and returns a DCCConnection object. + + Arguments: + + dcctype -- "chat" for DCC CHAT connections or "raw" for + DCC SEND (or other DCC types). If "chat", + incoming data will be split in newline-separated + chunks. If "raw", incoming data is not touched. + """ + c = DCCConnection(self, dcctype) + self.connections.append(c) + return c + + def _handle_event(self, connection, event): + """[Internal]""" + h = self.handlers + for handler in h.get("all_events", []) + h.get(event.eventtype(), []): + if handler[1](connection, event) == "NO MORE": + return + + def _remove_connection(self, connection): + """[Internal]""" + self.connections.remove(connection) + if self.fn_to_remove_socket: + self.fn_to_remove_socket(connection._get_socket()) + +_rfc_1459_command_regexp = re.compile("^(:(?P[^ ]+) +)?(?P[^ ]+)( *(?P .+))?") + +class Connection: + """Base class for IRC connections. + + Must be overridden. + """ + def __init__(self, irclibobj): + self.irclibobj = irclibobj + + def _get_socket(): + raise IRCError, "Not overridden" + + ############################## + ### Convenience wrappers. + + def execute_at(self, at, function, arguments=()): + self.irclibobj.execute_at(at, function, arguments) + + def execute_delayed(self, delay, function, arguments=()): + self.irclibobj.execute_delayed(delay, function, arguments) + + +class ServerConnectionError(IRCError): + pass + +class ServerNotConnectedError(ServerConnectionError): + pass + + +# Huh!? Crrrrazy EFNet doesn't follow the RFC: their ircd seems to +# use \n as message separator! :P +_linesep_regexp = re.compile("\r?\n") + +class ServerConnection(Connection): + """This class represents an IRC server connection. + + ServerConnection objects are instantiated by calling the server + method on an IRC object. + """ + + def __init__(self, irclibobj): + Connection.__init__(self, irclibobj) + self.connected = 0 # Not connected yet. + self.socket = None + self.ssl = None + + def connect(self, server, port, nickname, password=None, username=None, + ircname=None, localaddress="", localport=0, ssl=False, ipv6=False): + """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 ("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. + """ + if self.connected: + self.disconnect("Changing servers") + + self.previous_buffer = "" + self.handlers = {} + self.real_server_name = "" + self.real_nickname = nickname + self.server = server + self.port = port + self.nickname = nickname + self.username = username or nickname + self.ircname = ircname or nickname + self.password = password + self.localaddress = localaddress + self.localport = localport + self.localhost = socket.gethostname() + if ipv6: + self.socket = socket.socket(socket.AF_INET6, socket.SOCK_STREAM) + else: + self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + try: + self.socket.bind((self.localaddress, self.localport)) + self.socket.connect((self.server, self.port)) + if ssl: + self.ssl = socket.ssl(self.socket) + except socket.error, x: + self.socket.close() + self.socket = None + raise ServerConnectionError, "Couldn't connect to socket: %s" % x + self.connected = 1 + if self.irclibobj.fn_to_add_socket: + self.irclibobj.fn_to_add_socket(self.socket) + + # Log on... + if self.password: + self.pass_(self.password) + self.nick(self.nickname) + self.user(self.username, self.ircname) + return self + + def close(self): + """Close the connection. + + This method closes the connection permanently; after it has + been called, the object is unusable. + """ + + self.disconnect("Closing object") + self.irclibobj._remove_connection(self) + + def _get_socket(self): + """[Internal]""" + return self.socket + + def get_server_name(self): + """Get the (real) server name. + + This method returns the (real) server name, or, more + specifically, what the server calls itself. + """ + + if self.real_server_name: + return self.real_server_name + else: + return "" + + def get_nickname(self): + """Get 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. """ + + return self.real_nickname + + def process_data(self): + """[Internal]""" + + try: + if self.ssl: + new_data = self.ssl.read(2**14) + else: + new_data = self.socket.recv(2**14) + except socket.error, x: + # The server hung up. + self.disconnect("Connection reset by peer") + return + if not new_data: + # Read nothing: connection must be down. + self.disconnect("Connection reset by peer") + return + + lines = _linesep_regexp.split(self.previous_buffer + new_data) + + # Save the last, unfinished line. + self.previous_buffer = lines.pop() + + for line in lines: + if DEBUG: + print "FROM SERVER:", line + + if not line: + continue + + prefix = None + command = None + arguments = None + self._handle_event(Event("all_raw_messages", + self.get_server_name(), + None, + [line])) + + m = _rfc_1459_command_regexp.match(line) + if m.group("prefix"): + prefix = m.group("prefix") + if not self.real_server_name: + self.real_server_name = prefix + + if m.group("command"): + command = m.group("command").lower() + + if m.group("argument"): + a = m.group("argument").split(" :", 1) + arguments = a[0].split() + if len(a) == 2: + arguments.append(a[1]) + + # Translate numerics into more readable strings. + if command in numeric_events: + command = numeric_events[command] + + if command == "nick": + if nm_to_n(prefix) == self.real_nickname: + self.real_nickname = arguments[0] + elif command == "welcome": + # Record the nickname in case the client changed nick + # in a nicknameinuse callback. + self.real_nickname = arguments[0] + + if command in ["privmsg", "notice"]: + target, message = arguments[0], arguments[1] + messages = _ctcp_dequote(message) + + if command == "privmsg": + if is_channel(target): + command = "pubmsg" + else: + if is_channel(target): + command = "pubnotice" + else: + command = "privnotice" + + for m in messages: + if type(m) is types.TupleType: + if command in ["privmsg", "pubmsg"]: + command = "ctcp" + else: + command = "ctcpreply" + + m = list(m) + if DEBUG: + print "command: %s, source: %s, target: %s, arguments: %s" % ( + command, prefix, target, m) + self._handle_event(Event(command, prefix, target, m)) + if command == "ctcp" and m[0] == "ACTION": + self._handle_event(Event("action", prefix, target, m[1:])) + else: + if DEBUG: + print "command: %s, source: %s, target: %s, arguments: %s" % ( + command, prefix, target, [m]) + self._handle_event(Event(command, prefix, target, [m])) + else: + target = None + + if command == "quit": + arguments = [arguments[0]] + elif command == "ping": + target = arguments[0] + else: + target = arguments[0] + arguments = arguments[1:] + + if command == "mode": + if not is_channel(target): + command = "umode" + + if DEBUG: + print "command: %s, source: %s, target: %s, arguments: %s" % ( + command, prefix, target, arguments) + self._handle_event(Event(command, prefix, target, arguments)) + + def _handle_event(self, event): + """[Internal]""" + self.irclibobj._handle_event(self, event) + if event.eventtype() in self.handlers: + for fn in self.handlers[event.eventtype()]: + fn(self, event) + + def is_connected(self): + """Return connection status. + + Returns true if connected, otherwise false. + """ + return self.connected + + def add_global_handler(self, *args): + """Add global handler. + + See documentation for IRC.add_global_handler. + """ + self.irclibobj.add_global_handler(*args) + + def remove_global_handler(self, *args): + """Remove global handler. + + See documentation for IRC.remove_global_handler. + """ + self.irclibobj.remove_global_handler(*args) + + def action(self, target, action): + """Send a CTCP ACTION command.""" + self.ctcp("ACTION", target, action) + + def admin(self, server=""): + """Send an ADMIN command.""" + self.send_raw(" ".join(["ADMIN", server]).strip()) + + def ctcp(self, ctcptype, target, parameter=""): + """Send a CTCP command.""" + ctcptype = ctcptype.upper() + self.privmsg(target, "\001%s%s\001" % (ctcptype, parameter and (" " + parameter) or "")) + + def ctcp_reply(self, target, parameter): + """Send a CTCP REPLY command.""" + self.notice(target, "\001%s\001" % parameter) + + def disconnect(self, message=""): + """Hang up the connection. + + Arguments: + + message -- Quit message. + """ + if not self.connected: + return + + self.connected = 0 + + self.quit(message) + + try: + self.socket.close() + except socket.error, x: + pass + self.socket = None + self._handle_event(Event("disconnect", self.server, "", [message])) + + def globops(self, text): + """Send a GLOBOPS command.""" + self.send_raw("GLOBOPS :" + text) + + def info(self, server=""): + """Send an INFO command.""" + self.send_raw(" ".join(["INFO", server]).strip()) + + def invite(self, nick, channel): + """Send an INVITE command.""" + self.send_raw(" ".join(["INVITE", nick, channel]).strip()) + + def ison(self, nicks): + """Send an ISON command. + + Arguments: + + nicks -- List of nicks. + """ + self.send_raw("ISON " + " ".join(nicks)) + + def join(self, channel, key=""): + """Send a JOIN command.""" + self.send_raw("JOIN %s%s" % (channel, (key and (" " + key)))) + + def kick(self, channel, nick, comment=""): + """Send a KICK command.""" + self.send_raw("KICK %s %s%s" % (channel, nick, (comment and (" :" + comment)))) + + def links(self, remote_server="", server_mask=""): + """Send a LINKS command.""" + command = "LINKS" + if remote_server: + command = command + " " + remote_server + if server_mask: + command = command + " " + server_mask + self.send_raw(command) + + def list(self, channels=None, server=""): + """Send a LIST command.""" + command = "LIST" + if channels: + command = command + " " + ",".join(channels) + if server: + command = command + " " + server + self.send_raw(command) + + def lusers(self, server=""): + """Send a LUSERS command.""" + self.send_raw("LUSERS" + (server and (" " + server))) + + def mode(self, target, command): + """Send a MODE command.""" + self.send_raw("MODE %s %s" % (target, command)) + + def motd(self, server=""): + """Send an MOTD command.""" + self.send_raw("MOTD" + (server and (" " + server))) + + def names(self, channels=None): + """Send a NAMES command.""" + self.send_raw("NAMES" + (channels and (" " + ",".join(channels)) or "")) + + def nick(self, newnick): + """Send a NICK command.""" + self.send_raw("NICK " + newnick) + + def notice(self, target, text): + """Send a NOTICE command.""" + # Should limit len(text) here! + self.send_raw("NOTICE %s :%s" % (target, text)) + + def oper(self, nick, password): + """Send an OPER command.""" + self.send_raw("OPER %s %s" % (nick, password)) + + def part(self, channels, message=""): + """Send a PART command.""" + if type(channels) == types.StringType: + self.send_raw("PART " + channels + (message and (" " + message))) + else: + self.send_raw("PART " + ",".join(channels) + (message and (" " + message))) + + def pass_(self, password): + """Send a PASS command.""" + self.send_raw("PASS " + password) + + def ping(self, target, target2=""): + """Send a PING command.""" + self.send_raw("PING %s%s" % (target, target2 and (" " + target2))) + + def pong(self, target, target2=""): + """Send a PONG command.""" + self.send_raw("PONG %s%s" % (target, target2 and (" " + target2))) + + def privmsg(self, target, text): + """Send a PRIVMSG command.""" + # Should limit len(text) here! + self.send_raw("PRIVMSG %s :%s" % (target, text)) + + def privmsg_many(self, targets, text): + """Send a PRIVMSG command to multiple targets.""" + # Should limit len(text) here! + self.send_raw("PRIVMSG %s :%s" % (",".join(targets), text)) + + def quit(self, message=""): + """Send a QUIT command.""" + # Note that many IRC servers don't use your QUIT message + # unless you've been connected for at least 5 minutes! + self.send_raw("QUIT" + (message and (" :" + message))) + + def send_raw(self, string): + """Send raw string to the server. + + The string will be padded with appropriate CR LF. + """ + if self.socket is None: + raise ServerNotConnectedError, "Not connected." + try: + if self.ssl: + self.ssl.write(string + "\r\n") + else: + self.socket.send(string + "\r\n") + if DEBUG: + print "TO SERVER:", string + except socket.error, x: + # Ouch! + self.disconnect("Connection reset by peer.") + + def squit(self, server, comment=""): + """Send an SQUIT command.""" + self.send_raw("SQUIT %s%s" % (server, comment and (" :" + comment))) + + def stats(self, statstype, server=""): + """Send a STATS command.""" + self.send_raw("STATS %s%s" % (statstype, server and (" " + server))) + + def time(self, server=""): + """Send a TIME command.""" + self.send_raw("TIME" + (server and (" " + server))) + + def topic(self, channel, new_topic=None): + """Send a TOPIC command.""" + if new_topic is None: + self.send_raw("TOPIC " + channel) + else: + self.send_raw("TOPIC %s :%s" % (channel, new_topic)) + + def trace(self, target=""): + """Send a TRACE command.""" + self.send_raw("TRACE" + (target and (" " + target))) + + def user(self, username, realname): + """Send a USER command.""" + self.send_raw("USER %s 0 * :%s" % (username, realname)) + + def userhost(self, nicks): + """Send a USERHOST command.""" + self.send_raw("USERHOST " + ",".join(nicks)) + + def users(self, server=""): + """Send a USERS command.""" + self.send_raw("USERS" + (server and (" " + server))) + + def version(self, server=""): + """Send a VERSION command.""" + self.send_raw("VERSION" + (server and (" " + server))) + + def wallops(self, text): + """Send a WALLOPS command.""" + self.send_raw("WALLOPS :" + text) + + def who(self, target="", op=""): + """Send a WHO command.""" + self.send_raw("WHO%s%s" % (target and (" " + target), op and (" o"))) + + def whois(self, targets): + """Send a WHOIS command.""" + self.send_raw("WHOIS " + ",".join(targets)) + + def whowas(self, nick, max="", server=""): + """Send a WHOWAS command.""" + self.send_raw("WHOWAS %s%s%s" % (nick, + max and (" " + max), + server and (" " + server))) + +class DCCConnectionError(IRCError): + pass + + +class DCCConnection(Connection): + """This class represents a DCC connection. + + DCCConnection objects are instantiated by calling the dcc + method on an IRC object. + """ + def __init__(self, irclibobj, dcctype): + Connection.__init__(self, irclibobj) + self.connected = 0 + self.passive = 0 + self.dcctype = dcctype + self.peeraddress = None + self.peerport = None + + def connect(self, address, port): + """Connect/reconnect to a DCC peer. + + Arguments: + address -- Host/IP address of the peer. + + port -- The port number to connect to. + + Returns the DCCConnection object. + """ + self.peeraddress = socket.gethostbyname(address) + self.peerport = port + self.socket = None + self.previous_buffer = "" + self.handlers = {} + self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + self.passive = 0 + try: + self.socket.connect((self.peeraddress, self.peerport)) + except socket.error, x: + raise DCCConnectionError, "Couldn't connect to socket: %s" % x + self.connected = 1 + if self.irclibobj.fn_to_add_socket: + self.irclibobj.fn_to_add_socket(self.socket) + return self + + def listen(self): + """Wait 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. + """ + self.previous_buffer = "" + self.handlers = {} + self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + self.passive = 1 + try: + self.socket.bind((socket.gethostbyname(socket.gethostname()), 0)) + self.localaddress, self.localport = self.socket.getsockname() + self.socket.listen(10) + except socket.error, x: + raise DCCConnectionError, "Couldn't bind socket: %s" % x + return self + + def disconnect(self, message=""): + """Hang up the connection and close the object. + + Arguments: + + message -- Quit message. + """ + if not self.connected: + return + + self.connected = 0 + try: + self.socket.close() + except socket.error, x: + pass + self.socket = None + self.irclibobj._handle_event( + self, + Event("dcc_disconnect", self.peeraddress, "", [message])) + self.irclibobj._remove_connection(self) + + def process_data(self): + """[Internal]""" + + if self.passive and not self.connected: + conn, (self.peeraddress, self.peerport) = self.socket.accept() + self.socket.close() + self.socket = conn + self.connected = 1 + if DEBUG: + print "DCC connection from %s:%d" % ( + self.peeraddress, self.peerport) + self.irclibobj._handle_event( + self, + Event("dcc_connect", self.peeraddress, None, None)) + return + + try: + new_data = self.socket.recv(2**14) + except socket.error, x: + # The server hung up. + self.disconnect("Connection reset by peer") + return + if not new_data: + # Read nothing: connection must be down. + self.disconnect("Connection reset by peer") + return + + if self.dcctype == "chat": + # The specification says lines are terminated with LF, but + # it seems safer to handle CR LF terminations too. + chunks = _linesep_regexp.split(self.previous_buffer + new_data) + + # Save the last, unfinished line. + self.previous_buffer = chunks[-1] + if len(self.previous_buffer) > 2**14: + # Bad peer! Naughty peer! + self.disconnect() + return + chunks = chunks[:-1] + else: + chunks = [new_data] + + command = "dccmsg" + prefix = self.peeraddress + target = None + for chunk in chunks: + if DEBUG: + print "FROM PEER:", chunk + arguments = [chunk] + if DEBUG: + print "command: %s, source: %s, target: %s, arguments: %s" % ( + command, prefix, target, arguments) + self.irclibobj._handle_event( + self, + Event(command, prefix, target, arguments)) + + def _get_socket(self): + """[Internal]""" + return self.socket + + def privmsg(self, string): + """Send data to DCC peer. + + The string will be padded with appropriate LF if it's a DCC + CHAT session. + """ + try: + self.socket.send(string) + if self.dcctype == "chat": + self.socket.send("\n") + if DEBUG: + print "TO PEER: %s\n" % string + except socket.error, x: + # Ouch! + self.disconnect("Connection reset by peer.") + +class SimpleIRCClient: + """A 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. + """ + def __init__(self): + self.ircobj = IRC() + self.connection = self.ircobj.server() + self.dcc_connections = [] + self.ircobj.add_global_handler("all_events", self._dispatcher, -10) + self.ircobj.add_global_handler("dcc_disconnect", self._dcc_disconnect, -10) + + def _dispatcher(self, c, e): + """[Internal]""" + m = "on_" + e.eventtype() + if hasattr(self, m): + getattr(self, m)(c, e) + + def _dcc_disconnect(self, c, e): + self.dcc_connections.remove(c) + + def connect(self, server, port, nickname, password=None, username=None, + ircname=None, localaddress="", localport=0, ssl=False, ipv6=False): + """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. + """ + self.connection.connect(server, port, nickname, + password, username, ircname, + localaddress, localport, ssl, ipv6) + + def dcc_connect(self, address, port, dcctype="chat"): + """Connect to a DCC peer. + + Arguments: + + address -- IP address of the peer. + + port -- Port to connect to. + + Returns a DCCConnection instance. + """ + dcc = self.ircobj.dcc(dcctype) + self.dcc_connections.append(dcc) + dcc.connect(address, port) + return dcc + + def dcc_listen(self, dcctype="chat"): + """Listen for connections from a DCC peer. + + Returns a DCCConnection instance. + """ + dcc = self.ircobj.dcc(dcctype) + self.dcc_connections.append(dcc) + dcc.listen() + return dcc + + def start(self): + """Start the IRC client.""" + self.ircobj.process_forever() + + +class Event: + """Class representing an IRC event.""" + def __init__(self, eventtype, source, target, arguments=None): + """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. + """ + self._eventtype = eventtype + self._source = source + self._target = target + if arguments: + self._arguments = arguments + else: + self._arguments = [] + + def eventtype(self): + """Get the event type.""" + return self._eventtype + + def source(self): + """Get the event source.""" + return self._source + + def target(self): + """Get the event target.""" + return self._target + + def arguments(self): + """Get the event arguments.""" + return self._arguments + +_LOW_LEVEL_QUOTE = "\020" +_CTCP_LEVEL_QUOTE = "\134" +_CTCP_DELIMITER = "\001" + +_low_level_mapping = { + "0": "\000", + "n": "\n", + "r": "\r", + _LOW_LEVEL_QUOTE: _LOW_LEVEL_QUOTE +} + +_low_level_regexp = re.compile(_LOW_LEVEL_QUOTE + "(.)") + +def mask_matches(nick, mask): + """Check if a nick matches a mask. + + Returns true if the nick matches, otherwise false. + """ + nick = irc_lower(nick) + mask = irc_lower(mask) + mask = mask.replace("\\", "\\\\") + for ch in ".$|[](){}+": + mask = mask.replace(ch, "\\" + ch) + mask = mask.replace("?", ".") + mask = mask.replace("*", ".*") + r = re.compile(mask, re.IGNORECASE) + return r.match(nick) + +_special = "-[]\\`^{}" +nick_characters = string.ascii_letters + string.digits + _special +_ircstring_translation = string.maketrans(string.ascii_uppercase + "[]\\^", + string.ascii_lowercase + "{}|~") + +def irc_lower(s): + """Returns a lowercased string. + + The definition of lowercased comes from the IRC specification (RFC + 1459). + """ + return s.translate(_ircstring_translation) + +def _ctcp_dequote(message): + """[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. + """ + + def _low_level_replace(match_obj): + ch = match_obj.group(1) + + # If low_level_mapping doesn't have the character as key, we + # should just return the character. + return _low_level_mapping.get(ch, ch) + + if _LOW_LEVEL_QUOTE in message: + # Yup, there was a quote. Release the dequoter, man! + message = _low_level_regexp.sub(_low_level_replace, message) + + if _CTCP_DELIMITER not in message: + return [message] + else: + # Split it into parts. (Does any IRC client actually *use* + # CTCP stacking like this?) + chunks = message.split(_CTCP_DELIMITER) + + messages = [] + i = 0 + while i < len(chunks)-1: + # Add message if it's non-empty. + if len(chunks[i]) > 0: + messages.append(chunks[i]) + + if i < len(chunks)-2: + # Aye! CTCP tagged data ahead! + messages.append(tuple(chunks[i+1].split(" ", 1))) + + i = i + 2 + + if len(chunks) % 2 == 0: + # Hey, a lonely _CTCP_DELIMITER at the end! This means + # that the last chunk, including the delimiter, is a + # normal message! (This is according to the CTCP + # specification.) + messages.append(_CTCP_DELIMITER + chunks[-1]) + + return messages + +def is_channel(string): + """Check if a string is a channel name. + + Returns true if the argument is a channel name, otherwise false. + """ + return string and string[0] in "#&+!" + +def ip_numstr_to_quad(num): + """Convert an IP number as an integer given in ASCII + representation (e.g. '3232235521') to an IP address string + (e.g. '192.168.0.1').""" + n = long(num) + p = map(str, map(int, [n >> 24 & 0xFF, n >> 16 & 0xFF, + n >> 8 & 0xFF, n & 0xFF])) + return ".".join(p) + +def ip_quad_to_numstr(quad): + """Convert an IP address string (e.g. '192.168.0.1') to an IP + number as an integer given in ASCII representation + (e.g. '3232235521').""" + p = map(long, quad.split(".")) + s = str((p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3]) + if s[-1] == "L": + s = s[:-1] + return s + +def nm_to_n(s): + """Get the nick part of a nickmask. + + (The source of an Event is a nickmask.) + """ + return s.split("!")[0] + +def nm_to_uh(s): + """Get the userhost part of a nickmask. + + (The source of an Event is a nickmask.) + """ + return s.split("!")[1] + +def nm_to_h(s): + """Get the host part of a nickmask. + + (The source of an Event is a nickmask.) + """ + return s.split("@")[1] + +def nm_to_u(s): + """Get the user part of a nickmask. + + (The source of an Event is a nickmask.) + """ + s = s.split("!")[1] + return s.split("@")[0] + +def parse_nick_modes(mode_string): + """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]] + """ + + return _parse_modes(mode_string, "") + +def parse_channel_modes(mode_string): + """Parse 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]] + """ + + return _parse_modes(mode_string, "bklvo") + +def _parse_modes(mode_string, unary_modes=""): + """[Internal]""" + modes = [] + arg_count = 0 + + # State variable. + sign = "" + + a = mode_string.split() + if len(a) == 0: + return [] + else: + mode_part, args = a[0], a[1:] + + if mode_part[0] not in "+-": + return [] + for ch in mode_part: + if ch in "+-": + sign = ch + elif ch == " ": + collecting_arguments = 1 + elif ch in unary_modes: + if len(args) >= arg_count + 1: + modes.append([sign, ch, args[arg_count]]) + arg_count = arg_count + 1 + else: + modes.append([sign, ch, None]) + else: + modes.append([sign, ch, None]) + return modes + +def _ping_ponger(connection, event): + """[Internal]""" + connection.pong(event.target()) + +# Numeric table mostly stolen from the Perl IRC module (Net::IRC). +numeric_events = { + "001": "welcome", + "002": "yourhost", + "003": "created", + "004": "myinfo", + "005": "featurelist", # XXX + "200": "tracelink", + "201": "traceconnecting", + "202": "tracehandshake", + "203": "traceunknown", + "204": "traceoperator", + "205": "traceuser", + "206": "traceserver", + "207": "traceservice", + "208": "tracenewtype", + "209": "traceclass", + "210": "tracereconnect", + "211": "statslinkinfo", + "212": "statscommands", + "213": "statscline", + "214": "statsnline", + "215": "statsiline", + "216": "statskline", + "217": "statsqline", + "218": "statsyline", + "219": "endofstats", + "221": "umodeis", + "231": "serviceinfo", + "232": "endofservices", + "233": "service", + "234": "servlist", + "235": "servlistend", + "241": "statslline", + "242": "statsuptime", + "243": "statsoline", + "244": "statshline", + "250": "luserconns", + "251": "luserclient", + "252": "luserop", + "253": "luserunknown", + "254": "luserchannels", + "255": "luserme", + "256": "adminme", + "257": "adminloc1", + "258": "adminloc2", + "259": "adminemail", + "261": "tracelog", + "262": "endoftrace", + "263": "tryagain", + "265": "n_local", + "266": "n_global", + "300": "none", + "301": "away", + "302": "userhost", + "303": "ison", + "305": "unaway", + "306": "nowaway", + "311": "whoisuser", + "312": "whoisserver", + "313": "whoisoperator", + "314": "whowasuser", + "315": "endofwho", + "316": "whoischanop", + "317": "whoisidle", + "318": "endofwhois", + "319": "whoischannels", + "321": "liststart", + "322": "list", + "323": "listend", + "324": "channelmodeis", + "329": "channelcreate", + "331": "notopic", + "332": "currenttopic", + "333": "topicinfo", + "341": "inviting", + "342": "summoning", + "346": "invitelist", + "347": "endofinvitelist", + "348": "exceptlist", + "349": "endofexceptlist", + "351": "version", + "352": "whoreply", + "353": "namreply", + "361": "killdone", + "362": "closing", + "363": "closeend", + "364": "links", + "365": "endoflinks", + "366": "endofnames", + "367": "banlist", + "368": "endofbanlist", + "369": "endofwhowas", + "371": "info", + "372": "motd", + "373": "infostart", + "374": "endofinfo", + "375": "motdstart", + "376": "endofmotd", + "377": "motd2", # 1997-10-16 -- tkil + "381": "youreoper", + "382": "rehashing", + "384": "myportis", + "391": "time", + "392": "usersstart", + "393": "users", + "394": "endofusers", + "395": "nousers", + "401": "nosuchnick", + "402": "nosuchserver", + "403": "nosuchchannel", + "404": "cannotsendtochan", + "405": "toomanychannels", + "406": "wasnosuchnick", + "407": "toomanytargets", + "409": "noorigin", + "411": "norecipient", + "412": "notexttosend", + "413": "notoplevel", + "414": "wildtoplevel", + "421": "unknowncommand", + "422": "nomotd", + "423": "noadmininfo", + "424": "fileerror", + "431": "nonicknamegiven", + "432": "erroneusnickname", # Thiss iz how its speld in thee RFC. + "433": "nicknameinuse", + "436": "nickcollision", + "437": "unavailresource", # "Nick temporally unavailable" + "441": "usernotinchannel", + "442": "notonchannel", + "443": "useronchannel", + "444": "nologin", + "445": "summondisabled", + "446": "usersdisabled", + "451": "notregistered", + "461": "needmoreparams", + "462": "alreadyregistered", + "463": "nopermforhost", + "464": "passwdmismatch", + "465": "yourebannedcreep", # I love this one... + "466": "youwillbebanned", + "467": "keyset", + "471": "channelisfull", + "472": "unknownmode", + "473": "inviteonlychan", + "474": "bannedfromchan", + "475": "badchannelkey", + "476": "badchanmask", + "477": "nochanmodes", # "Channel doesn't support modes" + "478": "banlistfull", + "481": "noprivileges", + "482": "chanoprivsneeded", + "483": "cantkillserver", + "484": "restricted", # Connection is restricted + "485": "uniqopprivsneeded", + "491": "nooperhost", + "492": "noservicehost", + "501": "umodeunknownflag", + "502": "usersdontmatch", +} + +generated_events = [ + # Generated events + "dcc_connect", + "dcc_disconnect", + "dccmsg", + "disconnect", + "ctcp", + "ctcpreply", +] + +protocol_events = [ + # IRC protocol events + "error", + "join", + "kick", + "mode", + "part", + "ping", + "privmsg", + "privnotice", + "pubmsg", + "pubnotice", + "quit", + "invite", + "pong", +] + +all_events = generated_events + protocol_events + numeric_events.values() diff --git a/python-irclib.spec b/python-irclib.spec new file mode 100644 index 0000000..69e3339 --- /dev/null +++ b/python-irclib.spec @@ -0,0 +1,74 @@ +Summary: A set of Python modules for IRC support. +Name: python-irclib +Version: 0.4.8 +Release: 1 +Group: Development/Libraries +License: LGPL +URL: http://python-irclib.sourceforge.net +Source: %{name}-%{version}.tar.gz +BuildRoot: %{_tmppath}/%{name}-root +Requires: python +BuildPrereq: python +BuildArch: noarch + +%description +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 and DCC +connections. + +%prep +%setup -q +chmod 644 * + +%build +python -c "import py_compile; py_compile.compile('irclib.py')" +python -c "import py_compile; py_compile.compile('ircbot.py')" + +%install +[ "$RPM_BUILD_ROOT" != "/" ] && rm -rf $RPM_BUILD_ROOT +%{__mkdir_p} $RPM_BUILD_ROOT/usr/lib/python1.5/site-packages +%{__install} -m 644 irclib.py* $RPM_BUILD_ROOT/usr/lib/python1.5/site-packages +%{__install} -m 644 ircbot.py* $RPM_BUILD_ROOT/usr/lib/python1.5/site-packages + +%clean +[ "$RPM_BUILD_ROOT" != "/" ] && rm -rf $RPM_BUILD_ROOT + +%files +%defattr(-,root,root) +%doc README ChangeLog COPYING irccat irccat2 servermap testbot.py dccsend dccreceive +/usr/lib/python*/site-packages/* + +%changelog +* Sat Sep 11 2008 Keltus 0.4.8-1 +- upgraded to 0.4.8 + +* Sat Aug 29 2008 Keltus 0.4.7-1 +- upgraded to 0.4.7 + +* Sat Dec 24 2005 Keltus 0.4.6-1 +- upgraded to 0.4.6 + +* Wed May 18 2005 Keltus 0.4.5-1 +- upgraded to 0.4.5 + +* Wed Feb 23 2005 Keltus 0.4.4-1 +- upgraded to 0.4.4 + +* Sun Jan 19 2005 Joel Rosdahl 0.4.3-1 +- upgraded to 0.4.3 + +* Fri Jul 9 2004 Joel Rosdahl 0.4.2-1 +- upgraded to 0.4.2 + +* Thu Oct 30 2003 Joel Rosdahl 0.4.1-1 +- upgraded to 0.4.1 + +* Mon Sep 1 2002 Gary Benson 0.4.0-1 +- upgraded to 0.4.0 + +* Wed Feb 20 2002 Gary Benson 0.3.4-1 +- upgraded to 0.3.4 + +* Wed Feb 20 2002 Gary Benson 0.3.3-1 +- initial revision diff --git a/servermap b/servermap new file mode 100755 index 0000000..f897f56 --- /dev/null +++ b/servermap @@ -0,0 +1,164 @@ +#! /usr/bin/env python +# +# Example program using irclib.py. +# +# Copyright (C) 1999-2002 Joel Rosdahl +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# Joel Rosdahl +# +# servermap connects to an IRC server and finds out what other IRC +# servers there are in the net and prints a tree-like map of their +# interconnections. +# +# Example: +# +# % ./servermap irc.dal.net somenickname +# Connecting to server... +# Getting links... +# +# 26 servers (18 leaves and 8 hubs) +# +# splitrock.tx.us.dal.net +# `-vader.ny.us.dal.net +# |-twisted.ma.us.dal.net +# |-sodre.nj.us.dal.net +# |-glass.oh.us.dal.net +# |-distant.ny.us.dal.net +# | |-algo.se.eu.dal.net +# | | |-borg.se.eu.dal.net +# | | | `-ced.se.eu.dal.net +# | | |-viking.no.eu.dal.net +# | | |-inco.fr.eu.dal.net +# | | |-paranoia.se.eu.dal.net +# | | |-gaston.se.eu.dal.net +# | | | `-powertech.no.eu.dal.net +# | | `-algo-u.se.eu.dal.net +# | |-philly.pa.us.dal.net +# | |-liberty.nj.us.dal.net +# | `-jade.va.us.dal.net +# `-journey.ca.us.dal.net +# |-ion.va.us.dal.net +# |-dragons.ca.us.dal.net +# |-toronto.on.ca.dal.net +# | `-netropolis-r.uk.eu.dal.net +# | |-traced.de.eu.dal.net +# | `-lineone.uk.eu.dal.net +# `-omega.ca.us.dal.net + +import irclib +import sys + +if len(sys.argv) != 3: + print "Usage: servermap " + sys.exit(1) + +links = [] + +def on_connect(connection, event): + sys.stdout.write("\nGetting links...") + sys.stdout.flush() + connection.links() + +def on_passwdmismatch(connection, event): + print "Password required." + sys.exit(1) + +def on_links(connection, event): + global links + + links.append((event.arguments()[0], + event.arguments()[1], + event.arguments()[2])) + +def on_endoflinks(connection, event): + global links + + print "\n" + + m = {} + for (to_node, from_node, desc) in links: + if from_node != to_node: + m[from_node] = m.get(from_node, []) + [to_node] + + if connection.get_server_name() in m: + if len(m[connection.get_server_name()]) == 1: + hubs = len(m) - 1 + else: + hubs = len(m) + else: + hubs = 0 + + print "%d servers (%d leaves and %d hubs)\n" % (len(links), len(links)-hubs, hubs) + + print_tree(0, [], connection.get_server_name(), m) + connection.quit("Using irclib.py") + +def on_disconnect(connection, event): + sys.exit(0) + +def indent_string(level, active_levels, last): + if level == 0: + return "" + s = "" + for i in range(level-1): + if i in active_levels: + s = s + "| " + else: + s = s + " " + if last: + s = s + "`-" + else: + s = s + "|-" + return s + +def print_tree(level, active_levels, root, map, last=0): + sys.stdout.write(indent_string(level, active_levels, last) + + root + "\n") + if root in map: + list = map[root] + for r in list[:-1]: + print_tree(level+1, active_levels[:]+[level], r, map) + print_tree(level+1, active_levels[:], list[-1], map, 1) + +s = sys.argv[1].split(":", 1) +server = s[0] +if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) +else: + port = 6667 +nickname = sys.argv[2] + +irc = irclib.IRC() +sys.stdout.write("Connecting to server...") +sys.stdout.flush() +try: + c = irc.server().connect(server, port, nickname) +except irclib.ServerConnectionError, x: + print x + sys.exit(1) + +c.add_global_handler("welcome", on_connect) +c.add_global_handler("passwdmismatch", on_passwdmismatch) +c.add_global_handler("links", on_links) +c.add_global_handler("endoflinks", on_endoflinks) +c.add_global_handler("disconnect", on_disconnect) + +irc.process_forever() diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b139a67 --- /dev/null +++ b/setup.py @@ -0,0 +1,9 @@ +#! /usr/bin/env python + +from distutils.core import setup +setup(name="python-irclib", + version="0.4.8", + py_modules=["irclib", "ircbot"], + author="Joel Rosdahl", + author_email="joel@rosdahl.net", + url="http://python-irclib.sourceforge.net") diff --git a/testbot.py b/testbot.py new file mode 100755 index 0000000..6dd6034 --- /dev/null +++ b/testbot.py @@ -0,0 +1,118 @@ +#! /usr/bin/env python +# +# Example program using ircbot.py. +# +# Joel Rosdahl + +"""A simple example bot. + +This is an example bot that uses the SingleServerIRCBot class from +ircbot.py. The bot enters a channel and listens for commands in +private messages and channel traffic. Commands in channel messages +are given by prefixing the text by the bot name followed by a colon. +It also responds to DCC CHAT invitations and echos data sent in such +sessions. + +The known commands are: + + stats -- Prints some channel information. + + disconnect -- Disconnect the bot. The bot will try to reconnect + after 60 seconds. + + die -- Let the bot cease to exist. + + dcc -- Let the bot invite you to a DCC CHAT connection. +""" + +from ircbot import SingleServerIRCBot +from irclib import nm_to_n, nm_to_h, irc_lower, ip_numstr_to_quad, ip_quad_to_numstr + +class TestBot(SingleServerIRCBot): + def __init__(self, channel, nickname, server, port=6667): + SingleServerIRCBot.__init__(self, [(server, port)], nickname, nickname) + self.channel = channel + + def on_nicknameinuse(self, c, e): + c.nick(c.get_nickname() + "_") + + def on_welcome(self, c, e): + c.join(self.channel) + + def on_privmsg(self, c, e): + self.do_command(e, e.arguments()[0]) + + def on_pubmsg(self, c, e): + a = e.arguments()[0].split(":", 1) + if len(a) > 1 and irc_lower(a[0]) == irc_lower(self.connection.get_nickname()): + self.do_command(e, a[1].strip()) + return + + def on_dccmsg(self, c, e): + c.privmsg("You said: " + e.arguments()[0]) + + def on_dccchat(self, c, e): + if len(e.arguments()) != 2: + return + args = e.arguments()[1].split() + if len(args) == 4: + try: + address = ip_numstr_to_quad(args[2]) + port = int(args[3]) + except ValueError: + return + self.dcc_connect(address, port) + + def do_command(self, e, cmd): + nick = nm_to_n(e.source()) + c = self.connection + + if cmd == "disconnect": + self.disconnect() + elif cmd == "die": + self.die() + elif cmd == "stats": + for chname, chobj in self.channels.items(): + c.notice(nick, "--- Channel statistics ---") + c.notice(nick, "Channel: " + chname) + users = chobj.users() + users.sort() + c.notice(nick, "Users: " + ", ".join(users)) + opers = chobj.opers() + opers.sort() + c.notice(nick, "Opers: " + ", ".join(opers)) + voiced = chobj.voiced() + voiced.sort() + c.notice(nick, "Voiced: " + ", ".join(voiced)) + elif cmd == "dcc": + dcc = self.dcc_listen() + c.ctcp("DCC", nick, "CHAT chat %s %d" % ( + ip_quad_to_numstr(dcc.localaddress), + dcc.localport)) + else: + c.notice(nick, "Not understood: " + cmd) + +def main(): + import sys + if len(sys.argv) != 4: + print "Usage: testbot " + sys.exit(1) + + s = sys.argv[1].split(":", 1) + server = s[0] + if len(s) == 2: + try: + port = int(s[1]) + except ValueError: + print "Error: Erroneous port." + sys.exit(1) + else: + port = 6667 + channel = sys.argv[2] + nickname = sys.argv[3] + + bot = TestBot(channel, nickname, server, port) + bot.start() + +if __name__ == "__main__": + main()