├── .gitignore ├── Dockerfile ├── LICENSE ├── Mod Action Names.md ├── Pipfile ├── README.md ├── assets ├── clientid.png ├── createapplication.png ├── devconsole.png ├── getauthtoken1.png ├── getauthtoken2.png ├── getuserid.png ├── manageapplication.png ├── running.png └── thelooks.png ├── docker-compose.yml ├── examplesettings.json ├── get_userid.py ├── main.py ├── message.py ├── messageparser.py ├── modactions.py ├── requirements.txt └── streamer.py /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | __pycache__ 3 | settings.json 4 | settings2.json 5 | test.py 6 | *.log 7 | venv -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3-slim 2 | WORKDIR /app 3 | COPY Pipfile ./ 4 | RUN pip install --no-cache-dir pipenv && pipenv install 5 | COPY *.py ./ 6 | CMD [ "pipenv", "run", "python3", "-O", "-u", "main.py" ] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 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 General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Mod Action Names.md: -------------------------------------------------------------------------------- 1 | # List of Moderaction Actions 2 | 3 | This list is a list of all moderation actions that may be sent from this script. This may be used to fill in the moderation action whitelist config 4 | 5 | Chatroom Actions: `slow, slowoff, uniquechat, uniquechatoff, clear, emoteonly, emoteonlyoff, subscribers, subscribersoff, followers, followersoff, raid, unraid` 6 | 7 | User Moderation Actions: `timeout, untimeout, delete, mod, unmod, vip_added, unvip, ban, unban` 8 | 9 | Channel Term Actions: `add_permitted_term, add_blocked_term, remove_permitted_term, remove_blocked_term` 10 | 11 | Automod: `automod_caught_message, automod_allowed_message, automod_denied_message` 12 | 13 | Unban Requests: `approve_unban_request, deny_unban_request` -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [packages] 2 | websockets = "12" 3 | asyncio = "*" 4 | disnake = "*" 5 | aiohttp = "*" 6 | requests = "*" -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Twitch mod logging with Python 2 | 3 | Figuring out how to do this was a pain, and there was nothing good on the internet that I could find, so I might as well give it out to anyone who might want it. 4 | 5 | ### The looks: 6 | 7 | Top is with embeds disabled, and bottom enabled 8 | 9 | ![How logs look](/assets/thelooks.png) 10 | 11 | ### Installation 12 | 13 | - Recommended Python Version: 3.12 14 | 15 | - Clone the repo with `git clone https://github.com/CataIana/twitch-modlogging.git` in your preferred terminal application 16 | 17 | - If not running on docker, install the required dependencies 18 | - `cd twitch-modlogging` 19 | - `python3 -m venv venv` 20 | - `source venv/bin/activate` on linux or `venv/scripts/activate.ps1` on windows 21 | - `pip install --upgrade -r requirements.txt` 22 | 23 | - Copy `examplesettings.json` to `settings.json` 24 | 25 | - Go to the [twitch developer console](https://dev.twitch.tv/console) and click Register Your Application 26 | 27 | ![Registering Application](/assets/devconsole.png) 28 | 29 | - Give the application a name (make it unique). If you have a redirect URI you can put yours in, but I just used `https://twitchapps.com/tmi/` since I don't have one. 30 | 31 | ![Creating application](/assets/createapplication.png) 32 | 33 | - Finish creating your application. It will redirect you to your list of applications after creation. Find your application and click `Manage` 34 | 35 | ![Finish creating application](/assets/manageapplication.png) 36 | 37 | - Open `settings.json`. From the twitch developers website, copy the Client ID and put it into the `client_id` key. 38 | 39 | ![Getting Client ID](/assets/clientid.png) 40 | 41 | - Then you will need to authorize the Application to access your account. If the authorized user does not have mod privileges for the streamer you wish to log for, no mod actions will be recieved. In this URL `https://id.twitch.tv/oauth2/authorize?client_id=CLIENT_ID&redirect_uri=https://twitchapps.com/tmi/&response_type=token&scope=moderator:manage:automod+moderator:read:blocked_terms+moderator:read:chat_settings+moderator:read:unban_requests+moderator:read:banned_users+moderator:read:chat_messages+moderator:read:warnings+moderator:read:moderators+moderator:read:vips` replace `CLIENT_ID` with your Client ID. If you have your own redirect URI, replace `https://twitchapps.com/tmi/` with your own. Upon authorizing with your twitch account, you will be redirected and shown an authorization token. Keep this safe and do not share it. You can always revoke access [here](https://www.twitch.tv/settings/connections) and authorize again for a new token. Copy that token into the "auth_token" key in the settings file. Removing `oauth:` from the beginning is optional 42 | 43 | ![Getting auth token 1](/assets/getauthtoken1.png) 44 | ![Getting auth token 2](/assets/getauthtoken2.png) 45 | 46 | - Finally put the user ID in the "id" key that will be used for getting logs. If you do not know this, run the python file `get_userid.py` included in this repo. You will need to enter the same client ID and Oauth token used above in this script. 47 | 48 | ![Getting user ID](/assets/getuserid.png) 49 | 50 | - Now you can configure which streamer/s mod actions you want to listen for. Each streamer allows a list of webhooks if you want to send each mod action to multiple webhooks. For more information on creating webhooks, see [here](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) 51 | 52 | - Config options that can be setup now: Toggling automod, moderator ignoring, toggling embeds, configuring moderation action whitelisting. All of these are optional 53 | 54 | - Now you can start the bot with `python3 main.py` or `docker compose up`, depending on whether you are using docker or not 55 | - The output should look like this: 56 | 57 | ![script running](/assets/running.png) 58 | 59 | - I personally run this on linux using a systemd service. I highly recommend following a similar approach. For help setting up such approach, check out [this](https://tecadmin.net/setup-autorun-python-script-using-systemd/) 60 | 61 | Have a nice day :) 62 | 63 | Copyright © 2025 CataIana, under the GNU GPLv3 License. 64 | -------------------------------------------------------------------------------- /assets/clientid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/clientid.png -------------------------------------------------------------------------------- /assets/createapplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/createapplication.png -------------------------------------------------------------------------------- /assets/devconsole.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/devconsole.png -------------------------------------------------------------------------------- /assets/getauthtoken1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/getauthtoken1.png -------------------------------------------------------------------------------- /assets/getauthtoken2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/getauthtoken2.png -------------------------------------------------------------------------------- /assets/getuserid.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/getuserid.png -------------------------------------------------------------------------------- /assets/manageapplication.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/manageapplication.png -------------------------------------------------------------------------------- /assets/running.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/running.png -------------------------------------------------------------------------------- /assets/thelooks.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/CataIana/twitch-modlogging/7cd474bddf8937f04c2eda1685b6893d58bc8f08/assets/thelooks.png -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | twitch-modlogging: 3 | container_name: twitch-modlogging 4 | build: . 5 | volumes: 6 | - "./settings.json:/app/settings.json" 7 | -------------------------------------------------------------------------------- /examplesettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "authorization": { 3 | "id": "", 4 | "auth_token": "", 5 | "client_id": "" 6 | }, 7 | "_config": { 8 | "use_embeds": true, 9 | "ignored_moderators": ["someusername", "someotherusername"], 10 | "uptime_heartbeat_url": "", 11 | "uptime_heartbeat_frequency_every_x_minutes": 0 12 | }, 13 | "somestreamername": { 14 | "enable_automod": false, 15 | "mod_action_whitelist": [], 16 | "webhooks": [ 17 | "https://discord.com/api/webhooks/whatever", 18 | "https://discord.com/api/webhooks/whatever" 19 | ] 20 | }, 21 | "someotherstreamername": { 22 | "enable_automod": false, 23 | "mod_action_whitelist": ["timeout", "vip_added", "mod", "delete"], 24 | "webhooks": [ 25 | "https://discord.com/api/webhooks/whatever" 26 | ] 27 | } 28 | } -------------------------------------------------------------------------------- /get_userid.py: -------------------------------------------------------------------------------- 1 | import requests 2 | 3 | client_id = input("Provide your client ID: ") 4 | oauth = input("Provide your oauth token: ") 5 | oauth = oauth.split("oauth:")[-1] #Remove the oauth: to prevent errors 6 | print("Input at least one USERNAME, or multiple seperated by commas without spaces") 7 | while True: 8 | username = input("Provide User ID: ") 9 | response = requests.get(url=f"https://api.twitch.tv/helix/users?login={'&login='.join(username.split(','))}", headers={"Client-ID": client_id, "Authorization": f"Bearer {oauth}"}) 10 | json_obj = response.json() 11 | try: 12 | for user in json_obj["data"]: 13 | print(f"{user['login']}: {user['id']}") 14 | except Exception: 15 | print(f"Error {json_obj.get('error', None)}: {json_obj.get('message', None)}") -------------------------------------------------------------------------------- /main.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import asyncio 4 | import json 5 | import logging 6 | import sys 7 | from contextlib import suppress 8 | from time import sleep, time 9 | from traceback import format_tb 10 | from typing import Dict 11 | 12 | import disnake 13 | import websockets 14 | from aiohttp import ClientSession 15 | from requests import get 16 | from requests.exceptions import ConnectionError 17 | from websockets.legacy.client import WebSocketClientProtocol 18 | 19 | from message import Message 20 | from messageparser import Parser 21 | from streamer import Streamer 22 | 23 | 24 | class ConfigError(Exception): 25 | pass 26 | 27 | # https://id.twitch.tv/oauth2/authorize?client_id=CLIENT_ID&redirect_uri=https://twitchapps.com/tmi/&response_type=token&scope=moderator:manage:automod+moderator:read:blocked_terms+moderator:read:chat_settings+moderator:read:unban_requests+moderator:read:banned_users+moderator:read:chat_messages+moderator:read:warnings+moderator:read:moderators+moderator:read:vips 28 | 29 | DEFAULT_CONNECTION_URL = "wss://eventsub.wss.twitch.tv/ws" 30 | API_URL = "https://api.twitch.tv/helix" 31 | 32 | class PubSubLogging: 33 | def __init__(self): 34 | self.logging = logging.getLogger("Twitch Pubsub Logging") 35 | self.logging.setLevel(logging.INFO) 36 | formatter = logging.Formatter( 37 | "%(levelname)s [%(module)s %(funcName)s %(lineno)d]: %(message)s") 38 | 39 | # Console logging 40 | chandler = logging.StreamHandler(sys.stdout) 41 | chandler.setLevel(self.logging.level) 42 | chandler.setFormatter(formatter) 43 | self.logging.addHandler(chandler) 44 | 45 | self.queue = asyncio.Queue(maxsize=0) 46 | self._streamers: Dict[str, Streamer] = {} 47 | self._tasks: list[asyncio.Task] = [] 48 | 49 | self.connection_url: str = DEFAULT_CONNECTION_URL 50 | self.last_message_time: int = 0 51 | self.should_resubscribe: bool = True 52 | self.current_session_id: str = None 53 | self.current_user_id: str = None 54 | self.client_id: str = None 55 | self.authorisation: str = None 56 | 57 | # Read twitch authorization data 58 | 59 | try: 60 | with open("settings.json") as f: 61 | channels = json.load(f) 62 | except FileNotFoundError: 63 | raise ConfigError("Unable to locate settings file!") 64 | if not channels.get("authorization", None): 65 | raise ConfigError("Authorization not provided") 66 | try: # Get authorization data 67 | self.current_user_id = str(channels["authorization"]["id"]) 68 | self.authorisation = channels["authorization"]["auth_token"].split("oauth:", 1)[-1] 69 | self.client_id = channels["authorization"]["client_id"] 70 | del channels["authorization"] 71 | except KeyError: 72 | raise ConfigError("Unable to fetch user ID and Authorization Token!") 73 | 74 | # Read config options 75 | 76 | use_embeds = channels["_config"].get("use_embeds", True) 77 | ignored_mods = channels["_config"].get("ignored_moderators", []) 78 | if type(ignored_mods) == str: 79 | ignored_mods = [ignored_mods] 80 | elif ignored_mods == None: 81 | ignored_mods = [] 82 | 83 | self.robot_heartbeat_url = channels["_config"].get("uptime_heartbeat_url", None) 84 | try: 85 | self.robot_heartbeat_frequency = int(channels["_config"].get("uptime_heartbeat_frequency_every_x_minutes", 0)) 86 | except ValueError: 87 | raise ConfigError("Uptime heartbeat frequency is not a valid integer!") 88 | 89 | del channels["_config"] 90 | 91 | try: 92 | failed_attempts = 0 93 | while True: 94 | # Get information of each defined streamer, such as ID, icon, and display name 95 | try: 96 | response = get(url=f"https://api.twitch.tv/helix/users?login={'&login='.join([channel for channel in channels.keys() if not channel.startswith('_')])}", headers={"Client-ID": self.client_id, "Authorization": f"Bearer {self.authorisation}"}) 97 | except ConnectionError: 98 | if 2**failed_attempts > 128: 99 | sleep(120) 100 | else: 101 | sleep(2**failed_attempts) 102 | failed_attempts += 1 # Continue to back off exponentially with every failed connection attempt up to 2 minutes 103 | self.logging.warning( 104 | f"{failed_attempts} failed attempts to fetch broadcaster data.") 105 | continue 106 | json_obj = response.json() 107 | for user in json_obj["data"]: 108 | if type(channels[user["login"]]) == list: #If settings file is the old configuration. 109 | webhooks = channels[user["login"]] 110 | self._streamers[user['id']] = Streamer( 111 | user["login"], display_name=user["display_name"], icon=user["profile_image_url"], webhook_urls=webhooks) 112 | else: 113 | webhooks = channels[user["login"]]["webhooks"] 114 | enable_automod = channels[user["login"]].get("enable_automod", False) 115 | mod_action_whitelist = channels[user["login"]].get("mod_action_whitelist", []) 116 | self._streamers[user['id']] = Streamer( 117 | user["login"], display_name=user["display_name"], icon=user["profile_image_url"], webhook_urls=webhooks, enable_automod=enable_automod, action_whitelist=mod_action_whitelist) 118 | break 119 | except KeyError: 120 | raise ConfigError("Error during initialization. Check your client id and settings file!") 121 | 122 | self.logging.info( 123 | f"Listening for chat moderation actions for: {', '.join(v.display_name for v in self._streamers.values())}") 124 | using_automod = [v.display_name for v in self._streamers.values() if v.enable_automod] 125 | if using_automod != []: 126 | self.logging.info(f"Listening for automod actions for: {', '.join(using_automod)}") 127 | 128 | self.parser = Parser(self._streamers, use_embeds=use_embeds, ignored_mods=ignored_mods) 129 | 130 | async def subscribe_to_events(self, session_id: str): 131 | headers = { 132 | "Authorization": f"Bearer {self.authorisation}", 133 | "Client-ID": self.client_id, 134 | } 135 | for c_id in list(self._streamers.keys()): 136 | r1 = await self.aioSession.post(f"{API_URL}/eventsub/subscriptions", headers=headers, json={ 137 | "type": "channel.moderate", 138 | "version": "2", 139 | "condition": { 140 | "broadcaster_user_id": c_id, 141 | "moderator_user_id": self.current_user_id 142 | }, 143 | "transport": { 144 | "method": "websocket", 145 | "session_id": session_id 146 | } 147 | }) 148 | r1.raise_for_status() 149 | if self._streamers[c_id].enable_automod: #Subscribe to automod topics if enabled. 150 | r2 = await self.aioSession.post(f"{API_URL}/eventsub/subscriptions", headers=headers, json={ 151 | "type": "automod.message.hold", 152 | "version": "2", 153 | "condition": { 154 | "broadcaster_user_id": c_id, 155 | "moderator_user_id": self.current_user_id 156 | }, 157 | "transport": { 158 | "method": "websocket", 159 | "session_id": session_id 160 | } 161 | }) 162 | r2.raise_for_status() 163 | r3 = await self.aioSession.post(f"{API_URL}/eventsub/subscriptions", headers=headers, json={ 164 | "type": "automod.message.update", 165 | "version": "2", 166 | "condition": { 167 | "broadcaster_user_id": c_id, 168 | "moderator_user_id": self.current_user_id 169 | }, 170 | "transport": { 171 | "method": "websocket", 172 | "session_id": session_id 173 | } 174 | }) 175 | r3.raise_for_status() 176 | await asyncio.sleep(0.05) 177 | self.logging.debug("Events Subscribed") 178 | self.logging.info("Ready") 179 | 180 | def run(self): 181 | self.loop = asyncio.new_event_loop() 182 | try: 183 | self.loop.run_until_complete(self.main()) 184 | except KeyboardInterrupt: 185 | pass 186 | finally: 187 | self.logging.info("Shutting down") 188 | for task in self._tasks: 189 | task.cancel() 190 | # Now we should await task to execute it's cancellation. 191 | # Cancelled task raises asyncio.CancelledError that we can suppress: 192 | with suppress(asyncio.CancelledError): 193 | self.loop.run_until_complete(task) 194 | self.loop.run_until_complete(self.aioSession.close()) 195 | # Takes forever to close 196 | self.loop.run_until_complete(self.connection.close()) 197 | self.loop.close() 198 | 199 | async def main(self): 200 | self.aioSession = ClientSession() 201 | while True: 202 | self.logging.debug("Connecting to websocket") 203 | async for connection in websockets.connect(self.connection_url): 204 | self.connection = connection 205 | self.logging.info("Connected to websocket") 206 | if self.connection_url != DEFAULT_CONNECTION_URL: 207 | self.connection_url = DEFAULT_CONNECTION_URL 208 | self._tasks = [ 209 | self.loop.create_task(self.twitch_heartbeat(connection)), # Twitch Pubsub requires occasional pings 210 | self.loop.create_task(self.message_reciever(connection)), # Recieves the messages from the websocket and parses them 211 | self.loop.create_task(self.worker(connection)) # Handles sending the messages created by the message reciever 212 | ] 213 | if self.robot_heartbeat_url and self.robot_heartbeat_frequency > 0: 214 | self._tasks += [ 215 | self.loop.create_task(self.robot_heartbeat(connection)) # If configured, send occasional pings to uptimerobot 216 | ] 217 | await asyncio.wait(self._tasks) # Tasks will run until the connection closes, we need to re-establish it if it closes 218 | 219 | async def message_reciever(self, connection: WebSocketClientProtocol): 220 | while not connection.closed: 221 | try: 222 | message = await connection.recv() 223 | self.last_message_time = time() 224 | await self.messagehandler(message) 225 | except websockets.exceptions.ConnectionClosed: 226 | self.logging.warning("Connection with server closed") 227 | [task.cancel() for task in self._tasks if task is not asyncio.tasks.current_task()] 228 | 229 | async def twitch_heartbeat(self, connection: WebSocketClientProtocol): 230 | while not connection.closed: 231 | await asyncio.sleep(30) 232 | if self.last_message_time + 30 < time() and not connection.closed: 233 | self.logging.info("Connection seems dead, restarting websocket") 234 | await connection.close() 235 | [task.cancel() for task in self._tasks if task is not asyncio.tasks.current_task()] 236 | 237 | async def robot_heartbeat(self, connection: WebSocketClientProtocol): 238 | while not connection.closed: 239 | if self.robot_heartbeat_url and self.robot_heartbeat_frequency > 0: 240 | self.logging.debug("Sending uptime heartbeat") 241 | await self.aioSession.get(self.robot_heartbeat_url) 242 | # Sleep for defined value 243 | await asyncio.sleep(self.robot_heartbeat_frequency*60) 244 | 245 | async def worker(self, connection: WebSocketClientProtocol): 246 | while not connection.closed: 247 | message: Message = await self.queue.get() 248 | self.logging.debug(f"Recieved queue event") 249 | if not message.ignore: # Some messages can be ignored as duplicates are recieved etc 250 | await message.send(session=self.aioSession) 251 | self.queue.task_done() 252 | 253 | async def messagehandler(self, raw_message: str): 254 | try: 255 | json_message = json.loads(str(raw_message)) 256 | metadata = json_message.get("metadata", {}) 257 | payload = json_message.get("payload", {}) 258 | if metadata["message_type"] == "session_welcome": 259 | self.logging.debug("Welcome message received") 260 | self.current_session_id = payload["session"]["id"] 261 | if self.should_resubscribe: 262 | await self.subscribe_to_events(self.current_session_id) 263 | self.should_resubscribe = True 264 | 265 | # Twitch sends this message when it wants the client to reconnect, so we force disconnect and reconnect with the provided url 266 | elif metadata["message_type"] == "session_reconnect": 267 | self.logging.warning("Twitch requested reconnection") 268 | self.connection_url = json_message["payload"]["session"]["reconnect_url"] 269 | self.should_resubscribe = False 270 | # Close the connection and let the code reconnect automatically 271 | await self.connection.close() 272 | [task.cancel() for task in self._tasks] 273 | 274 | elif metadata["message_type"] == "notification": 275 | self.logging.debug(json.dumps(json_message, indent=4)) 276 | # Data parser, along with all the switches for various mod actions 277 | message = await self.parser.parse_message(json_message) 278 | self.queue.put_nowait(message) 279 | 280 | elif metadata["message_type"] == "session_keepalive": 281 | return 282 | 283 | else: 284 | # Catch all other messages and log them to the console 285 | self.logging.warning(f"Unhandled event!: {json.dumps(json_message, indent=4)}") 286 | 287 | except Exception as e: #Catch every exception and send it to the associated streamer, if they can be gathered 288 | formatted_exception = "Traceback (most recent call last):\n" + ''.join( 289 | format_tb(e.__traceback__)) + f"{type(e).__name__}: {e}" 290 | self.logging.error(formatted_exception) 291 | try: 292 | json_message = json.loads(raw_message) 293 | 294 | # If payload is empty we have no broadcaster to go by so just log and continue 295 | if json_message.get("payload", {}) == {}: 296 | self.logging.error(json.dumps(raw_message, indent=4)) 297 | return 298 | 299 | streamer_id = json_message["payload"]["subscription"]["condition"]["broadcaster_user_id"] 300 | streamer = self._streamers[streamer_id] 301 | # Remove null values to save space 302 | exclude_these_keys = ['broadcaster_user_id', 'broadcaster_user_login', 'broadcaster_user_name', 'user_name', 'moderator_user_name'] 303 | minimised = {k: v for k, v in json_message["payload"]["event"].items() if v is not None and k != exclude_these_keys} 304 | del minimised["message"]["fragments"] 305 | embed = disnake.Embed( 306 | title=f"Safety Embed", 307 | description=f"If you see this something went wrong with the data from Twitch, or how it is being handled.", 308 | color=0x880080, 309 | timestamp=disnake.utils.utcnow() 310 | ) 311 | embed.add_field( 312 | name="Traceback", value=f"```python\n{formatted_exception}```", inline=False) 313 | embed.add_field( 314 | name="Debug Data", value=f"`{json.dumps(minimised)}`", inline=False) 315 | 316 | webhooks = [] 317 | for webhook in streamer.webhook_urls: 318 | webhooks.append(disnake.Webhook.from_url( 319 | webhook, session=self.aioSession)) 320 | embed.set_footer(text="Sad", icon_url=streamer.icon) 321 | for webhook in webhooks: 322 | try: 323 | await webhook.send(embed=embed) 324 | except disnake.NotFound: 325 | self.logging.error(f"Webhook not found for {streamer}") 326 | except disnake.HTTPException as e: 327 | self.logging.error(f"HTTP Exception sending webhook: {e}") 328 | except Exception as ee: 329 | self.logging.error("Exception handling exception message") 330 | formatted_nested_exception = "Traceback (most recent call last):\n" + ''.join( 331 | format_tb(ee.__traceback__)) + f"{type(ee).__name__}: {ee}" 332 | self.logging.error(formatted_nested_exception) 333 | 334 | if __name__ == "__main__": 335 | p = PubSubLogging() 336 | p.run() 337 | -------------------------------------------------------------------------------- /message.py: -------------------------------------------------------------------------------- 1 | import logging 2 | from datetime import datetime 3 | from typing import TYPE_CHECKING 4 | 5 | import disnake 6 | from aiohttp import ClientSession 7 | 8 | from modactions import ModAction 9 | from streamer import Streamer 10 | 11 | if TYPE_CHECKING: 12 | from messageparser import Parser 13 | 14 | class Message: 15 | def __init__(self, parser, raw, streamer, mod_action, ignore, embed, embed_text, **kwargs): 16 | self._parser: Parser = parser 17 | self.__raw_message: dict = raw 18 | self.logging = logging.getLogger("Twitch Pubsub Logging") 19 | self.__streamer: Streamer = streamer 20 | self.__mod_action: str = mod_action 21 | self.__ignore_message: bool = ignore 22 | self.__embed: disnake.Embed = embed 23 | self.__embed_text: str = embed_text 24 | self.__created_at = datetime.utcnow() 25 | 26 | self.footer_message: str = "Mew" 27 | 28 | @property 29 | def streamer(self): 30 | return self.__streamer 31 | 32 | @property 33 | def mod_action(self): 34 | return self.__mod_action 35 | 36 | @property 37 | def created_at(self): 38 | return self.__created_at 39 | 40 | @property 41 | def embed(self): 42 | return self.__embed 43 | 44 | @property 45 | def embed_text(self): 46 | return self.__embed_text 47 | 48 | @property 49 | def ignore(self): 50 | return self.__ignore_message 51 | 52 | async def send(self, session=None): 53 | close_when_done = False 54 | if session is None: 55 | session = ClientSession() 56 | close_when_done = True 57 | session = session or ClientSession() 58 | webhooks = [] 59 | for webhook in self.streamer.webhook_urls: 60 | webhooks.append(disnake.Webhook.from_url( 61 | webhook, session=session)) 62 | 63 | self.__embed.set_footer(text=self.footer_message, icon_url=self.__streamer.icon) 64 | for webhook in webhooks: 65 | try: 66 | if self.mod_action == ModAction.automod_allowed_message or self.mod_action == ModAction.automod_denied_message: 67 | existing = self._parser.automod_cache.get(self.__raw_message["payload"]["event"]["message_id"], None) 68 | if existing: #If we found the older message in the cache, update it :) 69 | try: 70 | if self._parser.use_embeds: 71 | await existing["message"].edit(embed=self.__embed, allowed_mentions=disnake.AllowedMentions.none()) 72 | else: 73 | await existing["message"].edit(content=self.__embed_text, allowed_mentions=disnake.AllowedMentions.none()) 74 | except disnake.NotFound: 75 | pass 76 | del self._parser.automod_cache[self.__raw_message["payload"]["event"]["message_id"]] 77 | else: #If it's not in the cache for some reason just send it as normal 78 | if self._parser.use_embeds: 79 | w_message = await webhook.send(embed=self.__embed, allowed_mentions=disnake.AllowedMentions.none()) 80 | else: 81 | w_message = await webhook.send(content=self.__embed_text, allowed_mentions=disnake.AllowedMentions.none()) 82 | else: 83 | if self._parser.use_embeds: 84 | w_message = await webhook.send(embed=self.__embed, allowed_mentions=disnake.AllowedMentions.none(), wait=True) 85 | else: 86 | w_message = await webhook.send(content=self.__embed_text, allowed_mentions=disnake.AllowedMentions.none(), wait=True) 87 | if self.mod_action == ModAction.automod_caught_message: 88 | self._parser.automod_cache.update({self.__raw_message["payload"]["event"]["message_id"]: {"object": self, "message": w_message}}) 89 | except disnake.NotFound: 90 | self.logging.warning( 91 | f"Webhook not found for {self.streamer.username}") 92 | except disnake.HTTPException as e: 93 | self.logging.error(f"HTTP Exception sending webhook: {e}") 94 | if close_when_done: 95 | await session.close() -------------------------------------------------------------------------------- /messageparser.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import logging 3 | from datetime import datetime, timedelta 4 | 5 | import disnake 6 | 7 | from message import Message 8 | from modactions import ModAction 9 | from streamer import Streamer 10 | 11 | 12 | class Colours: 13 | def __init__(self): 14 | self.red = 0xE74C3C 15 | self.yellow = 0xFFBF00 16 | self.orange = 0xFFA500 17 | self.green = 0x2ECC71 18 | 19 | AUTOMOD_TIMEOUT = 180 20 | class Parser: 21 | def __init__(self, streamers, **kwargs): 22 | self.logging = logging.getLogger("Twitch Pubsub Logging") 23 | self.streamers = streamers 24 | self.ignored_mods = kwargs.get("ignored_mods", []) 25 | self.use_embeds = kwargs.get("use_embeds", True) 26 | self.colour = Colours() 27 | self._chatroom_actions = { 28 | ModAction.slow: "Slow Chat Mode Enabled", 29 | ModAction.slowoff: "Slow Chat Mode Disabled", 30 | ModAction.uniquechat: "Unique Chat Mode Enabled", 31 | ModAction.uniquechatoff: "Unique Chat Mode Disabled", 32 | ModAction.clear: "Chat Cleared by Moderator", 33 | ModAction.emoteonly: "Emote Only Chat Mode Enabled", 34 | ModAction.emoteonlyoff: "Emote Only Chat Mode Disabled", 35 | ModAction.subscribers: "Subscriber Only Chat Mode Enabled", 36 | ModAction.subscribersoff: "Subscriber Only Chat Mode Disabled", 37 | ModAction.followers: "Follower Only Chat Mode Enabled", 38 | ModAction.followersoff: "Follower Only Chat Mode Disabled", 39 | ModAction.host: "Host Action", 40 | ModAction.unhost: "Unhost Action", 41 | ModAction.raid: "Raid Action", 42 | ModAction.unraid: "Unraid Action" 43 | } 44 | self.automod_cache = {} 45 | self.loop = asyncio.get_event_loop() 46 | self.loop.create_task(self.cleanup_automod()) 47 | 48 | async def cleanup_automod(self): 49 | while True: 50 | await asyncio.sleep(360) 51 | count = 0 52 | for id, i in dict(self.automod_cache).items(): 53 | if i["object"].created_at.timestamp() > datetime.utcnow().timestamp() - AUTOMOD_TIMEOUT: 54 | del self.automod_cache[id] 55 | count += 1 56 | if count > 0: 57 | self.logging.info(f"Cleaned up {count} unanswered events") 58 | 59 | async def parse_message(self, data: dict) -> Message: 60 | metadata = data["metadata"] 61 | subscription = data["payload"]["subscription"] 62 | event = data["payload"]["event"] 63 | streamer: Streamer = self.streamers[event["broadcaster_user_id"]] 64 | ignore_message = False 65 | 66 | embed = disnake.Embed(timestamp=disnake.utils.utcnow()) 67 | 68 | embed.add_field( 69 | name="Channel", value=f"[{streamer.display_name}]()", inline=True) # Every embed should have the channel link 70 | 71 | if subscription["type"] == "automod.message.hold": 72 | mod_action_str = "automod_caught_message" 73 | moderator = "Automod" 74 | elif subscription["type"] == "automod.message.update": 75 | if event["status"] == "approved": 76 | mod_action_str = "automod_allowed_message" 77 | else: 78 | mod_action_str = "automod_denied_message" 79 | moderator = event["moderator_user_name"] 80 | else: 81 | mod_action_str = event["action"] 82 | moderator = event["moderator_user_name"] 83 | 84 | embed.add_field(name="Moderator", value=moderator, inline=True) 85 | 86 | try: 87 | mod_action = ModAction(mod_action_str) 88 | mod_action_func = getattr(self, mod_action.value) 89 | r = mod_action_func(streamer, event, metadata, mod_action, embed) 90 | if type(r) == tuple: 91 | embed = r[1] 92 | ignore_message = r[0] 93 | else: 94 | embed = r 95 | except AttributeError: 96 | embed.add_field(name="UNKNOWN ACTION", value=f"`{mod_action_str}`", inline=False) 97 | 98 | if moderator in self.ignored_mods: 99 | ignore_message = True 100 | 101 | #Ignores 102 | if mod_action.value not in streamer.action_whitelist and streamer.action_whitelist != [] and mod_action != ModAction.automod_caught_message: #Automod ignoring handled seperately 103 | ignore_message = True 104 | 105 | # Make the text version out of the embed. This is shitty, I know. Works surprisingly well though, for now... 106 | d = embed.to_dict() 107 | embed_text = "\n" 108 | if d.get("title", None) is not None: 109 | embed_text += f"**{d['title']}**" 110 | for field in d["fields"]: 111 | if field["name"] == "Channel": 112 | embed_text += f" **||** **Channel:** {field['value']}" 113 | elif field["name"] == "Moderator": 114 | embed_text += f" **||** **Moderator:** {field['value']}" 115 | if d.get("description", None) is not None: 116 | embed_text += f" **||** {d['description']}\n" 117 | else: 118 | embed_text += "\n" 119 | embed_text += '\n'.join([f"{i['name']}: {i['value']}" for i in d['fields'] if i["name"] != "Moderator" and i["name"] != "Channel"]) 120 | 121 | self.logging.info(f"{moderator} used {mod_action.value} in #{streamer.username}") 122 | 123 | return Message(self, data, streamer, mod_action, ignore_message, embed, embed_text) 124 | 125 | # More generic functions that the specifics call 126 | 127 | def set_user_attrs(self, streamer: Streamer, event: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 128 | user = event[mod_action.name.replace("approve_", "").replace("deny_", "")]["user_login"] 129 | user_escaped = user.lower().replace('_', r'\_') 130 | embed.title = f"Mod {mod_action.value.replace('_', ' ').title()} Action" 131 | #embed.description=f"[Review Viewercard for User]()" 132 | embed.color = self.colour.red 133 | embed.add_field( 134 | name="Flagged Account", value=f"[{user_escaped}]()", inline=True) 135 | return embed 136 | 137 | def set_terms_attrs(self, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 138 | embed.title = f"Mod {mod_action.value.replace('_', ' ').title()} Action" 139 | embed.color = self.colour.red 140 | return embed 141 | 142 | def set_appeals_attrs(self, streamer: Streamer, event: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 143 | self.set_user_attrs(streamer, event, mod_action, embed) 144 | moderator_reason = event[mod_action.name.replace("approve_", "").replace("deny_", "")]['moderator_message'] if event[mod_action.name.replace("approve_", "").replace("deny_", "")]['moderator_message'] != '' else 'None Provided' 145 | embed.add_field( 146 | name="Moderator Reason", value=f"`{moderator_reason}`", inline=False) 147 | return embed 148 | 149 | def set_chatroom_attrs(self, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 150 | embed.title = self._chatroom_actions[mod_action] 151 | embed.color = self.colour.yellow 152 | return embed 153 | 154 | # Action type specific functions that are fetched using getattr() 155 | 156 | def approve_unban_request(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 157 | embed.colour = self.colour.green 158 | return self.set_appeals_attrs(streamer, event, mod_action, embed) 159 | 160 | def deny_unban_request(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 161 | return self.set_appeals_attrs(streamer, event, mod_action, embed) 162 | 163 | def slow(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 164 | embed = self.set_chatroom_attrs(mod_action, embed) 165 | embed.add_field( 166 | name=f"Slow Amount (second{'' if event[mod_action.name]['wait_time_seconds'] == 1 else 's'})", value=f"`{event[mod_action.name]['wait_time_seconds']}`", inline=True) 167 | return embed 168 | 169 | def slowoff(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 170 | return self.set_chatroom_attrs(mod_action, embed) 171 | 172 | def uniquechat(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 173 | return self.set_chatroom_attrs(mod_action, embed) 174 | 175 | def uniquechatoff(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 176 | return self.set_chatroom_attrs(mod_action, embed) 177 | 178 | def clear(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 179 | return self.set_chatroom_attrs(mod_action, embed) 180 | 181 | def emoteonly(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 182 | return self.set_chatroom_attrs(mod_action, embed) 183 | 184 | def emoteonlyoff(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 185 | return self.set_chatroom_attrs(mod_action, embed) 186 | 187 | def subscribers(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 188 | return self.set_chatroom_attrs(mod_action, embed) 189 | 190 | def subscribersoff(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 191 | return self.set_chatroom_attrs(mod_action, embed) 192 | 193 | def followers(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 194 | embed = self.set_chatroom_attrs(mod_action, embed) 195 | embed.add_field( 196 | name=f"Time Needed to be Following (minute{'' if int(event[mod_action.name]['follow_duration_minutes']) == 1 else 's'})", value=f"`{event[mod_action.name]['follow_duration_minutes']}`", inline=True) 197 | return embed 198 | 199 | def followersoff(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 200 | return self.set_chatroom_attrs(mod_action, embed) 201 | 202 | def raid(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 203 | embed = self.set_chatroom_attrs(mod_action, embed) 204 | embed.add_field( 205 | name="Raided Channel", value=f"[{event[mod_action.name]['user_name']}]()", inline=True) 206 | return embed 207 | 208 | def unraid(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 209 | return self.set_chatroom_attrs(mod_action, embed) 210 | 211 | def timeout(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 212 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 213 | if event[mod_action.name]["reason"] == "": 214 | embed.add_field( 215 | name="Flag Reason", value=f"`None Provided`") 216 | else: 217 | if "`" in event[mod_action.name]["reason"]: 218 | embed.add_field( 219 | name="Flag Reason", value=f"```{event[mod_action.name]['reason']}```") 220 | else: 221 | embed.add_field( 222 | name="Flag Reason", value=f"`{event[mod_action.name]['reason']}`") 223 | 224 | def round_seconds(obj: timedelta) -> int: 225 | if obj.microseconds >= 500_000: 226 | obj += timedelta(seconds=1) 227 | return obj.seconds 228 | 229 | duration = round_seconds(datetime.fromisoformat(event[mod_action.name]["expires_at"]) - datetime.fromisoformat(metadata["message_timestamp"])) 230 | 231 | embed.add_field( 232 | name="Duration", value=f"{duration} second{'' if duration == 1 else 's'}") 233 | 234 | #embed.add_field(name="\u200b", value="\u200b") 235 | return embed 236 | 237 | def untimeout(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 238 | return self.set_user_attrs(streamer, event, mod_action, embed) 239 | 240 | def ban(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 241 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 242 | if event[mod_action.name]["reason"] == "": 243 | embed.add_field( 244 | name="Flag Reason", value=f"`None Provided`") 245 | else: 246 | if "`" in event[mod_action.name]["reason"]: 247 | embed.add_field( 248 | name="Flag Reason", value=f"```{event[mod_action.name]['reason']}```") 249 | else: 250 | embed.add_field( 251 | name="Flag Reason", value=f"`{event[mod_action.name]['reason']}`") 252 | return embed 253 | 254 | def unban(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 255 | embed.colour = self.colour.green 256 | return self.set_user_attrs(streamer, event, mod_action, embed) 257 | 258 | def delete(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 259 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 260 | if "`" in event[mod_action.name]['message_body']: 261 | embed.add_field( 262 | name="Message", value=f"```{event[mod_action.name]['message_body']}```") 263 | else: 264 | embed.add_field( 265 | name="Message", value=f"`{event[mod_action.name]['message_body']}`") 266 | 267 | return embed 268 | 269 | def mod(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 270 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 271 | embed.title = "Moderator Added Action" #Use a custom title for adding/removing mods for looks 272 | embed.colour = self.colour.green 273 | return embed 274 | 275 | def unmod(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 276 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 277 | embed.title = "Moderator Removed Action" 278 | return embed 279 | 280 | def vip(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 281 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 282 | embed.title = embed.title.replace('Vip', 'VIP') #Capitalize VIP for the looks 283 | embed.colour = self.colour.green 284 | return embed 285 | 286 | def unvip(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 287 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 288 | embed.title = embed.title.replace('Unvip', 'UnVIP') 289 | return embed 290 | 291 | def warn(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 292 | embed.colour = self.colour.yellow 293 | embed.add_field( 294 | name="Moderator Reason", value=f"`{event[mod_action.name]['reason']}`", inline=False) 295 | return self.set_user_attrs(streamer, event, mod_action, embed) 296 | 297 | def acknowledge_warning(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 298 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 299 | embed.colour = self.colour.green 300 | embed.title = "User Acknowledged Warning Action" 301 | embed.remove_field(1) 302 | return embed 303 | 304 | def shared_chat_ban(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 305 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 306 | if event[mod_action.name]["reason"] == "": 307 | embed.add_field( 308 | name="Flag Reason", value=f"`None Provided`") 309 | else: 310 | if "`" in event[mod_action.name]["reason"]: 311 | embed.add_field( 312 | name="Flag Reason", value=f"```{event[mod_action.name]['reason']}```") 313 | else: 314 | embed.add_field( 315 | name="Flag Reason", value=f"`{event[mod_action.name]['reason']}`") 316 | return embed 317 | 318 | def shared_chat_unban(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 319 | embed.colour = self.colour.green 320 | return self.set_user_attrs(streamer, event, mod_action, embed) 321 | 322 | def shared_chat_timeout(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 323 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 324 | if event[mod_action.name]["reason"] == "": 325 | embed.add_field( 326 | name="Flag Reason", value=f"`None Provided`") 327 | else: 328 | if "`" in event[mod_action.name]["reason"]: 329 | embed.add_field( 330 | name="Flag Reason", value=f"```{event[mod_action.name]['reason']}```") 331 | else: 332 | embed.add_field( 333 | name="Flag Reason", value=f"`{event[mod_action.name]['reason']}`") 334 | 335 | def round_seconds(obj: timedelta) -> int: 336 | if obj.microseconds >= 500_000: 337 | obj += timedelta(seconds=1) 338 | return obj.seconds 339 | 340 | duration = round_seconds(datetime.fromisoformat(event[mod_action.name]["expires_at"]) - datetime.fromisoformat(metadata["message_timestamp"])) 341 | 342 | embed.add_field( 343 | name="Duration", value=f"{duration} second{'' if duration == 1 else 's'}") 344 | 345 | return embed 346 | 347 | def shared_chat_untimeout(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 348 | return self.set_user_attrs(streamer, event, mod_action, embed) 349 | 350 | def shared_chat_delete(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 351 | embed = self.set_user_attrs(streamer, event, mod_action, embed) 352 | if "`" in event[mod_action.name]['message_body']: 353 | embed.add_field( 354 | name="Message", value=f"```{event[mod_action.name]['message_body']}```") 355 | else: 356 | embed.add_field( 357 | name="Message", value=f"`{event[mod_action.name]['message_body']}`") 358 | 359 | return embed 360 | 361 | def add_permitted_term(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 362 | embed = self.set_terms_attrs(mod_action, embed) 363 | embed.colour = self.colour.green 364 | embed.add_field( 365 | name="Added by", value=f"{event['moderator_user_login']}") 366 | if "`" in event['automod_terms']["terms"][0]: 367 | embed.add_field( 368 | name="Term", value=f"```{event['automod_terms']['terms'][0]}```", inline=False) 369 | else: 370 | embed.add_field( 371 | name="Term", value=f"`{event['automod_terms']['terms'][0]}`", inline=False) 372 | embed.add_field( 373 | name="From Automod", value=f"`{'Yes' if event['automod_terms']['from_automod'] else 'No'}`") 374 | 375 | embed.remove_field(1) 376 | return embed 377 | 378 | def add_blocked_term(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 379 | return self.add_permitted_term(streamer, event, metadata, mod_action, embed) 380 | 381 | def remove_permitted_term(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 382 | embed = self.set_terms_attrs(mod_action, embed) 383 | embed.add_field( 384 | name="Added by", value=f"{event['moderator_user_login']}") 385 | if "`" in event['automod_terms']["terms"][0]: 386 | embed.add_field( 387 | name="Term", value=f"```{event['automod_terms']['terms'][0]}```", inline=False) 388 | else: 389 | embed.add_field( 390 | name="Term", value=f"`{event['automod_terms']['terms'][0]}`", inline=False) 391 | embed.remove_field(1) 392 | return embed 393 | 394 | def remove_blocked_term(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 395 | return self.remove_permitted_term(streamer, event, metadata, mod_action, embed) 396 | 397 | def automod_caught_message(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 398 | ignore_message = False 399 | user = event["user_login"] 400 | user_escaped = user.replace('_', r'\_') 401 | embed.title = f"{mod_action.value.replace('_', ' ').title()}" 402 | embed.color = self.colour.red 403 | embed.add_field( 404 | name="Flagged Account", value=f"[{user_escaped}]()", inline=True) 405 | # Automod events 406 | if event["automod"] != None: 407 | embed.add_field( 408 | name="Content Classification", value=f"{event['automod']['category'].title()} level {event['automod']['level']}", inline=True) 409 | 410 | # Blocked term events 411 | elif event["blocked_term"] != None: 412 | terms_list = set([event["message"]["text"][term["boundary"]["start_pos"]:term["boundary"]["end_pos"]+1] for term in event["blocked_term"]["terms_found"]]) 413 | embed.add_field( 414 | name=f"Relevant Blocked Term{'s' if len(terms_list) != 1 else ''}", value=f"`{', '.join(terms_list)}`", inline=True) 415 | 416 | text_fragments = [] 417 | for fragment in event["message"]["fragments"]: 418 | if fragment != {}: 419 | if fragment.get("text", None) is not None: 420 | text_fragments.append(fragment.get("text", None)) 421 | 422 | embed.add_field(name="Text fragments", value=f"`{', '.join([f.strip(' ') for f in text_fragments]).strip(', ')}`") 423 | 424 | if event.get("status") == "allowed": 425 | if "automod_allowed_message" not in streamer.action_whitelist and streamer.action_whitelist != []: 426 | ignore_message = True 427 | embed.colour = self.colour.green 428 | elif event.get("status") == "denied": 429 | if "automod_denied_message" not in streamer.action_whitelist and streamer.action_whitelist != []: 430 | ignore_message = True 431 | embed.colour = self.colour.red 432 | else: 433 | if "automod_caught_message" not in streamer.action_whitelist and streamer.action_whitelist != []: 434 | ignore_message = True 435 | embed.colour = self.colour.yellow 436 | return ignore_message, embed 437 | 438 | def automod_allowed_message(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 439 | return self.automod_caught_message(streamer, event, metadata, mod_action, embed) 440 | 441 | def automod_denied_message(self, streamer: Streamer, event: dict, metadata: dict, mod_action: ModAction, embed: disnake.Embed) -> disnake.Embed: 442 | return self.automod_caught_message(streamer, event, metadata, mod_action, embed) -------------------------------------------------------------------------------- /modactions.py: -------------------------------------------------------------------------------- 1 | from enum import Enum 2 | 3 | 4 | class ModAction(Enum): 5 | #Chatroom actions 6 | slow = "slow" 7 | slowoff = "slowoff" 8 | uniquechat = "uniquechat" 9 | uniquechatoff = "uniquechatoff" 10 | clear = "clear" 11 | emoteonly = "emoteonly" 12 | emoteonlyoff = "emoteonlyoff" 13 | subscribers = "subscribers" 14 | subscribersoff = "subscribersoff" 15 | followers = "followers" 16 | followersoff = "followersoff" 17 | host = "host" 18 | unhost = "unhost" 19 | raid = "raid" 20 | unraid = "unraid" 21 | 22 | #User Moderation Actions 23 | timeout = "timeout" 24 | untimeout = "untimeout" 25 | ban = "ban" 26 | unban = "unban" 27 | delete = "delete" 28 | delete_notification = "delete_notification" 29 | mod = "mod" 30 | unmod = "unmod" 31 | vip = "vip" 32 | vip_added = "vip_added" 33 | unvip = "unvip" 34 | warn = "warn" 35 | acknowledge_warning = "acknowledge_warning" 36 | 37 | #Channel Terms 38 | add_permitted_term = "add_permitted_term" 39 | add_blocked_term = "add_blocked_term" 40 | remove_permitted_term = "remove_permitted_term" 41 | remove_blocked_term = "remove_blocked_term" 42 | 43 | #Automod 44 | automod_caught_message = "automod_caught_message" 45 | #Unused automod since they're faked by me 46 | automod_allowed_message = "automod_allowed_message" 47 | automod_denied_message = "automod_denied_message" 48 | 49 | #Unban Requests 50 | approve_unban_request = "approve_unban_request" 51 | deny_unban_request = "deny_unban_request" 52 | 53 | #Shared mod actions (unsure if currently used) 54 | shared_chat_ban = "shared_chat_ban" 55 | shared_chat_unban = "shared_chat_unban" 56 | shared_chat_timeout = "shared_chat_timeout" 57 | shared_chat_untimeout = "shared_chat_untimeout" 58 | shared_chat_delete = "shared_chat_delete" 59 | 60 | def __int__(self): 61 | return self.value -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | websockets==12 2 | asyncio 3 | disnake 4 | aiohttp 5 | requests -------------------------------------------------------------------------------- /streamer.py: -------------------------------------------------------------------------------- 1 | from dataclasses import dataclass, field 2 | from typing import List 3 | 4 | @dataclass(frozen=True, order=True) 5 | class Streamer: 6 | username: str 7 | display_name: str 8 | icon: str 9 | webhook_urls: List[str] 10 | enable_automod: bool = field(default=False) 11 | action_whitelist: List[str] = field(default_factory=list) 12 | 13 | def __str__(self): 14 | return self.username --------------------------------------------------------------------------------