From 0bfa34ee730a7e0cd5141bbb4143deaa41b1982a Mon Sep 17 00:00:00 2001 From: "L. Bradley LaBoon" Date: Tue, 14 Jan 2025 00:55:26 -0500 Subject: [PATCH] Initial commit. v1.0.0 --- LICENSE | 661 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 66 +++++ base-config.yaml | 21 ++ maubot.yaml | 13 + twitchbot.py | 503 ++++++++++++++++++++++++++++++++++++ 5 files changed, 1264 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 base-config.yaml create mode 100644 maubot.yaml create mode 100644 twitchbot.py 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..beade90 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# twitchbot +A [maubot](https://github.com/maubot/maubot) plugin to get Twitch live stream notifications. + +## Installation +Either download an `.mbp` file from the [release assets](https://laboon.dev/brad/twitchbot/releases) or [build one yourself](#building). +Then, [upload](https://docs.mau.fi/maubot/usage/basic.html#uploading-plugins) it to your maubot instance. + +## Configuration +Before configuring your instance, you must first [register a new application](https://dev.twitch.tv/console/apps/create) using your Twitch account on the dev console. +When registering the application, use `http://localhost` as the Redirect URL and "Confidential" as the Client Type. +After registration, click "Manage" next to your new application and then click "New Secret" to generate a new client secret. Make note of both the Client ID and Client Secret. + +This plugin has the following settings you can configure: + +### `client_id` +Fill this in with the client ID you generated earlier. + +### `client_secret` +Likewise, fill this in with the client secret you generated earlier. + +### `notify_channels` +A list of Twitch channels for which you will be notified when they go live. + +### `notify_room` +The room ID of the Matrix room where notifications will be sent. Make sure your bot user is added to this room. + +### `matrix_users` +(Optional) A mapping of Twitch users to Matrix users. This will allow the bot to @ mention users when they go live. + +### Example config +``` +client_id: 'my_client_id' +client_secret: 'my_client_secret' +notify_channels: + - twitch_channel1 + - twitch_channel2 + - twitch_channel3 +notify_room: '!matrix_room:example.com' +matrix_users: + twitch_channel1: '@matrix_user1:example.com' + twitch_channel2: '@matrix_user2:example.com' +``` + +## Usage +Once configured, notifications will automatically be sent to the specified room whenever one of the specified channels goes live. + +You can use `!twitch ` to get the current status of any Twitch channel. + +## Building +Use the `mbc` tool to build this plugin: +``` +mbc build +``` +Optionally, use the `-u` switch to upload it to your maubot instance, if configured: +``` +mbc build -u +``` +Since `.mbp` files are just zip archives with a different name, you can also just zip the files of this repository: +``` +zip -r twitchbot.mbp * +``` + +## License + + +This project is licensed under the GNU Affero General Public License v3.0, see [LICENSE](LICENSE). diff --git a/base-config.yaml b/base-config.yaml new file mode 100644 index 0000000..1bec365 --- /dev/null +++ b/base-config.yaml @@ -0,0 +1,21 @@ +# Your twitch client ID and secret +# You can register your client at https://dev.twitch.tv/console/apps/create +client_id: '' +client_secret: '' + +# A list of channels you want to be notified for +# Example: +# notify_channels: +# - example1 +# - example2 +notify_channels: [] + +# The room ID where stream notifications should be sent +notify_room: '' + +# A mapping of twitch users to matrix users, for @mentions +# Example: +# matrix_users: +# example1: '@example1:example.com' +# example2: '@example2:example.com' +matrix_users: {} diff --git a/maubot.yaml b/maubot.yaml new file mode 100644 index 0000000..e6f526e --- /dev/null +++ b/maubot.yaml @@ -0,0 +1,13 @@ +maubot: 0.5.0 +id: io.laboon.maubot.twitchbot +version: 1.0.0 +license: AGPL-3.0-only +modules: + - twitchbot +main_class: TwitchBot +extra_files: + - base-config.yaml +config: true +webapp: true +database: true +database_type: asyncpg diff --git a/twitchbot.py b/twitchbot.py new file mode 100644 index 0000000..98a47e3 --- /dev/null +++ b/twitchbot.py @@ -0,0 +1,503 @@ +''' +twitchbot - A maubot plugin for sending Twitch stream notifications +Copyright (C) 2025 L. Bradley LaBoon + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License version 3 as +published by the Free Software Foundation. + +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 . +''' +from aiohttp.web import Request, Response +from asyncio import Task, CancelledError, sleep +from maubot import Plugin, MessageEvent +from maubot.handlers import command, web +from mautrix.types import TextMessageEventContent, MessageType, Format +from mautrix.util import background_task +from mautrix.util.async_db import UpgradeTable, Connection +from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper +from secrets import token_hex +from typing import Type +import hashlib +import hmac + +upgrade_table = UpgradeTable() + +@upgrade_table.register(description="Initial version") +async def upgrade_v1(conn: Connection) -> None: + await conn.execute("CREATE TABLE twitchbot_data (key TEXT PRIMARY KEY, value TEXT NOT NULL)") + await conn.execute("CREATE TABLE twitchbot_subs (id TEXT PRIMARY KEY, login TEXT NOT NULL, name TEXT NOT NULL)") + +class Config(BaseProxyConfig): + def do_update(self, helper: ConfigUpdateHelper) -> None: + helper.copy("client_id") + helper.copy("client_secret") + helper.copy("notify_channels") + helper.copy("matrix_users") + helper.copy("notify_room") + +class TwitchBot(Plugin): + access_check_loop: Task + + # On startup: refresh the config, start the access token check loop, and register stream notifications + async def start(self) -> None: + self.config.load_and_update() + self.access_check_loop = background_task.create(self.check_access_token()) + background_task.create(self.register_notifications()) + + # On config update: refresh the config and re-register stream notifications + def on_external_config_update(self) -> None: + self.config.load_and_update() + background_task.create(self.register_notifications()) + + # On shutdown: stop the access check loop + async def stop(self) -> None: + self.access_check_loop.cancel() + + @classmethod + def get_config_class(cls) -> Type[BaseProxyConfig]: + return Config + + @classmethod + def get_db_upgrade_table(cls) -> UpgradeTable | None: + return upgrade_table + + # Check that we have a valid access token and get a new one if we don't + async def check_access_token(self) -> None: + try: + self.log.debug("Access check loop started.") + while True: + self.log.debug("Performing access token check...") + q = "SELECT value FROM twitchbot_data WHERE key = $1" + row = await self.database.fetchrow(q, "access_token") + if row: + headers = { "Authorization": f"Bearer {row['value']}" } + async with self.http.get("https://id.twitch.tv/oauth2/validate", headers=headers) as response: + result = await response.json() + if (response.status == 401): + self.log.info("Access token is invalid, fetching a new one...") + await self.get_access_token() + else: + self.log.debug("Current access token is valid!") + else: + self.log.info("Access token is missing, fetching a new one...") + await self.get_access_token() + + # Sleep for an hour + await sleep(3600) + except CancelledError: + self.log.debug("Access check loop stopped.") + + # Get a new access token + async def get_access_token(self) -> str: + data = { + "client_id": self.config["client_id"], + "client_secret": self.config["client_secret"], + "grant_type": "client_credentials" + } + async with self.http.post("https://id.twitch.tv/oauth2/token", data=data) as response: + result = await response.json() + if (response.status >= 400): + self.log.error(f"Error getting access token: {response.status} - {result['message']}") + return "" + + # Store new token in the DB + q = "INSERT INTO twitchbot_data (key, value) VALUES ($1, $2) ON CONFLICT (key) DO UPDATE SET value=excluded.value" + await self.database.execute(q, "access_token", result["access_token"]) + self.log.info("Stored new access token") + return result["access_token"] + + # Get or generate webhook secret + async def get_webhook_secret(self) -> str: + q = "SELECT value FROM twitchbot_data WHERE key = $1" + row = await self.database.fetchrow(q, "webhook_secret") + if row: + return row["value"] + else: + self.log.info("No webhook secret found. Generating a new one...") + secret = token_hex(32) + qi = "INSERT INTO twitchbot_data (key, value) VALUES ($1, $2) ON CONFLICT (key) DO UPDATE SET value=excluded.value" + await self.database.execute(qi, "webhook_secret", secret) + self.log.info("Stored new webhook secret") + return secret + + # Fetch an image URL, upload it to the matrix media store, and return the mcx:// address + async def upload_img(self, link: str) -> str: + image_req = await self.http.get(link) + if (image_req.status < 400): + image = await image_req.read() + mxc = await self.client.upload_media(image, filename=image_req.url.name) + return mxc + return "" + + # Make a Twitch API call and return the data + async def twitch_api(self, method: str, endpoint: str, params: dict | None, data: dict | None, evt: MessageEvent | None) -> dict | None: + # Get access token from DB + q = "SELECT value FROM twitchbot_data WHERE key = $1" + row = await self.database.fetchrow(q, "access_token") + if row: + access_token = row["value"] + else: + self.log.info("Access token is missing, fetching a new one...") + access_token = await self.get_access_token() + if (len(access_token) < 1): + if isinstance(evt, MessageEvent): + await evt.respond("I seem to be having trouble authenticating to the Twitch API. Check the logs for more details.") + return None + + if (method == "GET"): + httpfunc = self.http.get + elif (method == "POST"): + httpfunc = self.http.post + elif (method == "DELETE"): + httpfunc = self.http.delete + else: + self.log.error(f"Unknown method: {method}") + return None + + headers = { + "Authorization": f"Bearer {access_token}", + "Client-Id": self.config["client_id"] + } + retry = 2 + while (retry > 0): + async with httpfunc("https://api.twitch.tv/helix" + endpoint, headers=headers, params=params, json=data) as response: + if (response.status == 204): + rdata = {} + else: + rdata = await response.json() + if (response.status == 401): + self.log.info("Access token is invalid, fetching a new one...") + access_token = await self.get_access_token() + if (len(access_token) < 1): + if isinstance(evt, MessageEvent): + await evt.respond("I seem to be having trouble authenticating to the Twitch API. Check the logs for more details.") + return None + headers["Authorization"] = f"Bearer {access_token}" + retry = retry - 1 + continue + elif (response.status >= 400): + # For some reason the /streams endpoint returns 400 for nonexistent or deactivated channels + if (endpoint == "/streams" and rdata["message"] == "Malformed query params."): + if isinstance(evt, MessageEvent): + await evt.respond("Sorry, I can't seem to find that channel.") + else: + self.log.warning(f"Channel '{params['user_login']}' does not exist.") + return None + self.log.error(f"{method} {str(response.url)}: {response.status} {rdata['error']} - {rdata['message']}") + if isinstance(evt, MessageEvent): + await evt.respond(f"{rdata['error']} - {rdata['message']}") + return None + return rdata + return None + + # Main !twitch command handler + @command.new(name="twitch", help="Get the status of a Twitch channel") + @command.argument("channel", required=True, pass_raw=True) + async def twitch(self, evt: MessageEvent, channel: str) -> None: + await self.get_status(evt, channel) + + # Get the status of a Twitch channel + async def get_status(self, evt: MessageEvent | None, channel: str) -> None: + if (len(channel) < 1): + if isinstance(evt, MessageEvent): + await evt.respond("You forgot to give me a channel name") + return + + # Get stream info + params = { "user_login": channel, "type": "live" } + streams = await self.twitch_api("GET", "/streams", params, None, evt) + if not streams: + return + + # If there are no live streams, return channel info instead + if (len(streams["data"]) < 1): + params = { "login": channel } + users = await self.twitch_api("GET", "/users", params, None, evt) + if not users: + return + + if (len(users["data"]) < 1): + if isinstance(evt, MessageEvent): + await evt.respond(f"Could not find user: {channel}") + return + user = users["data"][0] + + # Upload channel image + if (len(user["offline_image_url"]) > 0): + mxc = await self.upload_img(user["offline_image_url"]) + elif (len(user["profile_image_url"]) > 0): + mxc = await self.upload_img(user["profile_image_url"]) + else: + mxc = "" + if (len(mxc) > 0): + img_html = f"" + else: + img_html = "" + + # Mention room user if defined + if user["login"] in self.config["matrix_users"]: + user_html = f"{user['display_name']}" + else: + user_html = user["display_name"] + + # Construct and send response + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + format=Format.HTML, + body=f"> {user['display_name']} is offline.\n> **[{user['display_name']}](https://twitch.tv/{user['login']})**\n> {user['description']}\n> **Total Views:** {user['view_count']}", + formatted_body=f"
{user_html} is offline.

