From b2f90fb412218973608b24a32eebadc60de9878a Mon Sep 17 00:00:00 2001 From: Sergey Matveev Date: Sun, 11 May 2014 20:18:55 +0400 Subject: [PATCH] Initial commit --- AUTHORS | 1 + COPYING | 674 +++++++++++++++++++++++++++++++++++++++++++++++++ INSTALL | 12 + README | 68 +++++ TODO | 1 + client.go | 119 +++++++++ client_test.go | 148 +++++++++++ daemon.go | 433 +++++++++++++++++++++++++++++++ daemon_test.go | 140 ++++++++++ events.go | 109 ++++++++ goircd.go | 121 +++++++++ room.go | 168 ++++++++++++ 12 files changed, 1994 insertions(+) create mode 100644 AUTHORS create mode 100644 COPYING create mode 100644 INSTALL create mode 100644 README create mode 100644 TODO create mode 100644 client.go create mode 100644 client_test.go create mode 100644 daemon.go create mode 100644 daemon_test.go create mode 100644 events.go create mode 100644 goircd.go create mode 100644 room.go diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..f047789 --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +* Sergey Matveev diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..9a2708d --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state 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 program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..b73f970 --- /dev/null +++ b/INSTALL @@ -0,0 +1,12 @@ +goircd requires only standard Go's libraries and consists of single main +package. You can install it using either: + + % go get github.com/stargrave/goircd + % go install github.com/stargrave/goircd + +or if you are already inside goircd directory: + + % go install + +You should found goircd executable binary in your $GOPATH/bin/goircd. +Just run it with -help argument to see available options. diff --git a/README b/README new file mode 100644 index 0000000..b0082f0 --- /dev/null +++ b/README @@ -0,0 +1,68 @@ + goircd -- minimalistic simple Internet Relay Chat (IRC) server + ============================================================== + +SYNOPSIS + +goircd is very simple IRC server, written on Go. + +DESCRIPTION + +It is heavily inspired by miniircd daemon written on Python. +It is not aimed to replace full featured mass scalable IRC networks: + +* It can not connect to other servers. Just standalone installation +* It has few basic IRC commands +* There is not support for channel operators, modes, votes, invites + and so on +* No ident lookups, reverse DNS queries + +But it has some convincing features: + +* Only standard Go libraries, no external requirements +* Single executable binary +* No configuration file, just few command line arguments +* IPv6 out-of-box support +* Optional channel logging to plain text files +* Optional permanent channel's state saving in plain text files + (so you can reload daemon and all channels topics and keys won't + disappear) + +Some remarks and recommendations related to it's simplicity: + +* Use either nohup or similar tools to daemonize it +* Use either crywrap or similar tools for TLS-capable connections +* Just plain logging on stderr, without syslog support + +SUPPORTED IRC COMMANDS + +* NICK/USER during registration workflow +* PING/PONGs +* NOTICE/PRIVMSG +* MOTD, LUSERS, WHO, WHOIS, QUIT +* LIST, JOIN, TOPIC, +k/-k channel MODE + +USAGE + +Just execute goircd daemon. It has following optional arguments: + +* -hostname: hostname to show for client's connections +* -bind: address to bind to (:6667 be default) +* -motd: absolute path to MOTD file. It is reread every time MOTD is + requested +* -logdir: directory where all channels messages will be saved. If + omitted, then no logs will be kept +* -statedir: directory where all channels states will be saved and + loaded during startup. If omitted, then states will be + lost after daemon termination + +LICENCE + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +any later version. + +This program 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 General Public License for more details. diff --git a/TODO b/TODO new file mode 100644 index 0000000..b9f7192 --- /dev/null +++ b/TODO @@ -0,0 +1 @@ +* Cover all available commands with unittests diff --git a/client.go b/client.go new file mode 100644 index 0000000..632bf1f --- /dev/null +++ b/client.go @@ -0,0 +1,119 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "bytes" + "log" + "net" + "strings" + "time" +) + +const ( + CRLF = "\x0d\x0a" + BUF_SIZE = 1380 +) + +type Client struct { + hostname string + conn net.Conn + registered bool + ping_sent bool + timestamp time.Time + nickname string + username string + realname string +} + +func (client Client) String() string { + return client.nickname + "!" + client.username + "@" + client.conn.RemoteAddr().String() +} + +func NewClient(hostname string, conn net.Conn) *Client { + return &Client{hostname: hostname, conn: conn, nickname: "*"} +} + +// Client processor blockingly reads everything remote client sends, +// splits messages by CRLF and send them to Daemon gorouting for processing +// it futher. Also it can signalize that client is unavailable (disconnected). +func (client *Client) Processor(sink chan ClientEvent) { + var buf_net []byte + buf := make([]byte, 0) + log.Println("New client", client) + sink <- ClientEvent{client, EVENT_NEW, ""} + for { + buf_net = make([]byte, BUF_SIZE) + _, err := client.conn.Read(buf_net) + if err != nil { + log.Println(client, "connection lost", err) + sink <- ClientEvent{client, EVENT_DEL, ""} + break + } + client.timestamp = time.Now() + client.ping_sent = false + buf_net = bytes.TrimRight(buf_net, "\x00") + buf = append(buf, buf_net...) + if !bytes.HasSuffix(buf, []byte(CRLF)) { + continue + } + for _, msg := range bytes.Split(buf[:len(buf)-2], []byte(CRLF)) { + if len(msg) > 0 { + sink <- ClientEvent{client, EVENT_MSG, string(msg)} + } + } + buf = []byte{} + } +} + +// Send message as is with CRLF appended. +func (client *Client) Msg(text string) { + client.conn.Write([]byte(text + CRLF)) +} + +// Send message from server. It has ": servername" prefix. +func (client *Client) Reply(text string) { + client.Msg(":" + client.hostname + " " + text) +} + +// Send server message, concatenating all provided text parts and +// prefix the last one with ":". +func (client *Client) ReplyParts(code string, text ...string) { + parts := []string{code} + for _, t := range text { + parts = append(parts, t) + } + parts[len(parts)-1] = ":" + parts[len(parts)-1] + client.Reply(strings.Join(parts, " ")) +} + +// Send nicknamed server message. After servername it always has target +// client's nickname. The last part is prefixed with ":". +func (client *Client) ReplyNicknamed(code string, text ...string) { + client.ReplyParts(code, append([]string{client.nickname}, text...)...) +} + +// Reply "461 not enough parameters" error for given command. +func (client *Client) ReplyNotEnoughParameters(command string) { + client.ReplyNicknamed("461", command, "Not enough parameters") +} + +// Reply "403 no such channel" error for specified channel. +func (client *Client) ReplyNoChannel(channel string) { + client.ReplyNicknamed("403", channel, "No such channel") +} diff --git a/client_test.go b/client_test.go new file mode 100644 index 0000000..101de56 --- /dev/null +++ b/client_test.go @@ -0,0 +1,148 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "net" + "testing" + "time" +) + +// Testing network connection that satisfies net.Conn interface +// Can send predefined messages and store all written ones +type TestingConn struct { + msgs []string + msg_ptr int + incoming []string + closed bool +} + +func NewTestingConn(msgs ...string) *TestingConn { + msgs_crlf := []string{} + for _, msg := range msgs { + msgs_crlf = append(msgs_crlf, msg+"\r\n") + } + return &TestingConn{msgs: msgs_crlf, msg_ptr: -1} +} + +func (conn TestingConn) Error() string { + return "i am out" +} + +func (conn *TestingConn) Read(b []byte) (n int, err error) { + conn.msg_ptr++ + if len(conn.msgs) == conn.msg_ptr { + return 0, TestingConn{} + } + for n, bt := range []byte(conn.msgs[conn.msg_ptr]) { + b[n] = bt + } + return len(conn.msgs[conn.msg_ptr]), nil +} + +type MyAddr struct{} + +func (a MyAddr) String() string { + return "someclient" +} +func (a MyAddr) Network() string { + return "somenet" +} + +func (conn *TestingConn) Write(b []byte) (n int, err error) { + conn.incoming = append(conn.incoming, string(b)) + return 0, nil +} + +func (conn *TestingConn) Close() error { + conn.closed = true + return nil +} + +func (conn TestingConn) LocalAddr() net.Addr { + return nil +} + +func (conn TestingConn) RemoteAddr() net.Addr { + return MyAddr{} +} + +func (conn TestingConn) SetDeadline(t time.Time) error { + return nil +} + +func (conn TestingConn) SetReadDeadline(t time.Time) error { + return nil +} + +func (conn TestingConn) SetWriteDeadline(t time.Time) error { + return nil +} + +// New client creation test. It must send an event about new client, +// two predefined messages from it and deletion one +func TestNewClient(t *testing.T) { + conn := NewTestingConn("foo", "bar") + sink := make(chan ClientEvent) + client := NewClient("foohost", conn) + go client.Processor(sink) + + event := <-sink + if event.event_type != EVENT_NEW { + t.Fail() + } + event = <-sink + if (event.event_type != EVENT_MSG) || (event.text != "foo") { + t.Fail() + } + event = <-sink + if (event.event_type != EVENT_MSG) || (event.text != "bar") { + t.Fail() + } + event = <-sink + if event.event_type != EVENT_DEL { + t.Fail() + } +} + +// Test replies formatting +func TestClientReplies(t *testing.T) { + conn := NewTestingConn("foo", "bar") + client := NewClient("foohost", conn) + client.nickname = "мойник" + + client.Reply("hello") + if (len(conn.incoming) != 1) || (conn.incoming[0] != ":foohost hello\r\n") { + t.Fatal("did not recieve hello message") + } + + client.ReplyParts("200", "foo", "bar") + if (len(conn.incoming) != 2) || (conn.incoming[1] != ":foohost 200 foo :bar\r\n") { + t.Fatal("did not recieve 200 message") + } + + client.ReplyNicknamed("200", "foo", "bar") + if (len(conn.incoming) != 3) || (conn.incoming[2] != ":foohost 200 мойник foo :bar\r\n") { + t.Fatal("did not recieve nicknamed message") + } + + client.ReplyNotEnoughParameters("CMD") + if (len(conn.incoming) != 4) || (conn.incoming[3] != ":foohost 461 мойник CMD :Not enough parameters\r\n") { + t.Fatal("did not recieve 461 message") + } +} diff --git a/daemon.go b/daemon.go new file mode 100644 index 0000000..7263db7 --- /dev/null +++ b/daemon.go @@ -0,0 +1,433 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "bytes" + "fmt" + "io" + "log" + "os" + "regexp" + "sort" + "strings" + "time" +) + +const ( + PING_TIMEOUT = time.Second * 180 // Max time deadline for client's unresponsiveness + PING_THRESHOLD = time.Second * 90 // Max idle client's time before PING are sent + ALIVENESS_CHECK = time.Second * 10 // Client's aliveness check period +) + +type Daemon struct { + hostname string + motd string + clients map[*Client]bool + rooms map[string]*Room + room_sinks map[*Room]chan ClientEvent + last_aliveness_check time.Time + log_sink chan LogEvent + state_sink chan StateEvent +} + +func NewDaemon(hostname, motd string, log_sink chan LogEvent, state_sink chan StateEvent) *Daemon { + daemon := Daemon{hostname: hostname, motd: motd} + daemon.clients = make(map[*Client]bool) + daemon.rooms = make(map[string]*Room) + daemon.room_sinks = make(map[*Room]chan ClientEvent) + daemon.log_sink = log_sink + daemon.state_sink = state_sink + return &daemon +} + +func (daemon *Daemon) SendLusers(client *Client) { + lusers := 0 + for client := range daemon.clients { + if client.registered { + lusers++ + } + } + client.ReplyNicknamed("251", fmt.Sprintf("There are %d users and 0 services on 1 server", lusers)) +} + +func (daemon *Daemon) SendMotd(client *Client) { + if daemon.motd != "" { + fd, err := os.Open(daemon.motd) + if err == nil { + defer fd.Close() + motd := []byte{} + var err error + for err != io.EOF { + buf := make([]byte, 1024) + _, err = fd.Read(buf) + motd = append(motd, bytes.TrimRight(buf, "\x00")...) + } + + client.ReplyNicknamed("375", "- "+daemon.hostname+" Message of the day -") + for _, s := range bytes.Split(motd, []byte("\n")) { + client.ReplyNicknamed("372", "- "+string(s)) + } + client.ReplyNicknamed("376", "End of /MOTD command") + return + } else { + log.Println("Can not open motd file", daemon.motd, err) + } + } + client.ReplyNicknamed("422", "MOTD File is missing") +} + +func (daemon *Daemon) SendWhois(client *Client, nicknames []string) { + for _, nickname := range nicknames { + nickname = strings.ToLower(nickname) + found := false + for c := range daemon.clients { + if c.nickname != nickname { + continue + } + found = true + client.ReplyNicknamed("311", c.nickname, c.username, c.conn.RemoteAddr().String(), "*", c.realname) + client.ReplyNicknamed("312", c.nickname, daemon.hostname, daemon.hostname) + subscriptions := []string{} + for _, room := range daemon.rooms { + for subscriber := range room.members { + if subscriber.nickname == nickname { + subscriptions = append(subscriptions, room.name) + } + } + } + sort.Strings(subscriptions) + client.ReplyNicknamed("319", c.nickname, strings.Join(subscriptions, " ")) + client.ReplyNicknamed("318", c.nickname, "End of WHOIS list") + } + if !found { + client.ReplyNicknamed("401", nickname, "No such nickname") + } + } +} + +func (daemon *Daemon) SendList(client *Client, cols []string) { + var rooms []string + if (len(cols) > 1) && (cols[1] != "") { + rooms = strings.Split(strings.Split(cols[1], " ")[0], ",") + } else { + rooms = []string{} + for room := range daemon.rooms { + rooms = append(rooms, room) + } + } + sort.Strings(rooms) + for _, room := range rooms { + r, found := daemon.rooms[room] + if found { + client.ReplyNicknamed("322", room, fmt.Sprintf("%d", len(r.members)), r.topic) + } + } + client.ReplyNicknamed("323", "End of LIST") +} + +// Unregistered client workflow processor. Unregistered client: +// * is not PINGed +// * only QUIT, NICK and USER commands are processed +// * other commands are quietly ignored +// When client finishes NICK/USER workflow, then MOTD and LUSERS are send to him. +func (daemon *Daemon) ClientRegister(client *Client, command string, cols []string) { + switch command { + case "NICK": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyParts("431", "No nickname given") + return + } + nickname := strings.ToLower(cols[1]) + nickname_found := false + for client := range daemon.clients { + if client.nickname == nickname { + nickname_found = true + } + } + if nickname_found { + client.ReplyParts("433", "*", cols[1], "Nickname is already in use") + return + } + if ok, _ := regexp.MatchString("^[^_-][_a-z0-9-]{1,50}$", nickname); !ok { + client.ReplyParts("432", "*", cols[1], "Erroneous nickname") + } + client.nickname = nickname + case "USER": + if len(cols) == 1 { + client.ReplyNotEnoughParameters("USER") + return + } + args := strings.SplitN(cols[1], " ", 4) + if len(args) < 4 { + client.ReplyNotEnoughParameters("USER") + return + } + client.username = args[0] + client.realname = strings.TrimLeft(args[3], ":") + } + if client.nickname != "*" && client.username != "" { + client.registered = true + client.ReplyNicknamed("001", "Hi, welcome to IRC") + client.ReplyNicknamed("002", "Your host is "+daemon.hostname+", running goircd") + client.ReplyNicknamed("003", "This server was created sometime") + client.ReplyNicknamed("004", daemon.hostname+" goircd o o") + daemon.SendLusers(client) + daemon.SendMotd(client) + } +} + +// Register new room in Daemon. Create an object, events sink, save pointers +// to corresponding daemon's places and start room's processor goroutine. +func (daemon *Daemon) RoomRegister(name string) (*Room, chan ClientEvent) { + room_new := NewRoom(daemon.hostname, name, daemon.log_sink, daemon.state_sink) + room_sink := make(chan ClientEvent) + daemon.rooms[name] = room_new + daemon.room_sinks[room_new] = room_sink + go room_new.Processor(room_sink) + return room_new, room_sink +} + +func (daemon *Daemon) HandlerJoin(client *Client, cmd string) { + args := strings.Split(cmd, " ") + rooms := strings.Split(args[0], ",") + var keys []string + if len(args) > 1 { + keys = strings.Split(args[1], ",") + } else { + keys = []string{} + } + for n, room := range rooms { + room, valid := RoomNameSanitize(room) + if !valid { + client.ReplyNoChannel(room) + continue + } + var key string + if (n < len(keys)) && (keys[n] != "") { + key = keys[n] + } else { + key = "" + } + denied := false + joined := false + for room_existing, room_sink := range daemon.room_sinks { + if room == room_existing.name { + if (room_existing.key != "") && (room_existing.key != key) { + denied = true + } else { + room_sink <- ClientEvent{client, EVENT_NEW, ""} + joined = true + } + break + } + } + if denied { + client.ReplyNicknamed("475", room, "Cannot join channel (+k) - bad key") + continue + } + if denied || joined { + continue + } + room_new, room_sink := daemon.RoomRegister(room) + if key != "" { + room_new.key = key + } + room_sink <- ClientEvent{client, EVENT_NEW, ""} + } +} + +func (daemon *Daemon) Processor(events chan ClientEvent) { + for event := range events { + + // Check for clients aliveness + now := time.Now() + if daemon.last_aliveness_check.Add(ALIVENESS_CHECK).Before(now) { + for c := range daemon.clients { + if c.timestamp.Add(PING_TIMEOUT).Before(now) { + log.Println(c, "ping timeout") + c.conn.Close() + continue + } + if !c.ping_sent && c.timestamp.Add(PING_THRESHOLD).Before(now) { + if c.registered { + c.Msg("PING :" + daemon.hostname) + c.ping_sent = true + } else { + log.Println(c, "ping timeout") + c.conn.Close() + } + } + } + daemon.last_aliveness_check = now + } + + client := event.client + switch event.event_type { + case EVENT_NEW: + daemon.clients[client] = true + case EVENT_DEL: + delete(daemon.clients, client) + for _, room_sink := range daemon.room_sinks { + room_sink <- event + } + case EVENT_MSG: + cols := strings.SplitN(event.text, " ", 2) + command := strings.ToUpper(cols[0]) + log.Println(client, "command", command) + if command == "QUIT" { + delete(daemon.clients, client) + client.conn.Close() + continue + } + if !client.registered { + go daemon.ClientRegister(client, command, cols) + continue + } + switch command { + case "AWAY": + continue + case "JOIN": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyNotEnoughParameters("JOIN") + continue + } + go daemon.HandlerJoin(client, cols[1]) + case "LIST": + daemon.SendList(client, cols) + case "LUSERS": + go daemon.SendLusers(client) + case "MODE": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyNotEnoughParameters("MODE") + continue + } + cols = strings.SplitN(cols[1], " ", 2) + if cols[0] == client.username { + if len(cols) == 1 { + client.Msg("221 " + client.nickname + " +") + } else { + client.ReplyNicknamed("501", "Unknown MODE flag") + } + continue + } + room, _ := RoomNameSanitize(cols[0]) + r, found := daemon.rooms[room] + if !found { + client.ReplyNoChannel(room) + continue + } + if len(cols) == 1 { + daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, ""} + } else { + daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, cols[1]} + } + case "MOTD": + go daemon.SendMotd(client) + case "PART": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyNotEnoughParameters("PART") + continue + } + for _, room := range strings.Split(cols[1], ",") { + room, _ = RoomNameSanitize(room) + r, found := daemon.rooms[room] + if !found { + client.ReplyNoChannel(room) + } + daemon.room_sinks[r] <- ClientEvent{client, EVENT_DEL, ""} + } + case "PING": + if len(cols) == 1 { + client.ReplyNicknamed("409", "No origin specified") + continue + } + client.Reply(fmt.Sprintf("PONG %s :%s", daemon.hostname, cols[1])) + case "PONG": + continue + case "NOTICE", "PRIVMSG": + if len(cols) == 1 { + client.ReplyNicknamed("411", "No recipient given") + continue + } + cols = strings.SplitN(cols[1], " ", 2) + if len(cols) == 1 { + client.ReplyNicknamed("412", "No text to send") + continue + } + msg := "" + target := strings.ToLower(cols[0]) + for c := range daemon.clients { + if c.nickname == target { + msg = fmt.Sprintf(":%s %s %s :%s", client, command, c.nickname, cols[1]) + c.Msg(msg) + break + } + } + if msg != "" { + continue + } + target, _ = RoomNameSanitize(target) + r, found := daemon.rooms[target] + if !found { + client.ReplyNicknamed("401", target, "No such nickname/channel") + } + daemon.room_sinks[r] <- ClientEvent{client, EVENT_MSG, command + " " + strings.TrimLeft(cols[1], ":")} + case "TOPIC": + if len(cols) == 1 { + client.ReplyNotEnoughParameters("TOPIC") + continue + } + cols = strings.SplitN(cols[1], " ", 2) + room, _ := RoomNameSanitize(cols[0]) + r, found := daemon.rooms[room] + if !found { + client.ReplyNoChannel(room) + } + var change string + if len(cols) > 1 { + change = cols[1] + } else { + change = "" + } + daemon.room_sinks[r] <- ClientEvent{client, EVENT_TOPIC, change} + case "WHO": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyNotEnoughParameters("WHO") + continue + } + room, _ := RoomNameSanitize(strings.Split(cols[1], " ")[0]) + r, found := daemon.rooms[room] + if !found { + client.ReplyNoChannel(room) + } + daemon.room_sinks[r] <- ClientEvent{client, EVENT_WHO, ""} + case "WHOIS": + if len(cols) == 1 || len(cols[1]) < 1 { + client.ReplyNotEnoughParameters("WHOIS") + continue + } + cols := strings.Split(cols[1], " ") + nicknames := strings.Split(cols[len(cols)-1], ",") + go daemon.SendWhois(client, nicknames) + default: + client.ReplyNicknamed("421", command, "Unknown command") + } + } + } +} diff --git a/daemon_test.go b/daemon_test.go new file mode 100644 index 0000000..b5f6580 --- /dev/null +++ b/daemon_test.go @@ -0,0 +1,140 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "fmt" + "io/ioutil" + "os" + "strings" + "testing" + "time" +) + +func TestRegistrationWorkflow(t *testing.T) { + daemon := NewDaemon("foohost", "", nil, nil) + events := make(chan ClientEvent) + go daemon.Processor(events) + conn := NewTestingConn() + client := NewClient("foohost", conn) + + events <- ClientEvent{client, EVENT_NEW, ""} + events <- ClientEvent{client, EVENT_MSG, "UNEXISTENT CMD"} + time.Sleep(100) + if len(conn.incoming) > 0 { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "NICK"} + time.Sleep(100) + if (len(conn.incoming) != 1) || (conn.incoming[0] != ":foohost 431 :No nickname given\r\n") { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "NICK meinick"} + time.Sleep(100) + if (len(conn.incoming) != 1) || (client.nickname != "meinick") || client.registered { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "USER"} + time.Sleep(100) + if (len(conn.incoming) != 2) || (conn.incoming[1] != ":foohost 461 meinick USER :Not enough parameters\r\n") { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "USER 1 2 3"} + time.Sleep(100) + if (len(conn.incoming) != 3) || (conn.incoming[2] != ":foohost 461 meinick USER :Not enough parameters\r\n") { + t.Fail() + } + + daemon.SendLusers(client) + if !strings.Contains(conn.incoming[len(conn.incoming)-1], "There are 0 users") { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "USER 1 2 3 :4 5"} + time.Sleep(100) + if (len(conn.incoming) < 4) || (client.username != "1") || (client.realname != "4 5") { + t.Fail() + } + + statuses := map[int]bool{1: false, 2: false, 3: false, 4: false, 251: false, 422: false} + for _, msg := range conn.incoming { + for k, _ := range statuses { + if strings.HasPrefix(msg, fmt.Sprintf(":foohost %03d", k)) { + statuses[k] = true + } + } + } + for _, v := range statuses { + if !v { + t.Fail() + } + } + if !client.registered { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "UNEXISTENT CMD"} + time.Sleep(100) + if conn.incoming[len(conn.incoming)-1] != ":foohost 421 meinick UNEXISTENT :Unknown command\r\n" { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "AWAY"} + time.Sleep(100) + if conn.incoming[len(conn.incoming)-1] == ":foohost 421 meinick AWAY :Unknown command\r\n" { + t.Fail() + } + + daemon.SendLusers(client) + if !strings.Contains(conn.incoming[len(conn.incoming)-1], "There are 1 users") { + t.Fail() + } + + events <- ClientEvent{client, EVENT_MSG, "QUIT"} + time.Sleep(100) + if !conn.closed { + t.Fail() + } +} + +func TestMotd(t *testing.T) { + fd, err := ioutil.TempFile("", "motd") + if err != nil { + t.Fatal("can not create temporary file") + } + defer os.Remove(fd.Name()) + fd.Write([]byte("catched\n")) + daemon := NewDaemon("foohost", fd.Name(), nil, nil) + conn := NewTestingConn() + client := NewClient("foohost", conn) + + daemon.SendMotd(client) + catched := false + for _, msg := range conn.incoming { + if strings.Contains(msg, "372 * :- catched") { + catched = true + } + } + if !catched { + t.Fail() + } +} diff --git a/events.go b/events.go new file mode 100644 index 0000000..6fdf1e7 --- /dev/null +++ b/events.go @@ -0,0 +1,109 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "fmt" + "log" + "os" + "path" + "time" +) + +const ( + EVENT_NEW = iota + EVENT_DEL = iota + EVENT_MSG = iota + EVENT_TOPIC = iota + EVENT_WHO = iota + EVENT_MODE = iota + FORMAT_MSG = "[%s] <%s> %s\n" + FORMAT_META = "[%s] * %s %s\n" +) + +// Client events going from each of client +// They can be either NEW, DEL or unparsed MSG +type ClientEvent struct { + client *Client + event_type int + text string +} + +func (m ClientEvent) String() string { + return string(m.event_type) + ": " + m.client.String() + ": " + m.text +} + +// Logging in-room events +// Intended to tell when, where and who send a message or meta command +type LogEvent struct { + where string + who string + what string + meta bool +} + +// Logging events logger itself +// Each room's events are written to separate file in logdir +// Events include messages, topic and keys changes, joining and leaving +func Logger(logdir string, events chan LogEvent) { + mode := os.O_CREATE | os.O_WRONLY | os.O_APPEND + perm := os.FileMode(0660) + var format string + for event := range events { + logfile := path.Join(logdir, event.where) + fd, err := os.OpenFile(logfile, mode, perm) + if err != nil { + log.Println("Can not open logfile", logfile, err) + continue + } + if event.meta { + format = FORMAT_META + } else { + format = FORMAT_MSG + } + _, err = fd.WriteString(fmt.Sprintf(format, time.Now(), event.who, event.what)) + fd.Close() + if err != nil { + log.Println("Error writing to logfile", logfile, err) + } + } +} + +type StateEvent struct { + where string + topic string + key string +} + +// Room state events saver +// Room states shows that either topic or key has been changed +// Each room's state is written to separate file in statedir +func StateKeeper(statedir string, events chan StateEvent) { + mode := os.O_CREATE | os.O_TRUNC | os.O_WRONLY + perm := os.FileMode(0660) + for event := range events { + state_path := path.Join(statedir, event.where) + fd, err := os.OpenFile(state_path, mode, perm) + if err != nil { + log.Println("Can not open statefile", state_path, err) + continue + } + fd.WriteString(event.topic + "\n" + event.key + "\n") + fd.Close() + } +} diff --git a/goircd.go b/goircd.go new file mode 100644 index 0000000..824b5f0 --- /dev/null +++ b/goircd.go @@ -0,0 +1,121 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "bytes" + "flag" + "log" + "net" + "os" + "path" + "path/filepath" + "strings" +) + +var ( + hostname = flag.String("hostname", "localhost", "Hostname") + bind = flag.String("bind", ":6667", "Address to bind to") + motd = flag.String("motd", "", "Path to MOTD file") + logdir = flag.String("logdir", "", "Absolute path to directory for logs") + statedir = flag.String("statedir", "", "Absolute path to directory for states") +) + +func Run() { + var client *Client + events := make(chan ClientEvent) + log.SetFlags(log.Ldate | log.Lmicroseconds | log.Lshortfile) + + log_sink := make(chan LogEvent) + if *logdir == "" { + // Dummy logger + go func() { + for { + <-log_sink + } + }() + } else { + if !path.IsAbs(*logdir) { + log.Fatalln("Need absolute path for logdir") + return + } + go Logger(*logdir, log_sink) + log.Println(*logdir, "logger initialized") + } + + state_sink := make(chan StateEvent) + daemon := NewDaemon(*hostname, *motd, log_sink, state_sink) + if *statedir == "" { + // Dummy statekeeper + go func() { + for { + <-state_sink + } + }() + } else { + if !path.IsAbs(*statedir) { + log.Fatalln("Need absolute path for statedir") + } + states, err := filepath.Glob(*statedir + "/#*") + if err != nil { + log.Fatalln("Can not read statedir", err) + } + for _, state := range states { + fd, err := os.Open(state) + if err != nil { + log.Fatalln("Can not open state", state, err) + } + buf := make([]byte, 1024) + _, err = fd.Read(buf) + fd.Close() + if err != nil { + log.Fatalln("Can not read state", state, err) + } + room, _ := daemon.RoomRegister(path.Base(state)) + buf = bytes.TrimRight(buf, "\x00") + contents := strings.Split(string(buf), "\n") + room.topic = contents[0] + room.key = contents[1] + log.Println("Loaded state for room", room.name) + } + go StateKeeper(*statedir, state_sink) + log.Println(*statedir, "statekeeper initialized") + } + + listener, err := net.Listen("tcp", *bind) + if err != nil { + log.Fatalln("Can not listen on ", *bind) + } + log.Println("Listening on", *bind) + + go daemon.Processor(events) + for { + conn, err := listener.Accept() + if err != nil { + log.Println("Error during accepting connection", err) + continue + } + client = NewClient(*hostname, conn) + go client.Processor(events) + } +} + +func main() { + flag.Parse() + Run() +} diff --git a/room.go b/room.go new file mode 100644 index 0000000..f58d708 --- /dev/null +++ b/room.go @@ -0,0 +1,168 @@ +/* +goircd -- minimalistic simple Internet Relay Chat (IRC) server +Copyright (C) 2014 Sergey Matveev + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program 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 General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +package main + +import ( + "fmt" + "log" + "regexp" + "sort" + "strings" +) + +// Sanitize room's name. It can consist of 1 to 50 ASCII symbols +// with some exclusions. All room names will have "#" prefix. +func RoomNameSanitize(name string) (n string, valid bool) { + n = strings.TrimLeft(strings.ToLower(name), "&#+!") + valid, _ = regexp.MatchString("^[^\x00\x07\x0a\x0d ,:/]{1,50}$", n) + return "#" + n, valid +} + +type Room struct { + name string + topic string + key string + members map[*Client]bool + hostname string + log_sink chan LogEvent + state_sink chan StateEvent +} + +func NewRoom(hostname, name string, log_sink chan LogEvent, state_sink chan StateEvent) *Room { + room := Room{name: name} + room.members = make(map[*Client]bool) + room.topic = "" + room.key = "" + room.hostname = hostname + room.log_sink = log_sink + room.state_sink = state_sink + return &room +} + +func (room *Room) SendTopic(client *Client) { + if room.topic == "" { + client.ReplyNicknamed("331", room.name, "No topic is set") + } else { + client.ReplyNicknamed("332", room.name, room.topic) + } +} + +// Send message to all room's subscribers, possibly excluding someone +func (room *Room) Broadcast(msg string, client_to_ignore ...*Client) { + for member := range room.members { + if (len(client_to_ignore) > 0) && member == client_to_ignore[0] { + continue + } + member.Msg(msg) + } +} + +func (room *Room) StateSave() { + room.state_sink <- StateEvent{room.name, room.topic, room.key} +} + +func (room *Room) Processor(events chan ClientEvent) { + var client *Client + for event := range events { + client = event.client + switch event.event_type { + case EVENT_NEW: + room.members[client] = true + log.Println(client, "joined", room.name) + room.SendTopic(client) + go room.Broadcast(fmt.Sprintf(":%s JOIN %s", client, room.name)) + room.log_sink <- LogEvent{room.name, client.nickname, "joined", true} + nicknames := []string{} + for member := range room.members { + nicknames = append(nicknames, member.nickname) + } + sort.Strings(nicknames) + client.ReplyNicknamed("353", "=", room.name, strings.Join(nicknames, " ")) + client.ReplyNicknamed("366", room.name, "End of NAMES list") + case EVENT_DEL: + if _, subscribed := room.members[client]; !subscribed { + client.ReplyNicknamed("442", room.name, "You are not on that channel") + continue + } + delete(room.members, client) + msg := fmt.Sprintf(":%s PART %s :%s", client, room.name, client.nickname) + go room.Broadcast(msg) + room.log_sink <- LogEvent{room.name, client.nickname, "left", true} + case EVENT_TOPIC: + if _, subscribed := room.members[client]; !subscribed { + client.ReplyParts("442", room.name, "You are not on that channel") + continue + } + if event.text == "" { + go room.SendTopic(client) + continue + } + room.topic = strings.TrimLeft(event.text, ":") + msg := fmt.Sprintf(":%s TOPIC %s :%s", client, room.name, room.topic) + go room.Broadcast(msg) + room.log_sink <- LogEvent{room.name, client.nickname, "set topic to " + room.topic, true} + room.StateSave() + case EVENT_WHO: + for m := range room.members { + client.ReplyNicknamed("352", room.name, m.username, m.conn.RemoteAddr().String(), room.hostname, m.nickname, "H", "0 "+m.realname) + } + client.ReplyNicknamed("315", room.name, "End of WHO list") + case EVENT_MODE: + if event.text == "" { + mode := "+" + if room.key != "" { + mode = mode + "k" + } + client.Msg(fmt.Sprintf("324 %s %s %s", client.nickname, room.name, mode)) + continue + } + if strings.HasPrefix(event.text, "-k") || strings.HasPrefix(event.text, "+k") { + if _, subscribed := room.members[client]; !subscribed { + client.ReplyParts("442", room.name, "You are not on that channel") + continue + } + } else { + client.ReplyNicknamed("472", event.text, "Unknown MODE flag") + continue + } + var msg string + var msg_log string + if strings.HasPrefix(event.text, "+k") { + cols := strings.Split(event.text, " ") + if len(cols) == 1 { + client.ReplyNotEnoughParameters("MODE") + continue + } + room.key = cols[1] + msg = fmt.Sprintf(":%s MODE %s +k %s", client, room.name, room.key) + msg_log = "set channel key to " + room.key + } else if strings.HasPrefix(event.text, "-k") { + room.key = "" + msg = fmt.Sprintf(":%s MODE %s -k", client, room.name) + msg_log = "removed channel key" + } + go room.Broadcast(msg) + room.log_sink <- LogEvent{room.name, client.nickname, msg_log, true} + room.StateSave() + case EVENT_MSG: + sep := strings.Index(event.text, " ") + go room.Broadcast(fmt.Sprintf(":%s %s %s :%s", client, event.text[:sep], room.name, event.text[sep+1:]), client) + room.log_sink <- LogEvent{room.name, client.nickname, event.text[sep+1:], false} + } + } +}