From ff2bc5d0931d4a460d4d74183b6f9dd9394c40a0 Mon Sep 17 00:00:00 2001 From: clsr Date: Wed, 22 Mar 2017 21:07:10 +0100 Subject: Initial commit --- .gitignore | 4 + LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++++++++ config.bash | 86 ++++++ ircbot.bash | 410 ++++++++++++++++++++++++++++ modules/channels.bash | 71 +++++ modules/ctcpversion.bash | 32 +++ modules/example.bash | 69 +++++ modules/ibip.bash | 41 +++ modules/invitejoin.bash | 15 ++ modules/log.bash | 44 ++++ modules/ping.bash | 17 ++ modules/sed.bash | 189 +++++++++++++ 12 files changed, 1652 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 config.bash create mode 100755 ircbot.bash create mode 100644 modules/channels.bash create mode 100644 modules/ctcpversion.bash create mode 100644 modules/example.bash create mode 100644 modules/ibip.bash create mode 100644 modules/invitejoin.bash create mode 100644 modules/log.bash create mode 100644 modules/ping.bash create mode 100644 modules/sed.bash diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d78cd7e --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +ircbot.err +ircbot.log +ircbot.channels +timeout diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -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/config.bash b/config.bash new file mode 100644 index 0000000..18d729d --- /dev/null +++ b/config.bash @@ -0,0 +1,86 @@ +######################################## +# core settings + +# set to non-zero to enable verbose output to stderr +IRCBOT_VERBOSE=1 + +# IRC server address +IRCBOT_HOST=irc.example.net + +# IRC server port +IRCBOT_PORT=6667 + +# bot nick +IRCBOT_NICK=sedbot + +# bot login name +IRCBOT_LOGIN=$IRCBOT_NICK + +# bot realname +IRCBOT_REALNAME=$IRCBOT_NICK + +# list of modules to load (array, note the parentheses) +IRCBOT_MODULES=(ping ctcpversion ibip channels log sed) + +# truncate lines to this many bytes +IRCBOT_MAX_LINE_LENGTH=400 + +# sleep after making connection to the IRC server +IRCBOT_SLEEP_CONNECT=0 + +# sleep before reconnecting on disconnect +IRCBOT_SLEEP_RECONNECT=10 + +# seconds before reconnect if no line is read (set to more than server ping interval) +IRCBOT_READ_TIMEOUT=300 + + +######################################## +# modules/channels + +# path to the list of stored channels +CHANNELS_LIST=./ircbot.channels + + +######################################## +# modules/ctcpversion + +# custom response to CTCP VERSION requests instead of bash version; optional +CTCP_VERSION="$(sed --version 2>&1 | trimrn)" # some seds don't have --version, have to fix? + + +######################################## +# modules/ibip + +# seconds between IBIP responses; optional +IBIP_TIMEOUT=5 + +# custom comment on IBIP response; optional +IBIP_COMMENT="See https://github.com/clsr/sedbot and pretend it's better" + +# set to non-zero to respond to IBIP using NOTICE instead of PRIVMSG; optional +IBIP_NOTICE=0 + + +######################################## +# modules/log + +# log file for IRC protocol traffic; optional +LOG_IRC=./ircbot.log + +# log file for stderr messages; optional +LOG_ERR=./ircbot.err + +# set to non-zero to show IRC output on stdout; optional +LOG_SHOW_IRC=1 + + +######################################## +# modules/sed + +# path to the timeout script; optional, used to prevent DoS regexps +# see https://github.com/pshved/timeout +SED_TIMEOUT_BIN=./timeout + +# amount of memory in kilobytes that a sed process may use when using the timeout script +SED_TIMEOUT_MEM=16386 diff --git a/ircbot.bash b/ircbot.bash new file mode 100755 index 0000000..c50518b --- /dev/null +++ b/ircbot.bash @@ -0,0 +1,410 @@ +#!/bin/bash + + +IRCBOT_VERSION=0.1.0 + + +# Modular IRC bot framework in bash +# +# Modules should be ./modules/*.bash +# +# Run as `bash ircbot.bash path/to/config.bash` + + +# Exposed variables: +# +# IRCBOT_MODULE +# the name of the current module +# +# IRCBOT_VERSION +# the version of the bot +# +# See config.bash for other exposed variables + + +# Exposed functions: +# +# verbose $format $args... +# log a message prefixed with the current module name to stderr (and error +# log if using modules/log); same arguments as printf +# +# parse_source_nick $source +# prints nick from source; returns 1 when no nick +# +# parse_source_user $source +# prints username from source; returns 1 when no username +# +# parse_source_host $source +# prints hostname from source; returns 1 when no hostname +# +# parse_targeted_nick $msg +# prints targeted nick (message prefixed with "nick: " or "nick, ") from a PRIVMSG message +# +# parse_targeted_msg $msg +# prints message part of a targeted message (all but the "nick: " or "nick, " prefix) from a PRIVMSG message +# +# parse_ctcp_command $msg +# prints the CTCP command from a PRIVMSG message; returns 1 if not valid CTCP message +# +# parse_ctcp_message $msg +# prints the CTCP message from a PRIVMSG message; returns 1 if not valid CTCP message +# +# trimrn +# removes all linebreaks and carriage returns from stdin +# +# indexof $haystack $needle +# prints the index of $needle in $haystack or -1 if not found +# +# sendmsg $command $args... +# sends an IRC command; only the last argument may contain spaces +# + + +set -euo pipefail + +IRCBOT_MODULE=ircbot + +_events=(connect disconnect readmsg sendmsg privmsg dm ctcp self_join self_kick self_part self_invite) + +verbose() { + if [ -n "$IRCBOT_VERBOSE" ] && [ "$IRCBOT_VERBOSE" -ne 0 ]; then + printf "[%s] $1\n" "$IRCBOT_MODULE" "${@:2}" >&2 + fi +} + +connect() { + if ! exec 3<>"/dev/tcp/$IRCBOT_HOST/$IRCBOT_PORT"; then + return $? + fi + + if ! sendmsg NICK "$IRCBOT_NICK"; then + return $? + fi + if ! sendmsg USER "$IRCBOT_LOGIN 8 *" "$IRCBOT_REALNAME"; then + return $? + fi + + return 0 +} + + +#nick!login@host +# 1-nick, 2-login, 3-host +_source_regex='^\([^!]\+\)!\([^@]\+\)@\(.*\)$' + +parse_source_nick() { # args: $1 - source + sed "s/$_source_regex/\\1/" <<< "$1" +} + +parse_source_login() { # args: $1 - source + sed "s/$_source_regex/\\2/" <<< "$1" +} + +parse_source_host() { # args: $1 - source + sed "s/$_source_regex/\\3/" <<< "$1" +} + + +_ctcp_regex='^\x01\([A-Za-z]\+\) \?\([^\x01]*\)\x01$' + +parse_ctcp_command() { # args: $1 - PRIVMSG message + local ctcp + ctcp="$(sed "s/$_ctcp_regex/\\U\\1/" <<< "$1")" + if [[ $ctcp != "$1" ]]; then + printf "%s\n" "$ctcp" + return 0 + fi + return 1 +} + +parse_ctcp_message() { # args: $1 - PRIVMSG message + local msg + msg="$(sed "s/$_ctcp_regex/\\2/" <<< "$1")" + if [[ $msg != "$1" ]]; then + printf "%s\n" "$ctcp" + return 0 + fi + return 1 +} + + +_targeted_regex='^\([^ /|,!:]\+\)[:,] \(.\+\)' + +parse_targeted_nick() { # args: $1 - PRIVMSG message + local target + target="$(sed "s/$_targeted_regex/\\1/" <<< "$1")" + if [[ -n $target && $target != "$1" ]]; then + sed : <<< "$target" + return 0 + fi + return 1 +} + +parse_targeted_msg() { # args: $1 - PRIVMSG message + local target + target="$(sed "s/$_targeted_regex/\\2/" <<< "$1")" + if [[ -n $target && $target != "$1" ]]; then + sed : <<< "$target" + return 0 + fi + return 1 +} + + +trimrn() { # no args, put input to stdin + #sed -e 's/\r//g' -e 's/\n//g' -e 1q + tr -d '\r\n' +} + +indexof() { # args: $1 - haystack, $2 - needle + local str search i + str="$1" + search="$2" + + i=0; + while :; do + if ((i >= ${#str})); then + i=-1 + break + fi + if [[ ${str:$i:1} == "$search" ]]; then + break + fi + ((i++)) + done + + echo "$i" +} + + +sendmsg() { # args: $1 - command, $2... - args (any number) + local msg oldifs cmd args + msg="$(sed 's/.*/\U&/' <<< "$1")" + cmd="$msg" + shift + args=("$@") + if [[ $# -gt 1 ]]; then + oldifs="$IFS" + IFS=' ' + msg="$msg ${*:1:(($#-1))}" + IFS="$oldifs" + shift $(($#-1)) + fi + if [[ $# -gt 0 ]]; then + msg="$msg :$1" + fi + msg="$(trimrn <<< "$msg" | sed 's/^\(.\{,'"$IRCBOT_MAX_LINE_LENGTH"'\}\).*/\1/')" + if ! _trigger sendmsg "$msg" "$cmd" "${args[@]}"; then + return $? + fi + printf "%s\r\n" "$msg" >&3 + return $? +} + +_readmsg() { + local line + IFS= read -r -u 3 -t "${IRCBOT_READ_TIMEOUT:-300}" line + success=$? + printf "%s\n" "$line" | trimrn + return $success +} + + +_readloop() { + local orig msg src cmd args pos + + while :; do + if ! msg="$(_readmsg)"; then + verbose 'disconnected from server' + return 1 + fi + + orig="$msg" + + # has source? + src= + if [[ ${msg:0:1} == : ]]; then + pos="$(indexof "$msg" ' ')" + if [[ $pos -lt 0 ]]; then + return 1 + fi + src="${msg:1:$pos}" + ((++pos)) + msg="${msg:$pos}" + fi + + # grab the command + pos="$(indexof "$msg" ' ')" + if [[ $pos -lt 0 ]]; then + cmd="$msg" + msg= + else + cmd="${msg:0:$pos}" + ((++pos)) + msg="${msg:$pos}" + fi + + # parse args, ending when no more spaces or on last arg starting with : + args=() + while :; do + if [[ ${msg:0:1} = : ]]; then + args+=("${msg:1}") + break + fi + pos="$(indexof "$msg" ' ')" + if [[ $pos -lt 0 ]]; then + args+=("$msg") + break + fi + args+=("${msg:0:$pos}") + ((++pos)) + msg="${msg:$pos}" + done + + #printf "raw: '%s'\n" "$orig" + #printf "source: '%s'\n" "$src" + #printf "nick: '%s'\n" "$(parse_source_nick "$src")" + #printf "command: '%s'\n" "$cmd" + #printf "args:\n" + #printf " %s\n" "${args[@]}" + #echo + + + _handle_msg "$orig" "$src" "$cmd" "${args[@]}" + done +} + +_handle_msg() { # args: $1 - raw message, $2 - source, $3 - command, $4... - args + local orig src cmd args nick where who why msg ctcp + orig="$1" + src="$2" + cmd="$3" + args=("${@:4}") + + + _trigger readmsg "$orig" "$src" "$cmd" "${args[@]}" + + + # XXX sometimes, you have to respond to a PING before registering + if [[ $_pre_register != 0 && $cmd != NOTICE && $cmd != PING ]]; then + _pre_register=0 + _trigger connect + fi + + + + case "$cmd" in + JOIN) + nick="$(parse_source_nick "$src")" + where="${args[0]:-}" + if [[ $nick == "$IRCBOT_NICK" ]]; then + _trigger self_join "$where" + fi + ;; + + KICK) + nick="$(parse_source_nick "$src")" + who="${args[0]}" + where="${args[1]}" + why="${args[2]:-}" + if [[ $who == "$IRCBOT_NICK" ]]; then + _trigger self_kick "$src" "$where" "$why" + fi + ;; + + PART) + nick="$(parse_source_nick "$src")" + where="${args[0]}" + why="${args[1]:-}" + if [[ $nick == "$IRCBOT_NICK" ]]; then + _trigger self_part "$where" "$why" + fi + ;; + + INVITE) + nick="$(parse_source_nick "$src")" + who="${args[0]}" + where="${args[1]}" + if [[ $who == "$IRCBOT_NICK" ]]; then + _trigger self_invite "$src" "$where" + fi + ;; + + 433) + verbose 'nick %s is already taken' "$IRCBOT_NICK" + #exit 1 + return # as if disconnected + ;; + + PRIVMSG) + where="${args[0]}" + msg="${args[1]}" + + _trigger privmsg "$src" "$where" "$msg" + + if [[ $where == "$IRCBOT_NICK" ]]; then + _trigger dm "$src" "$msg" + + if ctcp="$(parse_ctcp_command "$msg")"; then + _trigger ctcp "$src" "$ctcp" "$(parse_ctcp_message "$msg")" + fi + fi + ;; + esac + +} + +_trigger() { # args: $1 - event, $2... - event args + local mod ev fn ret + ev="$1" + shift + ret=0 + for mod in "${IRCBOT_MODULES[@]}"; do + fn="_module_${mod}_on_${ev}" + if declare -F "$fn" >/dev/null; then + IRCBOT_MODULE="$mod" + if ! "$fn" "$@"; then + ret=$? + fi + IRCBOT_MODULE=ircbot + fi + done + return "$ret" +} + +_load_modules() { + local mod ev + for mod in "${IRCBOT_MODULES[@]}"; do + IRCBOT_MODULE="$mod" + source "modules/$mod.bash" + IRCBOT_MODULE=ircbot + verbose "sourced module %s" "$mod" + for ev in "${_events[@]}"; do + if declare -F "on_${ev}" >/dev/null; then + # this is kinda evil + eval "$(echo "_module_${mod}_on_${ev}()"; declare -f "on_${ev}" | tail -n +2)" + unset -f "on_${ev}" + verbose "module %s installed handler %s" "$mod" "$ev" + fi + done + done +} + +_main() { # args: $1 - config file + source "$1" + _load_modules + while :; do + if connect; then + #_trigger connect + verbose 'connected' + sleep "${IRCBOT_SLEEP_CONNECT:-0}" + _pre_register=1 + _readloop + fi + _trigger disconnect + verbose 'reconnecting in %d seconds...' "${IRCBOT_SLEEP_RECONNECT:-10}" + sleep "${IRCBOT_SLEEP_RECONNECT:-10}" + done +} + +_main "$@" diff --git a/modules/channels.bash b/modules/channels.bash new file mode 100644 index 0000000..04c8a3b --- /dev/null +++ b/modules/channels.bash @@ -0,0 +1,71 @@ +# modules/channels.bash +# +# Provides persistant storage of channels the bot is in. +# +# Settings: +# CHANNELS_LIST: file to store channel list in + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +channels_list=() + + +# joins channels in the list after connecting +on_connect() { # no args + local ch + channels_load + for ch in "${channels_list[@]}"; do + sendmsg JOIN "$ch" + done +} + +# adds a joined channel to the list +on_self_join() { # args: $1 - channel + channels_add "$1" +} + +# removes a channel from the list +on_self_kick() { # args: $1 - source, $2 - channel, $3 - kick message + channels_remove "$2" +} + +# removes a channel from the list +on_self_part() { # args: $1 - channel, $2 - part message + channels_remove "$1" +} + + +channels_load() { # no args + local line + channels_list=() + if [ -f "$CHANNELS_LIST" ]; then + while IFS= read -r line || [ -n "$line" ]; do + verbose 'loaded channel %s' "$line" + channels_list+=("$line") + done < "$CHANNELS_LIST" + fi +} + +channels_add() { # args: $1 - channel + channels_load + verbose 'adding channel %s' "$1" + channels_list+=("$1") + channels_dump +} + +channels_remove() { # args: $1 - channel + channels_load + verbose 'removing channel %s' "$1" + printf "%s\n" "${channels_list[@]}" | grep -xvF "$1" > "$CHANNELS_LIST" # XXX: ugly hack + channels_load +} + +channels_dump() { + verbose 'dumping channel list: %s' "${channels_list[*]}" + printf "%s\n" "${channels_list[@]}" | sort | uniq > "$CHANNELS_LIST" +} diff --git a/modules/ctcpversion.bash b/modules/ctcpversion.bash new file mode 100644 index 0000000..092013b --- /dev/null +++ b/modules/ctcpversion.bash @@ -0,0 +1,32 @@ +# modules/ctcpversion.bash +# +# Responds to CTCP VERSION direct message requests. +# +# Settings: +# CTCP_VERSION: response to the CTCP VERSION request; optional, defaults to bash version + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +# respond to CTCP VERSION requests +on_ctcp() { # args: $1 - source, $2 - CTCP command, $3 - CTCP argument + local version interpreter + if [[ $2 == VERSION ]]; then + if [[ -n ${CTCP_VERSION:-} ]]; then + version="$CTCP_VERSION" + else + interpreter=sh # I should make it actually find out which interpreter it's running if it's not bash or zsh; also, fails on dash as it lacks --version + if [ "$BASH_VERSION" ]; then + interpreter=bash + elif [ "$ZSH_VERSION" ]; then + interpreter=zsh + fi + version="$("$interpreter" --version 2>&1 | sed 1q)" + fi + sendmsg NOTICE "$(parse_source_nick "$1")" "$(sed 's/^.*$/\x01&\x01/' <<< "VERSION $version")" + fi +} diff --git a/modules/example.bash b/modules/example.bash new file mode 100644 index 0000000..1893722 --- /dev/null +++ b/modules/example.bash @@ -0,0 +1,69 @@ +# modules/example.bash +# +# Provides example handlers for an ircbot.bash module. +# This file is sourced by ircbot.bash when the module is loaded. +# Any handlers may be omitted in modules if they're not used. +# If an event matches multiple handlers, they're all called (e.g. on_readmsg is +# always called alongside on_privmsg). +# +# Global variables: +# +# IRCBOT_HOST: IRC server address +# IRCBOT_PORT: IRC server port +# IRCBOT_NICK: bot nick +# IRCBOT_LOGIN: bot login name +# IRCBOT_REALNAME: bot realname +# IRCBOT_MODULE: current module the bot is running + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +# on_connect is called when the bot connects (or reconnects) to the server +on_connect() { # no args +} + +# on_disconnect is called when the bot disconnects from the server +on_disconnect() { # no args +} + +# on_readmsg is called whenever a message is read from the IRC server +on_readmsg() { # args: $1 - raw message, $2 - source, $3 - command, $4... - args +} + +# on_sendmsg is called whenever sendmsg is used to send IRC messages +# If it returns non-zero, the sendmsg itself is aborted. +# Be careful not to create infinite sendmsg/on_sendmsg loops. +on_sendmsg() { # args: $1 - raw message, $2 - command, $3... - args +} + +# on_privmsg is called whenever a PRIVMSG is received +on_privmsg() { # args: $1 - source, $2 - channel/target, $3 - message +} + +# on_dm is called whenever a PRIVMSG direct (not channel) message is received +on_dm() { # args: $1 - source, $2 - message +} + +# on_ctcp is called whenever a CTCP PRIVMSG direct (not channel) message is received +on_ctcp() { # args: $1 - source, $2 - CTCP command, $3 - CTCP argument +} + +# on_self_join is called whenever the bot successfully joins a channel +on_self_join() { # args: $1 - channel +} + +# on_self_kick is called whnever the bot is kicked from a channel +on_self_kick() { # args: $1 - source, $2 - channel, $3 - kick message +} + +# on_self_part is called whenever the bot parts a channel +on_self_part() { # args: $1 - channel, $2 - part message +} + +# on_self_invite is called whenever the bot is invited into a channel +on_self_invite() { # args: $1 - source, $2 - channel +} diff --git a/modules/ibip.bash b/modules/ibip.bash new file mode 100644 index 0000000..13efd0c --- /dev/null +++ b/modules/ibip.bash @@ -0,0 +1,41 @@ +# modules/ibip.bash +# +# Responds to ``.bots'' +# +# Settings: +# IBIP_TIMEOUT: seconds that must pass between IBIP responses; optional +# IBIP_COMMENT: the comment at the end of the IBIP message; optional +# IBIP_NOTICE: set to 1 to respond with NOTICE instead of PRIVMSG; optional + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +ibip_last=0 + +if [[ -z ${IBIP_COMMENT:-} ]]; then + IBIP_COMMENT='See https://git.clsr.net/mbibot' +fi + +# on_privmsg is called whenever a PRIVMSG is received +on_privmsg() { # args: $1 - source, $2 - channel/target, $3 - message + local ts where msgtype + where="$2" + if [[ $where == "$IRCBOT_NICK" ]]; then + where="$(parse_source_nick "$1")" + fi + msgtype=PRIVMSG + if [[ ${IBIP_NOTICE:-0} -ne 0 ]]; then + msgtype=NOTICE + fi + if [[ $3 == ".bots" ]]; then + ts="$(printf '%(%s)T' -1)" + if [[ -z ${IBIP_TIMEOUT:-} ]] || ((ts - ibip_last > IBIP_TIMEOUT)); then + ibip_last="$ts" + sendmsg "$msgtype" "$where" "Reporting in! [bash] $IBIP_COMMENT" + fi + fi +} diff --git a/modules/invitejoin.bash b/modules/invitejoin.bash new file mode 100644 index 0000000..d76d85d --- /dev/null +++ b/modules/invitejoin.bash @@ -0,0 +1,15 @@ +# modules/invitejoin.bash +# +# Joins channels when invited. + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +# joins the channel the bot was invited to +on_self_invite() { # args: $1 - source, $2 - channel + sendmsg JOIN "$2" +} diff --git a/modules/log.bash b/modules/log.bash new file mode 100644 index 0000000..e9fc665 --- /dev/null +++ b/modules/log.bash @@ -0,0 +1,44 @@ +# modules/log.bash +# +# Logs IRC messages and bot debug/error output. +# +# Settings: +# LOG_IRC: log file for IRC protocol traffic +# LOG_ERR: log file for stderr messages +# LOG_SHOW_IRC: set to non-zero to show IRC output on stdout + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +if [[ -n ${LOG_IRC:-} ]]; then + if [[ ${LOG_SHOW_IRC:-0} -ne 0 ]]; then + exec 14> >(tee -a -- "$LOG_IRC") + else + exec 14>>"$LOG_IRC" + fi +elif [[ ${LOG_SHOW_IRC:-0} -ne 0 ]]; then + exec 14>&1 +fi + +if [[ -n ${LOG_ERR:-} ]]; then + exec 2> >(tee -a -- "$LOG_ERR" >&2) +fi + + +# log received messages +on_readmsg() { # args: $1 - raw message, $2 - source, $3 - command, $4... - args + printf "%s <<< %s\n" "$(log_timestamp)" "$1" >&14 +} + +# log sent messages +on_sendmsg() { # args: $1 - raw message, $2 - command, $3... - args + printf "%s >>> %s\n" "$(log_timestamp)" "$1" >&14 +} + +log_timestamp() { + TZ=UTC date -u +%s.%N +} diff --git a/modules/ping.bash b/modules/ping.bash new file mode 100644 index 0000000..ece6a1f --- /dev/null +++ b/modules/ping.bash @@ -0,0 +1,17 @@ +# modules/ping.bash +# +# Responds to IRC PINGs. + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + + +# respond to PINGs +on_readmsg() { # args: $1 - raw message, $2 - source, $3 - command, $4... - args + if [[ $3 == PING ]]; then + sendmsg PONG "${@:4}" + fi +} diff --git a/modules/sed.bash b/modules/sed.bash new file mode 100644 index 0000000..b75a252 --- /dev/null +++ b/modules/sed.bash @@ -0,0 +1,189 @@ +# modules/sed.bash +# +# Provides sedbot. +# +# Settings: +# SED_TIMEOUT_BIN: path to the timeout script¹; optional to prevent regex DoS +# SED_TIMEOUT_MEM: maximum amount of memory (in kilobytes) a sed process may use +# +# ¹: https://github.com/pshved/timeout + + +if [ -z "$IRCBOT_MODULE" ]; then + printf "error: %s is a module for ircbot.bash and should not be run separately\n" "$0" + exit 1 +fi + +declare -g -A sed_messages + +# seds a previous message if instucted to +on_privmsg() { # args: $1 - source, $2 - channel/target, $3 - message + local where nick msg + local targetednick origmsg origkey + local key target fromnick regexed ctcp + + where="$2" + nick="$(parse_source_nick "$1")" + msg="$3" + if [[ $where == "$IRCBOT_NICK" ]]; then + where="$nick" + fi + + # targeted means the message was `` user2: s/foo/bar/'' (targets user2's last message) + origmsg="$msg" + origkey="$where $nick" + if targetednick="$(parse_targeted_nick "$msg")"; then + nick="$targetednick" + msg="$(parse_targeted_msg "$msg")" + fi + + + key="$where $nick" + target="${sed_messages[$key]:-}" + + # handle regexing CTCP ACTIONs properly + ctcp="$(parse_ctcp_command "$target")" || true + if [[ $ctcp == ACTION ]]; then + target="$(parse_ctcp_message "$target")" + fromnick="$(printf "\\x02* %s\\x02" "$nick")" + else + fromnick="<$nick>" + fi + + if regexed="$(sed_replace "$msg" "$target")"; then # if a replacement was done, send it + sendmsg PRIVMSG "$where" "$fromnick $regexed" + else # otherwise, store the triggering message + sed_messages[$origkey]="$origmsg" + fi +} + +sed_replace() { # args: $1 - sed s expression, $2 - text to regex + local msg target + local l pos i p del + local regexps ok t target + + msg="$1" + target="$2" + + del="${msg:1:1}" + if [[ -z $del ]] || [[ $(indexof '/|,!:' "$del") -lt 0 ]]; then + return 1 + fi + + # TODO: rewrite so that only one expression is tokenized at once (allows different delimiters) + + # tokenize + l=() + pos="$(indexof "$msg" "$del")" + while ((pos >= 0)); do + i=0 + ((p=pos-i-1)) + while ((p >= 0)) && [[ ${msg:$p:1} == '\' ]]; do # count \ characters + ((i++)) + ((p=pos-i-1)) + done + if ((i%2 == 0)); then + l+=("${msg:0:$pos}") + ((p=pos+1)) + msg="${msg:$p}" + pos=0 + else + ((pos++)) + fi + p="$(indexof "${msg:$pos}" "$del")" + if ((p >= 0)); then + ((pos+=p)) + else + pos=$p + fi + done + l+=("$msg") + + # l is now an array of the expr separated by unescaped delimiters + + i=0 + regexps=() + ok=1 + + # s/expr1/repl1/opts1 s/expr2/repl2/opts2 s/expr3/repl3 + while ((i < ${#l[@]})); do + # begins with s + if [ "${l[$i]}" != "s" ]; then + break + fi + ((i++)) + + # expr + if ((i >= ${#l[@]})); then + break + fi + exp="${l[$i]}" + ((i++)) + + # repl + if ((i >= ${#l[@]})); then + break + fi + repl="${l[$i]}" + ((i++)) + + # opts + opts='' + if ((i < ${#l[@]})); then + opts="${l[$i]}" + p=0 + while ((p < ${#opts})); do + c="${opts:$p:1}" + if ! [[ $c =~ ^[ig0-9]$ ]]; then # allowed opts are 0-9, i and g + ok=0 + break + fi + ((p++)) + done + if ! ((ok)); then + # multiple regexps per line + if [[ "${opts:$p:1}" == ' ' || "${opts:$p:1}" == ';' ]]; then # expression separators are space and ; + p1=$p + while ((p < ${#opts})); do + if [[ "${opts:$p:1}" != ' ' && "${opts:$p:1}" != ';' ]]; then + break + fi + p=$((p+1)) + done + l[$i]="${opts:$p}" + opts="${opts:0:$p1}" + ok=1 + else + break + fi + fi + fi + + if ((ok)); then + regexps+=("s$del$exp$del$repl$del$opts") + fi + done + + + if ! ((ok)) || ((${#regexps[@]} == 0)); then + return 1 + fi + + t="$target" + for re in "${regexps[@]}"; do + if [[ -n ${SED_TIMEOUT_BIN:-} ]]; then + target="$("$SED_TIMEOUT_BIN" -m "$SED_TIMEOUT_MEM" sed -e "$re" <<< "$target")" + else + target="$(sed -e "$re" <<< "$target")" + fi + done + target="$(trimrn <<< "$target")" + verbose "sed '%s' <<< '%s' >>> '%s'" "$1" "$2" "$target" + if [[ $target != "$t" ]]; then + if [[ -n $target ]]; then + trimrn <<< "$target" + return 0 + fi + fi + return 1 +} -- cgit