├── .gitignore ├── .gitlab-ci.yml ├── LICENSE ├── README.md ├── base-config.yaml ├── disruptor ├── __init__.py ├── bot.py └── source │ ├── __init__.py │ ├── abstract.py │ ├── cache.py │ ├── ctxsplit.py │ ├── noop.py │ ├── random.py │ ├── reddit.py │ ├── unsplash.py │ ├── unsplash_legacy.py │ └── url.py └── maubot.yaml /.gitignore: -------------------------------------------------------------------------------- 1 | *.mbp 2 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | include: 2 | - project: 'maubot/maubot' 3 | file: '/.gitlab-ci-plugin.yml' 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cat Disruptor 6000 2 | A [maubot](https://github.com/maubot/maubot) that disrupts monologues with cat pictures. 3 | -------------------------------------------------------------------------------- /base-config.yaml: -------------------------------------------------------------------------------- 1 | # Image source configuration 2 | source: 3 | type: random 4 | config: 5 | sources: 6 | - weight: 10 7 | type: unsplash 8 | config: 9 | topics: 10 | - animals/cat 11 | - weight: 2 12 | type: url 13 | config: 14 | url: https://display-a.sand.cat/cat.php 15 | # Number of messages before messages are considered a monologue that needs to be disrupted. 16 | min_monologue_size: 10 17 | # Maximum number of seconds between messages for a monologue to end. 18 | max_monologue_delay: 300 19 | # Cooldown in seconds after disrupting a monologue during which messages are counted, 20 | # but monologues aren't disrupted even if the message count goes over the limit. 21 | disrupt_cooldown: 10 22 | # Rate limits for manual cat requests. 23 | user_ratelimit: 24 | # How many cat pictures can be manually requested per time unit per room 25 | rate: 3 26 | # The time unit for the above, as seconds 27 | per: 3600 28 | # The message to send when the rate limit is exceeded. 29 | message: You have exceeded your hourly cat allowance. 30 | # Same rate limit as above, but per room instead of per user. 31 | # Both per user and per room rate limits are checked before allowing a cat request. 32 | room_ratelimit: 33 | rate: 3 34 | per: 86400 35 | message: This room has exceeded its daily cat allowance. 36 | -------------------------------------------------------------------------------- /disruptor/__init__.py: -------------------------------------------------------------------------------- 1 | from .bot import DisruptorBot 2 | -------------------------------------------------------------------------------- /disruptor/bot.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2021 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Dict, Type, Tuple, Optional 17 | from collections import defaultdict 18 | from time import time 19 | import asyncio 20 | 21 | from attr import dataclass 22 | import magic 23 | 24 | from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper 25 | from mautrix.types import (EventType, UserID, RoomID, MediaMessageEventContent, ContentURI, 26 | MessageType, EncryptedEvent, BaseMessageEventContent, RelationType, 27 | EncryptedMegolmEventContent) 28 | 29 | from maubot import Plugin, MessageEvent 30 | from maubot.handlers import event, command 31 | 32 | from .source import AbstractSource, CancelDisruption, DisruptionContext 33 | 34 | try: 35 | from PIL import Image 36 | from io import BytesIO 37 | except ImportError: 38 | Image = None 39 | BytesIO = None 40 | 41 | 42 | class Config(BaseProxyConfig): 43 | def do_update(self, helper: ConfigUpdateHelper) -> None: 44 | helper.copy("source.type") 45 | helper.copy("source.config") 46 | helper.copy("min_monologue_size") 47 | helper.copy("max_monologue_delay") 48 | helper.copy("disrupt_cooldown") 49 | helper.copy("user_ratelimit.rate") 50 | helper.copy("user_ratelimit.per") 51 | helper.copy("user_ratelimit.message") 52 | helper.copy("room_ratelimit.rate") 53 | helper.copy("room_ratelimit.per") 54 | helper.copy("room_ratelimit.message") 55 | 56 | 57 | class MonologueInfo: 58 | user_id: Optional[UserID] 59 | streak: int 60 | last_message: float 61 | prev_disrupt: float 62 | lock: asyncio.Lock 63 | 64 | def __init__(self, user_id: Optional[UserID] = None, streak: int = 0, last_message: float = 0, 65 | prev_disrupt: float = 0) -> None: 66 | self.user_id = user_id 67 | self.streak = streak 68 | self.last_message = last_message 69 | self.prev_disrupt = prev_disrupt 70 | self.lock = asyncio.Lock() 71 | 72 | def message(self, user_id: UserID) -> None: 73 | if self.user_id == user_id: 74 | self.streak += 1 75 | else: 76 | self.user_id = user_id 77 | self.streak = 1 78 | self.last_message = time() 79 | 80 | def reset(self) -> None: 81 | self.user_id = None 82 | self.streak = 0 83 | 84 | def is_outdated(self, max_delay: int) -> bool: 85 | return self.last_message != 0 and self.last_message + max_delay < time() 86 | 87 | def should_disrupt(self, min_count: int, disrupt_cooldown: int) -> bool: 88 | return self.streak >= min_count and self.prev_disrupt + disrupt_cooldown < time() 89 | 90 | def __repr__(self) -> str: 91 | return str(self) 92 | 93 | def __str__(self) -> str: 94 | return (f"MonologueInfo(user_id={self.user_id}, streak={self.streak}, " 95 | f"last_message={self.last_message}, prev_disrupt={self.prev_disrupt})") 96 | 97 | 98 | @dataclass 99 | class ManualRateLimit: 100 | rate: float = 3.0 101 | per: float = 3600.0 102 | allowance: float = 0.0 103 | last_request: float = 0.0 104 | 105 | def __attrs_post_init__(self) -> None: 106 | self.allowance = self.rate 107 | 108 | def request(self) -> bool: 109 | now = time() 110 | time_passed = now - self.last_request 111 | self.last_request = now 112 | self.allowance += time_passed * (self.rate / self.per) 113 | if self.allowance > self.rate: 114 | self.allowance = self.rate 115 | if self.allowance < 1.0: 116 | return False 117 | else: 118 | self.allowance -= 1.0 119 | return True 120 | 121 | 122 | class DisruptorBot(Plugin): 123 | monologue_size: Dict[RoomID, MonologueInfo] 124 | manual_room_ratelimits: Dict[RoomID, ManualRateLimit] 125 | manual_user_ratelimits: Dict[UserID, ManualRateLimit] 126 | source: AbstractSource 127 | reload_lock: asyncio.Lock 128 | 129 | async def start(self): 130 | await super().start() 131 | self.config.load_and_update() 132 | 133 | self.monologue_size = defaultdict(lambda: MonologueInfo()) 134 | self.manual_room_ratelimits = defaultdict(lambda: ManualRateLimit( 135 | rate=float(self.config["room_ratelimit.rate"]), 136 | per=float(self.config["room_ratelimit.per"]))) 137 | self.manual_user_ratelimits = defaultdict(lambda: ManualRateLimit( 138 | rate=float(self.config["user_ratelimit.rate"]), 139 | per=float(self.config["user_ratelimit.per"]))) 140 | self.reload_lock = asyncio.Lock() 141 | 142 | self.source = AbstractSource.create(self, self.config["source"]) 143 | await self.source.prepare() 144 | 145 | @event.on(EventType.ROOM_ENCRYPTED) 146 | async def encrypted_monologue_detector(self, evt: EncryptedEvent) -> None: 147 | if (isinstance(evt.content, EncryptedMegolmEventContent) 148 | and evt.content.relates_to.rel_type == RelationType.REPLACE): 149 | return 150 | await self.monologue_detector(evt.sender, evt.room_id) 151 | 152 | @event.on(EventType.ROOM_MESSAGE) 153 | async def normal_monologue_detector(self, evt: MessageEvent) -> None: 154 | if isinstance(evt.content, BaseMessageEventContent) and evt.content.get_edit(): 155 | return 156 | await self.monologue_detector(evt.sender, evt.room_id) 157 | 158 | async def monologue_detector(self, user_id: UserID, room_id: RoomID) -> None: 159 | monologue = self.monologue_size[room_id] 160 | if monologue.is_outdated(self.config["max_monologue_delay"]): 161 | monologue.reset() 162 | monologue.message(user_id) 163 | async with monologue.lock: 164 | if monologue.should_disrupt(self.config["min_monologue_size"], 165 | self.config["disrupt_cooldown"]): 166 | self.log.debug(f"Disrupting monologue in {room_id}: {monologue}") 167 | await self.disrupt(user_id, room_id) 168 | monologue.reset() 169 | 170 | async def reupload(self, url: str) -> Tuple[ContentURI, str, bytes]: 171 | resp = await self.http.get(url, headers={"User-Agent": self.config["user_agent"]}) 172 | data = await resp.read() 173 | mime_type = magic.from_buffer(data, mime=True) 174 | mxc = await self.client.upload_media(data, mime_type) 175 | return mxc, mime_type, data 176 | 177 | @command.passive(r"^\U0001f408\ufe0f?$") 178 | async def cat_command(self, evt: MessageEvent, _: str) -> None: 179 | if self.manual_user_ratelimits[evt.sender].request(): 180 | if self.manual_room_ratelimits[evt.room_id].request(): 181 | await self.disrupt(evt.sender, evt.room_id) 182 | else: 183 | await evt.reply(self.config["room_ratelimit.message"]) 184 | self.manual_user_ratelimits[evt.sender].allowance += 1 185 | else: 186 | await evt.reply(self.config["user_ratelimit.message"]) 187 | 188 | async def disrupt(self, user_id: UserID, room_id: RoomID) -> None: 189 | ctx = DisruptionContext(user_id=user_id, room_id=room_id) 190 | try: 191 | image = await self.source.fetch_with_context(ctx) 192 | except CancelDisruption: 193 | return 194 | except Exception: 195 | self.log.exception("Failed to fetch image for disruption") 196 | return 197 | content = MediaMessageEventContent(body=image.title, url=image.url, info=image.info, 198 | msgtype=MessageType.IMAGE, 199 | external_url=image.external_url) 200 | await self.client.send_message_event(room_id, EventType.ROOM_MESSAGE, content) 201 | 202 | @classmethod 203 | def get_config_class(cls) -> Type[BaseProxyConfig]: 204 | return Config 205 | -------------------------------------------------------------------------------- /disruptor/source/__init__.py: -------------------------------------------------------------------------------- 1 | from .abstract import AbstractSource, CancelDisruption, DisruptionContext 2 | from .unsplash_legacy import UnsplashLegacy 3 | from .unsplash import Unsplash 4 | from .reddit import Reddit 5 | from .cache import Cache 6 | from .random import Random 7 | from .ctxsplit import ContextSplit 8 | from .noop import Noop 9 | 10 | for source in AbstractSource.__subclasses__(): 11 | AbstractSource.all[(source.type_name or source.__name__).lower()] = source 12 | 13 | __all__ = ["AbstractSource", "CancelDisruption", "DisruptionContext"] 14 | -------------------------------------------------------------------------------- /disruptor/source/abstract.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2021 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import NamedTuple, Tuple, Type, Optional, Dict, Any, ClassVar, TYPE_CHECKING 17 | from abc import ABC, abstractmethod 18 | from io import BytesIO 19 | import mimetypes 20 | import cgi 21 | 22 | from aiohttp import ClientResponse 23 | from yarl import URL 24 | import magic 25 | 26 | from mautrix.types import ImageInfo, ContentURI, UserID, RoomID 27 | from mautrix.util.logging import TraceLogger 28 | 29 | try: 30 | from PIL import Image as Pillow 31 | except ImportError: 32 | Pillow = None 33 | 34 | if TYPE_CHECKING: 35 | from ..bot import DisruptorBot 36 | 37 | 38 | class Image(NamedTuple): 39 | title: str 40 | url: ContentURI 41 | info: ImageInfo 42 | external_url: str 43 | 44 | 45 | class CancelDisruption(Exception): 46 | pass 47 | 48 | 49 | class DisruptionContext(NamedTuple): 50 | room_id: RoomID 51 | user_id: UserID 52 | 53 | 54 | class AbstractSource(ABC): 55 | type_name: ClassVar[str] = None 56 | all: ClassVar[Dict[str, Type['AbstractSource']]] = {} 57 | bot: 'DisruptorBot' 58 | log: TraceLogger 59 | config: Dict[str, Any] 60 | 61 | def __init__(self, bot: 'DisruptorBot', config: Dict[str, Any]) -> None: 62 | self.bot = bot 63 | self.log = bot.log.getChild("source").getChild(self.__class__.__name__.lower()) 64 | self.config = config 65 | 66 | async def prepare(self) -> None: 67 | pass 68 | 69 | async def fetch_with_context(self, ctx: DisruptionContext) -> Image: 70 | return await self.fetch() 71 | 72 | @abstractmethod 73 | async def fetch(self) -> Image: 74 | pass 75 | 76 | @classmethod 77 | def create(cls, bot: 'DisruptorBot', config: Dict[str, Any] 78 | ) -> 'AbstractSource': 79 | type_cls = cls.all[config["type"].lower()] 80 | return type_cls(bot, config.get("config", {})) 81 | 82 | @staticmethod 83 | def _get_filename(url: URL, resp: ClientResponse, mimetype: str) -> str: 84 | filename = None 85 | try: 86 | _, params = cgi.parse_header(resp.headers["Content-Disposition"]) 87 | filename = params.get("filename") 88 | except KeyError: 89 | pass 90 | if not filename: 91 | filename = (resp.url or url).path.split("/")[-1] 92 | if "." not in filename: 93 | filename += mimetypes.guess_extension(mimetype) or "" 94 | return filename 95 | 96 | async def _reupload(self, url: URL, title: Optional[str] = None, blurhash: Optional[str] = None, 97 | dimensions: Optional[Tuple[int, int]] = None, 98 | external_url: Optional[str] = None, 99 | thumbnail_url: Optional[URL] = None, 100 | thumbnail_dimensions: Optional[Tuple[int, int]] = None, 101 | headers: Optional[Dict[str, str]] = None) -> Image: 102 | self.log.debug(f"Reuploading {title} from {url}") 103 | info = ImageInfo() 104 | if "user_agent" in self.config: 105 | headers["User-Agent"] = self.config["user_agent"] 106 | async with self.bot.http.get(url, headers=headers) as resp: 107 | data = await resp.read() 108 | info.size = len(data) 109 | info.mimetype = resp.headers["Content-Type"] 110 | if not info.mimetype: 111 | info.mimetype = magic.from_buffer(data, mime=True) 112 | if not title: 113 | title = self._get_filename(url, resp, info.mimetype) 114 | if dimensions: 115 | info.width, info.height = dimensions 116 | elif Pillow: 117 | img = Pillow.open(BytesIO(data)) 118 | info.width, info.height = img.size 119 | mxc = await self.bot.client.upload_media(data, info.mimetype) 120 | if thumbnail_url: 121 | thumbnail = await self._reupload(thumbnail_url, title=title, headers=headers, 122 | dimensions=thumbnail_dimensions) 123 | info.thumbnail_url = thumbnail.url 124 | info.thumbnail_info = thumbnail.info 125 | if blurhash: 126 | info["blurhash"] = blurhash 127 | info["xyz.amorgan.blurhash"] = blurhash 128 | return Image(url=mxc, info=info, title=title, external_url=external_url) 129 | -------------------------------------------------------------------------------- /disruptor/source/cache.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2021 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Deque 17 | from collections import deque 18 | import asyncio 19 | 20 | from mautrix.util import background_task 21 | 22 | from .abstract import AbstractSource, CancelDisruption, Image 23 | 24 | 25 | class Cache(AbstractSource): 26 | source: AbstractSource 27 | cache: Deque[Image] 28 | fetch_errors: int 29 | 30 | async def prepare(self) -> None: 31 | self.source = AbstractSource.create(self.bot, self.config) 32 | self.source.log = self.log.getChild(self.source.__class__.__name__.lower()) 33 | await self.source.prepare() 34 | self.cache = deque(maxlen=self.config.get("size", 5)) 35 | initial_fetch_sleep = self.config.get("initial_fetch_sleep", 0) 36 | self.fetch_errors = 0 37 | self.log.debug(f"Fetching {self.cache.maxlen} images to fill cache") 38 | for i in range(self.cache.maxlen): 39 | await self.fetch_to_cache() 40 | if initial_fetch_sleep: 41 | await asyncio.sleep(initial_fetch_sleep) 42 | 43 | async def fetch_to_cache(self) -> None: 44 | try: 45 | image = await self.source.fetch() 46 | except CancelDisruption: 47 | self.log.warning("Child cancelled fetch to fill cache") 48 | self.fetch_errors += 1 49 | except Exception: 50 | self.log.exception("Child threw error trying to fetch image to fill cache") 51 | self.fetch_errors += 1 52 | else: 53 | self.cache.appendleft(image) 54 | self.log.debug(f"Got image for cache, size is now {len(self.cache)}") 55 | if self.fetch_errors > 0: 56 | self.log.debug("Fetching additional image after successful fetch " 57 | "to cover earlier error") 58 | self.fetch_errors -= 1 59 | background_task.create(self.fetch_to_cache()) 60 | 61 | async def fetch(self) -> Image: 62 | try: 63 | image = self.cache.pop() 64 | except IndexError: 65 | self.log.error("Cache is empty, canceling disruption") 66 | # TODO try refetching at some point 67 | raise CancelDisruption() 68 | self.log.debug("Fetching image to refill cache") 69 | background_task.create(self.fetch_to_cache()) 70 | return image 71 | -------------------------------------------------------------------------------- /disruptor/source/ctxsplit.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2022 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, List, Tuple, ClassVar 17 | 18 | from attr import dataclass 19 | from mautrix.types import RoomID, UserID 20 | 21 | from .abstract import AbstractSource, Image, DisruptionContext, CancelDisruption 22 | 23 | 24 | @dataclass 25 | class PartialDisruptionContext: 26 | room_id: Optional[RoomID] = None 27 | room_ids: Optional[List[RoomID]] = None 28 | user_id: Optional[UserID] = None 29 | user_ids: Optional[List[RoomID]] = None 30 | 31 | def matches(self, ctx: DisruptionContext) -> bool: 32 | if self.room_id is not None and ctx.room_id != self.room_id: 33 | return False 34 | elif self.room_ids is not None and ctx.room_id not in self.room_ids: 35 | return False 36 | if self.user_id is not None and ctx.user_id != self.user_id: 37 | return False 38 | elif self.user_ids is not None and ctx.user_id not in self.user_ids: 39 | return False 40 | return True 41 | 42 | 43 | class ContextSplit(AbstractSource): 44 | type_name: ClassVar[str] = "context_split" 45 | sources: List[Tuple[PartialDisruptionContext, AbstractSource]] 46 | 47 | async def prepare(self) -> None: 48 | self.sources = [] 49 | for index, source_cfg in enumerate(self.config["sources"]): 50 | source = AbstractSource.create(self.bot, source_cfg) 51 | source_name = f"{index}_{type(source).__name__.lower()}" 52 | source.log = self.log.getChild(source_name) 53 | await source.prepare() 54 | ctx = PartialDisruptionContext(**source_cfg["context"]) 55 | self.sources.append((ctx, source)) 56 | 57 | async def fetch_with_context(self, ctx: DisruptionContext) -> Image: 58 | for src_ctx, src in self.sources: 59 | if src_ctx.matches(ctx): 60 | return await src.fetch() 61 | self.log.debug("Failed to disrupt: no sources matched context") 62 | raise CancelDisruption() 63 | 64 | async def fetch(self) -> Image: 65 | self.log.error("Failed to disrupt: called non-context fetch on ContextSplit") 66 | raise CancelDisruption() 67 | -------------------------------------------------------------------------------- /disruptor/source/noop.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2022 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from .abstract import AbstractSource, Image, CancelDisruption 17 | 18 | 19 | class Noop(AbstractSource): 20 | def fetch(self) -> Image: 21 | raise CancelDisruption() 22 | -------------------------------------------------------------------------------- /disruptor/source/random.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2022 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from __future__ import annotations 17 | 18 | import random 19 | 20 | from .abstract import AbstractSource, Image, DisruptionContext 21 | 22 | 23 | class Random(AbstractSource): 24 | sources: list[AbstractSource] 25 | weights: list[float] 26 | 27 | async def prepare(self) -> None: 28 | self.sources = [] 29 | int_weights: list[int] = [] 30 | for index, source_cfg in enumerate(self.config["sources"]): 31 | source = AbstractSource.create(self.bot, source_cfg) 32 | source_name = f"{index}_{type(source).__name__.lower()}" 33 | source.log = self.log.getChild(source_name) 34 | await source.prepare() 35 | self.sources.append(source) 36 | int_weights.append(source_cfg["weight"]) 37 | weight_sum = sum(int_weights) 38 | self.weights = [weight / weight_sum for weight in int_weights] 39 | 40 | async def fetch_with_context(self, ctx: DisruptionContext | None = None) -> Image: 41 | source = random.choices(self.sources, self.weights, k=1)[0] 42 | return await source.fetch_with_context(ctx) 43 | 44 | async def fetch(self) -> Image: 45 | return await self.fetch_with_context(None) 46 | -------------------------------------------------------------------------------- /disruptor/source/reddit.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2021 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Set, List 17 | import asyncio 18 | 19 | from yarl import URL 20 | import aiohttp 21 | 22 | from mautrix.util import background_task 23 | 24 | from .abstract import AbstractSource, Image, CancelDisruption 25 | 26 | 27 | class Reddit(AbstractSource): 28 | reload_lock: asyncio.Lock 29 | subreddit: str 30 | handled_ids: Set[str] 31 | cache: List[dict] 32 | 33 | async def prepare(self) -> None: 34 | self.reload_lock = asyncio.Lock() 35 | self.handled_ids = set() 36 | self.subreddit = self.config["subreddit"] 37 | 38 | async def fetch_posts(self, subreddit: str) -> list: 39 | resp = await self.bot.http.get(f"https://www.reddit.com/r/{subreddit}/.json?raw_json=1", 40 | headers={"User-Agent": self.config["user_agent"]}) 41 | try: 42 | data = await resp.json() 43 | except aiohttp.ContentTypeError: 44 | self.log.error( 45 | "Got non-JSON response data with status %s while trying to find pictures", 46 | resp.status) 47 | return [] 48 | return data["data"]["children"] 49 | 50 | async def load_disruption_content(self) -> None: 51 | self.log.debug(f"Caching data from {self.subreddit}...") 52 | n = 0 53 | listing = await self.fetch_posts(self.subreddit) 54 | for post in listing: 55 | data = post["data"] 56 | if (data.get("post_hint", "") == "image" 57 | and not data.get("over_18", False) 58 | and data["id"] not in self.handled_ids): 59 | self.handled_ids.add(data["id"]) 60 | self.cache.append({ 61 | "url": URL(data["url"]), 62 | "thumbnail_url": URL(data["thumbnail"]), 63 | "thumbnail_dimensions": (data["thumbnail_width"], data["thumbnail_height"]), 64 | "external_url": "https://www.reddit.com" + data["permalink"], 65 | "title": data["title"], 66 | }) 67 | n += 1 68 | self.log.info(f"{n} posts cached from {self.subreddit}") 69 | 70 | async def reload_disruption_content(self) -> None: 71 | async with self.reload_lock: 72 | if len(self.cache) < 5: 73 | await self.load_disruption_content() 74 | 75 | async def fetch(self) -> Image: 76 | if len(self.cache) == 0: 77 | self.log.warning("Cache is empty, awaiting reload") 78 | await self.reload_disruption_content() 79 | if len(self.cache) == 0: 80 | self.log.error("Failed to disrupt: cache is still empty after reload") 81 | raise CancelDisruption() 82 | disruption_content = self.cache.pop() 83 | if len(self.cache) < 5: 84 | background_task.create(self.reload_disruption_content()) 85 | return await self._reupload(**disruption_content["image"]) 86 | -------------------------------------------------------------------------------- /disruptor/source/unsplash.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2023 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from __future__ import annotations 17 | 18 | import time 19 | from collections import deque 20 | import asyncio 21 | 22 | from yarl import URL 23 | from mautrix.util import background_task 24 | 25 | from .abstract import AbstractSource, Image, CancelDisruption 26 | 27 | 28 | class Unsplash(AbstractSource): 29 | type_name = "unsplash2" 30 | cache: deque[Image] 31 | min_cache_size: int 32 | fetch_count: int 33 | api_url: URL 34 | cache_lock: asyncio.Lock 35 | size_name: str 36 | thumb_size_name: str 37 | next_refill_allowed: float 38 | access_key: str 39 | 40 | async def prepare(self) -> None: 41 | self.access_key = self.config["access_key"] 42 | self.min_cache_size = self.config.get("min_cache_size", 10) 43 | self.fetch_count = self.config.get("fetch_count", 30) 44 | self.size_name = self.config.get("size_name", "regular") 45 | self.thumb_size_name = self.config.get("thumb_size_name", "thumb") 46 | self.cache = deque(maxlen=self.min_cache_size+self.fetch_count) 47 | self.next_refill_allowed = 0 48 | search_query = self.config.get("query") 49 | orientation = self.config.get("orientation") 50 | query_params = {"count": str(self.fetch_count)} 51 | if search_query: 52 | query_params["query"] = search_query 53 | if orientation: 54 | query_params["orientation"] = orientation 55 | self.cache_lock = asyncio.Lock() 56 | self.api_url = URL("https://api.unsplash.com/photos/random").with_query(query_params) 57 | await self._refill_cache() 58 | 59 | async def _refill_cache(self) -> None: 60 | try: 61 | async with self.cache_lock: 62 | if len(self.cache) > self.min_cache_size: 63 | return 64 | await self._try_refill_cache() 65 | except Exception: 66 | self.log.exception("Failed to refill cache") 67 | 68 | async def _try_refill_cache(self) -> None: 69 | if self.next_refill_allowed > time.monotonic(): 70 | self.log.debug("Not refilling cache, low on ratelimit") 71 | return 72 | headers = {} 73 | if "user_agent" in self.config: 74 | headers["User-Agent"] = self.config["user_agent"] 75 | headers["Authorization"] = f"Client-ID {self.access_key}" 76 | self.log.info(f"Refilling cache (current size: {len(self.cache)})") 77 | async with self.bot.http.get(self.api_url, headers=headers) as resp: 78 | data = await resp.json() 79 | if resp.status >= 400: 80 | self.log.error(f"Failed to refill cache: HTTP {resp.status}: {data}") 81 | resp.raise_for_status() 82 | if int(resp.headers["x-ratelimit-remaining"]) < 10: 83 | self.log.debug("Low on ratelimit, marking next refill as only allowed in an hour") 84 | self.next_refill_allowed = time.monotonic() + 60 * 60 85 | for image_info in data: 86 | download_url = URL(image_info["urls"][self.size_name]) 87 | dimensions = (image_info["width"], image_info["height"]) if self.size_name in ("raw", "full") else None 88 | external_url = image_info["links"]["html"] 89 | image = await self._reupload( 90 | download_url, 91 | title=image_info["id"] + ".jpg", 92 | blurhash=image_info.get("blur_hash", None), 93 | dimensions=dimensions, 94 | external_url=external_url, 95 | thumbnail_url=image_info["urls"][self.thumb_size_name], 96 | headers=headers, 97 | ) 98 | self.cache.appendleft(image) 99 | self.log.info(f"Cache refilled, now have {len(self.cache)} images") 100 | 101 | async def fetch(self) -> Image: 102 | if len(self.cache) < self.min_cache_size: 103 | background_task.create(self._refill_cache()) 104 | try: 105 | return self.cache.pop() 106 | except IndexError: 107 | self.log.error("Cache is empty, canceling disruption") 108 | raise CancelDisruption() 109 | -------------------------------------------------------------------------------- /disruptor/source/unsplash_legacy.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2021 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from yarl import URL 17 | 18 | from .url import URLSource, AbstractSource 19 | 20 | 21 | class UnsplashLegacy(URLSource, AbstractSource): 22 | type_name = "unsplash" 23 | 24 | async def prepare(self) -> None: 25 | source = self.config.get("source", "featured") 26 | url = URL("https://source.unsplash.com") / source 27 | 28 | dimensions = self.config.get("dimensions", None) 29 | if dimensions: 30 | url /= dimensions 31 | 32 | topics = self.config.get("topics", []) 33 | if not topics and "topic" in self.config: 34 | topics = [self.config["topic"]] 35 | self.url = url.with_query({key: "true" for key in topics}) 36 | -------------------------------------------------------------------------------- /disruptor/source/url.py: -------------------------------------------------------------------------------- 1 | # disruptor - A maubot plugin that disrupts monologues with cat pictures. 2 | # Copyright (C) 2022 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import ClassVar 17 | from yarl import URL 18 | 19 | from .abstract import AbstractSource, Image 20 | 21 | 22 | class URLSource(AbstractSource): 23 | type_name: ClassVar[str] = "url" 24 | url: URL 25 | 26 | async def prepare(self) -> None: 27 | self.url = URL(self.config["url"]) 28 | 29 | async def fetch(self) -> Image: 30 | return await self._reupload(self.url) 31 | -------------------------------------------------------------------------------- /maubot.yaml: -------------------------------------------------------------------------------- 1 | maubot: 0.4.1 2 | id: xyz.maubot.disruptor 3 | version: 0.2.0 4 | license: AGPL-3.0-or-later 5 | modules: 6 | - disruptor 7 | main_class: DisruptorBot 8 | extra_files: 9 | - base-config.yaml 10 | --------------------------------------------------------------------------------