{user['display_name']}

{user['description']}

{img_html}
" + ) + if isinstance(evt, MessageEvent): + await evt.respond(content) + else: + await self.client.send_message(self.config["notify_room"], content) + + return + + # Use game name as title if no title is provided + stream = streams["data"][0] + if (len(stream["title"]) < 1): + stream["title"] = stream["game_name"] + + # Upload thumbnail + mxc = await self.upload_img(stream["thumbnail_url"].format(width="400", height="225")) + if (len(mxc) > 0): + img_html = f"" + else: + img_html = "" + + # Mention room user if defined + if stream["user_login"] in self.config["matrix_users"]: + user_html = f"{stream['user_name']}" + else: + user_html = stream["user_name"] + + # Construct and send response + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + format=Format.HTML, + body=f"> {stream['user_name']} is now live on Twitch!\n> **[{stream['title']}](https://twitch.tv/{stream['user_login']})**\n> **Game:** {stream['game_name']}\n> **Viewers:** {stream['viewer_count']}", + formatted_body=f"
{user_html} is now live on Twitch!

{stream['title']}

Game: {stream['game_name']}
Viewers: {stream['viewer_count']}

{img_html}
" + ) + if isinstance(evt, MessageEvent): + await evt.respond(content) + else: + await self.client.send_message(self.config["notify_room"], content) + + # Register channel notifications and/or unregister old subscriptions + async def register_notifications(self) -> None: + self.log.debug("Registering notifications...") + + # Exit immediately if client_id and client_secret aren't set + if ("client_id" not in self.config or "client_secret" not in self.config or len(self.config["client_id"]) < 1 or len(self.config["client_secret"]) < 1): + return + + # Get sub list from config + config_subs = self.config["notify_channels"].copy() + + # Get subs from DB + db_subs = await self.database.fetch("SELECT * FROM twitchbot_subs") + + # Get current sub list from API + register_error = TextMessageEventContent( + msgtype=MessageType.NOTICE, + body="I encountered an issue while registering Twitch notifications. Check the logs for more details." + ) + response = await self.twitch_api("GET", "/eventsub/subscriptions", None, None, None) + if not response: + await self.client.send_message(self.config["notify_room"], register_error) + return + api_subs = response["data"] + + # Handle paginated results + while (response["pagination"] and response["pagination"]["cursor"]): + params = { "after": response["pagination"]["cursor"] } + response = await self.twitch_api("GET", "/eventsub/subscriptions", params, None, None) + if not response: + await self.client.send_message(self.config["notify_room"], register_error) + return + api_subs = api_subs + response["data"] + + # Check current subs for ones that need removal + for sub in api_subs: + # Ignore subs that aren't for our instance + if (sub["transport"]["callback"] != str(self.webapp_url) + "/stream-notify"): + continue + + # Locate corresponding sub from DB + db_sub = None + for i in db_subs: + if (i["id"] == sub["id"]): + db_sub = i + break + + # Unsubscribe from the notification if we have no record of it, or if it's no longer in the config list + if (db_sub is None or db_sub["login"] not in config_subs): + params = { "id": sub["id"] } + await self.twitch_api("DELETE", "/eventsub/subscriptions", params, None, None) + + # Remove record from the DB + if db_sub: + self.log.info(f"Unsubscribed from channel {db_sub['login']}") + db_subs.remove(db_sub) + qd = "DELETE FROM twitchbot_subs WHERE id = $1" + await self.database.execute(qd, sub["id"]) + else: + self.log.info(f"Unsubscribed from user ID {sub['condition']['broadcaster_user_id']}") + + continue + + # Otherwise, this sub checks out so remove it from the list of subs that need processing + config_subs.remove(db_sub["login"]) + db_subs.remove(db_sub) + + webhook_secret = await self.get_webhook_secret() + + # Register remaining subs from the config + for sub in config_subs: + # Check if there is a corresponding DB entry + db_sub = None + for i in db_subs: + if (i["login"] == sub): + db_sub = i + break + + # Lookup channel name + params = { "login": sub } + users = await self.twitch_api("GET", "/users", params, None, None) + if not users or len(users["data"]) < 1: + if db_sub: + if (sub in self.config["matrix_users"]): + user_html = f"{db_sub['name']}" + else: + user_html = db_sub["name"] + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + format=Format.HTML, + body=f"Lost Twitch channel notification subscription for {db_sub['name']}. Check the logs for more details.", + formatted_body=f"

Lost Twitch channel notification subscription for {user_html}. Check the logs for more details.

" + ) + await self.client.send_message(self.config["notify_room"], content) + else: + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + body=f"Could not subscribe to Twitch channel '{sub}'. Are you sure it exists?" + ) + await self.client.send_message(self.config["notify_room"], content) + continue + + user = users["data"][0] + + # Register subscription + req = { + "type": "stream.online", + "version": "1", + "condition": { + "broadcaster_user_id": user["id"] + }, + "transport": { + "method": "webhook", + "callback": str(self.webapp_url) + "/stream-notify", + "secret": webhook_secret + } + } + response = await self.twitch_api("POST", "/eventsub/subscriptions", None, req, None) + if not response: + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + body=f"I encountered an issue subscribing to channel '{sub}'. Check the logs for more details." + ) + await self.client.send_message(self.config["notify_room"], content) + continue + + # Add new subscription to DB + self.log.info(f"Storing new subscription for channel {sub}") + q = "INSERT INTO twitchbot_subs (id, login, name) VALUES ($1, $2, $3) ON CONFLICT (id) DO UPDATE SET login=excluded.login, name=excluded.name" + await self.database.execute(q, response["data"][0]["id"], sub, user["display_name"]) + + # Clean up remaining stale DB entries + for sub in db_subs: + self.log.info(f"Cleaning stale DB entry for channel {sub['login']}") + qd = "DELETE FROM twitchbot_subs WHERE id = $1" + await self.database.execute(qd, sub["id"]) + + # Webhook handler for live stream notifications + @web.post("/stream-notify") + async def stream_notify(self, req: Request) -> Response: + self.log.debug("Handling webhook event...") + # Check for necessary headers + id = req.headers.get("Twitch-Eventsub-Message-Id") + timestamp = req.headers.get("Twitch-Eventsub-Message-Timestamp") + signature = req.headers.get("Twitch-Eventsub-Message-Signature") + type = req.headers.get("Twitch-Eventsub-Message-Type") + if (id is None or timestamp is None or signature is None or type is None): + self.log.info("Webhook event is missing required headers") + return Response(status=403, text="Missing required headers") + + # Compute HMAC and validate against the one supplied + body = await req.text() + data = await req.json() + secret = await self.get_webhook_secret() + my_hmac = hmac.new(secret.encode(), id.encode(), hashlib.sha256) + my_hmac.update(timestamp.encode()) + my_hmac.update(body.encode()) + if (hmac.compare_digest("sha256=" + my_hmac.hexdigest(), signature) == False): + self.log.info("Webhook event failed validation") + return Response(status=403, text="Invalid HMAC signature") + + # Handle challenge requests + if (type == "webhook_callback_verification"): + self.log.info("Responded to webhook challenge") + return Response(status=200, text=data["challenge"]) + + # Handle subscription revocations + if (type == "revocation"): + reasons = { + "user_removed": "Channel no longer exists", + "authorization_revoked": "API access has been revoked (try resetting the bot)", + "notification_failures_exceeded": "Notification responses have been too slow (consider a hardware upgrade?)", + "version_removed": "This type of subscription is no longer available - please file a bug report" + } + if (data["subscription"]["status"] in reasons): + reason = reasons[data["subscription"]["status"]] + else: + reason = data["subscription"]["status"] + + # Get subscription data from DB and send channel notification + q = "SELECT * FROM twitchbot_subs WHERE id = $1" + row = await self.database.fetchrow(q, data["subscription"]["id"]) + if row: + self.log.warning(f"Subscription to channel '{row['login']}' revoked.") + user_name = row["name"] + if (row["login"] in self.config["matrix_users"]): + user_html = f"{row['name']}" + else: + user_html = row["name"] + # Delete subscription from DB + qd = "DELETE FROM twitchbot_subs WHERE id = $1" + await self.database.execute(qd, data["subscription"]["id"]) + else: + self.log.warning(f"Subscription to user ID {data['subscription']['condition']['broadcaster_user_id']} revoked.") + user_name = f"ID {data['subscription']['condition']['broadcaster_user_id']}" + user_html = user_name + content = TextMessageEventContent( + msgtype=MessageType.NOTICE, + format=Format.HTML, + body=f"Lost Twitch channel notification subscription for {user_name}: {reason}", + formatted_body=f"

Lost Twitch channel notification subscription for {user_html}: {reason}

" + ) + await self.client.send_message(self.config["notify_room"], content) + + # Handle notifications + if (type == "notification"): + self.log.info(f"Sending channel notification for {data['event']['broadcaster_user_login']}") + await self.get_status(None, data["event"]["broadcaster_user_login"]) + + return Response(status=204)