├── .gitignore ├── .gitlab-ci.yml ├── LICENSE ├── README.md ├── base-config.yaml ├── karma ├── __init__.py ├── bot.py ├── db.py └── migrations.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 | # karma 2 | A [maubot](https://github.com/maubot/maubot) that tracks the karma of users. 3 | -------------------------------------------------------------------------------- /base-config.yaml: -------------------------------------------------------------------------------- 1 | # Whether or not to show content of messages in !karma best. 2 | show_content: true 3 | # Whether or not to store content of messages. 4 | # false - no storage 5 | # partial - store one line 6 | # full - store whole content 7 | store_content: partial 8 | 9 | # SHA1 hashes of users who have opted out. 10 | opt_out: 11 | - 783660685956dadb4fa2f1aeac54c8525e8b75b7 12 | 13 | # Whether or not everyone can vote. 14 | democracy: true 15 | # The list of people to filter. 16 | # If democracy is enabled, this is a blacklist. Otherwise this is a whitelist. 17 | filter: 18 | - "@user:example.com" 19 | 20 | # Error message switches. 21 | # If false, the bot will simply not react when the error occurs. 22 | errors: 23 | # Sorry, you're not allowed to vote. 24 | filtered_users: true 25 | # Sorry, you can't vote on votes. 26 | vote_on_vote: true 27 | # Hey! You can't upvote yourself! 28 | upvote_self: true 29 | # You already ±1'd that message. 30 | already_voted: true 31 | -------------------------------------------------------------------------------- /karma/__init__.py: -------------------------------------------------------------------------------- 1 | from .bot import KarmaBot 2 | -------------------------------------------------------------------------------- /karma/bot.py: -------------------------------------------------------------------------------- 1 | # karma - A maubot plugin to track the karma of users. 2 | # Copyright (C) 2019 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 Awaitable, Type, Optional, Tuple 17 | import hashlib 18 | import json 19 | import html 20 | 21 | from mautrix.client import Client 22 | from mautrix.types import (Event, StateEvent, EventID, UserID, FileInfo, MessageType, EventType, 23 | MediaMessageEventContent, ReactionEvent, RedactionEvent) 24 | from mautrix.types.event.message import media_reply_fallback_body_map 25 | from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper 26 | from maubot import Plugin, MessageEvent 27 | from maubot.handlers import command, event 28 | 29 | from .db import make_tables, Karma, Version 30 | 31 | UPVOTE_EMOJI = r"(?:\U0001F44D[\U0001F3FB-\U0001F3FF]?)" 32 | UPVOTE_EMOJI_SHORTHAND = r"(?:\:\+1\:)|(?:\:thumbsup\:)" 33 | UPVOTE_TEXT = r"(?:\+(?:1|\+)?)" 34 | UPVOTE = f"^(?:{UPVOTE_EMOJI}|{UPVOTE_EMOJI_SHORTHAND}|{UPVOTE_TEXT})$" 35 | 36 | DOWNVOTE_EMOJI = r"(?:\U0001F44E[\U0001F3FB-\U0001F3FF]?)" 37 | DOWNVOTE_EMOJI_SHORTHAND = r"(?:\:-1\:)|(?:\:thumbsdown\:)" 38 | DOWNVOTE_TEXT = r"(?:-(?:1|-)?)" 39 | DOWNVOTE = f"^(?:{DOWNVOTE_EMOJI}|{DOWNVOTE_EMOJI_SHORTHAND}|{DOWNVOTE_TEXT})$" 40 | 41 | 42 | class Config(BaseProxyConfig): 43 | def do_update(self, helper: ConfigUpdateHelper) -> None: 44 | helper.copy("democracy") 45 | helper.copy("opt_out") 46 | helper.copy("show_content") 47 | helper.copy("store_content") 48 | helper.copy("filter") 49 | helper.copy("errors.filtered_users") 50 | helper.copy("errors.vote_on_vote") 51 | helper.copy("errors.upvote_self") 52 | helper.copy("errors.already_voted") 53 | 54 | 55 | def sha1(val: str) -> str: 56 | return hashlib.sha1(val.encode("utf-8")).hexdigest() 57 | 58 | 59 | class KarmaBot(Plugin): 60 | karma_t: Type[Karma] 61 | version: Type[Version] 62 | 63 | async def start(self) -> None: 64 | await super().start() 65 | self.config.load_and_update() 66 | self.karma_t, self.version = make_tables(self.database) 67 | 68 | @command.new("karma", help="View users' karma or karma top lists") 69 | async def karma(self) -> None: 70 | pass 71 | 72 | @karma.subcommand("up", help="Upvote an event") 73 | @command.argument("event_id", "Event ID", required=True) 74 | def upvote(self, evt: MessageEvent, event_id: EventID) -> Awaitable[None]: 75 | return self._vote(evt, event_id, +1) 76 | 77 | @karma.subcommand("down", help="Downvote a message") 78 | @command.argument("event_id", "Event ID", required=True) 79 | def downvote(self, evt: MessageEvent, event_id: EventID) -> Awaitable[None]: 80 | return self._vote(evt, event_id, -1) 81 | 82 | @command.passive(UPVOTE) 83 | def upvote(self, evt: MessageEvent, _: Tuple[str]) -> Awaitable[None]: 84 | return self._vote(evt, evt.content.get_reply_to(), +1) 85 | 86 | @command.passive(DOWNVOTE) 87 | def downvote(self, evt: MessageEvent, _: Tuple[str]) -> Awaitable[None]: 88 | return self._vote(evt, evt.content.get_reply_to(), -1) 89 | 90 | @command.passive(regex=UPVOTE_EMOJI, field=lambda evt: evt.content.relates_to.key, 91 | event_type=EventType.REACTION, msgtypes=None) 92 | def upvote_react(self, evt: ReactionEvent, key: Tuple[str]) -> Awaitable[None]: 93 | try: 94 | return self._vote(evt, evt.content.relates_to.event_id, 1) 95 | except KeyError: 96 | pass 97 | 98 | @command.passive(regex=DOWNVOTE_EMOJI, field=lambda evt: evt.content.relates_to.key, 99 | event_type=EventType.REACTION, msgtypes=None) 100 | def downvote_react(self, evt: ReactionEvent, key: Tuple[str]) -> Awaitable[None]: 101 | try: 102 | return self._vote(evt, evt.content.relates_to.event_id, -1) 103 | except KeyError: 104 | pass 105 | 106 | @event.on(EventType.ROOM_REDACTION) 107 | async def redact(self, evt: RedactionEvent) -> None: 108 | karma = self.karma_t.get_by_given_from(evt.redacts) 109 | if karma: 110 | self.log.debug(f"Deleting {karma} due to redaction by {evt.sender}.") 111 | karma.delete() 112 | 113 | @karma.subcommand("stats", help="View global karma statistics") 114 | async def karma_stats(self, evt: MessageEvent) -> None: 115 | await evt.reply("Not yet implemented :(") 116 | 117 | @karma.subcommand("view", help="View your or another users karma") 118 | @command.argument("user", "user ID", required=False, 119 | parser=lambda val: Client.parse_user_id(val) if val else None) 120 | async def view_karma(self, evt: MessageEvent, user: Optional[Tuple[str, str]]) -> None: 121 | if user is not None: 122 | mxid = UserID(f"@{user[0]}:{user[1]}") 123 | name = f"[{user[0]}](https://matrix.to/#/{mxid})" 124 | word_have = "has" 125 | word_to_be = "is" 126 | else: 127 | mxid = evt.sender 128 | name = "You" 129 | word_have = "have" 130 | word_to_be = "are" 131 | karma = self.karma_t.get_karma(mxid) 132 | if karma is None or karma.total is None: 133 | await evt.reply(f"{name} {word_have} no karma :(") 134 | return 135 | index = self.karma_t.find_index_from_top(mxid) 136 | await evt.reply(f"{name} {word_have} {karma.total} karma " 137 | f"(+{karma.positive}/-{karma.negative}) " 138 | f"and {word_to_be} #{index + 1 or '∞'} on the top list.") 139 | 140 | @karma.subcommand("export", help="Export the data of your karma") 141 | async def export_own_karma(self, evt: MessageEvent) -> None: 142 | karma_list = [karma.to_dict() for karma in self.karma_t.export(evt.sender)] 143 | data = json.dumps(karma_list).encode("utf-8") 144 | url = await self.client.upload_media(data, mime_type="application/json") 145 | await evt.reply(MediaMessageEventContent( 146 | msgtype=MessageType.FILE, 147 | body=f"karma-{evt.sender}.json", 148 | url=url, 149 | info=FileInfo( 150 | mimetype="application/json", 151 | size=len(data), 152 | ) 153 | )) 154 | 155 | @karma.subcommand("breakdown", help="View your karma breakdown") 156 | async def own_karma_breakdown(self, evt: MessageEvent) -> None: 157 | await evt.reply("Not yet implemented :(") 158 | 159 | @karma.subcommand("top", help="View the highest rated users") 160 | async def karma_top(self, evt: MessageEvent) -> None: 161 | await evt.reply(self._karma_user_list("top")) 162 | 163 | @karma.subcommand("bottom", help="View the lowest rated users") 164 | async def karma_bottom(self, evt: MessageEvent) -> None: 165 | await evt.reply(self._karma_user_list("bottom")) 166 | 167 | @karma.subcommand("best", help="View the highest rated messages") 168 | async def karma_best(self, evt: MessageEvent) -> None: 169 | await evt.reply(self._karma_message_list("best")) 170 | 171 | @karma.subcommand("worst", help="View the lowest rated messages") 172 | async def karma_worst(self, evt: MessageEvent) -> None: 173 | await evt.reply(self._karma_message_list("worst")) 174 | 175 | def _parse_content(self, evt: Event) -> str: 176 | if not self.config["store_content"]: 177 | return "" 178 | if isinstance(evt, MessageEvent): 179 | if evt.content.msgtype in (MessageType.NOTICE, MessageType.TEXT, MessageType.EMOTE): 180 | body = evt.content.body 181 | if evt.content.msgtype == MessageType.EMOTE: 182 | body = "/me " + body 183 | if self.config["store_content"] == "partial": 184 | body = body.split("\n")[0] 185 | if len(body) > 60: 186 | body = body[:50] + " \u2026" 187 | return body 188 | name = media_reply_fallback_body_map[evt.content.msgtype] 189 | return f"[{name}]({self.client.api.get_download_url(evt.content.url)})" 190 | elif isinstance(evt, StateEvent): 191 | return "a state event" 192 | return "an unknown event" 193 | 194 | @staticmethod 195 | def _sign(value: int) -> str: 196 | if value > 0: 197 | return f"+{value}" 198 | elif value < 0: 199 | return str(value) 200 | else: 201 | return "±0" 202 | 203 | async def _vote(self, evt: MessageEvent, target: EventID, value: int) -> None: 204 | if not target: 205 | return 206 | in_filter = evt.sender in self.config["filter"] 207 | if self.config["democracy"] == in_filter or sha1(evt.sender) in self.config["opt_out"]: 208 | if self.config["errors.filtered_users"] and isinstance(evt, MessageEvent): 209 | await evt.reply("Sorry, you're not allowed to vote.") 210 | return 211 | if self.karma_t.is_vote_event(target): 212 | if self.config["errors.vote_on_vote"] and isinstance(evt, MessageEvent): 213 | await evt.reply("Sorry, you can't vote on votes.") 214 | return 215 | karma_target = await self.client.get_event(evt.room_id, target) 216 | if not karma_target: 217 | return 218 | if karma_target.sender == evt.sender and value > 0: 219 | if self.config["errors.upvote_self"] and isinstance(evt, MessageEvent): 220 | await evt.reply("Hey! You can't upvote yourself!") 221 | return 222 | karma_id = dict(given_to=karma_target.sender, given_by=evt.sender, given_in=evt.room_id, 223 | given_for=karma_target.event_id) 224 | anonymize = sha1(karma_target.sender) in self.config["opt_out"] 225 | if anonymize: 226 | karma_id["given_to"] = "" 227 | existing = self.karma_t.get(**karma_id) 228 | if existing is not None: 229 | if existing.value == value: 230 | if self.config["errors.already_voted"] and isinstance(evt, MessageEvent): 231 | await evt.reply(f"You already {self._sign(value)}'d that message.") 232 | return 233 | existing.update(new_value=value) 234 | else: 235 | karma = self.karma_t(**karma_id, given_from=evt.event_id, value=value, 236 | content=self._parse_content(karma_target) if not anonymize else "") 237 | karma.insert() 238 | if isinstance(evt, MessageEvent): 239 | await evt.mark_read() 240 | 241 | def _denotify(self, mxid: UserID) -> str: 242 | localpart, _ = self.client.parse_user_id(mxid) 243 | return "\u2063".join(localpart) 244 | 245 | def _user_link(self, user_id: UserID) -> str: 246 | if not user_id: 247 | return "Anonymous" 248 | return f"[{self._denotify(user_id)}](https://matrix.to/#/{user_id})" 249 | 250 | def _karma_user_list(self, list_type: str) -> Optional[str]: 251 | if list_type == "top": 252 | karma_list = self.karma_t.get_top_users() 253 | message = "#### Highest karma\n\n" 254 | elif list_type in ("bot", "bottom"): 255 | karma_list = self.karma_t.get_bottom_users() 256 | message = "#### Lowest karma\n\n" 257 | else: 258 | return None 259 | message += "\n".join( 260 | f"{index + 1}. {self._user_link(karma.user_id)}: " 261 | f"{self._sign(karma.total)} (+{karma.positive}/-{karma.negative})" 262 | for index, karma in enumerate(karma_list) if karma.user_id) 263 | return message 264 | 265 | def _message_text(self, index, event) -> str: 266 | text = (f"{index + 1}. [Event](https://matrix.to/#/{event.room_id}/{event.event_id})" 267 | f" by {self._user_link(event.sender)} with" 268 | f" {self._sign(event.total)} karma (+{event.positive}/-{event.negative})\n") 269 | if event.content and self.config["show_content"]: 270 | text += f" \n > {html.escape(event.content)}\n" 271 | return text 272 | 273 | def _karma_message_list(self, list_type: str) -> Optional[str]: 274 | if list_type == "best": 275 | karma_list = self.karma_t.get_best_events() 276 | message = "#### Best messages\n\n" 277 | elif list_type == "worst": 278 | karma_list = self.karma_t.get_worst_events() 279 | message = "#### Worst messages\n\n" 280 | else: 281 | return None 282 | message += "\n".join(self._message_text(index, event) 283 | for index, event in enumerate(karma_list)) 284 | return message 285 | 286 | @classmethod 287 | def get_config_class(cls) -> Type[BaseProxyConfig]: 288 | return Config 289 | -------------------------------------------------------------------------------- /karma/db.py: -------------------------------------------------------------------------------- 1 | # karma - A maubot plugin to track the karma of users. 2 | # Copyright (C) 2019 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 Tuple, Optional, Type, Iterable, Dict, Any, NamedTuple 17 | from time import time 18 | 19 | from sqlalchemy import (Column, String, Integer, BigInteger, Text, Table, 20 | select, and_, or_, func, case, asc, desc) 21 | from sqlalchemy.sql.base import ImmutableColumnCollection 22 | from sqlalchemy.engine.base import Engine 23 | from sqlalchemy.ext.declarative import declarative_base 24 | 25 | from mautrix.types import Event, UserID, EventID, RoomID 26 | 27 | EventKarmaStats = NamedTuple("EventKarmaStats", room_id=RoomID, event_id=EventID, sender=UserID, 28 | content=str, total=int, positive=int, negative=int) 29 | UserKarmaStats = NamedTuple("UserKarmaStats", user_id=UserID, total=int, positive=int, negative=int) 30 | 31 | 32 | class Karma: 33 | __tablename__ = "karma" 34 | db: Engine = None 35 | t: Table = None 36 | c: ImmutableColumnCollection = None 37 | 38 | given_to: UserID = Column(String(255), primary_key=True) 39 | given_by: UserID = Column(String(255), primary_key=True) 40 | given_in: RoomID = Column(String(255), primary_key=True) 41 | given_for: EventID = Column(String(255), primary_key=True) 42 | 43 | given_from: EventID = Column(String(255), unique=True) 44 | given_at: int = Column(BigInteger) 45 | value: int = Column(Integer) 46 | content: str = Column(Text) 47 | 48 | @classmethod 49 | def get_best_events(cls, limit: int = 10) -> Iterable['EventKarmaStats']: 50 | return cls.get_event_stats(direction=desc, limit=limit) 51 | 52 | @classmethod 53 | def get_worst_events(cls, limit: int = 10) -> Iterable['EventKarmaStats']: 54 | return cls.get_event_stats(direction=asc, limit=limit) 55 | 56 | @classmethod 57 | def get_event_stats(cls, direction, limit: int = 10) -> Iterable['EventKarmaStats']: 58 | c = cls.c 59 | return (EventKarmaStats(*row) for row in cls.db.execute( 60 | select([c.given_in, c.given_for, c.given_to, c.content, 61 | func.sum(c.value).label("total"), 62 | func.sum(case([(c.value > 0, c.value)], else_=0)).label("positive"), 63 | func.abs(func.sum(case([(c.value < 0, c.value)], else_=0))).label("negative")]) 64 | .group_by(c.given_for) 65 | .order_by(direction("total"), asc(c.given_for)) 66 | .limit(limit))) 67 | 68 | @classmethod 69 | def get_top_users(cls, limit: int = 10) -> Iterable['UserKarmaStats']: 70 | return cls.get_user_stats(direction=desc, limit=limit) 71 | 72 | @classmethod 73 | def get_bottom_users(cls, limit: int = 10) -> Iterable['UserKarmaStats']: 74 | return cls.get_user_stats(direction=asc, limit=limit) 75 | 76 | @classmethod 77 | def get_user_stats(cls, direction, limit: int = 10) -> Iterable['UserKarmaStats']: 78 | c = cls.c 79 | return (UserKarmaStats(*row) for row in cls.db.execute( 80 | select([c.given_to, 81 | func.sum(c.value).label("total"), 82 | func.sum(case([(c.value > 0, c.value)], else_=0)).label("positive"), 83 | func.abs(func.sum(case([(c.value < 0, c.value)], else_=0))).label("negative")]) 84 | .group_by(c.given_to) 85 | .order_by(direction("total"), asc(c.given_to)) 86 | .limit(limit))) 87 | 88 | @classmethod 89 | def get_karma(cls, user_id: UserID) -> Optional['UserKarmaStats']: 90 | c = cls.c 91 | rows = cls.db.execute( 92 | select([c.given_to, 93 | func.sum(c.value).label("total"), 94 | func.sum(case([(c.value > 0, c.value)], else_=0)).label("positive"), 95 | func.abs(func.sum(case([(c.value < 0, c.value)], else_=0))).label("negative")] 96 | ).where(c.given_to == user_id)) 97 | try: 98 | return UserKarmaStats(*next(rows)) 99 | except StopIteration: 100 | return None 101 | 102 | @classmethod 103 | def find_index_from_top(cls, user_id: UserID) -> int: 104 | c = cls.c 105 | rows = cls.db.execute(select([c.given_to]) 106 | .group_by(c.given_to) 107 | .order_by(desc(func.sum(c.value)), asc(c.given_to))) 108 | for i, row in enumerate(rows): 109 | if row[0] == user_id: 110 | return i 111 | return -1 112 | 113 | @classmethod 114 | def all(cls, user_id: UserID) -> Iterable['Karma']: 115 | return (cls(given_to=given_to, given_by=given_by, given_in=given_in, given_for=given_for, 116 | given_from=given_from, given_at=given_at, value=value, content=content) 117 | for given_to, given_by, given_in, given_for, given_from, given_at, value, content 118 | in cls.db.execute(cls.t.select().where(cls.c.given_to == user_id))) 119 | 120 | @classmethod 121 | def export(cls, user_id: UserID) -> Iterable['Karma']: 122 | return (cls(given_to=given_to, given_by=given_by, given_in=given_in, given_for=given_for, 123 | given_from=given_from, given_at=given_at, value=value, content=content) 124 | for given_to, given_by, given_in, given_for, given_from, given_at, value, content 125 | in cls.db.execute(cls.t.select().where(or_(cls.c.given_to == user_id, 126 | cls.c.given_by == user_id)))) 127 | 128 | @classmethod 129 | def is_vote_event(cls, event_id: EventID) -> bool: 130 | rows = cls.db.execute(cls.t.select().where(cls.c.given_from == event_id)) 131 | try: 132 | next(rows) 133 | return True 134 | except StopIteration: 135 | return False 136 | 137 | @classmethod 138 | def get(cls, given_to: UserID, given_by: UserID, given_in: RoomID, given_for: Event 139 | ) -> Optional['Karma']: 140 | rows = cls.db.execute(cls.t.select().where(and_( 141 | cls.c.given_to == given_to, cls.c.given_by == given_by, 142 | cls.c.given_in == given_in, cls.c.given_for == given_for))) 143 | try: 144 | (given_to, given_by, given_in, given_for, 145 | given_from, given_at, value, content) = next(rows) 146 | except StopIteration: 147 | return None 148 | return cls(given_to=given_to, given_by=given_by, given_in=given_in, given_for=given_for, 149 | given_from=given_from, given_at=given_at, value=value, content=content) 150 | 151 | @classmethod 152 | def get_by_given_from(cls, given_from: EventID) -> Optional['Karma']: 153 | rows = cls.db.execute(cls.t.select().where(cls.c.given_from == given_from)) 154 | try: 155 | (given_to, given_by, given_in, given_for, 156 | given_from, given_at, value, content) = next(rows) 157 | except StopIteration: 158 | return None 159 | return cls(given_to=given_to, given_by=given_by, given_in=given_in, given_for=given_for, 160 | given_from=given_from, given_at=given_at, value=value, content=content) 161 | 162 | def delete(self) -> None: 163 | self.db.execute(self.t.delete().where(and_( 164 | self.c.given_to == self.given_to, self.c.given_by == self.given_by, 165 | self.c.given_in == self.given_in, self.c.given_for == self.given_for))) 166 | 167 | def insert(self) -> None: 168 | self.given_at = int(time() * 1000) 169 | self.db.execute(self.t.insert().values(given_to=self.given_to, given_by=self.given_by, 170 | given_in=self.given_in, given_for=self.given_for, 171 | given_from=self.given_from, value=self.value, 172 | given_at=self.given_at, content=self.content)) 173 | 174 | def update(self, new_value: int) -> None: 175 | self.given_at = int(time() * 1000) 176 | self.value = new_value 177 | self.db.execute(self.t.update().where(and_( 178 | self.c.given_to == self.given_to, self.c.given_by == self.given_by, 179 | self.c.given_in == self.given_in, self.c.given_for == self.given_for 180 | )).values(given_from=self.given_from, value=self.value, given_at=self.given_at)) 181 | 182 | def to_dict(self) -> Dict[str, Any]: 183 | return { 184 | "to": self.given_to, 185 | "by": self.given_by, 186 | "in": self.given_in, 187 | "for": self.given_for, 188 | "from": self.given_from, 189 | "at": self.given_at, 190 | "value": self.value, 191 | "content": self.content, 192 | } 193 | 194 | 195 | class Version: 196 | __tablename__ = "version" 197 | db: Engine = None 198 | t: Table = None 199 | c: ImmutableColumnCollection = None 200 | 201 | version: int = Column(Integer, primary_key=True) 202 | 203 | 204 | def make_tables(engine: Engine) -> Tuple[Type[Karma], Type[Version]]: 205 | base = declarative_base() 206 | 207 | class KarmaImpl(Karma, base): 208 | __table__: Table 209 | 210 | class VersionImpl(Version, base): 211 | __table__: Table 212 | 213 | base.metadata.bind = engine 214 | for table in KarmaImpl, VersionImpl: 215 | table.db = engine 216 | table.t = table.__table__ 217 | table.c = table.__table__.c 218 | table.Karma = KarmaImpl 219 | 220 | # TODO replace with alembic 221 | base.metadata.create_all() 222 | 223 | return KarmaImpl, VersionImpl 224 | -------------------------------------------------------------------------------- /karma/migrations.py: -------------------------------------------------------------------------------- 1 | # karma - A maubot plugin to track the karma of users. 2 | # Copyright (C) 2019 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 sqlalchemy import select 17 | from sqlalchemy.engine.base import Engine 18 | from alembic.migration import MigrationContext 19 | from alembic.operations import Operations 20 | 21 | 22 | def run(engine: Engine): 23 | conn = engine.connect() 24 | ctx = MigrationContext.configure(conn) 25 | op = Operations(ctx) 26 | -------------------------------------------------------------------------------- /maubot.yaml: -------------------------------------------------------------------------------- 1 | maubot: 0.1.0 2 | id: xyz.maubot.karma 3 | version: 1.0.1 4 | license: AGPL-3.0-or-later 5 | modules: 6 | - karma 7 | main_class: KarmaBot 8 | extra_files: 9 | - base-config.yaml 10 | database: true 11 | --------------------------------------------------------------------------------