diff --git a/.gitignore b/.gitignore index 86b10b3..43ae774 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,3 @@ plugins/mokubot* -plugins/qtbot* -plugins/mjolnir* -plugins/antisquigbot* -profile-pictures *.db -lua-tg -drua-tg tg diff --git a/LICENSE b/LICENSE index 8cdb845..dba13ed 100755 --- a/LICENSE +++ b/LICENSE @@ -1,281 +1,620 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + 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 licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. 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 -this service 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. +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 make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. 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. + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. The precise terms and conditions for copying, distribution and modification follow. - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + TERMS AND CONDITIONS - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". + 0. Definitions. -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. + "This License" refers to version 3 of the GNU Affero General Public License. - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. + "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. - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: + 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) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. + A "covered work" means either the unmodified Program or a work based +on the Program. - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. + 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. - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) + 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. -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. + 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. -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. + 1. Source Code. -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. + 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. - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: + 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. - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, + 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. - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, + 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. - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. + The Corresponding Source for a work in source code form is that +same work. -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. + 2. Basic Permissions. - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. + 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. - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. + 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. - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to + 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. - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or + 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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. +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. -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. + 13. Remote Network Interaction; Use with the GNU General Public License. -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. + 14. Revised Versions of this License. - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero 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 Affero General Public License, you may choose any version ever published +by the Free Software Foundation. - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. + If the Program specifies that a proxy can decide which future +versions of the GNU Affero 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. - NO WARRANTY + 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. - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + 15. Disclaimer of Warranty. - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE 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. + 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 @@ -287,54 +626,36 @@ 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 -convey the exclusion of warranty; and each file should have at least +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. - {description} - Copyright (C) {year} {fullname} + + 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 2 of the License, or + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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. + GNU Affero General Public License for more details. - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + You should have received a copy of the GNU Affero 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 is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision 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, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - {signature of Ty Coon}, 1 April 1989 - Ty Coon, President of Vice - -This 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. + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + 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 AGPL, see +. diff --git a/README.md b/README.md index e2c3dc3..f267680 100755 --- a/README.md +++ b/README.md @@ -5,19 +5,21 @@ The plugin-wielding, multipurpose Telegram bot. otouto is an independently-developed Telegram API bot written in Lua. Originally conceived as a CLI script in February of 2015, otouto has since been open-sourced and migrated to the API, and is being developed to this day. -| The Manual | -|:------------------------------------------------------| -| [Setup](#setup) | -| [Plugins](#plugins) | -| [Control plugins](#control-plugins) | -| [administration.lua](#administrationlua) | -| [Liberbot-related plugins](#liberbot-related-plugins) | -| [List of plugins](#list-of-plugins) | -| [Style](#style) | -| [Contributors](#contributors) | +otouto is free software; you are free to redistribute it and/or modify it under the terms of the GNU Affero General Public License, version 3. See `LICENSE` for details. + +| The Manual | +|:-----------------------------------------| +| [Setup](#setup) | +| [Bindings](#bindings) | +| [Plugins](#plugins) | +| [Control plugins](#control-plugins) | +| [administration.lua](#administrationlua) | +| [List of plugins](#list-of-plugins) | +| [Style](#style) | +| [Contributors](#contributors) | ## Setup -You _must_ have Lua (5.2+), luasocket, luasec, and dkjson installed. You should also have lpeg, though it is not required. It is recommended you install these with LuaRocks. To upload photos and other files, you must have curl installed. To use fortune.lua, you must have fortune installed. +You _must_ have Lua (5.2+), luasocket, luasec, multipart-post, and dkjson installed. You should also have lpeg, though it is not required. It is recommended you install these with LuaRocks. Clone the repository and set the following values in `config.lua`: @@ -45,6 +47,60 @@ Note that certain plugins, such as translate.lua and greetings.lua, will require * * * +## Bindings +Calls to the Telegram bot API are performed with the `bindings.lua` file through the multipart-post library. otouto's bindings file supports all standard API methods and all arguments. Its main function, `bindings.request`, accepts four arguments: `self`, `method`, `parameters`, `file`. (At the very least, `self` should be a table containing `BASE_URL`, which is bot's API endpoint, ending with a slash, eg `https://api.telegram.org/bot123456789:ABCDEFGHIJKLMNOPQRSTUVWXYZ987654321/`.) + +`method` is the name of the API method. `parameters` (optional) is a table of key/value pairs of the method's parameters to be sent with the method. `file` (super-optional) is a table of a single key/value pair, where the key is the name of the parameter and the value is the filename (if these are included in `parameters` instead, otouto will attempt to send the filename as a file ID). + +Additionally, any method can be called as a key in the `bindings` table (for example, `bindings.getMe`). The `bindings.gen` function (which is also the __index function in its metatable) will forward its arguments to `bindings.request` in their proper form. In this way, the following two function calls are equivalent: + +``` +bindings.request( + self, + 'sendMessage', + { + chat_id = 987654321, + text = 'Quick brown fox.', + reply_to_message_id = 54321, + disable_web_page_preview = false, + parse_method = 'Markdown' + } +) + +bindings.sendMessage( + self, + { + chat_id = 987654321, + text = 'Quick brown fox.', + reply_to_message_id = 54321, + disable_web_page_preview = false, + parse_method = 'Markdown' + } +) +``` + +Furthermore, `utilities.lua` provides two "shortcut" functions to mimic the behavior of otouto's old bindings: `send_message` and `send_reply`. `send_message` accepts these arguments: `self`, `chat_id`, `text`, `disable_web_page_preview`, `reply_to_message_id`, `use_markdown`. The following function call is equivalent to the two above: + +``` +utilities.send_message(self, 987654321, 'Quick brown fox.', false, 54321, true) +``` + +Uploading a file for the `sendPhoto` method would look like this: + +``` +bindings.sendPhoto(self, { chat_id = 987654321 }, { photo = 'rarepepe.jpg' } ) +``` + +and using `sendPhoto` with a file ID would look like this: + +``` +bindings.sendPhoto(self, { chat_id = 987654321, photo = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789' } ) +``` + +Upon success, bindings will return the deserialized result from the API. Upon failure, it will return false and the result. In the case of a connection error, it will return two false values. If an invalid method name is given, bindings will throw an exception. This is to mimic the behavior of more conventional bindings as well as to prevent "silent errors". + +* * * + ## Plugins otouto uses a robust plugin system, similar to that of yagop's [Telegram-Bot](http://github.com/yagop/telegram-bot). The aim of the otouto project is to contain any desirable bot feature within one universal bot framework. @@ -67,7 +123,7 @@ Return values from `plugin:action` are optional, but they do effect the flow. If When an action or cron function fails, the exception is caught and passed to the `handle_exception` utilty and is either printed to the console or send to the chat/channel defined in `log_chat` in config.lua. -Interactions with the bot API are straightforward. Every binding function shares the name of the API method (eg `sendMessage`). An additional function, `sendReply`, accepts the `msg` table and a string as an argument, and sends the string as a reply to that message. +Interactions with the bot API are straightforward. See the [Bindings section](#bindings) for details. Several functions used in multiple plugins are defined in utilities.lua. Refer to that file for usage and documentation. @@ -76,13 +132,14 @@ Several functions used in multiple plugins are defined in utilities.lua. Refer t ## Control plugins Some plugins are designed to be used by the bot's owner. Here are some examples, how they're used, and what they do. -| Plugin | Command | Function | -|:--------------|:-----------|:------------------------------------------------| -| control.lua | /reload | Reloads all plugins and configuration. | -| control.lua | /halt | Shuts down the bot after saving the database. | -| blacklist.lua | /blacklist | Blocks people from using the bot. | -| shell.lua | /run | Executes shell commands on the host system. | -| luarun.lua | /lua | Executes Lua commands in the bot's environment. | +| Plugin | Command | Function | +|:--------------|:-----------|:---------------------------------------------------| +| control.lua | /reload | Reloads all plugins and configuration. | +| | /halt | Shuts down the bot after saving the database. | +| | /script | Runs a list a bot commands, separated by newlines. | +| blacklist.lua | /blacklist | Blocks people from using the bot. | +| shell.lua | /run | Executes shell commands on the host system. | +| luarun.lua | /lua | Executes Lua commands in the bot's environment. | * * * @@ -93,7 +150,7 @@ The administration plugin enables self-hosted, single-realm group administration To get started, run `./tg-install.sh`. Note that this script is written for Ubuntu/Debian. If you're running Arch (the only acceptable alternative), you'll have to do it yourself. If that is the case, note that otouto uses the "test" branch of tg, and the AUR package `telegram-cli-git` will not be sufficient, as it does not have support for supergroups yet. -Once the installation is finished, enable `administration.lua` in your config file. **The administration plugin must be loaded before about.lua and blacklist.lua.** You may have reason to change the default TCP port (4567); if that is the case, remember to change it in `tg-launch.sh` as well. Run `./tg-launch.sh` in a separate screen/tmux window. You'll have to enter your phone number and go through the login process the first time. The script is set to restart tg after two seconds, so you'll need to Ctrl+C after exiting. +Once the installation is finished, enable the `administration` plugin in your config file. **The administration plugin must be loaded before the `about` and `blacklist` plugins.** You may have reason to change the default TCP port (4567); if that is the case, remember to change it in `tg-launch.sh` as well. Run `./tg-launch.sh` in a separate screen/tmux window. You'll have to enter your phone number and go through the login process the first time. The script is set to restart tg after two seconds, so you'll need to Ctrl+C after exiting. While tg is running, you may start/reload otouto with administration.lua enabled, and have access to a wide variety of administrative commands and automata. The administration "database" is stored in `administration.json`. To start using otouto to administrate a group (note that you must be the owner (or an administrator)), send `/gadd` to that group. For a list of commands, use `/ahelp`. Below I'll describe various functions now available to you. @@ -107,18 +164,23 @@ While tg is running, you may start/reload otouto with administration.lua enabled | /motd | Returns the message of the day of a group. | 1 | Y | | /link | Returns the link for a group. | 1 | Y | | /kick | Removes the target from the group. | 2 | Y | -| /(un)ban | Bans the target from the group or vice-versa. | 2 | Y | +| /ban | Bans the target from the group. | 2 | Y | +| /unban | Unbans the target from the group. | 2 | Y | +| /setmotd | Sets the message of the day for a group. | 2 | Y | | /changerule | Changes an individual group rule. | 3 | Y | | /setrules | Sets the rules for a group. | 3 | Y | -| /setmotd | Sets the message of the day for a group. | 3 | Y | | /setlink | Sets the link for a group. | 3 | Y | | /alist | Returns a list of administrators. | 3 | Y | | /flags | Returns a list of flags and their states, or toggles one. | 3 | Y | | /antiflood | Configures antiflood (flag 5) settings. | 3 | Y | -| /(de)mod | Promotes a user to a moderator or vice-versa. | 3 | Y | -| /(de)gov | Promotes a user to the governor or vice-versa. | 4 | Y | -| /(un)hammer | Bans a user globally and blacklists him or vice-versa. | 4 | N | -| /(de)admin | Promotes a user to an administrator or vice-versa. | 5 | N | +| /mod | Promotes a user to a moderator. | 3 | Y | +| /demod | Demotes a moderator to a user. | 3 | Y | +| /gov | Promotes a user to the governor. | 4 | Y | +| /degov | Demotes the governor to a user. | 4 | Y | +| /hammer | Blacklists and globally bans a user. | 4 | N | +| /unhammer | Unblacklists and globally bans a user. | 4 | N | +| /admin | Promotes a user to an administrator. | 5 | N | +| /deadmin | Demotes an administrator to a user. | 5 | N | | /gadd | Adds a group to the administrative system. | 5 | N | | /grem | Removes a group from the administrative system. | 5 | Y | | /glist | Returns a list of all administrated groups and their governors. | 5 | N | @@ -132,8 +194,8 @@ Internal commands can only be run within an administrated group. |:-:|:--------------|:------------------------------------------------------------------|:-------| | 0 | Banned | Cannot enter the group(s). | Either | | 1 | User | Default rank. | Local | -| 2 | Moderator | Can kick/ban/unban users. | Local | -| 3 | Governor | Can set rules/motd/link, promote/demote moderators, modify flags. | Local | +| 2 | Moderator | Can kick/ban/unban users. Can set MOTD. | Local | +| 3 | Governor | Can set rules/link, promote/demote moderators, modify flags. | Local | | 4 | Administrator | Can globally ban/unban users, promote/demote governors. | Global | | 5 | Owner | Can add/remove groups, broadcast, promote/demote administrators. | Global | @@ -148,6 +210,7 @@ Obviously, each greater rank inherits the privileges of the lower, positive rank | 3 | antisquig++ | Automatically removes users whose names contain Arabic script or RTL characters. | | 4 | antibot | Prevents bots from being added by non-moderators. | | 5 | antiflood | Prevents flooding by rate-limiting messages per user. | +| 6 | antihammer | Allows globally-banned users to enter a group. | #### antiflood antiflood (flag 5) provides a system of automatic flood protection by removing users who post too much. It is entirely configurable by a group's governor, an administrator, or the bot owner. For each message to a particular group, a user is awarded a certain number of "points". The number of points is different for each message type. When the user reaches 100 points, he is removed. Points are reset each minute. In this way, if a user posts twenty messages within one minute, he is removed. @@ -166,15 +229,7 @@ antiflood (flag 5) provides a system of automatic flood protection by removing u | video | 10 | | sticker | 20 | -* * * - -# Liberbot-related plugins -**Note:** This section may be out of date. The Liberbot-related plugins have not changed in very long time. -Some plugins are only useful when the bot is used in a Liberbot group, like floodcontrol.lua and moderation.lua. - -**floodcontrol.lua** makes the bot compliant with Liberbot's floodcontrol function. When the bot has posted too many messages to a single group in a given period of time, Liberbot will send it a message telling it to cease posting in that group. Here is an example floodcontrol command: -`/floodcontrol {"groupid":987654321,"duration":600}` -The bot will accept these commands from both Liberbot and the configured administrator. +Additionally, antiflood can be configured to automatically ban a user after he has been automatically kicked from a single group a certain number of times in one day. This is configurable as the antiflood value `autoban` and is set to three by default. * * * @@ -186,7 +241,7 @@ The bot will accept these commands from both Liberbot and the configured adminis | about.lua | /about | Returns the about text as configured in config.lua. | | ping.lua | /ping | The simplest plugin ever! | | echo.lua | /echo ‹text› | Repeats a string of text. | -| gSearch.lua | /google ‹query› | Returns Google web results. | /g | +| bing.lua | /bing ‹query› | Returns Bing web results. | /g | | gImages.lua | /images ‹query› | Returns a Google image result. | /i | | gMaps.lua | /location ‹query› | Returns location data from Google Maps. | /loc | | youtube.lua | /youtube ‹query› | Returns the top video result from YouTube. | /yt | @@ -219,6 +274,7 @@ The bot will accept these commands from both Liberbot and the configured adminis | dilbert.lua | /dilbert [date] | Returns a Dilbert strip. | | patterns.lua | /s/‹from›/‹to›/ | Search-and-replace using Lua patterns. | | me.lua | /me | Returns user-specific data stored by the bot. | +| remind.lua | /remind | Reminds a user of something after a duration of minutes. | * * * diff --git a/bindings.lua b/bindings.lua index d960193..5d57f7e 100755 --- a/bindings.lua +++ b/bindings.lua @@ -1,340 +1,78 @@ --- bindings.lua --- Bindings for the Telegram bot API. --- https://core.telegram.org/bots/api +--[[ + bindings.lua (rev. 2016/05/28) + otouto's bindings for the Telegram bot API. + https://core.telegram.org/bots/api + Copyright 2016 topkecleon. Published under the AGPLv3. + + See the "Bindings" section of README.md for usage information. +]]-- local bindings = {} local HTTPS = require('ssl.https') local JSON = require('dkjson') -local URL = require('socket.url') +local ltn12 = require('ltn12') +local MP_ENCODE = require('multipart-post').encode -function bindings.sendRequest(url) - - local dat, res = HTTPS.request(url) - - if not dat then return false, res end - - local tab = JSON.decode(dat) - - if not tab.ok then - return false, tab.description + -- Build and send a request to the API. + -- Expecting self, method, and parameters, where method is a string indicating + -- the API method and parameters is a key/value table of parameters with their + -- values. + -- Returns the table response with success. Returns false and the table + -- response with failure. Returns false and false with a connection error. + -- To mimic old/normal behavior, it errs if used with an invalid method. +function bindings:request(method, parameters, file) + parameters = parameters or {} + for k,v in pairs(parameters) do + parameters[k] = tostring(v) end - - return tab - -end - -function bindings:getMe() - - local url = self.BASE_URL .. '/getMe' - return bindings.sendRequest(url) - -end - -function bindings:getUpdates(offset) - - local url = self.BASE_URL .. '/getUpdates?timeout=20' - - if offset then - url = url .. '&offset=' .. offset + if file and next(file) ~= nil then + local file_type, file_name = next(file) + local file_file = io.open(file_name, 'r') + local file_data = { + filename = file_name, + data = file_file:read('*a') + } + file_file:close() + parameters[file_type] = file_data end - - return bindings.sendRequest(url) - -end - -function bindings:sendMessage(chat_id, text, disable_web_page_preview, reply_to_message_id, use_markdown, disable_notification) - - local url = self.BASE_URL .. '/sendMessage?chat_id=' .. chat_id .. '&text=' .. URL.escape(text) - - if disable_web_page_preview == true then - url = url .. '&disable_web_page_preview=true' + if next(parameters) == nil then + parameters = {''} end - - if reply_to_message_id then - url = url .. '&reply_to_message_id=' .. reply_to_message_id - end - - if use_markdown then - url = url .. '&parse_mode=Markdown' - end - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings:sendReply(msg, text, use_markdown, disable_notification) - - return bindings.sendMessage(self, msg.chat.id, text, true, msg.message_id, use_markdown, disable_notification) - -end - -function bindings:sendChatAction(chat_id, action) - -- Support actions are typing, upload_photo, record_video, upload_video, record_audio, upload_audio, upload_document, find_location - - local url = self.BASE_URL .. '/sendChatAction?chat_id=' .. chat_id .. '&action=' .. action - return bindings.sendRequest(url) - -end - -function bindings:sendLocation(chat_id, latitude, longitude, reply_to_message_id, disable_notification) - - if latitude == 0 then latitude = 0.001 end - if longitude == 0 then longitude = 0.001 end - - local url = self.BASE_URL .. '/sendLocation?chat_id=' .. chat_id .. '&latitude=' .. latitude .. '&longitude=' .. longitude - - if reply_to_message_id then - url = url .. '&reply_to_message_id=' .. reply_to_message_id - end - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings:sendVenue(chat_id, latitude, longitude, title, address, foursquare_id, reply_to_message_id, disable_notification) - - if latitude == 0 then latitude = 0.001 end - if longitude == 0 then longitude = 0.001 end - - local url = self.BASE_URL .. '/sendVenue?chat_id=' .. chat_id .. '&latitude=' .. latitude .. '&longitude=' .. longitude .. '&title=' .. title .. '&address=' .. address - - if foursquare_id then - url = url .. '&foursquare_id=' .. foursquare_id - end - - if reply_to_message_id then - url = url .. '&reply_to_message_id=' .. reply_to_message_id - end - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings.sendContact(chat_id, phone_number, first_name, last_name, reply_to_message_id, disable_notification) - - local url = self.BASE_URL .. '/sendContact?chat_id=' .. chat_id .. '&phone_number=' .. phone_number .. '&first_name=' .. first_name - - if last_name then - url = url .. '&last_name=' .. last_name - end - - if reply_to_message_id then - url = url .. '&reply_to_message_id=' .. reply_to_message_id - end - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings:forwardMessage(chat_id, from_chat_id, message_id, disable_notification) - - local url = self.BASE_URL .. '/forwardMessage?chat_id=' .. chat_id .. '&from_chat_id=' .. from_chat_id .. '&message_id=' .. message_id - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings:kickChatMember(chat_id, user_id) - local url = self.BASE_URL .. '/kickChatMember?chat_id=' .. chat_id .. '&user_id=' .. user_id - return bindings.sendRequest(url) -end - -function bindings:unbanChatMember(chat_id, user_id) - local url = self.BASE_URL .. '/unbanChatMember?chat_id=' .. chat_id .. '&user_id=' .. user_id - return bindings.sendRequest(url) -end - - -- TODO: More of this. - -function bindings:sendPhotoID(chat_id, file_id, caption, reply_to_message_id, disable_notification) - - local url = self.BASE_URL .. '/sendPhoto?chat_id=' .. chat_id .. '&photo=' .. file_id - - if caption then - url = url .. '&caption=' .. URL.escape(caption) - end - - if reply_to_message_id then - url = url .. '&reply_to_message_id=' .. reply_to_message_id - end - - if disable_notification then - url = url .. '&disable_notification=true' - end - - return bindings.sendRequest(url) - -end - -function bindings.curlRequest(curl_command, give_output) - if give_output then - local s = io.popen(curl_command):read('*all') - local tab = JSON.encode(s) - if not tab then return false end - if not tab.ok then - return false, tab.description - end - return tab + local response = {} + local body, boundary = MP_ENCODE(parameters) + local success = HTTPS.request{ + url = self.BASE_URL .. method, + method = 'POST', + headers = { + ["Content-Type"] = "multipart/form-data; boundary=" .. boundary, + ["Content-Length"] = #body, + }, + source = ltn12.source.string(body), + sink = ltn12.sink.table(response) + } + local data = table.concat(response) + if not success then + print(method .. ': Connection error.') + return false, false else - io.popen(curl_command) + local result = JSON.decode(data) + if not result then + return false, false + elseif result.ok then + return result + else + assert(result.description ~= 'Method not found', method .. ': Method not found.') + return false, result + end end end -function bindings:sendPhoto(chat_id, photo, caption, reply_to_message_id, disable_notification) - - local url = self.BASE_URL .. '/sendPhoto' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "photo=@' .. photo .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' +function bindings.gen(_, key) + return function(self, params, file) + return bindings.request(self, key, params, file) end - - if caption then - curl_command = curl_command .. ' -F "caption=' .. caption .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - -end - -function bindings:sendDocument(chat_id, document, reply_to_message_id, disable_notification) - - local url = self.BASE_URL .. '/sendDocument' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "document=@' .. document .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - -end - -function bindings:sendSticker(chat_id, sticker, reply_to_message_id, disable_notification) - - local url = self.BASE_URL .. '/sendSticker' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "sticker=@' .. sticker .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - -end - -function bindings:sendAudio(chat_id, audio, reply_to_message_id, duration, performer, title, disable_notification) - - local url = self.BASE_URL .. '/sendAudio' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "audio=@' .. audio .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' - end - - if duration then - curl_command = curl_command .. ' -F "duration=' .. duration .. '"' - end - - if performer then - curl_command = curl_command .. ' -F "performer=' .. performer .. '"' - end - - if title then - curl_command = curl_command .. ' -F "title=' .. title .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - -end - -function bindings:sendVideo(chat_id, video, reply_to_message_id, duration, caption, disable_notification) - - local url = self.BASE_URL .. '/sendVideo' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "video=@' .. video .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' - end - - if caption then - curl_command = curl_command .. ' -F "caption=' .. caption .. '"' - end - - if duration then - curl_command = curl_command .. ' -F "duration=' .. duration .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - -end - -function bindings:sendVoice(chat_id, voice, reply_to_message_id, duration, disable_notification) - - local url = self.BASE_URL .. '/sendVoice' - - local curl_command = 'curl -s "' .. url .. '" -F "chat_id=' .. chat_id .. '" -F "voice=@' .. voice .. '"' - - if reply_to_message_id then - curl_command = curl_command .. ' -F "reply_to_message_id=' .. reply_to_message_id .. '"' - end - - if duration then - curl_command = curl_command .. ' -F "duration=' .. duration .. '"' - end - - if disable_notification then - curl_command = curl_command .. ' -F "disable_notification=true"' - end - - return bindings.curlRequest(curl_command) - end +setmetatable(bindings, { __index = bindings.gen }) return bindings diff --git a/bot.lua b/bot.lua index 5fd2e95..1d909b1 100755 --- a/bot.lua +++ b/bot.lua @@ -4,7 +4,7 @@ local bot = {} local bindings -- Load Telegram bindings. local utilities -- Load miscellaneous and cross-plugin functions. -bot.version = '3.7' +bot.version = '3.8' function bot:init() -- The function run when the bot is started or reloaded. @@ -13,10 +13,11 @@ function bot:init() -- The function run when the bot is started or reloaded. self.config = require('config') -- Load configuration file. - if self.config.bot_api_key == '' then - error('You did not set your bot token in config.lua!') - end - self.BASE_URL = 'https://api.telegram.org/bot' .. self.config.bot_api_key + assert( + self.config.bot_api_key and self.config.bot_api_key ~= '', + 'You did not set your bot token in config.lua!' + ) + self.BASE_URL = 'https://api.telegram.org/bot' .. self.config.bot_api_key .. '/' -- Fetch bot information. Try until it succeeds. repeat @@ -73,7 +74,7 @@ function bot:on_msg_receive(msg) -- The fn run whenever a message is received. return v.action(self, msg) end) if not success then - bindings.sendReply(self, msg, 'Sorry, an unexpected error occurred.') + utilities.send_reply(self, msg, 'Sorry, an unexpected error occurred.') utilities.handle_exception(self, result, msg.from.id .. ': ' .. msg.text) return end @@ -95,7 +96,7 @@ function bot:run() while self.is_started do -- Start a loop while the bot should be running. - local res = bindings.getUpdates(self, self.last_update+1) -- Get the latest updates! + local res = bindings.getUpdates(self, { timeout=20, offset = self.last_update+1 } ) if res then for _,v in ipairs(res.result) do -- Go through every new message. self.last_update = v.update_id @@ -104,7 +105,7 @@ function bot:run() end end else - print(self.config.errors.connection) + print('Connection error fetching updates.') end if self.last_cron ~= os.date('%M') then -- Run cron jobs every minute. @@ -112,8 +113,8 @@ function bot:run() utilities.save_data(self.info.username..'.db', self.database) -- Save the database. for i,v in ipairs(self.plugins) do if v.cron then -- Call each plugin's cron function, if it has one. - local res, err = pcall(function() v.cron(self) end) - if not res then + local result, err = pcall(function() v.cron(self) end) + if not result then utilities.handle_exception(self, err, 'CRON: ' .. i) end end diff --git a/config.lua b/config.lua index 541a9f0..b790aa1 100755 --- a/config.lua +++ b/config.lua @@ -19,6 +19,8 @@ I am otouto, the plugin-wielding, multipurpose Telegram bot. Send /help to get started. ]], + -- https://datamarket.azure.com/dataset/bing/search + bing_api_key = '', -- http://console.developers.google.com google_api_key = '', -- https://cse.google.com/cse @@ -56,7 +58,6 @@ Send /help to get started. 'whoami', 'nick', 'echo', - 'gSearch', 'gMaps', 'wikipedia', 'hackernews', @@ -74,7 +75,6 @@ Send /help to get started. 'currency', 'cats', 'shout', - 'patterns', -- Put new plugins above this line. 'help', 'greetings' diff --git a/plugins/about.lua b/plugins/about.lua index 8b11ace..f577742 100755 --- a/plugins/about.lua +++ b/plugins/about.lua @@ -1,7 +1,7 @@ local about = {} local bot = require('bot') -local bindings = require('bindings') +local utilities = require('utilities') about.command = 'about' about.doc = '`Returns information about the bot.`' @@ -16,13 +16,13 @@ function about:action(msg) -- other plugins. if msg.forward_from then return end - local output = self.config.about_text .. '\nBased on @otouto v'..bot.version..' by topkecleon.' + local output = self.config.about_text .. '\nBased on otouto v'..bot.version..' by topkecleon.' if (msg.new_chat_participant and msg.new_chat_participant.id == self.info.id) or msg.text_lower:match('^/about') or msg.text_lower:match('^/about@'..self.info.username:lower()) or msg.text_lower:match('^/start') then - bindings.sendMessage(self, msg.chat.id, output, true) + utilities.send_message(self, msg.chat.id, output, true) return end diff --git a/plugins/administration.lua b/plugins/administration.lua index be104fc..c6b00be 100644 --- a/plugins/administration.lua +++ b/plugins/administration.lua @@ -22,7 +22,7 @@ autokick_timer = 0 groups[*].flags[6] = false groups[*].autoban = 3 - groups[*].autokicks = {} + groups[*].autokicks = {}b 1.9.1 - Returned to non-toggled promotions/bans (too many complaints!). @@ -104,7 +104,7 @@ administration.flags = { }, [6] = { name = 'antihammer', - desc = 'Removes the ban on globally-banned users. Note that users hammered in this group will also be banned locally.', + desc = 'Allows globally banned users to enter this group. Note that users hammered in this group will also be banned locally.', short = 'This group does not acknowledge global bans.', enabled = 'This group will no longer remove users for being globally banned.', disabled = 'This group will now remove users for being globally banned.' @@ -412,10 +412,10 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if new_user ~= user and new_user.do_kick then administration.kick_user(self, msg.chat.id, msg.new_chat_participant.id, new_user.reason) if new_user.output then - bindings.sendMessage(self, msg.new_chat_participant.id, new_user.output) + utilities.send_message(self, msg.new_chat_participant.id, new_user.output) end if not new_user.dont_unban and msg.chat.type == 'supergroup' then - bindings.unbanChatMember(self, msg.chat.id, msg.from.id) + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } ) end end @@ -437,16 +437,16 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if user.do_kick then administration.kick_user(self, msg.chat.id, msg.from.id, user.reason) if user.output then - bindings.sendMessage(self, msg.from.id, user.output) + utilities.send_message(self, msg.from.id, user.output) end if not user.dont_unban and msg.chat.type == 'supergroup' then - bindings.unbanChatMember(self, msg.chat.id, msg.from.id) + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } ) end end if msg.new_chat_participant and not new_user.do_kick then local output = administration.get_desc(self, msg.chat.id) - bindings.sendMessage(self, msg.new_chat_participant.id, output, true, nil, true) + utilities.send_message(self, msg.new_chat_participant.id, output, true, nil, true) end -- Last active time for group listing. @@ -489,7 +489,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) else output = '*Groups:*\n' .. output end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -515,10 +515,10 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) end if doc then local output = '*Help for* _' .. input .. '_ :\n```\n' .. doc .. '\n```' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) else local output = 'Sorry, there is no help for that command.\n/ahelp@'..self.info.username - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end else local output = '*Commands for ' .. administration.ranks[rank] .. ':*\n' @@ -528,12 +528,12 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) end end output = output .. 'Arguments: \\[optional]' - if bindings.sendMessage(self, msg.from.id, output, true, nil, true) then + if utilities.send_message(self, msg.from.id, output, true, nil, true) then if msg.from.id ~= msg.chat.id then - bindings.sendReply(self, msg, 'I have sent you the requested information in a private message.') + utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.') end else - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end end end @@ -564,7 +564,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if output == '\n\n' then output = 'There are currently no moderators for this group.' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -579,12 +579,12 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) local output = administration.get_desc(self, msg.chat.id) - if bindings.sendMessage(self, msg.from.id, output, true, nil, true) then + if utilities.send_message(self, msg.from.id, output, true, nil, true) then if msg.from.id ~= msg.chat.id then - bindings.sendReply(self, msg, 'I have sent you the requested information in a private message.') + utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.') end else - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end end }, @@ -613,7 +613,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) else output = 'No rules have been set for ' .. msg.chat.title .. '.' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -630,7 +630,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if group.motd then output = '*MOTD for ' .. msg.chat.title .. ':*\n' .. group.motd end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -647,7 +647,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if group.link then output = '[' .. msg.chat.title .. '](' .. group.link .. ')' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -661,11 +661,11 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) if administration.get_rank(self, msg.from.id) == 5 then - bindings.sendReply(self, msg, 'I can\'t let you do that, '..msg.from.name..'.') + utilities.send_reply(self, msg, 'I can\'t let you do that, '..msg.from.name..'.') else administration.kick_user(self, msg.chat.id, msg.from.id, 'kickme') if msg.chat.type == 'supergroup' then - bindings.unbanChatMember(self, msg.chat.id, msg.from.id) + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = msg.from.id } ) end end end @@ -682,14 +682,14 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif target.rank > 1 then - bindings.sendReply(self, msg, target.name .. ' is too privileged to be kicked.') + utilities.send_reply(self, msg, target.name .. ' is too privileged to be kicked.') else administration.kick_user(self, msg.chat.id, target.id, 'kicked by ' .. msg.from.name) - bindings.sendMessage(self, msg.chat.id, target.name .. ' has been kicked.') + utilities.send_message(self, msg.chat.id, target.name .. ' has been kicked.') if msg.chat.type == 'supergroup' then - bindings.unbanChatMember(self, msg.chat.id, target.id) + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } ) end end end @@ -706,14 +706,14 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif target.rank > 1 then - bindings.sendReply(self, msg, target.name .. ' is too privileged to be banned.') + utilities.send_reply(self, msg, target.name .. ' is too privileged to be banned.') elseif group.bans[target.id_str] then - bindings.sendReply(self, msg, target.name .. ' is already banned.') + utilities.send_reply(self, msg, target.name .. ' is already banned.') else - administration.kick_user(self, msg.chat.id, target.id, ' banned by '..msg.from.name) - bindings.sendReply(self, msg, target.name .. ' has been banned.') + administration.kick_user(self, msg.chat.id, target.id, 'banned by '..msg.from.name) + utilities.send_reply(self, msg, target.name .. ' has been banned.') group.bans[target.id_str] = true end end @@ -730,16 +730,16 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) else if not group.bans[target.id_str] then - bindings.sendReply(self, msg, target.name .. ' is not banned.') + utilities.send_reply(self, msg, target.name .. ' is not banned.') else group.bans[target.id_str] = nil - bindings.sendReply(self, msg, target.name .. ' has been unbanned.') + utilities.send_reply(self, msg, target.name .. ' has been unbanned.') end if msg.chat.type == 'supergroup' then - bindings.unbanChatMember(self, msg.chat.id, target.id) + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } ) end end end @@ -757,7 +757,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) local input = msg.text:match('^/setrules[@'..self.info.username..']*(.+)') if input == ' --' or input == ' ' .. utilities.char.em_dash then group.rules = {} - bindings.sendReply(self, msg, 'The rules have been cleared.') + utilities.send_reply(self, msg, 'The rules have been cleared.') elseif input then group.rules = {} input = utilities.trim(input) .. '\n' @@ -768,9 +768,9 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) i = i + 1 table.insert(group.rules, utilities.trim(l)) end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) else - bindings.sendReply(self, msg, 'Please specify the new rules.') + utilities.send_reply(self, msg, 'Please specify the new rules.') end end }, @@ -808,7 +808,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) output = '*' .. rule_num .. '*. ' .. new_rule end end - bindings.sendReply(self, msg, output, true) + utilities.send_reply(self, msg, output, true) end }, @@ -828,18 +828,18 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) if input then if input == '--' or input == utilities.char.em_dash then group.motd = nil - bindings.sendReply(self, msg, 'The MOTD has been cleared.') + utilities.send_reply(self, msg, 'The MOTD has been cleared.') else input = utilities.trim(input) group.motd = input local output = '*MOTD for ' .. msg.chat.title .. ':*\n' .. input - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end if group.grouptype == 'supergroup' then administration.update_desc(self, msg.chat.id) end else - bindings.sendReply(self, msg, 'Please specify the new message of the day.') + utilities.send_reply(self, msg, 'Please specify the new message of the day.') end end }, @@ -856,13 +856,13 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) local input = utilities.input(msg.text) if input == '--' or input == utilities.char.em_dash then group.link = drua.export_link(msg.chat.id) - bindings.sendReply(self, msg, 'The link has been regenerated.') + utilities.send_reply(self, msg, 'The link has been regenerated.') elseif input then group.link = input local output = '[' .. msg.chat.title .. '](' .. input .. ')' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) else - bindings.sendReply(self, msg, 'Please specify the new link.') + utilities.send_reply(self, msg, 'Please specify the new link.') end end }, @@ -881,7 +881,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) for id,_ in pairs(self.database.administration.admins) do output = output .. administration.mod_format(self, id) end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -906,13 +906,13 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) local status = group.flags[i] or false output = output .. '`[' .. i .. ']` *' .. v.name .. '*` = ' .. tostring(status) .. '`\n• ' .. v.desc .. '\n' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) elseif group.flags[input] == true then group.flags[input] = false - bindings.sendReply(self, msg, administration.flags[input].disabled) + utilities.send_reply(self, msg, administration.flags[input].disabled) else group.flags[input] = true - bindings.sendReply(self, msg, administration.flags[input].enabled) + utilities.send_reply(self, msg, administration.flags[input].enabled) end end }, @@ -927,7 +927,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) if not group.flags[5] then - bindings.sendMessage(self, msg.chat.id, 'antiflood is not enabled. Use `/flag 5` to enable it.', true, nil, true) + utilities.send_message(self, msg.chat.id, 'antiflood is not enabled. Use `/flag 5` to enable it.', true, nil, true) else if not group.antiflood then group.antiflood = JSON.decode(JSON.encode(administration.antiflood)) @@ -952,7 +952,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) end output = output .. 'Users will be banned automatically after *' .. group.autoban .. '* autokicks. Configure this with the *autoban* keyword.' end - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end end }, @@ -968,14 +968,14 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) else if target.rank > 1 then - bindings.sendReply(self, msg, target.name .. ' is already a moderator or greater.') + utilities.send_reply(self, msg, target.name .. ' is already a moderator or greater.') else group.bans[target.id_str] = nil group.mods[target.id_str] = true - bindings.sendReply(self, msg, target.name .. ' is now a moderator.') + utilities.send_reply(self, msg, target.name .. ' is now a moderator.') end if group.grouptype == 'supergroup' then drua.channel_set_admin(msg.chat.id, target.id, 2) @@ -995,13 +995,13 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) else if not group.mods[target.id_str] then - bindings.sendReply(self, msg, target.name .. ' is not a moderator.') + utilities.send_reply(self, msg, target.name .. ' is not a moderator.') else group.mods[target.id_str] = nil - bindings.sendReply(self, msg, target.name .. ' is no longer a moderator.') + utilities.send_reply(self, msg, target.name .. ' is no longer a moderator.') end if group.grouptype == 'supergroup' then drua.channel_set_admin(msg.chat.id, target.id, 0) @@ -1021,15 +1021,15 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) else if group.governor == target.id then - bindings.sendReply(self, msg, target.name .. ' is already the governor.') + utilities.send_reply(self, msg, target.name .. ' is already the governor.') else group.bans[target.id_str] = nil group.mods[target.id_str] = nil group.governor = target.id - bindings.sendReply(self, msg, target.name .. ' is the new governor.') + utilities.send_reply(self, msg, target.name .. ' is the new governor.') end if group.grouptype == 'supergroup' then drua.channel_set_admin(msg.chat.id, target.id, 2) @@ -1050,13 +1050,13 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) else if group.governor ~= target.id then - bindings.sendReply(self, msg, target.name .. ' is not the governor.') + utilities.send_reply(self, msg, target.name .. ' is not the governor.') else group.governor = msg.from.id - bindings.sendReply(self, msg, target.name .. ' is no longer the governor.') + utilities.send_reply(self, msg, target.name .. ' is no longer the governor.') end if group.grouptype == 'supergroup' then drua.channel_set_admin(msg.chat.id, target.id, 0) @@ -1077,11 +1077,11 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif target.rank > 3 then - bindings.sendReply(self, msg, target.name .. ' is too privileged to be globally banned.') + utilities.send_reply(self, msg, target.name .. ' is too privileged to be globally banned.') elseif self.database.blacklist[target.id_str] then - bindings.sendReply(self, msg, target.name .. ' is already globally banned.') + utilities.send_reply(self, msg, target.name .. ' is already globally banned.') else administration.kick_user(self, msg.chat.id, target.id, 'hammered by '..msg.from.name) self.database.blacklist[target.id_str] = true @@ -1097,7 +1097,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) group.bans[target.id_str] = true output = target.name .. ' has been globally and locally banned.' end - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end end }, @@ -1110,15 +1110,18 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) interior = false, doc = 'Removes a global ban. The target may be specified via reply, username, or ID.', - action = function(self, msg, group) + action = function(self, msg) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif not self.database.blacklist[target.id_str] then - bindings.sendReply(self, msg, target.name .. ' is not globally banned.') + utilities.send_reply(self, msg, target.name .. ' is not globally banned.') else self.database.blacklist[target.id_str] = nil - bindings.sendReply(self, msg, target.name .. ' has been globally unbanned.') + utilities.send_reply(self, msg, target.name .. ' has been globally unbanned.') + end + if msg.chat.type == 'supergroup' then + bindings.unbanChatMember(self, { chat_id = msg.chat.id, user_id = target.id } ) end end }, @@ -1131,18 +1134,18 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) interior = false, doc = 'Promotes a user to an administrator. The target may be specified via reply, username, or ID.', - action = function(self, msg) + action = function(self, msg, group) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif target.rank >= 4 then - bindings.sendReply(self, msg, target.name .. ' is already an administrator or greater.') + utilities.send_reply(self, msg, target.name .. ' is already an administrator or greater.') else - for _,group in pairs(self.database.administration.groups) do - group.mods[target.id_str] = nil + for _,g in pairs(self.database.administration.groups) do + g.mods[target.id_str] = nil end self.database.administration.admins[target.id_str] = true - bindings.sendReply(self, msg, target.name .. ' is now an administrator.') + utilities.send_reply(self, msg, target.name .. ' is now an administrator.') end if group.grouptype == 'supergroup' then drua.channel_set_admin(msg.chat.id, target.id, 2) @@ -1161,12 +1164,12 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) local target = administration.get_target(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) elseif target.rank ~= 4 then - bindings.sendReply(self, msg, target.name .. ' is not an administrator.') + utilities.send_reply(self, msg, target.name .. ' is not an administrator.') else self.database.administration.admins[target.id_str] = nil - bindings.sendReply(self, msg, target.name .. ' is no longer an administrator.') + utilities.send_reply(self, msg, target.name .. ' is no longer an administrator.') end end }, @@ -1181,7 +1184,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) if self.database.administration.groups[msg.chat.id_str] then - bindings.sendReply(self, msg, 'I am already administrating this group.') + utilities.send_reply(self, msg, 'I am already administrating this group.') else self.database.administration.groups[msg.chat.id_str] = { mods = {}, @@ -1202,7 +1205,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) self.database.administration.groups[msg.chat.id_str].flags[i] = false end table.insert(self.database.administration.activity, msg.chat.id_str) - bindings.sendReply(self, msg, 'I am now administrating this group.') + utilities.send_reply(self, msg, 'I am now administrating this group.') drua.channel_set_admin(msg.chat.id, self.info.id, 2) end end @@ -1235,7 +1238,7 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) output = 'I do not administrate that group.' end end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end }, @@ -1260,9 +1263,9 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) else output = 'There are no groups.' end - if bindings.sendMessage(self, msg.from.id, output, true, nil, true) then + if utilities.send_message(self, msg.from.id, output, true, nil, true) then if msg.from.id ~= msg.chat.id then - bindings.sendReply(self, msg, 'I have sent you the requested information in a private message.') + utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.') end end end @@ -1279,11 +1282,11 @@ local rank = administration.get_rank(self, msg.from.id, msg.chat.id) action = function(self, msg) local input = utilities.input(msg.text) if not input then - bindings.sendReply(self, msg, 'Give me something to broadcast.') + utilities.send_reply(self, msg, 'Give me something to broadcast.') else input = '*Admin Broadcast:*\n' .. input for id,_ in pairs(self.database.administration.groups) do - bindings.sendMessage(self, id, input, true, nil, true) + utilities.send_message(self, id, input, true, nil, true) end end end diff --git a/plugins/apod.lua b/plugins/apod.lua index 7370c06..2fb2d1d 100755 --- a/plugins/apod.lua +++ b/plugins/apod.lua @@ -1,9 +1,10 @@ + -- Credit to Heitor (tg:Wololo666; gh:heitorPB) for this plugin. + local apod = {} local HTTPS = require('ssl.https') local JSON = require('dkjson') local URL = require('socket.url') -local bindings = require('bindings') local utilities = require('utilities') apod.command = 'apod [date]' @@ -40,7 +41,7 @@ function apod:action(msg) url = url .. '&date=' .. URL.escape(input) date = date .. input else - bindings.sendMessage(self, msg.chat.id, apod.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, apod.doc, true, msg.message_id, true) return end else @@ -51,14 +52,14 @@ function apod:action(msg) local jstr, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.error then - bindings.sendReply(msg, self.config.errors.results) + utilities.send_reply(msg, self.config.errors.results) return end @@ -79,7 +80,7 @@ function apod:action(msg) output = output .. '\nCopyright: ' .. jdat.copyright end - bindings.sendMessage(self, msg.chat.id, output, disable_page_preview, nil, true) + utilities.send_message(self, msg.chat.id, output, disable_page_preview, nil, true) end diff --git a/plugins/bandersnatch.lua b/plugins/bandersnatch.lua index 5d44e81..a703d37 100755 --- a/plugins/bandersnatch.lua +++ b/plugins/bandersnatch.lua @@ -1,6 +1,5 @@ local bandersnatch = {} -local bindings = require('bindings') local utilities = require('utilities') bandersnatch.command = 'bandersnatch' @@ -29,7 +28,7 @@ function bandersnatch:action(msg) output = firstnames[math.random(#firstnames)] .. ' ' .. lastnames[math.random(#lastnames)] end - bindings.sendMessage(self, msg.chat.id, '_'..output..'_', true, nil, true) + utilities.send_message(self, msg.chat.id, '_'..output..'_', true, nil, true) end diff --git a/plugins/bible.lua b/plugins/bible.lua index a0da16a..60222e6 100755 --- a/plugins/bible.lua +++ b/plugins/bible.lua @@ -2,7 +2,6 @@ local bible = {} local HTTP = require('socket.http') local URL = require('socket.url') -local bindings = require('bindings') local utilities = require('utilities') function bible:init() @@ -26,7 +25,7 @@ function bible:action(msg) local input = utilities.input(msg.text) if not input then - bindings.sendMessage(self, msg.chat.id, bible.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, bible.doc, true, msg.message_id, true) return end @@ -47,7 +46,7 @@ function bible:action(msg) output = 'The text is too long to post here. Try being more specific.' end - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end diff --git a/plugins/bing.lua b/plugins/bing.lua new file mode 100644 index 0000000..b2413a5 --- /dev/null +++ b/plugins/bing.lua @@ -0,0 +1,70 @@ + -- Credit to Juan (tg:JuanPotato; gh:JuanPotato) for this plugin. + -- Or rather, the seven lines that actually mean anything. + +local bing = {} + +local URL = require('socket.url') +local JSON = require('dkjson') +local mime = require('mime') +local https = require('ssl.https') +local ltn12 = require('ltn12') +local utilities = require('utilities') + +bing.command = 'bing ' +bing.doc = [[``` +/bing +Returns the top web search results from Bing. +Aliases: /g, /google +```]] + +bing.search_url = 'https://api.datamarket.azure.com/Data.ashx/Bing/Search/Web?Query=\'%s\'&$format=json' + +function bing:init() + if not self.config.bing_api_key then + print('Missing config value: bing_api_key.') + print('bing.lua will not be enabled.') + return + end + bing.triggers = utilities.triggers(self.info.username):t('bing', true):t('g', true):t('google', true).table +end + +function bing:action(msg) + local input = utilities.input(msg.text) + if not input then + if msg.reply_to_message and msg.reply_to_message.text ~= '' then + input = msg.reply_to_message.text + else + utilities.send_reply(self, msg, bing.doc, true) + return + end + end + local url = bing.search_url:format(URL.escape(input)) + local resbody = {} + local _,b,_ = https.request{ + url = url, + headers = { ["Authorization"] = "Basic " .. mime.b64(":" .. self.config.bing_api_key) }, + sink = ltn12.sink.table(resbody), + } + if b ~= 200 then + utilities.send_reply(self, msg, self.config.errors.results) + return + end + local dat = JSON.decode(table.concat(resbody)) + local limit = 4 + if msg.chat.type == 'private' then + limit = 8 + end + if limit > #dat.d.results then + limit = #dat.d.results + end + local reslist = {} + for i = 1, limit do + local result = dat.d.results[i] + local s = '• [' .. result.Title:gsub('%]', '\\]') .. '](' .. result.Url:gsub('%)', '\\)') .. ')' + table.insert(reslist, s) + end + local output = '*Search results for* _' .. utilities.md_escape(input) .. '_ *:*\n' .. table.concat(reslist, '\n') + utilities.send_message(self, msg.chat.id, output, true, nil, true) +end + +return bing diff --git a/plugins/blacklist.lua b/plugins/blacklist.lua index 4a77457..14d288e 100755 --- a/plugins/blacklist.lua +++ b/plugins/blacklist.lua @@ -3,7 +3,6 @@ local blacklist = {} -local bindings = require('bindings') local utilities = require('utilities') function blacklist:init() @@ -25,7 +24,7 @@ function blacklist:action(msg) local target = utilities.user_from_message(self, msg) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) return end @@ -35,10 +34,10 @@ function blacklist:action(msg) if self.database.blacklist[tostring(target.id)] then self.database.blacklist[tostring(target.id)] = nil - bindings.sendReply(self, msg, target.name .. ' has been removed from the blacklist.') + utilities.send_reply(self, msg, target.name .. ' has been removed from the blacklist.') else self.database.blacklist[tostring(target.id)] = true - bindings.sendReply(self, msg, target.name .. ' has been added to the blacklist.') + utilities.send_reply(self, msg, target.name .. ' has been added to the blacklist.') end end diff --git a/plugins/calc.lua b/plugins/calc.lua index 0ee1070..4188496 100755 --- a/plugins/calc.lua +++ b/plugins/calc.lua @@ -2,7 +2,6 @@ local calc = {} local URL = require('socket.url') local HTTPS = require('ssl.https') -local bindings = require('bindings') local utilities = require('utilities') calc.command = 'calc ' @@ -22,7 +21,7 @@ function calc:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, calc.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, calc.doc, true, msg.message_id, true) return end end @@ -31,13 +30,13 @@ function calc:action(msg) local output = HTTPS.request(url) if not output then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end output = '`' .. output .. '`' - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/cats.lua b/plugins/cats.lua index a43b97c..3321c79 100755 --- a/plugins/cats.lua +++ b/plugins/cats.lua @@ -1,7 +1,6 @@ local cats = {} local HTTP = require('socket.http') -local bindings = require('bindings') local utilities = require('utilities') function cats:init() @@ -25,14 +24,14 @@ function cats:action(msg) local str, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(msg, self.config.errors.connection) + utilities.send_reply(msg, self.config.errors.connection) return end str = str:match('') local output = '[Cat!]('..str..')' - bindings.sendMessage(self, msg.chat.id, output, false, nil, true) + utilities.send_message(self, msg.chat.id, output, false, nil, true) end diff --git a/plugins/channel.lua b/plugins/channel.lua new file mode 100644 index 0000000..4dca032 --- /dev/null +++ b/plugins/channel.lua @@ -0,0 +1,65 @@ +local channel = {} + +local bindings = require('bindings') +local utilities = require('utilities') + +--channel.command = 'ch \\n ' +channel.doc = [[``` +/ch + + +Sends a message to a channel. Channel may be specified via ID or username. Messages are markdown-enabled. Users may only send messages to channels for which they are the owner or an administrator. + +The following markdown syntax is supported: + *bold text* + _italic text_ + [text](URL) + `inline fixed-width code` + `‌`‌`pre-formatted fixed-width code block`‌`‌` + +Due to the frequent dysfunction and incompletion of the API method used to determine the administrators of a channel, this command may not work for the owners of some channels. +```]] + +function channel:init() + channel.triggers = utilities.triggers(self.info.username):t('ch', true).table +end + +function channel:action(msg) + -- An exercise in using zero early returns. :) + local input = utilities.input(msg.text) + local output + if input then + local chat_id = utilities.get_word(input, 1) + local admin_list, t = bindings.getChatAdministrators(self, { chat_id = chat_id } ) + if admin_list then + local is_admin = false + for _, admin in ipairs(admin_list.result) do + if admin.user.id == msg.from.id then + is_admin = true + end + end + if is_admin then + local text = input:match('\n(.+)') + if text then + local success, result = utilities.send_message(self, chat_id, text, true, nil, true) + if success then + output = 'Your message has been sent!' + else + output = 'Sorry, I was unable to send your message.\n`' .. result.description .. '`' + end + else + output = 'Please enter a message to be sent. Markdown is supported.' + end + else + output = 'Sorry, you do not appear to be an administrator for that channel.\nThere is currently a known bug in the getChatAdministrators method, where administrator lists will often not show a channel\'s owner.' + end + else + output = 'Sorry, I was unable to retrieve a list of administrators for that channel.\n`' .. t.description .. '`' + end + else + output = channel.doc + end + utilities.send_reply(self, msg, output, true) +end + +return channel diff --git a/plugins/chatter.lua b/plugins/chatter.lua index 95a081f..fb735c3 100755 --- a/plugins/chatter.lua +++ b/plugins/chatter.lua @@ -6,6 +6,7 @@ local HTTP = require('socket.http') local URL = require('socket.url') local JSON = require('dkjson') local bindings = require('bindings') +local utilities = require('utilities') function chatter:init() if not self.config.simsimi_key then @@ -37,7 +38,7 @@ function chatter:action(msg) return true end - bindings.sendChatAction(self, msg.chat.id, 'typing') + bindings.sendChatAction(self, { action = 'typing' } ) local input = msg.text_lower input = input:gsub(self.info.first_name, 'simsimi') @@ -54,13 +55,13 @@ function chatter:action(msg) local jstr, res = HTTP.request(url) if res ~= 200 then - bindings.sendMessage(self, msg.chat.id, self.config.errors.chatter_connection) + utilities.send_message(self, msg.chat.id, self.config.errors.chatter_connection) return end local jdat = JSON.decode(jstr) if not jdat.response then - bindings.sendMessage(self, msg.chat.id, self.config.errors.chatter_response) + utilities.send_message(self, msg.chat.id, self.config.errors.chatter_response) return end local output = jdat.response @@ -85,7 +86,7 @@ function chatter:action(msg) output = output .. '.' end - bindings.sendMessage(self, msg.chat.id, output) + utilities.send_message(self, msg.chat.id, output) end diff --git a/plugins/commit.lua b/plugins/commit.lua index b9ae235..c2c5666 100755 --- a/plugins/commit.lua +++ b/plugins/commit.lua @@ -2,7 +2,6 @@ local commit = {} -local bindings = require('bindings') local utilities = require('utilities') commit.command = 'commit' @@ -424,7 +423,7 @@ local commits = { function commit:action(msg) local output = '`'..commits[math.random(#commits)]..'`' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/control.lua b/plugins/control.lua index 69e0186..2afa16b 100644 --- a/plugins/control.lua +++ b/plugins/control.lua @@ -1,7 +1,6 @@ local control = {} local bot = require('bot') -local bindings = require('bindings') local utilities = require('utilities') function control:init() @@ -27,14 +26,14 @@ function control:action(msg) package.loaded['config'] = nil end bot.init(self) - bindings.sendReply(self, msg, 'Bot reloaded!') + utilities.send_reply(self, msg, 'Bot reloaded!') elseif msg.text:match('^'..utilities.INVOCATION_PATTERN..'halt') then self.is_started = false - bindings.sendReply(self, msg, 'Stopping bot!') + utilities.send_reply(self, msg, 'Stopping bot!') elseif msg.text:match('^'..utilities.INVOCATION_PATTERN..'script') then local input = msg.text:match('^'..utilities.INVOCATION_PATTERN..'script\n(.+)') if not input then - bindings.sendReply(self, msg, 'usage: ```\n/script\n/command \n...\n```', true) + utilities.send_reply(self, msg, 'usage: ```\n/script\n/command \n...\n```', true) return end input = input .. '\n' diff --git a/plugins/currency.lua b/plugins/currency.lua index d4b1936..f6aa969 100755 --- a/plugins/currency.lua +++ b/plugins/currency.lua @@ -1,7 +1,6 @@ local currency = {} local HTTPS = require('ssl.https') -local bindings = require('bindings') local utilities = require('utilities') currency.command = 'cash [amount] to ' @@ -20,7 +19,7 @@ function currency:action(msg) local input = msg.text:upper() if not input:match('%a%a%a TO %a%a%a') then - bindings.sendMessage(self, msg.chat.id, currency.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, currency.doc, true, msg.message_id, true) return end @@ -37,13 +36,13 @@ function currency:action(msg) url = url .. '?from=' .. from .. '&to=' .. to .. '&a=' .. amount local str, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end str = str:match('(.*) %u+') if not str then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -55,7 +54,7 @@ function currency:action(msg) output = output .. os.date('!%F %T UTC') .. '\nSource: Google Finance`' output = '```\n' .. output .. '\n```' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/dice.lua b/plugins/dice.lua index 2e5689b..d12165d 100755 --- a/plugins/dice.lua +++ b/plugins/dice.lua @@ -1,6 +1,5 @@ local dice = {} -local bindings = require('bindings') local utilities = require('utilities') dice.command = 'roll ' @@ -17,7 +16,7 @@ function dice:action(msg) local input = utilities.input(msg.text_lower) if not input then - bindings.sendMessage(self, msg.chat.id, dice.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, dice.doc, true, msg.message_id, true) return end @@ -28,7 +27,7 @@ function dice:action(msg) count = 1 range = input:match('^d?([%d]+)$') else - bindings.sendMessage(self, msg.chat.id, dice.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, dice.doc, true, msg.message_id, true) return end @@ -36,11 +35,11 @@ function dice:action(msg) range = tonumber(range) if range < 2 then - bindings.sendReply(self, msg, 'The minimum range is 2.') + utilities.send_reply(self, msg, 'The minimum range is 2.') return end if range > 1000 or count > 1000 then - bindings.sendReply(self, msg, 'The maximum range and count are 1000.') + utilities.send_reply(self, msg, 'The maximum range and count are 1000.') return end @@ -50,7 +49,7 @@ function dice:action(msg) end output = output .. '`' - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/dilbert.lua b/plugins/dilbert.lua index 8012f6a..02742d8 100644 --- a/plugins/dilbert.lua +++ b/plugins/dilbert.lua @@ -19,7 +19,7 @@ end function dilbert:action(msg) - bindings.sendChatAction(self, msg.chat.id, 'upload_photo') + bindings.sendChatAction(self, { chat_id = msg.chat.id, action = 'upload_photo' } ) local input = utilities.input(msg.text) if not input then input = os.date('%F') end @@ -28,7 +28,7 @@ function dilbert:action(msg) local url = 'http://dilbert.com/strip/' .. URL.escape(input) local str, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -44,7 +44,7 @@ function dilbert:action(msg) local strip_title = str:match('') - bindings.sendPhoto(self, msg.chat.id, strip_file, strip_title) + bindings.sendPhoto(self, { chat_id = msg.chat.id, caption = strip_title }, { photo = strip_file } ) end diff --git a/plugins/echo.lua b/plugins/echo.lua index 5d5d1ca..8917209 100755 --- a/plugins/echo.lua +++ b/plugins/echo.lua @@ -1,6 +1,5 @@ local echo = {} -local bindings = require('bindings') local utilities = require('utilities') echo.command = 'echo ' @@ -18,7 +17,7 @@ function echo:action(msg) local input = utilities.input(msg.text) if not input then - bindings.sendMessage(self, msg.chat.id, echo.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, echo.doc, true, msg.message_id, true) else local output if msg.chat.type == 'supergroup' then @@ -26,7 +25,7 @@ function echo:action(msg) else output = utilities.md_escape(utilities.char.zwnj..input) end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/eightball.lua b/plugins/eightball.lua index 84c207d..f95f090 100755 --- a/plugins/eightball.lua +++ b/plugins/eightball.lua @@ -1,6 +1,5 @@ local eightball = {} -local bindings = require('bindings') local utilities = require('utilities') eightball.command = '8ball' @@ -51,7 +50,7 @@ function eightball:action(msg) output = ball_answers[math.random(#ball_answers)] end - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end diff --git a/plugins/floodcontrol.lua b/plugins/floodcontrol.lua deleted file mode 100755 index 92ec5e5..0000000 --- a/plugins/floodcontrol.lua +++ /dev/null @@ -1,56 +0,0 @@ - -- Liberbot-compliant floodcontrol. - -- Put this after moderation.lua or blacklist.lua. - -local floodcontrol = {} - -local JSON = require('dkjson') -local utilities = require('utilities') - -function floodcontrol:init() - self.floodcontrol = self.floodcontrol or {} -end - -floodcontrol.triggers = { - '' -} - -function floodcontrol:action(msg) - - if self.floodcontrol[-msg.chat.id] then - return - end - - local input = msg.text_lower:match('^/floodcontrol (.+)') or msg.text_lower:match('^/floodcontrol@'..self.info.username..' (.+)') - if not input then return true end - - if msg.from.id ~= 100547061 and msg.from.id ~= self.config.admin then - return -- Only run for Liberbot or the admin. - end - - input = JSON.decode(input) - - if not input.groupid then - return - end - if not input.duration then - input.duration = 600 - end - - self.floodcontrol[input.groupid] = os.time() + input.duration - - local output = input.groupid .. ' silenced for ' .. input.duration .. ' seconds.' - utilities.handle_exception(self, 'floodcontrol.lua', output) - -end - -function floodcontrol:cron() - - for k,v in pairs(self.floodcontrol) do - if os.time() > v then - self.floodcontrol[k] = nil - end - end - -end - -return floodcontrol diff --git a/plugins/fortune.lua b/plugins/fortune.lua index edd5f1b..808547c 100755 --- a/plugins/fortune.lua +++ b/plugins/fortune.lua @@ -2,7 +2,6 @@ local fortune = {} -local bindings = require('bindings') local utilities = require('utilities') function fortune:init() @@ -24,7 +23,7 @@ function fortune:action(msg) local fortunef = io.popen('fortune') local output = fortunef:read('*all') output = '```\n' .. output .. '\n```' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) fortunef:close() end diff --git a/plugins/gImages.lua b/plugins/gImages.lua index fb4d75e..040cd4e 100755 --- a/plugins/gImages.lua +++ b/plugins/gImages.lua @@ -6,7 +6,6 @@ local gImages = {} local HTTPS = require('ssl.https') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') function gImages:init() @@ -37,7 +36,7 @@ function gImages:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, gImages.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, gImages.doc, true, msg.message_id, true) return end end @@ -52,13 +51,13 @@ function gImages:action(msg) local jstr, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.searchInformation.totalResults == '0' then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -69,9 +68,9 @@ function gImages:action(msg) if msg.text:match('nsfw') then - bindings.sendReply(self, '*NSFW*\n'..msg, output) + utilities.send_reply(self, '*NSFW*\n'..msg, output) else - bindings.sendMessage(self, msg.chat.id, output, false, nil, true) + utilities.send_message(self, msg.chat.id, output, false, nil, true) end end diff --git a/plugins/gMaps.lua b/plugins/gMaps.lua index 672db06..cb2901b 100755 --- a/plugins/gMaps.lua +++ b/plugins/gMaps.lua @@ -21,18 +21,23 @@ function gMaps:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, gMaps.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, gMaps.doc, true, msg.message_id, true) return end end local coords = utilities.get_coords(self, input) if type(coords) == 'string' then - bindings.sendReply(self, msg, coords) + utilities.send_reply(self, msg, coords) return end - bindings.sendLocation(self, msg.chat.id, coords.lat, coords.lon, msg.message_id) + bindings.sendLocation(self, { + chat_id = msg.chat.id, + latitude = coords.lat, + longitude = coords.lon, + reply_to_message_id = msg.message_id + } ) end diff --git a/plugins/gSearch.lua b/plugins/gSearch.lua index 36482c9..8c9b12c 100755 --- a/plugins/gSearch.lua +++ b/plugins/gSearch.lua @@ -3,7 +3,6 @@ local gSearch = {} local HTTPS = require('ssl.https') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') gSearch.command = 'google ' @@ -24,7 +23,7 @@ function gSearch:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, gSearch.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, gSearch.doc, true, msg.message_id, true) return end end @@ -45,17 +44,17 @@ function gSearch:action(msg) local jstr, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if not jdat.responseData then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end if not jdat.responseData.results[1] then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -67,15 +66,15 @@ function gSearch:action(msg) title = title:sub(1, 45) .. '...' end ]]-- - local url = jdat.responseData.results[i].unescapedUrl - if url:find('%)') then - output = output .. '• ' .. title .. '\n' .. url:gsub('_', '\\_') .. '\n' + local u = jdat.responseData.results[i].unescapedUrl + if u:find('%)') then + output = output .. '• ' .. title .. '\n' .. u:gsub('_', '\\_') .. '\n' else - output = output .. '• [' .. title .. '](' .. url .. ')\n' + output = output .. '• [' .. title .. '](' .. u .. ')\n' end end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/greetings.lua b/plugins/greetings.lua index 48148e2..4237951 100755 --- a/plugins/greetings.lua +++ b/plugins/greetings.lua @@ -4,7 +4,6 @@ local greetings = {} -local bindings = require('bindings') local utilities = require('utilities') function greetings:init() @@ -49,7 +48,7 @@ function greetings:action(msg) for trigger,responses in pairs(self.config.greetings) do for _,response in pairs(responses) do if msg.text_lower:match(response..',? '..self.info.first_name:lower()) then - bindings.sendMessage(self, msg.chat.id, utilities.latcyr(trigger:gsub('#NAME', nick))) + utilities.send_message(self, msg.chat.id, utilities.latcyr(trigger:gsub('#NAME', nick))) return end end diff --git a/plugins/hackernews.lua b/plugins/hackernews.lua index 2e68fd1..8fd4092 100755 --- a/plugins/hackernews.lua +++ b/plugins/hackernews.lua @@ -17,11 +17,11 @@ end function hackernews:action(msg) - bindings.sendChatAction(self, msg.chat.id, 'typing') + bindings.sendChatAction(self, { chat_id = msg.chat.id, action = 'typing' } ) local jstr, res = HTTPS.request('https://hacker-news.firebaseio.com/v0/topstories.json') if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -37,7 +37,7 @@ function hackernews:action(msg) local res_url = 'https://hacker-news.firebaseio.com/v0/item/' .. jdat[i] .. '.json' jstr, res = HTTPS.request(res_url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local res_jdat = JSON.decode(jstr) @@ -47,7 +47,7 @@ function hackernews:action(msg) end local url = res_jdat.url if not url then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end if url:find('%(') then @@ -58,7 +58,7 @@ function hackernews:action(msg) end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/hearthstone.lua b/plugins/hearthstone.lua index 6f5b6da..9b3fd09 100755 --- a/plugins/hearthstone.lua +++ b/plugins/hearthstone.lua @@ -2,9 +2,8 @@ local hearthstone = {} -local HTTPS = require('ssl.https') +--local HTTPS = require('ssl.https') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') function hearthstone:init() @@ -79,7 +78,7 @@ local function format_card(card) end -- unused? - local info = '' + local info if card.text then info = card.text:gsub('',''):gsub('%$','') if card.flavor then @@ -107,7 +106,7 @@ function hearthstone:action(msg) local input = utilities.input(msg.text_lower) if not input then - bindings.sendMessage(self, msg.chat.id, hearthstone.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, hearthstone.doc, true, msg.message_id, true) return end @@ -120,11 +119,11 @@ function hearthstone:action(msg) output = utilities.trim(output) if output:len() == 0 then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/help.lua b/plugins/help.lua index ca81ed9..a30ca09 100755 --- a/plugins/help.lua +++ b/plugins/help.lua @@ -3,7 +3,6 @@ local help = {} -local bindings = require('bindings') local utilities = require('utilities') local help_text @@ -38,11 +37,11 @@ function help:action(msg) -- Attempts to send the help message via PM. -- If msg is from a group, it tells the group whether the PM was successful. if not input then - local res = bindings.sendMessage(self, msg.from.id, help_text, true, nil, true) + local res = utilities.send_message(self, msg.from.id, help_text, true, nil, true) if not res then - bindings.sendReply(self, msg, 'Please message me privately for a list of commands.') + utilities.send_reply(self, msg, 'Please message me privately for a list of commands.') elseif msg.chat.type ~= 'private' then - bindings.sendReply(self, msg, 'I have sent you the requested information in a private message.') + utilities.send_reply(self, msg, 'I have sent you the requested information in a private message.') end return end @@ -50,12 +49,12 @@ function help:action(msg) for _,plugin in ipairs(self.plugins) do if plugin.command and utilities.get_word(plugin.command, 1) == input and plugin.doc then local output = '*Help for* _' .. utilities.get_word(plugin.command, 1) .. '_ *:*\n' .. plugin.doc - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) return end end - bindings.sendReply(self, msg, 'Sorry, there is no help for that command.') + utilities.send_reply(self, msg, 'Sorry, there is no help for that command.') end diff --git a/plugins/imdb.lua b/plugins/imdb.lua index 0ee3dd7..068863b 100755 --- a/plugins/imdb.lua +++ b/plugins/imdb.lua @@ -3,7 +3,6 @@ local imdb = {} local HTTP = require('socket.http') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') imdb.command = 'imdb ' @@ -23,7 +22,7 @@ function imdb:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, imdb.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, imdb.doc, true, msg.message_id, true) return end end @@ -32,14 +31,14 @@ function imdb:action(msg) local jstr, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.Response ~= 'True' then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -48,7 +47,7 @@ function imdb:action(msg) output = output .. '_' .. jdat.Plot .. '_\n' output = output .. '[Read more.](http://imdb.com/title/' .. jdat.imdbID .. ')' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/lastfm.lua b/plugins/lastfm.lua index fa5d7b1..1908a94 100755 --- a/plugins/lastfm.lua +++ b/plugins/lastfm.lua @@ -1,9 +1,11 @@ + -- TODO: Add support for librefm API. + -- Just kidding, nobody actually uses that. + local lastfm = {} local HTTP = require('socket.http') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') function lastfm:init() @@ -30,17 +32,17 @@ function lastfm:action(msg) local input = utilities.input(msg.text) if string.match(msg.text, '^/lastfm') then - bindings.sendMessage(self, msg.chat.id, lastfm.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, lastfm.doc, true, msg.message_id, true) return elseif string.match(msg.text, '^/fmset') then if not input then - bindings.sendMessage(self, msg.chat.id, lastfm.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, lastfm.doc, true, msg.message_id, true) elseif input == '--' or input == utilities.char.em_dash then self.database.users[msg.from.id_str].lastfm = nil - bindings.sendReply(self, msg, 'Your last.fm username has been forgotten.') + utilities.send_reply(self, msg, 'Your last.fm username has been forgotten.') else self.database.users[msg.from.id_str].lastfm = input - bindings.sendReply(self, msg, 'Your last.fm username has been set to "' .. input .. '".') + utilities.send_reply(self, msg, 'Your last.fm username has been set to "' .. input .. '".') end return end @@ -58,7 +60,7 @@ function lastfm:action(msg) alert = '\n\nYour username has been set to ' .. username .. '.\nTo change it, use /fmset .' self.database.users[msg.from.id_str].lastfm = username else - bindings.sendReply(self, msg, 'Please specify your last.fm username or set it with /fmset.') + utilities.send_reply(self, msg, 'Please specify your last.fm username or set it with /fmset.') return end @@ -70,19 +72,19 @@ function lastfm:action(msg) jstr, res = HTTP.request(url) end) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.error then - bindings.sendReply(self, msg, 'Please specify your last.fm username or set it with /fmset.') + utilities.send_reply(self, msg, 'Please specify your last.fm username or set it with /fmset.') return end jdat = jdat.recenttracks.track[1] or jdat.recenttracks.track if not jdat then - bindings.sendReply(self, msg, 'No history for this user.' .. alert) + utilities.send_reply(self, msg, 'No history for this user.' .. alert) return end @@ -102,7 +104,7 @@ function lastfm:action(msg) end output = output .. title .. ' - ' .. artist .. alert - bindings.sendMessage(self, msg.chat.id, output) + utilities.send_message(self, msg.chat.id, output) end diff --git a/plugins/librefm.lua b/plugins/librefm.lua deleted file mode 100644 index 0504d30..0000000 --- a/plugins/librefm.lua +++ /dev/null @@ -1,103 +0,0 @@ -local librefm = {} - -local HTTPS = require('ssl.https') -local URL = require('socket.url') -local JSON = require('dkjson') -local bindings = require('bindings') -local utilities = require('utilities') - -function librefm:init() - if not self.database.librefm then - self.database.librefm = {} - end - - librefm.triggers = utilities.triggers(self.info.username):t('librefm', true):t('lnp', true):t('lfmset', true) -end - -librefm.command = 'librefm' -librefm.doc = [[``` -/lnp [username] -Returns what you are or were last listening to. If you specify a username, info will be returned for that username. - -/lfmset -Sets your libre.fm username. Otherwise, /np will use your Telegram username. Use "/fmset -" to delete it. -```]] - -function librefm:action(msg) - - local input = utilities.input(msg.text) - - if string.match(msg.text, '^/librefm') then - bindings.sendMessage(self, msg.chat.id, librefm.doc, true, msg.message_id, true) - return - elseif string.match(msg.text, '^/lfmset') then - if not input then - bindings.sendMessage(self, msg.chat.id, librefm.doc, true, msg.message_id, true) - elseif input == '-' then - self.database.librefm[msg.from.id_str] = nil - bindings.sendReply(self, msg, 'Your libre.fm username has been forgotten.') - else - self.database.librefm[msg.from.id_str] = input - bindings.sendReply(self, msg, 'Your libre.fm username has been set to "' .. input .. '".') - end - return - end - - local url = 'http://alpha.libre.fm/2.0/?method=user.getrecenttracks&format=json&limit=1&api_key=0&user=' - - local username - local alert = '' - if input then - username = input - elseif self.database.librefm[msg.from.id_str] then - username = self.database.librefm[msg.from.id_str] - elseif msg.from.username then - username = msg.from.username - alert = '\n\nYour username has been set to ' .. username .. '.\nTo change it, use /lfmset .' - self.database.librefm[msg.from.id_str] = username - else - bindings.sendReply(self, msg, 'Please specify your libre.fm username or set it with /lfmset.') - return - end - - url = url .. URL.escape(username) - - local jstr, res = HTTPS.request(url) - if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) - return - end - - local jdat = JSON.decode(jstr) - if jdat.error then - bindings.sendReply(self, msg, 'Please specify your libre.fm username or set it with /lfmset.') - return - end - - jdat = jdat.recenttracks.track[1] or jdat.recenttracks.track - if not jdat then - bindings.sendReply(self, msg, 'No history for this user.' .. alert) - return - end - - local output = input or msg.from.first_name - output = '🎵 ' .. output - - if jdat['@attr'] and jdat['@attr'].nowplaying then - output = output .. ' is currently listening to:\n' - else - output = output .. ' last listened to:\n' - end - - local title = jdat.name or 'Unknown' - local artist = 'Unknown' - if jdat.artist then - artist = jdat.artist['#text'] - end - - output = output .. title .. ' - ' .. artist .. alert - bindings.sendMessage(self, msg.chat.id, output) - -end - -return librefm diff --git a/plugins/luarun.lua b/plugins/luarun.lua index d41d9aa..dacb4be 100644 --- a/plugins/luarun.lua +++ b/plugins/luarun.lua @@ -1,25 +1,31 @@ local luarun = {} -local bindings = require('bindings') local utilities = require('utilities') +local URL = require('socket.url') +local JSON = require('dkjson') function luarun:init() - luarun.triggers = utilities.triggers(self.info.username):t('lua', true).table + luarun.triggers = utilities.triggers(self.info.username):t('lua', true):t('return', true).table end function luarun:action(msg) if msg.from.id ~= self.config.admin then - return + return true end local input = utilities.input(msg.text) if not input then - bindings.sendReply(self, msg, 'Please enter a string to load.') + utilities.send_reply(self, msg, 'Please enter a string to load.') return end + if msg.text_lower:match('^/return') then + input = 'return ' .. input + end + local output = loadstring( [[ + local bot = require('bot') local bindings = require('bindings') local utilities = require('utilities') local JSON = require('dkjson') @@ -31,9 +37,15 @@ function luarun:action(msg) if output == nil then output = 'Done!' else + if type(output) == 'table' then + local s = JSON.encode(output, {indent=true}) + if URL.escape(s):len() < 4000 then + output = s + end + end output = '```\n' .. tostring(output) .. '\n```' end - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/me.lua b/plugins/me.lua index 7db354e..8849d1b 100644 --- a/plugins/me.lua +++ b/plugins/me.lua @@ -1,6 +1,5 @@ local me = {} -local bindings = require('bindings') local utilities = require('utilities') function me:init() @@ -14,7 +13,7 @@ function me:action(msg) if msg.from.id == self.config.admin and (msg.reply_to_message or utilities.input(msg.text)) then target = utilities.user_from_message(self, msg, true) if target.err then - bindings.sendReply(self, msg, target.err) + utilities.send_reply(self, msg, target.err) return end end @@ -23,7 +22,7 @@ function me:action(msg) for k,v in pairs(target) do output = output .. '*' .. k .. ':* `' .. tostring(v) .. '`\n' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/nick.lua b/plugins/nick.lua index 37f3c2f..27110de 100755 --- a/plugins/nick.lua +++ b/plugins/nick.lua @@ -1,6 +1,5 @@ local nick = {} -local bindings = require('bindings') local utilities = require('utilities') nick.command = 'nick ' @@ -45,7 +44,7 @@ function nick:action(msg) output = target.name .. '\'s nickname has been set to "' .. input .. '".' end - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end diff --git a/plugins/patterns.lua b/plugins/patterns.lua index cb8f6c3..7fe7867 100644 --- a/plugins/patterns.lua +++ b/plugins/patterns.lua @@ -1,6 +1,6 @@ local patterns = {} -local bindings = require('bindings') +local utilities = require('utilities') patterns.triggers = { '^/?s/.-/.-/?$' @@ -19,11 +19,11 @@ function patterns:action(msg) ) if res == false then output = 'Malformed pattern!' - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) return end output = 'Did you mean:\n"' .. output:sub(1, 4000) .. '"' - bindings.sendReply(self, msg.reply_to_message, output) + utilities.send_reply(self, msg.reply_to_message, output) end diff --git a/plugins/ping.lua b/plugins/ping.lua index 4678950..a60a5d1 100755 --- a/plugins/ping.lua +++ b/plugins/ping.lua @@ -3,7 +3,6 @@ local ping = {} local utilities = require('utilities') -local bindings = require('bindings') function ping:init() ping.triggers = utilities.triggers(self.info.username):t('ping'):t('annyong').table @@ -11,7 +10,7 @@ end function ping:action(msg) local output = msg.text_lower:match('^/ping') and 'Pong!' or 'Annyong.' - bindings.sendMessage(self, msg.chat.id, output) + utilities.send_message(self, msg.chat.id, output) end return ping diff --git a/plugins/pokedex.lua b/plugins/pokedex.lua index 7315ce7..c9a9331 100755 --- a/plugins/pokedex.lua +++ b/plugins/pokedex.lua @@ -18,12 +18,14 @@ end function pokedex:action(msg) + bindings.sendChatAction(self, { chat_id = msg.chat.id, action = 'typing' } ) + local input = utilities.input(msg.text_lower) if not input then if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, pokedex.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, pokedex.doc, true, msg.message_id, true) return end end @@ -33,7 +35,7 @@ function pokedex:action(msg) local dex_url = url .. '/api/v1/pokemon/' .. input local dex_jstr, res = HTTP.request(dex_url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -42,7 +44,7 @@ function pokedex:action(msg) local desc_url = url .. dex_jdat.descriptions[math.random(#dex_jdat.descriptions)].resource_uri local desc_jstr, _ = HTTP.request(desc_url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -62,7 +64,7 @@ function pokedex:action(msg) local output = '*' .. dex_jdat.name .. '*\n#' .. dex_jdat.national_id .. ' | ' .. poke_type .. '\n_' .. desc_jdat.description:gsub('POKMON', 'Pokémon'):gsub('Pokmon', 'Pokémon') .. '_' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/preview.lua b/plugins/preview.lua index 34af40b..d959d97 100644 --- a/plugins/preview.lua +++ b/plugins/preview.lua @@ -1,7 +1,6 @@ local preview = {} local HTTP = require('socket.http') -local bindings = require('bindings') local utilities = require('utilities') preview.command = 'preview ' @@ -19,7 +18,7 @@ function preview:action(msg) local input = utilities.input(msg.text) if not input then - bindings.sendMessage(self, msg.chat.id, preview.doc, true, nil, true) + utilities.send_message(self, msg.chat.id, preview.doc, true, nil, true) return end @@ -30,18 +29,18 @@ function preview:action(msg) local res = HTTP.request(input) if not res then - bindings.sendReply(self, msg, 'Please provide a valid link.') + utilities.send_reply(self, msg, 'Please provide a valid link.') return end if res:len() == 0 then - bindings.sendReply(self, msg, 'Sorry, the link you provided is not letting us make a preview.') + utilities.send_reply(self, msg, 'Sorry, the link you provided is not letting us make a preview.') return end -- Invisible zero-width, non-joiner. local output = '[​](' .. input .. ')' - bindings.sendMessage(self, msg.chat.id, output, false, nil, true) + utilities.send_message(self, msg.chat.id, output, false, nil, true) end diff --git a/plugins/pun.lua b/plugins/pun.lua index 2579c77..2e55a78 100755 --- a/plugins/pun.lua +++ b/plugins/pun.lua @@ -1,6 +1,5 @@ local pun = {} -local bindings = require('bindings') local utilities = require('utilities') pun.command = 'pun' @@ -138,7 +137,7 @@ local puns = { function pun:action(msg) - bindings.sendReply(self, msg, puns[math.random(#puns)]) + utilities.send_reply(self, msg, puns[math.random(#puns)]) end diff --git a/plugins/reactions.lua b/plugins/reactions.lua index 3d472dd..53e6659 100755 --- a/plugins/reactions.lua +++ b/plugins/reactions.lua @@ -8,7 +8,6 @@ local reactions = {} -local bindings = require('bindings') local utilities = require('utilities') reactions.command = 'reactions' @@ -39,12 +38,12 @@ end function reactions:action(msg) if string.match(msg.text_lower, utilities.INVOCATION_PATTERN..'reactions') then - bindings.sendMessage(self, msg.chat.id, help) + utilities.send_message(self, msg.chat.id, help) return end for trigger,reaction in pairs(mapping) do if string.match(msg.text_lower, utilities.INVOCATION_PATTERN..trigger) then - bindings.sendMessage(self, msg.chat.id, reaction) + utilities.send_message(self, msg.chat.id, reaction) return end end diff --git a/plugins/reddit.lua b/plugins/reddit.lua index 0ada3e8..a92bd50 100755 --- a/plugins/reddit.lua +++ b/plugins/reddit.lua @@ -3,7 +3,6 @@ local reddit = {} local HTTP = require('socket.http') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') reddit.command = 'reddit [r/subreddit | query]' @@ -70,15 +69,15 @@ function reddit:action(msg) end local jstr, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) else local jdat = JSON.decode(jstr) if #jdat.data.children == 0 then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) else local output = format_results(jdat.data.children) output = source .. output - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end end end diff --git a/plugins/remind.lua b/plugins/remind.lua index b4fca96..67a6975 100644 --- a/plugins/remind.lua +++ b/plugins/remind.lua @@ -1,6 +1,5 @@ local remind = {} -local bindings = require('bindings') local utilities = require('utilities') remind.command = 'remind ' @@ -19,13 +18,13 @@ function remind:action(msg) -- Ensure there are arguments. If not, send doc. local input = utilities.input(msg.text) if not input then - bindings.sendMessage(self, msg.chat.id, remind.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, remind.doc, true, msg.message_id, true) return end -- Ensure first arg is a number. If not, send doc. local duration = utilities.get_word(input, 1) if not tonumber(duration) then - bindings.sendMessage(self, msg.chat.id, remind.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, remind.doc, true, msg.message_id, true) return end -- Duration must be between one minute and one year (approximately). @@ -38,17 +37,17 @@ function remind:action(msg) -- Ensure there is a second arg. local message = utilities.input(input) if not message then - bindings.sendMessage(self, msg.chat.id, remind.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, remind.doc, true, msg.message_id, true) return end -- Make a database entry for the group/user if one does not exist. self.database.reminders[msg.chat.id_str] = self.database.reminders[msg.chat.id_str] or {} -- Limit group reminders to 10 and private reminders to 50. if msg.chat.type ~= 'private' and utilities.table_size(self.database.reminders[msg.chat.id_str]) > 9 then - bindings.sendReply(self, msg, 'Sorry, this group already has ten reminders.') + utilities.send_reply(self, msg, 'Sorry, this group already has ten reminders.') return elseif msg.chat.type == 'private' and utilities.table_size(self.database.reminders[msg.chat.id_str]) > 49 then - bindings.sendReply(msg, 'Sorry, you already have fifty reminders.') + utilities.send_reply(msg, 'Sorry, you already have fifty reminders.') return end -- Put together the reminder with the expiration, message, and message to reply to. @@ -63,7 +62,7 @@ function remind:action(msg) else output = output .. ' minutes!' end - bindings.sendReply(self, msg, output) + utilities.send_reply(self, msg, output) end function remind:cron() @@ -77,7 +76,7 @@ function remind:cron() -- Otherwise, add it to the replacement table. if time > reminder.time then local output = '*Reminder:*\n"' .. utilities.md_escape(reminder.message) .. '"' - local res = bindings.sendMessage(self, chat_id, output, true, nil, true) + local res = utilities.send_message(self, chat_id, output, true, nil, true) -- If the message fails to send, save it for later. if not res then table.insert(new_group, reminder) diff --git a/plugins/setandget.lua b/plugins/setandget.lua index e24cc9f..60e06e1 100644 --- a/plugins/setandget.lua +++ b/plugins/setandget.lua @@ -1,6 +1,5 @@ local setandget = {} -local bindings = require('bindings') local utilities = require('utilities') function setandget:init() @@ -25,7 +24,7 @@ function setandget:action(msg) if msg.text_lower:match('^/set') then if not input then - bindings.sendMessage(self, msg.chat.id, setandget.doc, true, nil, true) + utilities.send_message(self, msg.chat.id, setandget.doc, true, nil, true) return end @@ -33,13 +32,13 @@ function setandget:action(msg) local value = utilities.input(input) if not name or not value then - bindings.sendMessage(self, msg.chat.id, setandget.doc, true, nil, true) + utilities.send_message(self, msg.chat.id, setandget.doc, true, nil, true) elseif value == '--' or value == '—' then self.database.setandget[msg.chat.id_str][name] = nil - bindings.sendMessage(self, msg.chat.id, 'That value has been deleted.') + utilities.send_message(self, msg.chat.id, 'That value has been deleted.') else self.database.setandget[msg.chat.id_str][name] = value - bindings.sendMessage(self, msg.chat.id, '"' .. name .. '" has been set to "' .. value .. '".', true) + utilities.send_message(self, msg.chat.id, '"' .. name .. '" has been set to "' .. value .. '".', true) end elseif msg.text_lower:match('^/get') then @@ -54,7 +53,7 @@ function setandget:action(msg) output = output .. '• ' .. k .. ': `' .. v .. '`\n' end end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) return end @@ -65,7 +64,7 @@ function setandget:action(msg) output = 'There is no value stored by that name.' end - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/shell.lua b/plugins/shell.lua index 1a1bd6f..259b7da 100644 --- a/plugins/shell.lua +++ b/plugins/shell.lua @@ -1,6 +1,5 @@ local shell = {} -local bindings = require('bindings') local utilities = require('utilities') function shell:init() @@ -15,9 +14,9 @@ function shell:action(msg) local input = utilities.input(msg.text) input = input:gsub('—', '--') - + if not input then - bindings.sendReply(self, msg, 'Please specify a command to run.') + utilities.send_reply(self, msg, 'Please specify a command to run.') return end @@ -27,7 +26,7 @@ function shell:action(msg) else output = '```\n' .. output .. '\n```' end - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/shout.lua b/plugins/shout.lua index dd66ac3..602fecc 100644 --- a/plugins/shout.lua +++ b/plugins/shout.lua @@ -1,6 +1,5 @@ local shout = {} -local bindings = require('bindings') local utilities = require('utilities') shout.command = 'shout ' @@ -18,7 +17,7 @@ function shout:action(msg) local input = utilities.input(msg.text) if not input then - bindings.sendMessage(self, msg.chat.id, shout.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, shout.doc, true, msg.message_id, true) return end input = utilities.trim(input) @@ -43,7 +42,7 @@ function shout:action(msg) output = output .. match .. ' ' .. spacing .. match .. '\n' end output = '```\n' .. utilities.trim(output) .. '\n```' - bindings.sendMessage(self, msg.chat.id, output, true, false, true) + utilities.send_message(self, msg.chat.id, output, true, false, true) end diff --git a/plugins/slap.lua b/plugins/slap.lua index 6a0af3f..91c5f1e 100755 --- a/plugins/slap.lua +++ b/plugins/slap.lua @@ -1,6 +1,5 @@ local slap = {} -local bindings = require('bindings') local utilities = require('utilities') slap.command = 'slap [target]' @@ -124,7 +123,7 @@ function slap:action(msg) output = output:gsub('VICTOR', victor_name) output = utilities.char.zwnj .. output - bindings.sendMessage(self, msg.chat.id, output) + utilities.send_message(self, msg.chat.id, output) end diff --git a/plugins/time.lua b/plugins/time.lua index be47ddd..c390c5d 100755 --- a/plugins/time.lua +++ b/plugins/time.lua @@ -2,7 +2,6 @@ local time = {} local HTTPS = require('ssl.https') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') time.command = 'time ' @@ -22,14 +21,14 @@ function time:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, time.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, time.doc, true, msg.message_id, true) return end end local coords = utilities.get_coords(self, input) if type(coords) == 'string' then - bindings.sendReply(self, msg, coords) + utilities.send_reply(self, msg, coords) return end @@ -40,7 +39,7 @@ function time:action(msg) local jstr, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -56,7 +55,7 @@ function time:action(msg) local output = os.date('!%I:%M %p\n', timestamp) .. os.date('!%A, %B %d, %Y\n', timestamp) .. jdat.timeZoneName .. ' (UTC' .. utcoff .. ')' output = '```\n' .. output .. '\n```' - bindings.sendReply(self, msg, output, true) + utilities.send_reply(self, msg, output, true) end diff --git a/plugins/translate.lua b/plugins/translate.lua index 204f297..97ab221 100755 --- a/plugins/translate.lua +++ b/plugins/translate.lua @@ -3,7 +3,6 @@ local translate = {} local HTTPS = require('ssl.https') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') translate.command = 'translate [text]' @@ -23,7 +22,7 @@ function translate:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, translate.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, translate.doc, true, msg.message_id, true) return end end @@ -32,20 +31,20 @@ function translate:action(msg) local str, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(str) if jdat.code ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local output = jdat.text[1] output = '*Translation:*\n"' .. utilities.md_escape(output) .. '"' - bindings.sendReply(self, msg.reply_to_message or msg, output, true) + utilities.send_reply(self, msg.reply_to_message or msg, output, true) end diff --git a/plugins/urbandictionary.lua b/plugins/urbandictionary.lua index b32dc6d..e8e0d75 100755 --- a/plugins/urbandictionary.lua +++ b/plugins/urbandictionary.lua @@ -3,7 +3,6 @@ local urbandictionary = {} local HTTP = require('socket.http') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') urbandictionary.command = 'urbandictionary ' @@ -24,7 +23,7 @@ function urbandictionary:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, urbandictionary.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, urbandictionary.doc, true, msg.message_id, true) return end end @@ -33,13 +32,13 @@ function urbandictionary:action(msg) local jstr, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.result_type == "no_results" then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -50,7 +49,7 @@ function urbandictionary:action(msg) output = output:gsub('%[', ''):gsub('%]', '') - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/weather.lua b/plugins/weather.lua index 89ea62d..2097f4a 100755 --- a/plugins/weather.lua +++ b/plugins/weather.lua @@ -2,7 +2,6 @@ local weather = {} local HTTP = require('socket.http') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') function weather:init() @@ -28,14 +27,14 @@ function weather:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, weather.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, weather.doc, true, msg.message_id, true) return end end local coords = utilities.get_coords(self, input) if type(coords) == 'string' then - bindings.sendReply(self, msg, coords) + utilities.send_reply(self, msg, coords) return end @@ -43,13 +42,13 @@ function weather:action(msg) local jstr, res = HTTP.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.cod ~= 200 then - bindings.sendReply(self, msg, 'Error: City not found.') + utilities.send_reply(self, msg, 'Error: City not found.') return end @@ -57,7 +56,7 @@ function weather:action(msg) local fahrenheit = string.format('%.2f', celsius * (9/5) + 32) local output = '`' .. celsius .. '°C | ' .. fahrenheit .. '°F, ' .. jdat.weather[1].description .. '.`' - bindings.sendReply(self, msg, output, true) + utilities.send_reply(self, msg, output, true) end diff --git a/plugins/whoami.lua b/plugins/whoami.lua index ddb1891..a04b2a0 100755 --- a/plugins/whoami.lua +++ b/plugins/whoami.lua @@ -1,6 +1,5 @@ local whoami = {} -local bindings = require('bindings') local utilities = require('utilities') whoami.command = 'whoami' @@ -45,7 +44,7 @@ function whoami:action(msg) local output = user .. ', and you are messaging ' .. group - bindings.sendMessage(self, msg.chat.id, output, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, output, true, msg.message_id, true) end diff --git a/plugins/wikipedia.lua b/plugins/wikipedia.lua index 774b02f..981dfef 100755 --- a/plugins/wikipedia.lua +++ b/plugins/wikipedia.lua @@ -3,7 +3,6 @@ local wikipedia = {} local HTTPS = require('ssl.https') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') wikipedia.command = 'wikipedia ' @@ -18,7 +17,7 @@ function wikipedia:init() end local get_title = function(search) - for i,v in ipairs(search) do + for _,v in ipairs(search) do if not v.snippet:match('may refer to:') then return v.title end @@ -35,7 +34,7 @@ function wikipedia:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, wikipedia.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, wikipedia.doc, true, msg.message_id, true) return end end @@ -51,19 +50,19 @@ function wikipedia:action(msg) jstr, res = HTTPS.request(search_url .. URL.escape(input)) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end jdat = JSON.decode(jstr) if jdat.query.searchinfo.totalhits == 0 then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end local title = get_title(jdat.query.search) if not title then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -71,7 +70,7 @@ function wikipedia:action(msg) jstr, res = HTTPS.request(res_url .. URL.escape(title)) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end @@ -79,7 +78,7 @@ function wikipedia:action(msg) local text = JSON.decode(jstr).query.pages _, text = next(text) if not text then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return else text = text.extract @@ -108,7 +107,7 @@ function wikipedia:action(msg) end output = output .. '\n[Read more.](' .. url:gsub('%)', '\\)') .. ')' - bindings.sendMessage(self, msg.chat.id, output, true, nil, true) + utilities.send_message(self, msg.chat.id, output, true, nil, true) end diff --git a/plugins/xkcd.lua b/plugins/xkcd.lua index 6834baf..dff1e9e 100755 --- a/plugins/xkcd.lua +++ b/plugins/xkcd.lua @@ -1,9 +1,7 @@ local xkcd = {} local HTTP = require('socket.http') -local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') xkcd.command = 'xkcd [i]' @@ -20,7 +18,7 @@ function xkcd:action(msg) local jstr, res = HTTP.request('http://xkcd.com/info.0.json') if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local latest = JSON.decode(jstr).num @@ -29,7 +27,7 @@ function xkcd:action(msg) local input = utilities.input(msg.text) if input then if input == '404' then - bindings.sendMessage(self, msg.chat.id, '*404*\nNot found.', false, nil, true) + utilities.send_message(self, msg.chat.id, '*404*\nNot found.', false, nil, true) return elseif tonumber(input) then if tonumber(input) > latest then @@ -46,14 +44,14 @@ function xkcd:action(msg) jstr, res = HTTP.request(res_url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) local output = '*' .. jdat.safe_title .. '* ([' .. jdat.num .. '](' .. jdat.img .. '))\n' .. jdat.alt - bindings.sendMessage(self, msg.chat.id, output, false, nil, true) + utilities.send_message(self, msg.chat.id, output, false, nil, true) end diff --git a/plugins/youtube.lua b/plugins/youtube.lua index 1979919..bb3b3ff 100755 --- a/plugins/youtube.lua +++ b/plugins/youtube.lua @@ -5,7 +5,6 @@ local youtube = {} local HTTPS = require('ssl.https') local URL = require('socket.url') local JSON = require('dkjson') -local bindings = require('bindings') local utilities = require('utilities') function youtube:init() @@ -32,7 +31,7 @@ function youtube:action(msg) if msg.reply_to_message and msg.reply_to_message.text then input = msg.reply_to_message.text else - bindings.sendMessage(self, msg.chat.id, youtube.doc, true, msg.message_id, true) + utilities.send_message(self, msg.chat.id, youtube.doc, true, msg.message_id, true) return end end @@ -41,13 +40,13 @@ function youtube:action(msg) local jstr, res = HTTPS.request(url) if res ~= 200 then - bindings.sendReply(self, msg, self.config.errors.connection) + utilities.send_reply(self, msg, self.config.errors.connection) return end local jdat = JSON.decode(jstr) if jdat.pageInfo.totalResults == 0 then - bindings.sendReply(self, msg, self.config.errors.results) + utilities.send_reply(self, msg, self.config.errors.results) return end @@ -56,7 +55,7 @@ function youtube:action(msg) vid_title = vid_title:gsub('%(.+%)',''):gsub('%[.+%]','') local output = '[' .. vid_title .. '](' .. vid_url .. ')' - bindings.sendMessage(self, msg.chat.id, output, false, nil, true) + utilities.send_message(self, msg.chat.id, output, false, nil, true) end diff --git a/utilities.lua b/utilities.lua index 9d3fb85..ea1ccc2 100755 --- a/utilities.lua +++ b/utilities.lua @@ -10,6 +10,28 @@ local URL = require('socket.url') local JSON = require('dkjson') local bindings = require('bindings') + -- For the sake of ease to new contributors and familiarity to old contributors, + -- we'll provide a couple of aliases to real bindings here. +function utilities:send_message(chat_id, text, disable_web_page_preview, reply_to_message_id, use_markdown) + return bindings.request(self, 'sendMessage', { + chat_id = chat_id, + text = text, + disable_web_page_preview = disable_web_page_preview, + reply_to_message_id = reply_to_message_id, + parse_mode = use_markdown and 'Markdown' or nil + } ) +end + +function utilities:send_reply(old_msg, text, use_markdown) + return bindings.request(self, 'sendMessage', { + chat_id = old_msg.chat.id, + text = text, + disable_web_page_preview = true, + reply_to_message_id = old_msg.message_id, + parse_mode = use_markdown and 'Markdown' or nil + } ) +end + -- get the indexed word in a string function utilities.get_word(s, i) s = s or '' @@ -205,7 +227,7 @@ function utilities:handle_exception(err, message) if self.config.log_chat then output = '```' .. output .. '```' - bindings.sendMessage(self, self.config.log_chat, output, true, nil, true) + utilities.send_message(self, self.config.log_chat, output, true, nil, true) else print(output) end