commit d572522a9674091166e12ef199b679a19bb3e08f Author: Tulir Asokan Date: Thu Jun 14 01:41:05 2018 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4abb511 --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +.idea +.vscode + +*.db +*.yaml +!example-config.yaml + +plugins/ + +# Bots under maubot.xyz +jesaribot/ +sed/ +github/ +gitlab/ +rss/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU 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 +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. + + 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. + + 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. + + 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. + + 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. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + 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. + + 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. + + 14. Revised Versions of this License. + + 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 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. + + 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. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 Affero General Public License for more details. + + 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 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 new file mode 100644 index 0000000..802a980 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# maubot +A plugin-based [Matrix](https://matrix.org) bot system written in Go. + +Work in progress. Please come back later. + +## Discussion +Matrix room: [#maubot:maunium.net](https://matrix.to/#/#maubot:maunium.net) diff --git a/cmd/maubot/main.go b/cmd/maubot/main.go new file mode 100644 index 0000000..7f82b61 --- /dev/null +++ b/cmd/maubot/main.go @@ -0,0 +1,68 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package main + +import ( + "fmt" + "os" + "os/signal" + "syscall" + + "maubot.xyz" + "maubot.xyz/config" + flag "maunium.net/go/mauflag" + log "maunium.net/go/maulogger" +) + +func main() { + flag.SetHelpTitles("maubot - A plugin-based Matrix bot system written in Go.", "maubot [-c /path/to/config] [-h]") + configPath := flag.MakeFull("c", "config", "The path to the main config file", "maubot.yaml").String() + wantHelp, _ := flag.MakeHelpFlag() + + err := flag.Parse() + if err != nil { + fmt.Println(err) + flag.PrintHelp() + os.Exit(1) + } + + if *wantHelp { + flag.PrintHelp() + return + } + + cfg := &config.MainConfig{} + err = cfg.Load(*configPath) + if err != nil { + fmt.Println("Failed to load config:", err) + return + } + cfg.Logging.Configure(log.DefaultLogger) + log.Debugln("Logger configured") + + bot := maubot.New(cfg) + bot.Init() + bot.Start() + + c := make(chan os.Signal, 1) + signal.Notify(c, os.Interrupt, syscall.SIGTERM) + <-c + log.Debugln("Interrupt received, stopping components...") + bot.Stop() + log.Debugln("Components stopped, bye!") + os.Exit(0) +} diff --git a/config/config.go b/config/config.go new file mode 100644 index 0000000..6e7c7e9 --- /dev/null +++ b/config/config.go @@ -0,0 +1,54 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package config + +import ( + "io/ioutil" + + "gopkg.in/yaml.v2" + "maubot.xyz/database" +) + +type MainConfig struct { + Logging LogConfig `yaml:"logging"` + Database database.Database `yaml:"database"` + Server ServerConfig `yaml:"server"` + PluginDirs []string `yaml:"plugin_directories"` +} + +func (config *MainConfig) Load(path string) error { + data, err := ioutil.ReadFile(path) + if err != nil { + return err + } + + return yaml.Unmarshal(data, config) +} + +func (config *MainConfig) Save(path string) error { + data, err := yaml.Marshal(config) + if err != nil { + return err + } + + return ioutil.WriteFile(path, data, 0644) +} + +type ServerConfig struct { + Listen string `yaml:"listen"` + BasePath string `yaml:"base_path"` +} diff --git a/config/logging.go b/config/logging.go new file mode 100644 index 0000000..0c170d5 --- /dev/null +++ b/config/logging.go @@ -0,0 +1,68 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package config + +import ( + "maunium.net/go/maulogger" + "os" + "fmt" +) + +// LogConfig contains configs for the logger. +type LogConfig struct { + Directory string `yaml:"directory"` + FileNameFormat string `yaml:"file_name_format"` + FileDateFormat string `yaml:"file_date_format"` + FileMode uint32 `yaml:"file_mode"` + TimestampFormat string `yaml:"timestamp_format"` + Debug bool `yaml:"print_debug"` +} + +// CreateLogConfig creates a basic LogConfig. +func CreateLogConfig() LogConfig { + return LogConfig{ + Directory: "./logs", + FileNameFormat: "%[1]s-%02[2]d.log", + TimestampFormat: "Jan _2, 2006 15:04:05", + FileMode: 0600, + FileDateFormat: "2006-01-02", + Debug: false, + } +} + +// GetFileFormat returns a mauLogger-compatible logger file format based on the data in the struct. +func (lc LogConfig) GetFileFormat() maulogger.LoggerFileFormat { + path := lc.FileNameFormat + if len(lc.Directory) > 0 { + path = lc.Directory + "/" + path + } + + return func(now string, i int) string { + return fmt.Sprintf(path, now, i) + } +} + +// Configure configures a mauLogger instance with the data in this struct. +func (lc LogConfig) Configure(log *maulogger.Logger) { + log.FileFormat = lc.GetFileFormat() + log.FileMode = os.FileMode(lc.FileMode) + log.FileTimeFormat = lc.FileDateFormat + log.TimeFormat = lc.TimestampFormat + if lc.Debug { + log.PrintLevel = maulogger.LevelDebug.Severity + } +} diff --git a/database/clients.go b/database/clients.go new file mode 100644 index 0000000..3ee5c50 --- /dev/null +++ b/database/clients.go @@ -0,0 +1,110 @@ +// jesaribot - A simple maubot plugin. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package database + +import ( + log "maunium.net/go/maulogger" + "database/sql" +) + +type MatrixClient struct { + db *Database + sql *sql.DB + + UserID string `json:"user_id"` + Homeserver string `json:"homeserver"` + AccessToken string `json:"access_token"` + NextBatch string `json:"next_batch"` + FilterID string `json:"filter_id"` + + Sync bool `json:"sync"` + AutoJoinRooms bool `json:"auto_join_rooms"` + DisplayName string `json:"display_name"` + AvatarURL string `json:"avatar_url"` +} + +type MatrixClientStatic struct { + db *Database + sql *sql.DB +} + +func (mcs *MatrixClientStatic) CreateTable() error { + _, err := mcs.sql.Exec(`CREATE TABLE IF NOT EXISTS matrix_client ( + user_id VARCHAR(255) PRIMARY KEY, + homeserver VARCHAR(255) NOT NULL, + access_token VARCHAR(255) NOT NULL, + next_batch VARCHAR(255) NOT NULL, + filter_id VARCHAR(255) NOT NULL, + + sync BOOLEAN NOT NULL, + autojoin BOOLEAN NOT NULL, + display_name VARCHAR(255) NOT NULL, + avatar_url VARCHAR(255) NOT NULL + )`) + return err +} + +func (mcs *MatrixClientStatic) Get(userID string) *MatrixClient { + row := mcs.sql.QueryRow("SELECT user_id, homeserver, access_token, next_batch, filter_id, sync, autojoin, display_name, avatar_url FROM matrix_client WHERE user_id=?", userID) + if row != nil { + return mcs.New().Scan(row) + } + return nil +} + +func (mcs *MatrixClientStatic) GetAll() (clients []*MatrixClient) { + rows, err := mcs.sql.Query("SELECT user_id, homeserver, access_token, next_batch, filter_id, sync, autojoin, display_name, avatar_url FROM matrix_client") + if err != nil || rows == nil { + return nil + } + defer rows.Close() + for rows.Next() { + clients = append(clients, mcs.New().Scan(rows)) + } + return +} + +func (mcs *MatrixClientStatic) New() *MatrixClient { + return &MatrixClient{ + db: mcs.db, + sql: mcs.sql, + } +} + +type Scannable interface { + Scan(...interface{}) error +} + +func (mxc *MatrixClient) Scan(row Scannable) *MatrixClient { + err := row.Scan(&mxc.UserID, &mxc.Homeserver, &mxc.AccessToken, &mxc.NextBatch, &mxc.FilterID, &mxc.Sync, &mxc.AutoJoinRooms, &mxc.DisplayName, &mxc.AvatarURL) + if err != nil { + log.Fatalln("Database scan failed:", err) + } + return mxc +} + +func (mxc *MatrixClient) Insert() error { + _, err := mxc.sql.Exec("INSERT INTO matrix_client (user_id, homeserver, access_token, next_batch, filter_id, sync, autojoin, display_name, avatar_url) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)", + mxc.UserID, mxc.Homeserver, mxc.AccessToken, mxc.NextBatch, mxc.FilterID, mxc.Sync, mxc.AutoJoinRooms, mxc.DisplayName, mxc.AvatarURL) + return err +} + +func (mxc *MatrixClient) Update() error { + _, err := mxc.sql.Exec("UPDATE matrix_client SET access_token=?, next_batch=?, filter_id=?, sync=?, autojoin=?, display_name=?, avatar_url=? WHERE user_id=?", + mxc.AccessToken, mxc.NextBatch, mxc.FilterID, mxc.Sync, mxc.AutoJoinRooms, mxc.DisplayName, mxc.AvatarURL, mxc.UserID) + return err +} diff --git a/database/database.go b/database/database.go new file mode 100644 index 0000000..80d1616 --- /dev/null +++ b/database/database.go @@ -0,0 +1,64 @@ +// jesaribot - A simple maubot plugin. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package database + +import ( + "database/sql" + + _ "github.com/mattn/go-sqlite3" + log "maunium.net/go/maulogger" +) + +type Database struct { + Type string `yaml:"type"` + Name string `yaml:"name"` + + MatrixClient *MatrixClientStatic `yaml:"-"` + Plugin *PluginStatic `yaml:"-"` + + sql *sql.DB +} + +func (db *Database) Connect() (err error) { + db.sql, err = sql.Open(db.Type, db.Name) + if err != nil { + return + } + + db.MatrixClient = &MatrixClientStatic{db: db, sql: db.sql} + db.Plugin = &PluginStatic{db: db, sql: db.sql} + + return nil +} + +func (db *Database) CreateTables() { + log.Debugln("Creating database tables") + + err := db.MatrixClient.CreateTable() + if err != nil { + log.Errorln("Failed to create matrix_client table:", err) + } + + err = db.Plugin.CreateTable() + if err != nil { + log.Errorln("Failed to create plugin table:", err) + } +} + +func (db *Database) SQL() *sql.DB { + return db.sql +} diff --git a/database/plugins.go b/database/plugins.go new file mode 100644 index 0000000..4224e67 --- /dev/null +++ b/database/plugins.go @@ -0,0 +1,105 @@ +// jesaribot - A simple maubot plugin. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package database + +import ( + "database/sql" + + log "maunium.net/go/maulogger" +) + +type Plugin struct { + db *Database + sql *sql.DB + + ID string `json:"id"` + Type string `json:"type"` + Enabled bool `json:"enabled"` + UserID string `json:"user_id"` + //User *MatrixClient `json:"-"` +} + +type PluginStatic struct { + db *Database + sql *sql.DB +} + +func (ps *PluginStatic) CreateTable() error { + _, err := ps.sql.Exec(`CREATE TABLE IF NOT EXISTS plugin ( + id VARCHAR(255) PRIMARY KEY, + type VARCHAR(255) NOT NULL, + enabled BOOLEAN NOT NULL, + + user_id VARCHAR(255) NOT NULL, + + FOREIGN KEY (user_id) REFERENCES matrix_client(user_id) + ON DELETE RESTRICT ON UPDATE CASCADE + )`) + return err +} + +func (ps *PluginStatic) Get(id string) *Plugin { + row := ps.sql.QueryRow("SELECT * FROM plugin WHERE id=?", id) + if row != nil { + return ps.New().Scan(row) + } + return nil +} + +func (ps *PluginStatic) GetAll() (plugins []*Plugin) { + rows, err := ps.sql.Query("SELECT * FROM plugin") + if err != nil || rows == nil { + return nil + } + defer rows.Close() + for rows.Next() { + plugins = append(plugins, ps.New().Scan(rows)) + } + return +} + +func (ps *PluginStatic) New() *Plugin { + return &Plugin{ + db: ps.db, + sql: ps.sql, + } +} + +/*func (p *Plugin) LoadUser() *Plugin { + p.User = p.db.MatrixClient.Get(p.UserID) + return p +}*/ + +func (p *Plugin) Scan(row Scannable) *Plugin { + err := row.Scan(&p.ID, &p.Type, &p.Enabled, &p.UserID) + if err != nil { + log.Fatalln("Database scan failed:", err) + } + return p +} + +func (p *Plugin) Insert() error { + _, err := p.sql.Exec("INSERT INTO plugin (id, type, enabled, user_id) VALUES (?, ?, ?, ?)", + p.ID, p.Type, p.Enabled, p.UserID) + return err +} + +func (p *Plugin) Update() error { + _, err := p.sql.Exec("UPDATE plugin SET enabled=? WHERE id=?", + p.Enabled, p.ID) + return err +} diff --git a/example-config.yaml b/example-config.yaml new file mode 100644 index 0000000..e51d6c9 --- /dev/null +++ b/example-config.yaml @@ -0,0 +1,19 @@ +database: + type: sqlite3 + name: maubot.db + +logging: + directory: ./logs + file_mode: 0600 + print_debug: false + file_name_format: "%[1]s-%02[2]d.log" + file_date_format: 2006-01-02 + timestamp_format: Jan _2, 2006 15:04:05 + +# If multiple directories have a plugin with the same name, the first directory is used. +plugin_directories: +- ./plugins + +server: + listen: 0.0.0.0:29316 + base_path: /_matrix/maubot diff --git a/http.go b/http.go new file mode 100644 index 0000000..fe96a47 --- /dev/null +++ b/http.go @@ -0,0 +1,59 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package maubot + +import ( + "context" + "net/http" + "os" + "time" + + "github.com/gorilla/mux" + log "maunium.net/go/maulogger" +) + +func (bot *Bot) initServer() { + log.Debugln("Initializing HTTP server") + r := mux.NewRouter() + http.Handle(bot.Config.Server.BasePath, r) + bot.Server = &http.Server{ + Addr: bot.Config.Server.Listen, + WriteTimeout: time.Second * 15, + ReadTimeout: time.Second * 15, + IdleTimeout: time.Second * 60, + Handler: r, + } +} + +func (bot *Bot) startServer() { + log.Debugf("Listening at http://%s%s\n", bot.Server.Addr, bot.Config.Server.BasePath) + if err := bot.Server.ListenAndServe(); err != nil { + log.Fatalln("HTTP server errored:", err) + bot.Server = nil + bot.Stop() + os.Exit(10) + } +} + +func (bot *Bot) stopServer() { + if bot.Server != nil { + log.Debugln("Stopping HTTP server") + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + bot.Server.Shutdown(ctx) + } +} diff --git a/matrix.go b/matrix.go new file mode 100644 index 0000000..c65a545 --- /dev/null +++ b/matrix.go @@ -0,0 +1,54 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package maubot + +import ( + "os" + + "maubot.xyz/matrix" + log "maunium.net/go/maulogger" +) + +func (bot *Bot) initClients() { + log.Debugln("Initializing Matrix clients") + clients := bot.Database.MatrixClient.GetAll() + for _, client := range clients { + mxClient, err := matrix.NewClient(client) + if err != nil { + log.Fatalf("Failed to create client to %s as %s: %v\n", client.Homeserver, client.UserID, err) + os.Exit(3) + } + log.Debugln("Initialized user", client.UserID, "with homeserver", client.Homeserver) + bot.Clients[client.UserID] = mxClient + } +} + +func (bot *Bot) startClients() { + log.Debugln("Starting Matrix syncer") + for _, client := range bot.Clients { + if client.DB.Sync { + client.Sync() + } + } +} + +func (bot *Bot) stopClients() { + log.Debugln("Stopping Matrix syncers") + for _, client := range bot.Clients { + client.StopSync() + } +} diff --git a/matrix/event.go b/matrix/event.go new file mode 100644 index 0000000..3d46301 --- /dev/null +++ b/matrix/event.go @@ -0,0 +1,45 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package matrix + +import ( + "maunium.net/go/gomatrix" +) + +type Event struct { + *gomatrix.Event + Client *Client +} + +func (evt *Event) Reply(text string) (string, error) { + return evt.SendEvent( + SetReply( + RenderMarkdown(text), + evt.Event)) +} + +func (evt *Event) SendMessage(text string) (string, error) { + return evt.SendEvent(RenderMarkdown(text)) +} + +func (evt *Event) SendEvent(content map[string]interface{}) (string, error) { + resp, err := evt.Client.SendMessageEvent(evt.RoomID, "m.room.message", content) + if err != nil { + return "", err + } + return resp.EventID, nil +} diff --git a/matrix/htmltotext.go b/matrix/htmltotext.go new file mode 100644 index 0000000..d1aa5af --- /dev/null +++ b/matrix/htmltotext.go @@ -0,0 +1,229 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package matrix + +import ( + "fmt" + "math" + "regexp" + "strings" + + "golang.org/x/net/html" + "strconv" +) + +var matrixToURL = regexp.MustCompile("^(?:https?://)?(?:www\\.)?matrix\\.to/#/([#@!].*)") + +type htmlParser struct {} + +type taggedString struct { + string + tag string +} + +func (parser *htmlParser) getAttribute(node *html.Node, attribute string) string { + for _, attr := range node.Attr { + if attr.Key == attribute { + return attr.Val + } + } + return "" +} + +func digits(num int) int { + return int(math.Floor(math.Log10(float64(num))) + 1) +} + +func (parser *htmlParser) listToString(node *html.Node, stripLinebreak bool) string { + ordered := node.Data == "ol" + taggedChildren := parser.nodeToTaggedStrings(node.FirstChild, stripLinebreak) + counter := 1 + indentLength := 0 + if ordered { + start := parser.getAttribute(node, "start") + if len(start) > 0 { + counter, _ = strconv.Atoi(start) + } + + longestIndex := (counter - 1) + len(taggedChildren) + indentLength = digits(longestIndex) + } + indent := strings.Repeat(" ", indentLength+2) + var children []string + for _, child := range taggedChildren { + if child.tag != "li" { + continue + } + var prefix string + if ordered { + indexPadding := indentLength - digits(counter) + prefix = fmt.Sprintf("%d. %s", counter, strings.Repeat(" ", indexPadding)) + } else { + prefix = "● " + } + str := prefix + child.string + counter++ + parts := strings.Split(str, "\n") + for i, part := range parts[1:] { + parts[i+1] = indent + part + } + str = strings.Join(parts, "\n") + children = append(children, str) + } + return strings.Join(children, "\n") +} + +func (parser *htmlParser) basicFormatToString(node *html.Node, stripLinebreak bool) string { + str := parser.nodeToTagAwareString(node.FirstChild, stripLinebreak) + switch node.Data { + case "b", "strong": + return fmt.Sprintf("**%s**", str) + case "i", "em": + return fmt.Sprintf("_%s_", str) + case "s", "del": + return fmt.Sprintf("~~%s~~", str) + } + return str +} + +func (parser *htmlParser) headerToString(node *html.Node, stripLinebreak bool) string { + children := parser.nodeToStrings(node.FirstChild, stripLinebreak) + length := int(node.Data[1] - '0') + prefix := strings.Repeat("#", length) + " " + return prefix + strings.Join(children, "") +} + +func (parser *htmlParser) blockquoteToString(node *html.Node, stripLinebreak bool) string { + str := parser.nodeToTagAwareString(node.FirstChild, stripLinebreak) + childrenArr := strings.Split(strings.TrimSpace(str), "\n") + for index, child := range childrenArr { + childrenArr[index] = "> " + child + } + return strings.Join(childrenArr, "\n") +} + +func (parser *htmlParser) linkToString(node *html.Node, stripLinebreak bool) string { + str := parser.nodeToTagAwareString(node.FirstChild, stripLinebreak) + href := parser.getAttribute(node, "href") + if len(href) == 0 { + return str + } + match := matrixToURL.FindStringSubmatch(href) + if len(match) == 2 { +// pillTarget := match[1] +// if pillTarget[0] == '@' { +// if member := parser.room.GetMember(pillTarget); member != nil { +// return member.DisplayName +// } +// } +// return pillTarget + return str + } + return fmt.Sprintf("%s (%s)", str, href) +} + +func (parser *htmlParser) tagToString(node *html.Node, stripLinebreak bool) string { + switch node.Data { + case "blockquote": + return parser.blockquoteToString(node, stripLinebreak) + case "ol", "ul": + return parser.listToString(node, stripLinebreak) + case "h1", "h2", "h3", "h4", "h5", "h6": + return parser.headerToString(node, stripLinebreak) + case "br": + return "\n" + case "b", "strong", "i", "em", "s", "del", "u", "ins": + return parser.basicFormatToString(node, stripLinebreak) + case "a": + return parser.linkToString(node, stripLinebreak) + case "p": + return parser.nodeToTagAwareString(node.FirstChild, stripLinebreak) + "\n" + case "pre": + return parser.nodeToString(node.FirstChild, false) + default: + return parser.nodeToTagAwareString(node.FirstChild, stripLinebreak) + } +} + +func (parser *htmlParser) singleNodeToString(node *html.Node, stripLinebreak bool) taggedString { + switch node.Type { + case html.TextNode: + if stripLinebreak { + node.Data = strings.Replace(node.Data, "\n", "", -1) + } + return taggedString{node.Data, "text"} + case html.ElementNode: + return taggedString{parser.tagToString(node, stripLinebreak), node.Data} + case html.DocumentNode: + return taggedString{parser.nodeToTagAwareString(node.FirstChild, stripLinebreak), "html"} + default: + return taggedString{"", "unknown"} + } +} + +func (parser *htmlParser) nodeToTaggedStrings(node *html.Node, stripLinebreak bool) (strs []taggedString) { + for ; node != nil; node = node.NextSibling { + strs = append(strs, parser.singleNodeToString(node, stripLinebreak)) + } + return +} + +var BlockTags = []string{"p", "h1", "h2", "h3", "h4", "h5", "h6", "ol", "ul", "pre", "blockquote", "div", "hr", "table"} + +func (parser *htmlParser) isBlockTag(tag string) bool { + for _, blockTag := range BlockTags { + if tag == blockTag { + return true + } + } + return false +} + +func (parser *htmlParser) nodeToTagAwareString(node *html.Node, stripLinebreak bool) string { + strs := parser.nodeToTaggedStrings(node, stripLinebreak) + var output strings.Builder + for _, str := range strs { + tstr := str.string + if parser.isBlockTag(str.tag) { + tstr = fmt.Sprintf("\n%s\n", tstr) + } + output.WriteString(tstr) + } + return strings.TrimSpace(output.String()) +} + +func (parser *htmlParser) nodeToStrings(node *html.Node, stripLinebreak bool) (strs []string) { + for ; node != nil; node = node.NextSibling { + strs = append(strs, parser.singleNodeToString(node, stripLinebreak).string) + } + return +} + +func (parser *htmlParser) nodeToString(node *html.Node, stripLinebreak bool) string { + return strings.Join(parser.nodeToStrings(node, stripLinebreak), "") +} + +func (parser *htmlParser) Parse(htmlData string) string { + node, _ := html.Parse(strings.NewReader(htmlData)) + return parser.nodeToTagAwareString(node, true) +} + +func HTMLToText(html string) string { + html = strings.Replace(html, "\t", " ", -1) + str := (&htmlParser{}).Parse(html) + return str +} diff --git a/matrix/htmlutil.go b/matrix/htmlutil.go new file mode 100644 index 0000000..565008f --- /dev/null +++ b/matrix/htmlutil.go @@ -0,0 +1,52 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package matrix + +import ( + "strings" + "gopkg.in/russross/blackfriday.v2" +) + +func RenderMarkdown(text string) map[string]interface{} { + parser := blackfriday.New( + blackfriday.WithExtensions(blackfriday.NoIntraEmphasis | + blackfriday.Tables | + blackfriday.FencedCode | + blackfriday.Strikethrough | + blackfriday.SpaceHeadings | + blackfriday.DefinitionLists)) + ast := parser.Parse([]byte(text)) + + renderer := blackfriday.NewHTMLRenderer(blackfriday.HTMLRendererParameters{ + Flags: blackfriday.UseXHTML, + }) + + var buf strings.Builder + renderer.RenderHeader(&buf, ast) + ast.Walk(func(node *blackfriday.Node, entering bool) blackfriday.WalkStatus { + return renderer.RenderNode(&buf, node, entering) + }) + renderer.RenderFooter(&buf, ast) + htmlBody := buf.String() + + return map[string]interface{}{ + "formatted_body": htmlBody, + "format": "org.matrix.custom.html", + "msgtype": "m.text", + "body": HTMLToText(htmlBody), + } +} diff --git a/matrix/matrix.go b/matrix/matrix.go new file mode 100644 index 0000000..a3eeab8 --- /dev/null +++ b/matrix/matrix.go @@ -0,0 +1,71 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package matrix + +import ( + "maubot.xyz/database" + "maunium.net/go/gomatrix" + log "maunium.net/go/maulogger" +) + +type Client struct { + *gomatrix.Client + + DB *database.MatrixClient +} + +func NewClient(db *database.MatrixClient) (*Client, error) { + mxClient, err := gomatrix.NewClient(db.Homeserver, db.UserID, db.AccessToken) + if err != nil { + return nil, err + } + + client := &Client{ + Client: mxClient, + DB: db, + } + + client.AddEventHandler(gomatrix.StateMember, client.onJoin) + + return client, nil +} + +func (client *Client) AddEventHandler(evt string, handler gomatrix.OnEventListener) { + client.Syncer.(*gomatrix.DefaultSyncer).OnEventType(evt, handler) +} + +func (client *Client) onJoin(evt *gomatrix.Event) { + if !client.DB.AutoJoinRooms || evt.StateKey == nil || *evt.StateKey != client.DB.UserID { + return + } + if membership, _ := evt.Content["membership"].(string); membership == "invite" { + client.JoinRoom(evt.RoomID) + } +} + +func (client *Client) JoinRoom(roomID string) { + client.Client.JoinRoom(roomID, "", nil) +} + +func (client *Client) Sync() { + go func() { + err := client.Client.Sync() + if err != nil { + log.Errorln("Sync() in client", client.UserID, "errored:", err) + } + }() +} diff --git a/matrix/replyutil.go b/matrix/replyutil.go new file mode 100644 index 0000000..3f4c2c0 --- /dev/null +++ b/matrix/replyutil.go @@ -0,0 +1,107 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package matrix + +import ( + "regexp" + "strings" + "fmt" + "maunium.net/go/gomatrix" + "golang.org/x/net/html" +) + +var HTMLReplyFallbackRegex = regexp.MustCompile(`^[\s\S]+?`) + +func TrimReplyFallbackHTML(html string) string { + return HTMLReplyFallbackRegex.ReplaceAllString(html, "") +} + +func TrimReplyFallbackText(text string) string { + if !strings.HasPrefix(text, "> ") || !strings.Contains(text, "\n") { + return text + } + + lines := strings.Split(text, "\n") + for len(lines) > 0 && strings.HasPrefix(lines[0], "> ") { + lines = lines[1:] + } + return strings.Join(lines, "\n") +} + +func RemoveReplyFallback(evt *gomatrix.Event) { + if format, ok := evt.Content["format"].(string); ok && format == "org.matrix.custom.html" { + htmlBody, _ := evt.Content["formatted_body"].(string) + evt.Content["formatted_body"] = TrimReplyFallbackHTML(htmlBody) + } + plainBody, _ := evt.Content["body"].(string) + evt.Content["body"] = TrimReplyFallbackText(plainBody) +} + +const ReplyFormat = `
+In reply to +%s +%s +
 +` + +func ReplyFallbackHTML(evt *gomatrix.Event) string { + body, ok := evt.Content["formatted_body"].(string) + if !ok { + body, _ = evt.Content["body"].(string) + body = html.EscapeString(body) + } + + senderDisplayName := evt.Sender + + return fmt.Sprintf(ReplyFormat, evt.RoomID, evt.ID, evt.Sender, senderDisplayName, body) +} + +func ReplyFallbackText(evt *gomatrix.Event) string { + body, _ := evt.Content["body"].(string) + lines := strings.Split(strings.TrimSpace(body), "\n") + firstLine, lines := lines[0], lines[1:] + + senderDisplayName := evt.Sender + + var fallbackText strings.Builder + fmt.Fprintf(&fallbackText, "> <%s> %s", senderDisplayName, firstLine) + for _, line := range lines { + fmt.Fprintf(&fallbackText, "\n> %s", line) + } + fallbackText.WriteString("\n\n") + return fallbackText.String() +} + +func SetReply(content map[string]interface{}, inReplyTo *gomatrix.Event) map[string]interface{} { + content["m.relates_to"] = map[string]interface{}{ + "m.in_reply_to": map[string]interface{}{ + "event_id": inReplyTo.ID, + "room_id": inReplyTo.RoomID, + }, + } + + body, _ := content["body"].(string) + content["body"] = ReplyFallbackText(inReplyTo) + body + + htmlBody, ok := content["formatted_body"].(string) + if !ok { + htmlBody = html.EscapeString(body) + content["format"] = "org.matrix.custom.html" + } + content["formatted_body"] = ReplyFallbackHTML(inReplyTo) + htmlBody + return content +} diff --git a/maubot.go b/maubot.go new file mode 100644 index 0000000..4731897 --- /dev/null +++ b/maubot.go @@ -0,0 +1,79 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package maubot + +import ( + "net/http" + "os" + + "maubot.xyz/config" + "maubot.xyz/database" + "maubot.xyz/matrix" + log "maunium.net/go/maulogger" +) + +type Bot struct { + Config *config.MainConfig + Database *database.Database + Clients map[string]*matrix.Client + PluginCreators map[string]*PluginCreator + Plugins map[string]*PluginWrapper + Server *http.Server +} + +func New(config *config.MainConfig) *Bot { + return &Bot{ + Config: config, + Clients: make(map[string]*matrix.Client), + Plugins: make(map[string]*PluginWrapper), + PluginCreators: make(map[string]*PluginCreator), + } +} + +func (bot *Bot) Init() { + bot.initDatabase() + bot.initClients() + bot.initServer() + bot.loadPlugins() + bot.createPlugins() + log.Debugln("Init func exit") +} + +func (bot *Bot) Start() { + go bot.startClients() + go bot.startServer() + bot.startPlugins() + log.Debugln("Start func exit") +} + +func (bot *Bot) Stop() { + bot.stopPlugins() + bot.stopServer() + bot.stopClients() + log.Debugln("Stop func exit") +} + +func (bot *Bot) initDatabase() { + log.Debugln("Initializing database") + bot.Database = &bot.Config.Database + err := bot.Database.Connect() + if err != nil { + log.Fatalln("Failed to connect to database:", err) + os.Exit(2) + } + bot.Database.CreateTables() +} diff --git a/plugin.go b/plugin.go new file mode 100644 index 0000000..c138a32 --- /dev/null +++ b/plugin.go @@ -0,0 +1,95 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package maubot + +import ( + "fmt" + "plugin" + + "maubot.xyz/database" + "maubot.xyz/matrix" +) + +type Plugin interface { + Start() + Stop() +} + +type PluginWrapper struct { + Plugin + Creator *PluginCreator + DB *database.Plugin +} + +type PluginCreatorFunc func(bot *Bot, info *database.Plugin, client *matrix.Client) Plugin + +type PluginCreator struct { + Create PluginCreatorFunc + Name string + Version string + Path string +} + +func LoadPlugin(path string) (*PluginCreator, error) { + rawPlugin, err := plugin.Open(path) + if err != nil { + return nil, fmt.Errorf("failed to open: %v", err) + } + + pluginCreatorSymbol, err := rawPlugin.Lookup("Plugin") + if err == nil { + pluginCreator, ok := pluginCreatorSymbol.(*PluginCreator) + if ok { + pluginCreator.Path = path + return pluginCreator, nil + } + } + + pluginCreatorFuncSymbol, err := rawPlugin.Lookup("Create") + if err != nil { + return nil, fmt.Errorf("symbol \"Create\" not found: %v", err) + } + pluginCreatorFunc, ok := pluginCreatorFuncSymbol.(PluginCreatorFunc) + if !ok { + return nil, fmt.Errorf("symbol \"Create\" does not implement maubot.PluginCreator") + } + + nameSymbol, err := rawPlugin.Lookup("Name") + if err != nil { + return nil, fmt.Errorf("symbol \"Name\" not found: %v", err) + } + name, ok := nameSymbol.(string) + if !ok { + return nil, fmt.Errorf("symbol \"Name\" is not a string") + } + + versionSymbol, err := rawPlugin.Lookup("Version") + if err != nil { + return nil, fmt.Errorf("symbol \"Version\" not found: %v", err) + } + version, ok := versionSymbol.(string) + if !ok { + return nil, fmt.Errorf("symbol \"Version\" is not a string") + } + + return &PluginCreator{ + Create: pluginCreatorFunc, + Name: name, + Version: version, + Path: path, + }, nil +} diff --git a/plugins.go b/plugins.go new file mode 100644 index 0000000..4d90e53 --- /dev/null +++ b/plugins.go @@ -0,0 +1,113 @@ +// maubot - A plugin-based Matrix bot system written in Go. +// Copyright (C) 2018 Tulir Asokan +// +// 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 Affero General Public License for more details. +// +// You should have received a copy of the GNU Affero General Public License +// along with this program. If not, see . + +package maubot + +import ( + "io/ioutil" + "os" + "path/filepath" + + log "maunium.net/go/maulogger" +) + +func (bot *Bot) loadPlugin(dir, fileName string) { + ext := fileName[len(fileName)-4:] + if ext != ".mbp" { + return + } + + path := filepath.Join(dir, fileName) + + pluginCreator, err := LoadPlugin(path) + if err != nil { + log.Fatalf("Failed to load plugin at %s: %v\n", path, err) + os.Exit(4) + } + + _, exists := bot.PluginCreators[pluginCreator.Name] + if exists { + log.Debugf("Skipping plugin at %s: plugin with same name already loaded", path) + return + } + + bot.PluginCreators[pluginCreator.Name] = pluginCreator + log.Debugf("Loaded plugin creator %s v%s\n", pluginCreator.Name, pluginCreator.Version) +} + +func (bot *Bot) loadPlugins() { + for _, dir := range bot.Config.PluginDirs { + files, err := ioutil.ReadDir(dir) + if err != nil { + log.Fatalf("Failed to read plugin directory %s: %v\n", dir, err) + os.Exit(4) + } + for _, file := range files { + bot.loadPlugin(dir, file.Name()) + } + } +} + +func (bot *Bot) createPlugins() { + log.Debugln("Creating plugin instances") + plugins := bot.Database.Plugin.GetAll() + for _, plugin := range plugins { + if !plugin.Enabled { + log.Debugln("Skipping disabled plugin", plugin.ID) + continue + } + + creator, ok := bot.PluginCreators[plugin.Type] + if !ok { + log.Errorln("Plugin creator", plugin.Type, "for", plugin.ID, "not found, disabling plugin...") + plugin.Enabled = false + plugin.Update() + continue + } + + client, ok := bot.Clients[plugin.UserID] + if !ok { + log.Errorln("Client", plugin.UserID, "for", plugin.ID, "not found, disabling plugin...") + plugin.Enabled = false + plugin.Update() + continue + } + + + log.Debugf("Created plugin %s (type %s v%s)\n", plugin.ID, creator.Name, creator.Version) + bot.Plugins[plugin.ID] = &PluginWrapper{ + Plugin: creator.Create(bot, plugin, client), + Creator: creator, + DB: plugin, + } + } +} + +func (bot *Bot) startPlugins() { + log.Debugln("Starting plugin instances...") + for _, plugin := range bot.Plugins { + log.Debugf("Starting plugin %s (type %s v%s)\n", plugin.DB.ID, plugin.Creator.Name, plugin.Creator.Version) + go plugin.Start() + } +} + +func (bot *Bot) stopPlugins() { + log.Debugln("Stopping plugin instances...") + for _, plugin := range bot.Plugins { + log.Debugf("Stopping plugin %s (type %s v%s)\n", plugin.DB.ID, plugin.Creator.Name, plugin.Creator.Version) + plugin.Stop() + } +}