├── .gitlab-ci.yml ├── LICENSE ├── README.md ├── base-config.yaml ├── maubot.yaml ├── pyproject.toml └── rsvc.py /.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 | # rsvc 2 | A [maubot](https://github.com/maubot/maubot) to check the version of servers in 3 | rooms. 4 | 5 | ## Commands 6 | - `!servers` - Test all servers in room and report aggregated tests. 7 | - `!servers retest ` - Re-test a server and update the previous results. 8 | - `!servers match [operator] ` - Show all servers with the 9 | given software and version. Operator can be `>`, `<`, `>=`, `<=`, `!=`, `=` 10 | or empty. 11 | - `!servers upgrade ` - Check which servers would be left 12 | behind if the room was upgraded. 13 | - `!server test ` - Test one server, independently of any previous whole-room tests. 14 | - `!server`, `!version` and `!versions` are aliases for `!servers`, `recheck` 15 | is an alias for `tetest`. 16 | -------------------------------------------------------------------------------- /base-config.yaml: -------------------------------------------------------------------------------- 1 | # The https://github.com/matrix-org/matrix-federation-tester instance to use. 2 | # {server} is replaced with the server name. 3 | federation_tester: https://matrix.org/federationtester/api/report?server_name={server} 4 | -------------------------------------------------------------------------------- /maubot.yaml: -------------------------------------------------------------------------------- 1 | maubot: 0.1.0 2 | id: xyz.maubot.rsvc 3 | version: 1.0.0 4 | license: AGPL-3.0-or-later 5 | modules: 6 | - rsvc 7 | main_class: ServerCheckerBot 8 | extra_files: 9 | - base-config.yaml 10 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.isort] 2 | profile = "black" 3 | force_to_top = "typing" 4 | from_first = true 5 | combine_as_imports = true 6 | known_first_party = "mautrix,maubot" 7 | line_length = 99 8 | 9 | [tool.black] 10 | line-length = 99 11 | target-version = ["py38"] 12 | -------------------------------------------------------------------------------- /rsvc.py: -------------------------------------------------------------------------------- 1 | # rsvc - A maubot plugin that checks the versions of all the servers in a room. 2 | # Copyright (C) 2020 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 | from typing import Any, Callable, NamedTuple, Union 19 | import asyncio 20 | import html 21 | import operator as op 22 | 23 | from attr import dataclass 24 | import attr 25 | import packaging.version 26 | import semver 27 | 28 | from maubot import MessageEvent, Plugin 29 | from maubot.handlers import command 30 | from mautrix.types import EventID, Format, MessageType, RoomID, TextMessageEventContent, UserID 31 | from mautrix.util import markdown 32 | from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper 33 | 34 | 35 | class Config(BaseProxyConfig): 36 | def do_update(self, helper: ConfigUpdateHelper) -> None: 37 | helper.copy("federation_tester") 38 | 39 | 40 | class TestError(Exception): 41 | pass 42 | 43 | 44 | known_room_versions = {"1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11"} 45 | versions_updated = "2023-09-30" 46 | latest_known_version = { 47 | "Synapse": packaging.version.parse("1.93.0"), 48 | "Dendrite": semver.parse("0.13.3"), 49 | "Conduit": semver.parse("0.6.0"), 50 | } 51 | 52 | minimum_version = { 53 | "Synapse": { 54 | "1": True, 55 | "2": packaging.version.parse("0.99.0rc1"), 56 | "3": packaging.version.parse("0.99.0rc1"), 57 | "4": packaging.version.parse("0.99.5rc1"), 58 | "5": packaging.version.parse("1.0.0rc1"), 59 | "6": packaging.version.parse("1.14.0rc1"), 60 | "7": packaging.version.parse("1.37.0rc1"), 61 | "8": packaging.version.parse("1.40.0rc3"), 62 | "9": packaging.version.parse("1.42.0rc2"), 63 | "10": packaging.version.parse("1.64.0rc1"), 64 | "11": packaging.version.parse("1.89.0rc1"), 65 | }, 66 | "construct": { 67 | "1": True, 68 | "2": True, 69 | "3": True, 70 | "4": True, 71 | "5": True, 72 | "6": True, 73 | "7": True, 74 | "8": True, 75 | "9": True, 76 | "10": False, 77 | "11": False, 78 | }, 79 | "Dendrite": { 80 | "1": True, 81 | "2": True, 82 | "3": True, 83 | "4": True, 84 | "5": True, 85 | "6": True, 86 | "7": semver.parse("0.4.1"), 87 | "8": semver.parse("0.8.6"), # actually added in 0.5.1, but only marked as stable in 0.8.6 88 | "9": semver.parse("0.8.6"), 89 | "10": semver.parse("0.8.7"), 90 | "11": semver.parse("0.13.3"), 91 | }, 92 | "Conduit": { 93 | "1": False, 94 | "2": False, 95 | "3": False, 96 | "4": False, 97 | "5": False, # Conduit's support for room versions below v6 is marked as unstable 98 | "6": True, 99 | "7": semver.parse("0.4.0"), 100 | "8": semver.parse("0.4.0"), 101 | "9": semver.parse("0.4.0"), 102 | "10": semver.parse("0.5.0"), 103 | "11": False, # semver.parse("0.6.0"), 104 | }, 105 | "Catalyst": { 106 | "1": False, 107 | "2": False, 108 | "3": False, 109 | "4": False, 110 | "5": False, # Same as Conduit 111 | "6": True, 112 | "7": True, 113 | "8": True, 114 | "9": True, 115 | "10": True, 116 | "11": False, 117 | }, 118 | } 119 | 120 | server_order: dict[str, int] = { 121 | "Synapse": 100, 122 | "Dendrite": 50, 123 | "Catalyst": 45, 124 | "Conduit": 40, 125 | "construct": 10, 126 | } 127 | 128 | VersionIdentifier = Union[str, packaging.version.Version, semver.VersionInfo] 129 | 130 | 131 | class ServerInfo(NamedTuple): 132 | software: str 133 | version: VersionIdentifier 134 | 135 | @classmethod 136 | def parse(cls, software: str, version: str) -> ServerInfo: 137 | software_lower = software.lower() 138 | if software_lower == "synapse": 139 | return ServerInfo( 140 | software="Synapse", 141 | version=packaging.version.parse(version.split(" ")[0]), 142 | ) 143 | elif software_lower == "dendrite": 144 | return ServerInfo(software="Dendrite", version=semver.VersionInfo.parse(version)) 145 | elif software_lower == "conduit": 146 | return ServerInfo(software="Conduit", version=semver.VersionInfo.parse(version)) 147 | elif software_lower == "catalyst": 148 | return ServerInfo(software="Catalyst", version=semver.VersionInfo.parse(version)) 149 | else: 150 | return ServerInfo(software=software, version=version) 151 | 152 | def is_new_enough(self, room_ver: str) -> bool: 153 | minimum = minimum_version[self.software].get(room_ver, False) 154 | if isinstance(minimum, bool): 155 | return minimum 156 | elif callable(minimum): 157 | return minimum(self.version) 158 | else: 159 | return self.version >= minimum 160 | 161 | @property 162 | def is_unknown(self) -> bool: 163 | try: 164 | return latest_known_version[self.software] < self.version 165 | except KeyError: 166 | return False 167 | 168 | def __str__(self) -> str: 169 | return f"{self.software} {self.version}" 170 | 171 | def __lt__(self, other: ServerInfo) -> bool: 172 | if self.software == other.software: 173 | return self.version < other.version 174 | else: 175 | return server_order.get(self.software, 0) < server_order.get(other.software, 0) 176 | 177 | 178 | @dataclass 179 | class Results: 180 | servers: dict[str, list[UserID]] 181 | versions: dict[str, ServerInfo] 182 | errors: dict[str, str] 183 | event_id: EventID | None = None 184 | lock: asyncio.Lock = attr.ib(factory=lambda: asyncio.Lock()) 185 | 186 | 187 | def _pluralize(val: int, word: str) -> str: 188 | if val == 1: 189 | return f"{val} {word}" 190 | else: 191 | return f"{val} {word}s" 192 | 193 | 194 | ComparisonOperator = Callable[[Any, Any], bool] 195 | 196 | op_map: dict[str, ComparisonOperator] = { 197 | "=": op.eq, 198 | "==": op.eq, 199 | "===": op.eq, 200 | ">": op.gt, 201 | ">=": op.ge, 202 | "<": op.lt, 203 | "<=": op.le, 204 | "!=": op.ne, 205 | "!==": op.ne, 206 | "≠": op.ne, 207 | } 208 | 209 | 210 | def parse_operator(val: str) -> ComparisonOperator: 211 | return op_map.get(val) 212 | 213 | 214 | class ServerCheckerBot(Plugin): 215 | caches: dict[RoomID, Results] 216 | tests_in_progress: dict[RoomID, asyncio.Task] 217 | 218 | async def start(self) -> None: 219 | self.caches = {} 220 | self.tests_in_progress = {} 221 | self.on_external_config_update() 222 | 223 | @classmethod 224 | def get_config_class(cls) -> type[Config]: 225 | return Config 226 | 227 | async def _edit( 228 | self, 229 | room_id: RoomID, 230 | event_id: EventID, 231 | text: str, 232 | results: Results | None = None, 233 | allow_html: bool = False, 234 | ) -> None: 235 | if results: 236 | text = self._format_results(results) 237 | content = TextMessageEventContent( 238 | msgtype=MessageType.NOTICE, 239 | body=text, 240 | format=Format.HTML, 241 | formatted_body=markdown.render(text, allow_html=allow_html), 242 | ) 243 | content.set_edit(event_id) 244 | if len(content.json()) > 60_000: 245 | content.body = "Plaintext version omitted due to large response size" 246 | if len(content.json()) > 60_000 and results: 247 | content.formatted_body = markdown.render( 248 | self._format_results(results, compact=True), allow_html=True 249 | ) 250 | await self.client.send_message(room_id, content) 251 | 252 | @staticmethod 253 | def _parse_error(server: str, result: dict) -> str: 254 | ipv4_failures = 0 255 | ipv6_failures = 0 256 | ipv4_connections = 0 257 | ipv6_connections = 0 258 | ipv4_successes = 0 259 | ipv6_successes = 0 260 | errors = set() 261 | errors_with_addr = [] 262 | failed_addresses = 0 263 | addr: str 264 | for addr, error in result.get("ConnectionErrors", {}).items(): 265 | if addr.startswith("[") or addr.count(":") > 1: 266 | ipv6_failures += 1 267 | else: 268 | ipv4_failures += 1 269 | for addr, data in result.get("ConnectionReports", {}).items(): 270 | if addr.startswith("[") or addr.count(":") > 1: 271 | ipv6_connections += 1 272 | else: 273 | ipv4_connections += 1 274 | 275 | def add_err(error: str) -> None: 276 | nonlocal failed_addresses 277 | failed_addresses += 1 278 | if error not in errors: 279 | errors.add(error) 280 | # if addr.startswith("[") or addr.count(":") > 1: 281 | # ipv6_errors.append((addr, error)) 282 | # else: 283 | errors_with_addr.append((addr, error)) 284 | 285 | checks = data.get("Checks") or {} 286 | if not checks.get("MatchingServerName"): 287 | got_server = (data.get("Keys") or {}).get("server_name", "undefined") 288 | add_err(f"mismatching server name, tested: {server}, got: {got_server}") 289 | elif not checks.get("ValidCertificates"): 290 | add_err("invalid TLS certificates") 291 | elif not checks.get("AllChecksOK"): 292 | add_err("some checks failed") 293 | else: 294 | if addr.startswith("[") or addr.count(":") > 1: 295 | ipv6_successes += 1 296 | else: 297 | ipv4_successes += 1 298 | total_ipv4 = ipv4_failures + ipv4_connections 299 | total_ipv6 = ipv6_failures + ipv6_connections 300 | msgs = [] 301 | if ipv4_failures + ipv6_failures == total_ipv4 + total_ipv6: 302 | if total_ipv4 + total_ipv6 == 1: 303 | msgs.append("Server couldn't be reached") 304 | else: 305 | msgs.append("Server couldn't be reached on any address") 306 | else: 307 | if ipv4_failures: 308 | prefix = ( 309 | f"{ipv4_failures}/{total_ipv4} IPv4 addresses" 310 | if total_ipv4 > 1 311 | else "IPv4 address" 312 | ) 313 | msgs.append(f"{prefix} couldn't be reached") 314 | if ipv6_failures: 315 | prefix = ( 316 | f"{ipv6_failures}/{total_ipv6} IPv6 addresses" 317 | if total_ipv6 > 1 318 | else "IPv6 address" 319 | ) 320 | msgs.append(f"{prefix} couldn't be reached") 321 | if errors_with_addr: 322 | es = "es" if failed_addresses > 1 else "" 323 | if len(errors_with_addr) == 1: 324 | _, errors_msg = errors_with_addr[0] 325 | else: 326 | errors_msg = ", ".join(f"{addr}: {msg}" for addr, msg in errors_with_addr) 327 | if total_ipv4 + total_ipv6 == 1 == failed_addresses: 328 | msgs.append(errors_msg) 329 | else: 330 | msgs.append( 331 | f"{failed_addresses}/{total_ipv4+total_ipv6} address{es} failed the test: " 332 | f"{errors_msg}" 333 | ) 334 | suffix = "" 335 | if ipv4_successes: 336 | if total_ipv4 == 1: 337 | suffix = "IPv4 is OK" 338 | else: 339 | suffix = f"{ipv4_successes}/{total_ipv4} IPv4 addresses are OK" 340 | if ipv6_successes: 341 | if total_ipv6 == 1: 342 | msg = "IPv6 is OK" 343 | else: 344 | msg = f"{ipv6_successes}/{total_ipv6} IPv6 addresses are OK" 345 | if suffix: 346 | suffix = f"{suffix} and {msg}" 347 | else: 348 | suffix = msg 349 | if suffix: 350 | suffix = f" ({suffix})" 351 | if len(msgs) > 1: 352 | return f"{', '.join(msgs[0:-1])} and {msgs[-1]}" + suffix 353 | elif len(msgs) == 1: 354 | return msgs[0] + suffix 355 | elif total_ipv4 + total_ipv6 == 0: 356 | return "No server addresses found" 357 | else: 358 | return "federation not OK (unknown error)" 359 | 360 | async def _test(self, server: str) -> ServerInfo: 361 | self.log.debug(f"Testing {server}") 362 | resp = await self.http.get(self.config["federation_tester"].format(server=server)) 363 | result = await resp.json() 364 | 365 | if not result["FederationOK"]: 366 | error_msg = self._parse_error(server, result) 367 | name = (result.get("Version") or {}).get("name", "") 368 | version = (result.get("Version") or {}).get("version", "") 369 | if name and version: 370 | server_info = ServerInfo.parse(name, version) 371 | raise TestError(f"{error_msg} // {server_info}") 372 | raise TestError(error_msg) 373 | 374 | try: 375 | name = result["Version"]["name"] 376 | version = result["Version"].get("version", "unknown version") 377 | except KeyError: 378 | raise TestError("server not responding to version requests") 379 | return ServerInfo.parse(name, version) 380 | 381 | async def _load_members(self, room_id: RoomID) -> dict[str, list[UserID]]: 382 | users = await self.client.get_joined_members(room_id) 383 | servers: dict[str, list[UserID]] = {} 384 | for user in users: 385 | _, server = self.client.parse_user_id(user) 386 | servers.setdefault(server, []).append(user) 387 | return servers 388 | 389 | async def _test_all(self, servers: dict[str, list[UserID]]) -> Results: 390 | versions: dict[str, ServerInfo] = {} 391 | errors: dict[str, str] = {} 392 | 393 | async def _test(server_name: str) -> None: 394 | try: 395 | versions[server_name] = await asyncio.wait_for(self._test(server_name), timeout=60) 396 | except TestError as e: 397 | errors[server_name] = str(e) 398 | except asyncio.TimeoutError: 399 | errors[server_name] = "test timed out" 400 | except Exception: 401 | errors[server_name] = "internal plugin error" 402 | 403 | await asyncio.gather(*[_test(server) for server in servers.keys()]) 404 | 405 | return Results(servers, versions, errors) 406 | 407 | @staticmethod 408 | def _aggregate_versions( 409 | results: Results, 410 | ) -> dict[ServerInfo, tuple[int, list[UserID]]]: 411 | by_version: dict[ServerInfo, tuple[int, list[UserID]]] = {} 412 | for server_name, info in results.versions.items(): 413 | users = results.servers[server_name] 414 | existing_server_count, existing_users = by_version.get(info, (0, [])) 415 | by_version[info] = (existing_server_count + 1, existing_users + users) 416 | return dict(sorted(by_version.items(), reverse=True)) 417 | 418 | @classmethod 419 | def _format_results(cls, results: Results, compact: bool = False) -> str: 420 | def members(server_name: str) -> str: 421 | return _pluralize(len(results.servers[server_name]), "member") 422 | 423 | versions_str = "\n".join( 424 | f"* {_pluralize(server_count, 'server')} " 425 | f"with {_pluralize(len(users), 'member')} on {info}" 426 | for info, (server_count, users) in cls._aggregate_versions(results).items() 427 | ) 428 | versions_str = f"### Versions\n\n{versions_str}" 429 | if not results.errors: 430 | return versions_str 431 | if compact: 432 | errors_str = f"{_pluralize(len(results.errors), 'server')} failed (full list omitted due to large size)" 433 | else: 434 | errors_str = "\n".join( 435 | f"* {server} ({members(server)}): {error}" 436 | for server, error in results.errors.items() 437 | ) 438 | errors_str = ( 439 | f"
{_pluralize(len(results.errors), 'server')} failed" 440 | f"\n\n{errors_str}\n\n
" 441 | ) 442 | return f"{versions_str}\n\n{errors_str}" 443 | 444 | @command.new( 445 | "servers", 446 | aliases=["versions", "server", "version"], 447 | require_subcommand=False, 448 | help="Check the version of all servers in the room.", 449 | arg_fallthrough=False, 450 | ) 451 | async def servers(self, evt: MessageEvent) -> None: 452 | if evt.room_id in self.tests_in_progress: 453 | await evt.reply("There is already a test in progress.") 454 | return 455 | await self.test_or_wait(evt) 456 | 457 | async def test_or_wait(self, evt: MessageEvent) -> None: 458 | if evt.room_id in self.tests_in_progress: 459 | await self.tests_in_progress[evt.room_id] 460 | return 461 | self.tests_in_progress[evt.room_id] = task = asyncio.create_task(self._servers(evt)) 462 | try: 463 | await task 464 | finally: 465 | del self.tests_in_progress[evt.room_id] 466 | 467 | async def cached_or_test(self, evt: MessageEvent) -> Results | None: 468 | try: 469 | return self.caches[evt.room_id] 470 | except KeyError: 471 | await self.test_or_wait(evt) 472 | try: 473 | return self.caches[evt.room_id] 474 | except KeyError: 475 | await evt.reply("Cache didn't contain test results even after waiting 😿") 476 | return None 477 | 478 | async def _servers(self, evt: MessageEvent) -> None: 479 | event_id = await evt.reply("Loading member list...") 480 | servers = await self._load_members(evt.room_id) 481 | user_count = sum(len(users) for users in servers.values()) 482 | await self._edit( 483 | evt.room_id, 484 | event_id, 485 | f"Member list loaded, found {_pluralize(user_count, 'member')} " 486 | f"on {_pluralize(len(servers), 'server')}. Now running federation tests", 487 | ) 488 | results = await self._test_all(servers) 489 | results.event_id = event_id 490 | self.caches[evt.room_id] = results 491 | await self._edit( 492 | evt.room_id, event_id, self._format_results(results), results=results, allow_html=True 493 | ) 494 | 495 | @servers.subcommand( 496 | "test", 497 | aliases=["check", "version"], 498 | help="Test one server, independently of any previous whole-room tests.", 499 | ) 500 | @command.argument("server", matches=".+", required=True) 501 | async def test(self, evt: MessageEvent, server: str) -> None: 502 | await evt.mark_read() 503 | 504 | try: 505 | version = await asyncio.wait_for(self._test(server), timeout=60) 506 | except TestError as e: 507 | await evt.reply(f"Testing {server} failed: {e}") 508 | except asyncio.TimeoutError: 509 | await evt.reply(f"Testing {server} failed: test timed out") 510 | except Exception: 511 | await evt.reply(f"Testing {server} failed: internal plugin error") 512 | else: 513 | await evt.reply(f"{server} is on {version}") 514 | 515 | @servers.subcommand( 516 | "retest", 517 | aliases=["recheck"], 518 | help="Re-test one server in the previous results.", 519 | ) 520 | @command.argument("server", matches=".+", required=True) 521 | async def retest(self, evt: MessageEvent, server: str) -> None: 522 | try: 523 | cache = self.caches[evt.room_id] 524 | except KeyError: 525 | await evt.reply( 526 | "No cached results. Please use `!servers` to test all servers in the room first." 527 | ) 528 | return 529 | if server not in cache.servers: 530 | await evt.reply( 531 | "That server isn't in the previous results. If the server joined " 532 | "recently, you must retest the whole room." 533 | ) 534 | return 535 | try: 536 | prev_version = cache.versions.pop(server) 537 | prev_error = None 538 | except KeyError: 539 | try: 540 | prev_error = cache.errors.pop(server) 541 | prev_version = None 542 | except KeyError: 543 | await evt.reply("That server seems to be in the progress of being retested.") 544 | return 545 | 546 | event_id = await evt.reply(f"Re-testing {server}...") 547 | new_version: ServerInfo | None = None 548 | new_error: str | None = None 549 | 550 | try: 551 | cache.versions[server] = new_version = await asyncio.wait_for( 552 | self._test(server), timeout=60 553 | ) 554 | except TestError as e: 555 | cache.errors[server] = new_error = str(e) 556 | except asyncio.TimeoutError: 557 | cache.errors[server] = new_error = "test timed out" 558 | except Exception: 559 | cache.errors[server] = new_error = "internal plugin error" 560 | 561 | if new_error != prev_error or new_version != prev_version: 562 | async with cache.lock: 563 | await self._edit( 564 | evt.room_id, 565 | cache.event_id, 566 | self._format_results(cache), 567 | results=cache, 568 | allow_html=True, 569 | ) 570 | 571 | if new_error is not None: 572 | cmd_reply_edit = f"Testing {server} failed: {new_error}" 573 | elif prev_version is not None: 574 | if prev_version == new_version: 575 | cmd_reply_edit = f"{server} is still on {prev_version}" 576 | else: 577 | if prev_version.software == new_version.software: 578 | action = "update" if prev_version < new_version else "downgrade" 579 | cmd_reply_edit = ( 580 | f"{server} {action}d {prev_version.software} " 581 | f"from {prev_version.version} to {new_version.version}" 582 | ) 583 | else: 584 | cmd_reply_edit = f"{server} switched from {prev_version} to {new_version}" 585 | else: 586 | cmd_reply_edit = f"{server} is back up and on version {new_version}" 587 | 588 | await self._edit(evt.room_id, event_id, cmd_reply_edit) 589 | 590 | @staticmethod 591 | def _antinotify(text: str) -> str: 592 | return "\ufeff".join(text) 593 | 594 | @classmethod 595 | def _user_link(cls, user_id: UserID) -> str: 596 | return ( 597 | f"[{html.escape(cls._antinotify(user_id))}]" 598 | f"(https://matrix.to/#/{html.escape(user_id)})" 599 | ) 600 | 601 | @classmethod 602 | def _make_user_list(cls, server_name: str, info: ServerInfo, users: list[UserID]) -> str: 603 | if len(users) == 1: 604 | user_list = cls._user_link(users[0]) 605 | elif len(users) == 2: 606 | user_list = f"{cls._user_link(users[0])} and {cls._user_link(users[1])}" 607 | elif len(users) == 3: 608 | user_list = ( 609 | f"{cls._user_link(users[0])}, {cls._user_link(users[1])} " 610 | f"and {cls._user_link(users[2])}" 611 | ) 612 | else: 613 | user_list = f"{cls._user_link(users[0])}, {cls._user_link(users[1])} and {len(users) - 2} others" 614 | return f"* {server_name} ({info}) with {user_list}" 615 | 616 | @servers.subcommand( 617 | "upgrade", 618 | help="Check which servers would be left behind if the room was upgraded", 619 | ) 620 | @command.argument( 621 | "room_version", label="stable room version", matches=r"[\d.]+", required=True 622 | ) 623 | async def upgrade(self, evt: MessageEvent, room_version: str) -> None: 624 | if room_version not in known_room_versions: 625 | await evt.reply(f"Unknown room version {room_version}") 626 | return 627 | cache = await self.cached_or_test(evt) 628 | if not cache: 629 | return 630 | 631 | up_to_date_servers = 0 632 | up_to_date_users = 0 633 | outdated_servers = 0 634 | outdated_users = 0 635 | unknown_servers = 0 636 | unknown_users = 0 637 | outdated_matches = [] 638 | may_contain_new_software = False 639 | for server_name, info in cache.versions.items(): 640 | users = cache.servers[server_name] 641 | if info.software not in minimum_version: 642 | unknown_servers += 1 643 | unknown_users += len(users) 644 | elif info.is_new_enough(room_version): 645 | up_to_date_servers += 1 646 | up_to_date_users += len(users) 647 | else: 648 | may_contain_new_software = may_contain_new_software or info.is_unknown 649 | outdated_servers += 1 650 | outdated_users += len(users) 651 | outdated_matches.append(self._make_user_list(server_name, info, users)) 652 | parts = [] 653 | if up_to_date_servers: 654 | parts.append( 655 | f"{_pluralize(up_to_date_users, 'user')} on " 656 | f"{_pluralize(up_to_date_servers, 'server')} are up to date" 657 | ) 658 | else: 659 | parts.append("Nobody is up to date 😿") 660 | if unknown_servers: 661 | are = "are" if unknown_users > 1 else "is" 662 | parts.append( 663 | f"{_pluralize(unknown_users, 'user')} on " 664 | f"{_pluralize(unknown_servers, 'server')} {are} using unknown software " 665 | f"or have faked their server's user agent" 666 | ) 667 | if outdated_matches: 668 | outdateds = "\n".join(outdated_matches) 669 | are = "are" if outdated_users > 1 else "is" 670 | parts.append( 671 | "
" 672 | f"{_pluralize(outdated_users, 'user')} on " 673 | f"{_pluralize(outdated_servers, 'server')} {are} outdated" 674 | f"\n\n{outdateds}\n\n
" 675 | ) 676 | else: 677 | parts.append("Nobody is outdated 🎉") 678 | if may_contain_new_software: 679 | parts.append( 680 | f"Room version support table last updated on {versions_updated}" 681 | ) 682 | await evt.reply("\n\n".join(parts), allow_html=True) 683 | 684 | @servers.subcommand( 685 | "match", 686 | help=( 687 | "Show which servers are on a specific version. " 688 | "Operator can be `>`, `<`, `>=`, `<=`, `!=`, `=` or empty." 689 | ), 690 | ) 691 | @command.argument("software", matches=".+", required=True) 692 | @command.argument("operator", required=False, parser=parse_operator) 693 | @command.argument("version", matches=".+", required=False, pass_raw=True) 694 | async def match( 695 | self, 696 | evt: MessageEvent, 697 | software: str, 698 | operator: ComparisonOperator | None, 699 | version: str, 700 | ) -> None: 701 | cache = await self.cached_or_test(evt) 702 | if not cache: 703 | return 704 | if not operator: 705 | operator = op.eq 706 | if not version: 707 | operator = lambda a, b: True 708 | want_info = ServerInfo(software=software, version=None) 709 | else: 710 | try: 711 | want_info = ServerInfo.parse(software, version) 712 | except ValueError as e: 713 | await evt.reply(str(e)) 714 | return 715 | matches = [] 716 | matched_users = 0 717 | matched_servers = 0 718 | for server_name, info in cache.versions.items(): 719 | if info.software.lower() == want_info.software.lower() and operator( 720 | info.version, want_info.version 721 | ): 722 | users = cache.servers[server_name] 723 | matched_users += len(users) 724 | matched_servers += 1 725 | matches.append(self._make_user_list(server_name, info, users)) 726 | if not matches: 727 | await evt.reply("No matches :(") 728 | else: 729 | await evt.reply( 730 | f"Matched {_pluralize(matched_users, 'user')} on " 731 | f"{_pluralize(matched_servers, 'server')}\n\n" + "\n".join(matches), 732 | allow_html=True, 733 | ) 734 | --------------------------------------------------------------------------------