├── .gitignore ├── .gitlab-ci.yml ├── LICENSE ├── README.md ├── base-config.yaml ├── maubot.yaml └── reminder ├── __init__.py ├── bot.py ├── db.py ├── locale_util.py ├── locales.py └── util.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.mbp 2 | -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | include: 2 | - project: 'maubot/maubot' 3 | file: '/.gitlab-ci-plugin.yml' 4 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # reminder 2 | A [maubot](https://github.com/maubot/maubot) to remind you about things. 3 | 4 | ## Hosted instances 5 | * maunium.net: [@reminder:maunium.net](https://matrix.to/#/@reminder:maunium.net). 6 | * t2bot.io: https://t2bot.io/reminderbot/ 7 | 8 | ## Usage 9 | Use `!remind ` to set a reminder. To subscribe to a reminder set by someone else, 10 | upvote the message with a 👍 reaction. To cancel a reminder, remove the message or reaction. 11 | After the reminder fires, you can re-schedule it with `!reminder again `. 12 | 13 | `` can be a time delta (e.g. `2 days 1.5 hours` or `friday at 15:00`) 14 | or an absolute date (e.g. `2020-03-27 15:00`). 15 | 16 | Note that subscribing to and cancelling reminders is only possible before the last minute. 17 | Each minute reminders that are scheduled to go off during that minute are sent to the event loop, 18 | at which point their target user list can no longer be updated. 19 | 20 | To set the timezone for date parsing and output for your messages, use `!remind tz `. 21 | It's recommended to use a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), 22 | but anything supported by Pytz will work. 23 | 24 | Similarly, you can set the locale for date parsing with `!remind locale `. If you 25 | provide multiple locales, each one will be tried for parsing your input until one matches. Unlike 26 | the timezone, the locale only affects input, not output. You can view available locales using 27 | `!remind locales`. You can also contribute new locales by making a pull request 28 | (see [locales.py](reminder/locales.py), content warning: long regexes). 29 | 30 | To list your upcoming reminders, use `!remind list` 31 | -------------------------------------------------------------------------------- /base-config.yaml: -------------------------------------------------------------------------------- 1 | # Default timezone for users who did not set one. 2 | # This is parsed with pytz, so the usual format is Continent/City, e.g. Europe/Helsinki. 3 | default_timezone: 'UTC' 4 | 5 | # Base command without the prefix (!). 6 | # If a list is provided, the first is the main name and the rest are aliases. 7 | base_command: 8 | - remind 9 | - reminder 10 | -------------------------------------------------------------------------------- /maubot.yaml: -------------------------------------------------------------------------------- 1 | maubot: 0.4.1 2 | id: xyz.maubot.reminder 3 | version: 0.2.2 4 | license: AGPL-3.0-or-later 5 | modules: 6 | - reminder 7 | main_class: ReminderBot 8 | extra_files: 9 | - base-config.yaml 10 | dependencies: 11 | - python-dateutil 12 | - pytz 13 | database: true 14 | -------------------------------------------------------------------------------- /reminder/__init__.py: -------------------------------------------------------------------------------- 1 | from .bot import ReminderBot 2 | -------------------------------------------------------------------------------- /reminder/bot.py: -------------------------------------------------------------------------------- 1 | # reminder - A maubot plugin to remind you about things. 2 | # Copyright (C) 2020 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Type, Tuple, List 17 | from datetime import datetime, timedelta 18 | from html import escape 19 | import asyncio 20 | 21 | import pytz 22 | 23 | from mautrix.types import (EventType, RedactionEvent, StateEvent, Format, MessageType, 24 | TextMessageEventContent, ReactionEvent, UserID) 25 | from mautrix.util.config import BaseProxyConfig 26 | from mautrix.util import background_task 27 | from maubot import Plugin, MessageEvent 28 | from maubot.handlers import command, event 29 | 30 | from .db import ReminderDatabase 31 | from .util import Config, ReminderInfo, DateArgument, parse_timezone, format_time 32 | from .locales import locales 33 | 34 | 35 | class ReminderBot(Plugin): 36 | db: ReminderDatabase 37 | reminder_loop_task: asyncio.Future 38 | base_command: str 39 | base_aliases: Tuple[str, ...] 40 | default_timezone: pytz.timezone 41 | 42 | @classmethod 43 | def get_config_class(cls) -> Type[BaseProxyConfig]: 44 | return Config 45 | 46 | async def start(self) -> None: 47 | self.on_external_config_update() 48 | self.db = ReminderDatabase(self.database) 49 | self.reminder_loop_task = asyncio.create_task(self.reminder_loop()) 50 | 51 | def on_external_config_update(self) -> None: 52 | self.config.load_and_update() 53 | bc = self.config["base_command"] 54 | self.base_command = bc[0] if isinstance(bc, list) else bc 55 | self.base_aliases = tuple(bc) if isinstance(bc, list) else (bc,) 56 | raw_timezone = self.config["default_timezone"] 57 | try: 58 | self.default_timezone = pytz.timezone(raw_timezone) 59 | except pytz.UnknownTimeZoneError: 60 | self.log.warning(f"Unknown default timezone {raw_timezone}") 61 | self.default_timezone = pytz.UTC 62 | 63 | async def stop(self) -> None: 64 | self.reminder_loop_task.cancel() 65 | 66 | async def reminder_loop(self) -> None: 67 | try: 68 | self.log.debug("Reminder loop started") 69 | while True: 70 | now = datetime.now(tz=pytz.UTC) 71 | next_minute = (now + timedelta(minutes=1)).replace(second=0, microsecond=0) 72 | await asyncio.sleep((next_minute - now).total_seconds()) 73 | await self.schedule_nearby_reminders(next_minute) 74 | except asyncio.CancelledError: 75 | self.log.debug("Reminder loop stopped") 76 | except Exception: 77 | self.log.exception("Exception in reminder loop") 78 | 79 | async def schedule_nearby_reminders(self, now: datetime) -> None: 80 | until = now + timedelta(minutes=1) 81 | for reminder in self.db.all_in_range(now, until): 82 | background_task.create(self.send_reminder(reminder)) 83 | 84 | async def send_reminder(self, reminder: ReminderInfo) -> None: 85 | try: 86 | await self._send_reminder(reminder) 87 | except Exception: 88 | self.log.exception("Failed to send reminder") 89 | 90 | async def _send_reminder(self, reminder: ReminderInfo) -> None: 91 | if len(reminder.users) == 0: 92 | self.log.debug(f"Cancelling reminder {reminder}, no users left to remind") 93 | return 94 | wait = (reminder.date - datetime.now(tz=pytz.UTC)).total_seconds() 95 | if wait > 0: 96 | self.log.debug(f"Waiting {wait} seconds to send {reminder}") 97 | await asyncio.sleep(wait) 98 | else: 99 | self.log.debug(f"Sending {reminder} immediately") 100 | users = " ".join(reminder.users) 101 | users_html = " ".join(f"{user_id}" 102 | for user_id in reminder.users) 103 | content = TextMessageEventContent( 104 | msgtype=MessageType.TEXT, body=f"{users}: {reminder.message}", format=Format.HTML, 105 | formatted_body=f"{users_html}: {escape(reminder.message)}") 106 | content["xyz.maubot.reminder"] = { 107 | "id": reminder.id, 108 | "message": reminder.message, 109 | "targets": list(reminder.users), 110 | "reply_to": reminder.reply_to, 111 | } 112 | if reminder.reply_to: 113 | content.set_reply(await self.client.get_event(reminder.room_id, reminder.reply_to)) 114 | await self.client.send_message(reminder.room_id, content) 115 | 116 | @command.new(name=lambda self: self.base_command, 117 | aliases=lambda self, alias: alias in self.base_aliases, 118 | help="Create a reminder", require_subcommand=False, arg_fallthrough=False) 119 | @DateArgument("date", required=True) 120 | @command.argument("message", pass_raw=True, required=False) 121 | async def remind(self, evt: MessageEvent, date: datetime, message: str) -> None: 122 | date = date.replace(microsecond=0) 123 | now = datetime.now(tz=pytz.UTC).replace(microsecond=0) 124 | if date < now: 125 | await evt.reply(f"Sorry, {date} is in the past and I don't have a time machine :(") 126 | return 127 | rem = ReminderInfo(date=date, room_id=evt.room_id, message=message, 128 | reply_to=evt.content.get_reply_to(), users={evt.sender: evt.event_id}) 129 | await self._remind(evt, rem, now) 130 | 131 | @remind.subcommand("reschedule", help="Reschedule a reminder you got", aliases=("again",)) 132 | @DateArgument("date", required=True) 133 | async def reschedule(self, evt: MessageEvent, date: datetime) -> None: 134 | reply_to_id = evt.content.get_reply_to() 135 | if not reply_to_id: 136 | await evt.reply("You must reply to a reminder event to reschedule it.") 137 | return 138 | date = date.replace(microsecond=0) 139 | now = datetime.now(tz=pytz.UTC).replace(microsecond=0) 140 | if date < now: 141 | await evt.reply(f"Sorry, {date} is in the past and I don't have a time machine :(") 142 | return 143 | reply_to = await self.client.get_event(evt.room_id, reply_to_id) 144 | try: 145 | reminder_info = reply_to.content["xyz.maubot.reminder"] 146 | rem = ReminderInfo(date=date, room_id=evt.room_id, message=reminder_info["message"], 147 | reply_to=reminder_info["reply_to"], users={evt.sender: evt.event_id}) 148 | except KeyError: 149 | await evt.reply("That doesn't look like a valid reminder event.") 150 | return 151 | await self._remind(evt, rem, now, again=True) 152 | 153 | async def _remind(self, evt: MessageEvent, rem: ReminderInfo, now: datetime, again: bool = False 154 | ) -> None: 155 | if rem.date == now: 156 | await self.send_reminder(rem) 157 | return 158 | remind_type = "remind you " 159 | if rem.reply_to: 160 | evt_link = f"[event](https://matrix.to/#/{rem.room_id}/{rem.reply_to})" 161 | if rem.message: 162 | remind_type += f"to {rem.message} (replying to that {evt_link})" 163 | else: 164 | remind_type += f"about that {evt_link}" 165 | elif rem.message: 166 | remind_type += f"to {rem.message}" 167 | else: 168 | remind_type = "ping you" 169 | rem.message = "ping" 170 | if again: 171 | remind_type += " again" 172 | msg = (f"I'll {remind_type} {self.format_time(evt.sender, rem)}.\n\n" 173 | f"(others can \U0001F44D this message to get pinged too)") 174 | rem.event_id = await evt.reply(msg) 175 | self.db.insert(rem) 176 | now = datetime.now(tz=pytz.UTC) 177 | if (rem.date - now).total_seconds() < 60 and now.minute == rem.date.minute: 178 | self.log.debug(f"Reminder {rem} is in less than a minute, scheduling now...") 179 | background_task.create(self.send_reminder(rem)) 180 | 181 | @remind.subcommand("help", help="Usage instructions") 182 | async def help(self, evt: MessageEvent) -> None: 183 | await evt.reply(f"Maubot [Reminder](https://github.com/maubot/reminder) plugin.\n\n" 184 | f"* !{self.base_command} - Add a reminder\n" 185 | f"* !{self.base_command} again - Reply to a reminder to reschedule it\n" 186 | f"* !{self.base_command} list - Get a list of your reminders\n" 187 | f"* !{self.base_command} tz - Set your time zone\n" 188 | f"* !{self.base_command} locale - Set your locale\n" 189 | f"* !{self.base_command} locales - List available locales\n\n" 190 | " can be a time delta (e.g. `2 days 1.5 hours` or `friday at 15:00`) " 191 | "or an absolute date (e.g. `2020-03-27 15:00`)\n\n" 192 | "To get mentioned by a reminder added by someone else, upvote the message " 193 | "by reacting with \U0001F44D.\n\n" 194 | "To cancel a reminder, remove the message or reaction.") 195 | 196 | @remind.subcommand("list", help="List your reminders") 197 | @command.argument("all", required=False) 198 | async def list(self, evt: MessageEvent, all: str) -> None: 199 | room_id = evt.room_id 200 | if "all" in all: 201 | room_id = None 202 | 203 | def format_rem(rem: ReminderInfo) -> str: 204 | if rem.reply_to: 205 | evt_link = f"[event](https://matrix.to/#/{rem.room_id}/{rem.reply_to})" 206 | if rem.message: 207 | return f'"{rem.message}" (replying to {evt_link})' 208 | else: 209 | return evt_link 210 | else: 211 | return f'"{rem.message}"' 212 | 213 | reminders_str = "\n".join(f"* {format_rem(reminder)} {self.format_time(evt.sender, reminder)}" 214 | for reminder in self.db.all_for_user(evt.sender, room_id=room_id)) 215 | message = "upcoming reminders" 216 | if room_id: 217 | message += " in this room" 218 | if len(reminders_str) == 0: 219 | await evt.reply(f"You have no {message} :(") 220 | else: 221 | await evt.reply(f"Your {message}:\n\n{reminders_str}") 222 | 223 | def format_time(self, sender: UserID, reminder: ReminderInfo) -> str: 224 | return format_time(reminder.date.astimezone(self.db.get_timezone(sender))) 225 | 226 | @remind.subcommand("locales", help="List available locales") 227 | async def locales(self, evt: MessageEvent) -> None: 228 | def _format_key(key: str) -> str: 229 | language, country = key.split("_") 230 | return f"{language.lower()}_{country.upper()}" 231 | 232 | await evt.reply("Available locales:\n\n" + 233 | "\n".join(f"* `{_format_key(key)}` - {locale.name}" 234 | for key, locale in locales.items())) 235 | 236 | @staticmethod 237 | def _fmt_locales(locale_ids: List[str]) -> str: 238 | locale_names = [locales[id].name for id in locale_ids] 239 | if len(locale_names) == 0: 240 | return "unset" 241 | elif len(locale_names) == 1: 242 | return locale_names[0] 243 | else: 244 | return ", ".join(locale_names[:-1]) + " and " + locale_names[-1] 245 | 246 | @remind.subcommand("locale", help="Set your locale") 247 | @command.argument("locale", required=False, pass_raw=True) 248 | async def locale(self, evt: MessageEvent, locale: str) -> None: 249 | if not locale: 250 | await evt.reply(f"Your locale is {self._fmt_locales(self.db.get_locales(evt.sender))}") 251 | return 252 | locale_ids = [part.strip() for part in locale.lower().split(" ")] 253 | for locale_id in locale_ids: 254 | if locale_id not in locales: 255 | await evt.reply(f"Locale `{locale_id}` is not supported") 256 | return 257 | self.db.set_locales(evt.sender, locale_ids) 258 | await evt.reply(f"Set your locale to {self._fmt_locales(locale_ids)}") 259 | 260 | @remind.subcommand("timezone", help="Set your timezone", aliases=("tz",)) 261 | @command.argument("timezone", parser=parse_timezone, required=False) 262 | async def timezone(self, evt: MessageEvent, timezone: pytz.timezone) -> None: 263 | if not timezone: 264 | await evt.reply(f"Your time zone is {self.db.get_timezone(evt.sender).zone}") 265 | return 266 | self.db.set_timezone(evt.sender, timezone) 267 | await evt.reply(f"Set your timezone to {timezone.zone}") 268 | 269 | @command.passive(regex=r"(?:\U0001F44D[\U0001F3FB-\U0001F3FF]?)", 270 | field=lambda evt: evt.content.relates_to.key, 271 | event_type=EventType.REACTION, msgtypes=None) 272 | async def subscribe_react(self, evt: ReactionEvent, _: Tuple[str]) -> None: 273 | reminder = self.db.get_by_event_id(evt.content.relates_to.event_id) 274 | if reminder: 275 | self.db.add_user(reminder, evt.sender, evt.event_id) 276 | 277 | @event.on(EventType.ROOM_REDACTION) 278 | async def redact(self, evt: RedactionEvent) -> None: 279 | self.db.redact_event(evt.redacts) 280 | 281 | @event.on(EventType.ROOM_TOMBSTONE) 282 | async def tombstone(self, evt: StateEvent) -> None: 283 | if not evt.content.replacement_room: 284 | return 285 | self.db.update_room_id(evt.room_id, evt.content.replacement_room) 286 | -------------------------------------------------------------------------------- /reminder/db.py: -------------------------------------------------------------------------------- 1 | # reminder - A maubot plugin to remind you about things. 2 | # Copyright (C) 2020 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Iterator, Dict, List 17 | from datetime import datetime 18 | 19 | import pytz 20 | from sqlalchemy import (Column, String, Integer, Text, DateTime, ForeignKey, Table, MetaData, 21 | select, and_) 22 | from sqlalchemy.engine.base import Engine 23 | 24 | from mautrix.types import UserID, EventID, RoomID 25 | 26 | from .util import ReminderInfo 27 | 28 | 29 | class ReminderDatabase: 30 | reminder: Table 31 | reminder_target: Table 32 | timezone: Table 33 | tz_cache: Dict[UserID, pytz.timezone] 34 | locale_cache: Dict[UserID, List[str]] 35 | db: Engine 36 | 37 | def __init__(self, db: Engine) -> None: 38 | self.db = db 39 | self.tz_cache = {} 40 | self.locale_cache = {} 41 | 42 | meta = MetaData() 43 | meta.bind = db 44 | 45 | self.reminder = Table("reminder", meta, 46 | Column("id", Integer, primary_key=True, autoincrement=True), 47 | Column("date", DateTime, nullable=False), 48 | Column("room_id", String(255), nullable=False), 49 | Column("event_id", String(255), nullable=False), 50 | Column("message", Text, nullable=False), 51 | Column("reply_to", String(255), nullable=True)) 52 | self.reminder_target = Table("reminder_target", meta, 53 | Column("reminder_id", Integer, 54 | ForeignKey("reminder.id", ondelete="CASCADE"), 55 | primary_key=True), 56 | Column("user_id", String(255), primary_key=True), 57 | Column("event_id", String(255), nullable=False)) 58 | self.timezone = Table("timezone", meta, 59 | Column("user_id", String(255), primary_key=True), 60 | Column("timezone", String(255), nullable=False)) 61 | self.locale = Table("locale", meta, 62 | Column("user_id", String(255), primary_key=True), 63 | Column("locales", String(255), nullable=False)) 64 | 65 | meta.create_all() 66 | 67 | def set_timezone(self, user_id: UserID, tz: pytz.timezone) -> None: 68 | with self.db.begin() as tx: 69 | tx.execute(self.timezone.delete().where(self.timezone.c.user_id == user_id)) 70 | tx.execute(self.timezone.insert().values(user_id=user_id, timezone=tz.zone)) 71 | self.tz_cache[user_id] = tz 72 | 73 | def get_timezone(self, user_id: UserID, default_tz: Optional[pytz.timezone] = None 74 | ) -> Optional[pytz.timezone]: 75 | try: 76 | return self.tz_cache[user_id] 77 | except KeyError: 78 | rows = self.db.execute(select([self.timezone.c.timezone]) 79 | .where(self.timezone.c.user_id == user_id)) 80 | try: 81 | self.tz_cache[user_id] = pytz.timezone(next(rows)[0]) 82 | except (pytz.UnknownTimeZoneError, StopIteration, IndexError): 83 | self.tz_cache[user_id] = default_tz or pytz.UTC 84 | return self.tz_cache[user_id] 85 | 86 | def set_locales(self, user_id: UserID, locales: List[str]) -> None: 87 | with self.db.begin() as tx: 88 | tx.execute(self.locale.delete().where(self.locale.c.user_id == user_id)) 89 | tx.execute(self.locale.insert().values(user_id=user_id, locales=",".join(locales))) 90 | self.locale_cache[user_id] = locales 91 | 92 | def get_locales(self, user_id: UserID) -> List[str]: 93 | try: 94 | return self.locale_cache[user_id] 95 | except KeyError: 96 | rows = self.db.execute(select([self.locale.c.locales]) 97 | .where(self.locale.c.user_id == user_id)) 98 | try: 99 | self.locale_cache[user_id] = next(rows)[0].split(",") 100 | except (StopIteration, IndexError): 101 | self.locale_cache[user_id] = ["en_iso"] 102 | return self.locale_cache[user_id] 103 | 104 | def all_for_user(self, user_id: UserID, room_id: Optional[RoomID] = None 105 | ) -> Iterator[ReminderInfo]: 106 | where = [self.reminder.c.id == self.reminder_target.c.reminder_id, 107 | self.reminder_target.c.user_id == user_id, 108 | self.reminder.c.date > datetime.now(tz=pytz.UTC)] 109 | if room_id: 110 | where.append(self.reminder.c.room_id == room_id) 111 | rows = self.db.execute(select([self.reminder]).where(and_(*where))) 112 | for row in rows: 113 | yield ReminderInfo(id=row[0], date=row[1].replace(tzinfo=pytz.UTC), room_id=row[2], 114 | event_id=row[3], message=row[4], reply_to=row[5], users=[user_id]) 115 | 116 | def get(self, id: int) -> Optional[ReminderInfo]: 117 | return self._get_one(self.reminder.c.id == id) 118 | 119 | def get_by_event_id(self, event_id: EventID) -> Optional[ReminderInfo]: 120 | reminder = self._get_one(self.reminder.c.event_id == event_id) 121 | if reminder: 122 | return reminder 123 | rows = self.db.execute(select([self.reminder_target.c.reminder_id]) 124 | .where(self.reminder_target.c.event_id == event_id)) 125 | try: 126 | reminder_id = int(next(rows)[0]) 127 | return self.get(reminder_id) 128 | except (StopIteration, IndexError, ValueError): 129 | return None 130 | 131 | def _get_one(self, whereclause) -> Optional[ReminderInfo]: 132 | rows = self.db.execute(select([self.reminder, self.reminder_target.c.user_id, 133 | self.reminder_target.c.event_id]).where( 134 | and_(whereclause, self.reminder_target.c.reminder_id == self.reminder.c.id))) 135 | try: 136 | first_row = next(rows) 137 | except StopIteration: 138 | return None 139 | info = ReminderInfo(id=first_row[0], date=first_row[1].replace(tzinfo=pytz.UTC), 140 | room_id=first_row[2], event_id=first_row[3], message=first_row[4], 141 | reply_to=first_row[5], users={first_row[6]: first_row[7]}) 142 | for row in rows: 143 | info.users[row[6]] = row[7] 144 | return info 145 | 146 | def _get_many(self, whereclause) -> Iterator[ReminderInfo]: 147 | rows = self.db.execute(select([self.reminder, self.reminder_target.c.user_id, 148 | self.reminder_target.c.event_id]) 149 | .where(whereclause) 150 | .order_by(self.reminder.c.id, self.reminder.c.date)) 151 | building_reminder = None 152 | for row in rows: 153 | if building_reminder is not None: 154 | if building_reminder.id == row[0]: 155 | building_reminder.users[row[6]] = row[7] 156 | continue 157 | yield building_reminder 158 | building_reminder = ReminderInfo(id=row[0], date=row[1].replace(tzinfo=pytz.UTC), 159 | room_id=row[2], event_id=row[3], message=row[4], 160 | reply_to=row[5], users={row[6]: row[7]}) 161 | if building_reminder is not None: 162 | yield building_reminder 163 | 164 | def all(self) -> Iterator[ReminderInfo]: 165 | yield from self._get_many(self.reminder_target.c.reminder_id == self.reminder.c.id) 166 | 167 | def all_in_range(self, after: datetime, before: datetime) -> Iterator[ReminderInfo]: 168 | yield from self._get_many(and_(self.reminder_target.c.reminder_id == self.reminder.c.id, 169 | after <= self.reminder.c.date, 170 | self.reminder.c.date < before)) 171 | 172 | def insert(self, reminder: ReminderInfo) -> None: 173 | with self.db.begin() as tx: 174 | res = tx.execute(self.reminder.insert() 175 | .values(date=reminder.date, room_id=reminder.room_id, 176 | event_id=reminder.event_id, message=reminder.message, 177 | reply_to=reminder.reply_to)) 178 | reminder.id = res.inserted_primary_key[0] 179 | tx.execute(self.reminder_target.insert(), 180 | [{"reminder_id": reminder.id, "user_id": user_id, 181 | "event_id": event_id} 182 | for user_id, event_id in reminder.users.items()]) 183 | 184 | def update_room_id(self, old: RoomID, new: RoomID) -> None: 185 | self.db.execute(self.reminder.update() 186 | .where(self.reminder.c.room_id == old) 187 | .values(room_id=new)) 188 | 189 | def redact_event(self, event_id: EventID) -> None: 190 | self.db.execute(self.reminder_target.delete() 191 | .where(self.reminder_target.c.event_id == event_id)) 192 | 193 | def add_user(self, reminder: ReminderInfo, user_id: UserID, event_id: EventID) -> bool: 194 | if user_id in reminder.users: 195 | return False 196 | self.db.execute(self.reminder_target.insert() 197 | .values(reminder_id=reminder.id, user_id=user_id, event_id=event_id)) 198 | if isinstance(reminder.users, list): 199 | reminder.users.append(user_id) 200 | elif isinstance(reminder.users, dict): 201 | reminder.users[user_id] = event_id 202 | return True 203 | 204 | def remove_user(self, reminder: ReminderInfo, user_id: UserID) -> bool: 205 | if user_id not in reminder.users: 206 | return False 207 | self.db.execute(self.reminder_target.delete().where( 208 | and_(self.reminder_target.c.reminder_id == reminder.id, 209 | self.reminder_target.c.user_id == user_id))) 210 | reminder.users.remove(user_id) 211 | return True 212 | -------------------------------------------------------------------------------- /reminder/locale_util.py: -------------------------------------------------------------------------------- 1 | # reminder - A maubot plugin to remind you about things. 2 | # Copyright (C) 2020 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import NamedTuple, Union, Pattern, Match, Dict, Type, Optional, TYPE_CHECKING 17 | from datetime import datetime 18 | from abc import ABC, abstractmethod 19 | import re 20 | 21 | from dateutil.relativedelta import MO 22 | 23 | WeekdayType = type(MO) 24 | 25 | if TYPE_CHECKING: 26 | from typing import TypedDict 27 | 28 | 29 | class RelativeDeltaParams(TypedDict): 30 | year: int 31 | month: int 32 | day: int 33 | hour: int 34 | minute: int 35 | second: int 36 | microsecond: int 37 | 38 | years: Union[int, float] 39 | months: Union[int, float] 40 | weeks: Union[int, float] 41 | days: Union[int, float] 42 | hours: Union[int, float] 43 | minutes: Union[int, float] 44 | seconds: Union[int, float] 45 | microseconds: Union[int, float] 46 | 47 | weekday: Union[int, WeekdayType] 48 | 49 | leapdays: int 50 | yearday: int 51 | nlyearday: int 52 | 53 | 54 | class MatcherReturn(NamedTuple): 55 | params: 'RelativeDeltaParams' 56 | unconsumed: str 57 | 58 | 59 | class Matcher(ABC): 60 | @abstractmethod 61 | def match(self, val: str) -> Optional[MatcherReturn]: 62 | pass 63 | 64 | 65 | def int_or_float(val: str) -> Union[int, float]: 66 | if "," in val: 67 | return float(val.replace(",", ".")) 68 | elif "." in val: 69 | return float(val) 70 | return int(val) 71 | 72 | 73 | class RegexMatcher(Matcher): 74 | regex: Pattern 75 | value_type: Type 76 | 77 | def __init__(self, pattern: str, value_type: Type = int_or_float) -> None: 78 | self.regex = re.compile(pattern, re.IGNORECASE) 79 | self.value_type = value_type 80 | 81 | def match(self, val: str) -> Optional[MatcherReturn]: 82 | match = self.regex.match(val) 83 | if match and match.end() > 0 and len(match.groups()) > 0: 84 | return MatcherReturn(params=self._convert_match(match), unconsumed=val[match.end():]) 85 | return None 86 | 87 | def _convert_match(self, match: Match) -> 'RelativeDeltaParams': 88 | return self._convert_groups(match.groupdict()) 89 | 90 | def _convert_groups(self, groups: Dict[str, str]) -> 'RelativeDeltaParams': 91 | return {key: self.value_type(value) for key, value in groups.items() if value} 92 | 93 | 94 | class TimeMatcher(RegexMatcher): 95 | def _convert_match(self, match: Match) -> 'RelativeDeltaParams': 96 | groups = match.groupdict() 97 | try: 98 | meridiem = groups.pop("meridiem").lower() 99 | except (KeyError, AttributeError): 100 | meridiem = None 101 | params = self._convert_groups(groups) 102 | if meridiem == "pm": 103 | params["hour"] += 12 104 | elif meridiem == "am" and params["hour"] == 12: 105 | params["hour"] = 0 106 | return params 107 | 108 | 109 | class ShortYearMatcher(RegexMatcher): 110 | def _convert_match(self, match: Match) -> 'RelativeDeltaParams': 111 | params = super()._convert_match(match) 112 | if params["year"] < 100: 113 | year = datetime.now().year 114 | current_century = year // 100 115 | if params["year"] < year % 100: 116 | current_century += 1 117 | params["year"] = (current_century * 100) + params["year"] 118 | return params 119 | 120 | 121 | class WeekdayMatcher(Matcher): 122 | regex: Pattern 123 | map: Dict[str, Union[int, WeekdayType]] 124 | substr: int 125 | 126 | def __init__(self, pattern: str, map: Dict[str, Union[int, WeekdayType]], substr: int) -> None: 127 | self.regex = re.compile(pattern, re.IGNORECASE) 128 | self.map = map 129 | self.substr = substr 130 | 131 | def match(self, val: str) -> Optional[MatcherReturn]: 132 | match = self.regex.match(val) 133 | if match and match.end() > 0: 134 | weekday = self.map[match.string[:self.substr].lower()] 135 | if isinstance(weekday, int): 136 | weekday = (datetime.now().weekday() + weekday) % 7 137 | return MatcherReturn(params={"weekday": weekday}, unconsumed=val[match.end():]) 138 | return None 139 | 140 | 141 | class Locale(Matcher): 142 | name: str 143 | timedelta: Matcher 144 | date: Matcher 145 | weekday: Matcher 146 | time: Matcher 147 | 148 | def __init__(self, name: str, timedelta: Matcher, date: Matcher, weekday: Matcher, 149 | time: Matcher) -> None: 150 | self.name = name 151 | self.timedelta = timedelta 152 | self.date = date 153 | self.weekday = weekday 154 | self.time = time 155 | 156 | def replace(self, name: str, timedelta: Matcher = None, date: Matcher = None, 157 | weekday: Matcher = None, time: Matcher = None) -> 'Locale': 158 | return Locale(name=name, timedelta=timedelta or self.timedelta, date=date or self.date, 159 | weekday=weekday or self.weekday, time=time or self.time) 160 | 161 | def match(self, val: str) -> Optional[MatcherReturn]: 162 | found_delta = self.timedelta.match(val) 163 | if found_delta: 164 | params, val = found_delta 165 | else: 166 | params = {} 167 | found_day = self.weekday.match(val) 168 | if found_day: 169 | params, val = found_day 170 | else: 171 | found_date = self.date.match(val) 172 | if found_date: 173 | params, val = found_date 174 | 175 | found_time = self.time.match(val) 176 | if found_time: 177 | params = {**params, **found_time.params} 178 | val = found_time.unconsumed 179 | return MatcherReturn(params=params, unconsumed=val) if len(params) > 0 else None 180 | 181 | 182 | Locales = Dict[str, Locale] 183 | -------------------------------------------------------------------------------- /reminder/locales.py: -------------------------------------------------------------------------------- 1 | # reminder - A maubot plugin to remind you about things. 2 | # Copyright (C) 2020 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from dateutil.relativedelta import MO, TU, WE, TH, FR, SA, SU 17 | 18 | from .locale_util import (Locales, Locale, RegexMatcher, 19 | WeekdayMatcher, TimeMatcher, ShortYearMatcher) 20 | 21 | locales: Locales = {} 22 | 23 | td_sep_en = r"(?:[\s,]{1,3}(?:and\s)?)?" 24 | number = r"[+-]?\d+(?:[.,]\d+)?" 25 | locales["en_iso"] = Locale( 26 | name="English (ISO)", 27 | timedelta=RegexMatcher(r"(?:(?:in|after)\s)?" 28 | rf"(?:(?P{number})\s?y(?:r|ear)?s?{td_sep_en})?" 29 | rf"(?:(?P{number})\s?mo(?:nth)?s?{td_sep_en})?" 30 | rf"(?:(?P{number})\s?w(?:k|eek)?s?{td_sep_en})?" 31 | rf"(?:(?P{number})\s?d(?:ays?)?{td_sep_en})?" 32 | rf"(?:(?P{number})\s?h(?:(?:r|our)?s?){td_sep_en})?" 33 | rf"(?:(?P{number})\s?m(?:in(?:ute)?s?)?{td_sep_en})?" 34 | rf"(?:(?P{number})\s?s(?:ec(?:ond)?s?)?)?" 35 | r"(?:\s|$)"), 36 | date=RegexMatcher(r"(?P\d{4})-(?P\d{2})-(?P\d{2})\s"), 37 | weekday=WeekdayMatcher(pattern=r"(?:today" 38 | r"|tomorrow" 39 | r"|mon(?:day)?" 40 | r"|tues?(?:day)?" 41 | r"|wed(?:nesday)?" 42 | r"|thu(?:rs(?:day)?)?" 43 | r"|fri(?:day)?" 44 | r"|sat(?:urday)?" 45 | r"|sun(?:day)?)" 46 | r"(?:\s|$)", 47 | map={ 48 | "tod": +0, "tom": +1, "mon": MO, "tue": TU, "wed": WE, "thu": TH, 49 | "fri": FR, "sat": SA, "sun": SU, 50 | }, substr=3), 51 | time=RegexMatcher(r"\s?(?:at\s)?" 52 | r"(?P\d{2})" 53 | r"[:.](?P\d{2})" 54 | r"(?:[:.](?P\d{2}))?" 55 | r"(?:\s|$)"), 56 | ) 57 | 58 | time_12_en = TimeMatcher(r"\s?(?:at\s)?" 59 | r"(?P\d{2})" 60 | r"(?:[:.](?P\d{2}))?" 61 | r"(?:[:.](?P\d{2}))?" 62 | r"(?:\s(?Pa\.?m|p\.?m)\.?)?" 63 | r"(?:\s|$)") 64 | 65 | locales["en_us"] = locales["en_iso"].replace( 66 | name="English (US)", time=time_12_en, date=ShortYearMatcher( 67 | r"(?P\d{1,2})/(?P\d{1,2})(?:/(?P\d{2}(?:\d{2})?))?(?:\s|$)")) 68 | 69 | locales["en_uk"] = locales["en_iso"].replace( 70 | name="English (UK)", time=time_12_en, date=ShortYearMatcher( 71 | r"(?P\d{1,2})/(?P\d{1,2})(?:/(?P\d{2}(?:\d{2})?))?(?:\s|$)")) 72 | 73 | td_sep_fi = r"(?:[\s,]{1,3}(?:ja\s)?)?" 74 | locales["fi_fi"] = Locale( 75 | name="Finnish", 76 | timedelta=RegexMatcher(rf"(?:(?P{number})\s?v(?:uo(?:tta|den))?{td_sep_fi})?" 77 | rf"(?:(?P{number})\s?k(?:k|uukau(?:si|tta|den))?{td_sep_fi})?" 78 | rf"(?:(?P{number})\s?v(?:k|iikk?o[an]?){td_sep_fi})?" 79 | rf"(?:(?P{number})\s?p(?:v|äivä[än]?){td_sep_fi})?" 80 | rf"(?:(?P{number})\s?t(?:un(?:nin?|tia))?{td_sep_fi})?" 81 | rf"(?:(?P{number})\s?m(?:in(?:uut(?:in?|tia))?)?{td_sep_fi})?" 82 | rf"(?:(?P{number})\s?s(?:ek(?:un(?:nin?|tia))?)?)?" 83 | r"(?:\s(?:kuluttua|päästä?))?" 84 | r"(?:\s|$)"), 85 | date=ShortYearMatcher(r"(?P\d{1,2})\.(?P\d{1,2})\.(?P\d{2}(?:\d{2})?)\s"), 86 | weekday=WeekdayMatcher(pattern=r"(?:tänään" 87 | r"|(?:yli)?huomen" 88 | r"|ma(?:aanantai)?" 89 | r"|ti(?:iistai)?" 90 | r"|ke(?:skiviikko)?" 91 | r"|to(?:rstai)?" 92 | r"|pe(?:rjantai)?" 93 | r"|la(?:uantai)?" 94 | r"|su(?:nnuntai)?)" 95 | r"(?:na)?" 96 | r"(?:\s|$)", 97 | map={ 98 | "tä": +0, "hu": +1, "yl": +2, 99 | "ma": MO, "ti": TU, "ke": WE, "to": TH, "pe": FR, "la": SA, "su": SU, 100 | }, substr=2), 101 | time=RegexMatcher(r"\s?(?:ke?ll?o\.?\s)?" 102 | r"(?P\d{1,2})" 103 | r"[:.](?P\d{2})" 104 | r"(?:[:.](?P\d{2}))?" 105 | r"(?:\s|$)"), 106 | ) 107 | 108 | td_sep_de = r"(?:[\s,]{1,3}(?:und\s)?)?" 109 | locales["de_de"] = Locale( 110 | name="German", 111 | timedelta=RegexMatcher(rf"(?:in\s)?" 112 | rf"(?:(?P{number})\s?jahr(?:en)?{td_sep_de})?" 113 | rf"(?:(?P{number})\s?monat(?:en)?{td_sep_de})?" 114 | rf"(?:(?P{number})\s?wochen?{td_sep_de})?" 115 | rf"(?:(?P{number})\s?tag(?:en)?{td_sep_de})?" 116 | rf"(?:(?P{number})\s?stunden?{td_sep_de})?" 117 | rf"(?:(?P{number})\s?minuten?{td_sep_de})?" 118 | rf"(?:(?P{number})\s?sekunden?)?" 119 | r"(?:\s|$)"), 120 | date=ShortYearMatcher( 121 | r"(?P\d{1,2})\.(?P\d{1,2})\.(?P\d{2}(?:\d{2})?)(?:\s|$)"), 122 | weekday=WeekdayMatcher(pattern=r"(?:heute" 123 | r"|(?:über)?morgen" 124 | r"|mo(?:ntag)?" 125 | r"|di(?:enstag)?" 126 | r"|mi(?:ttwoch)?" 127 | r"|do(?:nnerstag)?" 128 | r"|fr(?:eitag)?" 129 | r"|sa(?:mstag)?" 130 | r"|so(?:nntag)?)" 131 | r"(?:\s|$)", 132 | map={ 133 | "heu": +0, "mor": +1, "übe": +2, "mon": MO, "die": TU, "mit": WE, 134 | "don": TH, "fre": FR, "sam": SA, "son": SU, 135 | }, substr=3), 136 | time=RegexMatcher(r"\s?(?:um\s)?" 137 | r"(?P\d{1,2})" 138 | r"[:.](?P\d{2})" 139 | r"(?:[:.](?P\d{2}))?" 140 | r"(?:\s|$)"), 141 | ) 142 | -------------------------------------------------------------------------------- /reminder/util.py: -------------------------------------------------------------------------------- 1 | # reminder - A maubot plugin to remind you about things. 2 | # Copyright (C) 2020 Tulir Asokan 3 | # 4 | # This program is free software: you can redistribute it and/or modify 5 | # it under the terms of the GNU Affero General Public License as published by 6 | # the Free Software Foundation, either version 3 of the License, or 7 | # (at your option) any later version. 8 | # 9 | # This program is distributed in the hope that it will be useful, 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | # GNU Affero General Public License for more details. 13 | # 14 | # You should have received a copy of the GNU Affero General Public License 15 | # along with this program. If not, see . 16 | from typing import Optional, Dict, List, Union, Tuple, TYPE_CHECKING 17 | from datetime import datetime, timedelta 18 | from attr import dataclass 19 | import re 20 | 21 | import pytz 22 | from dateutil.relativedelta import relativedelta 23 | 24 | from mautrix.types import UserID, RoomID, EventID 25 | from mautrix.util.config import BaseProxyConfig, ConfigUpdateHelper 26 | from maubot import MessageEvent 27 | from maubot.handlers.command import Argument, ArgumentSyntaxError 28 | 29 | from .locales import locales 30 | 31 | if TYPE_CHECKING: 32 | from .bot import ReminderBot 33 | 34 | 35 | class Config(BaseProxyConfig): 36 | def do_update(self, helper: ConfigUpdateHelper) -> None: 37 | helper.copy("default_timezone") 38 | helper.copy("base_command") 39 | 40 | 41 | class DateArgument(Argument): 42 | def __init__(self, name: str, label: str = None, *, required: bool = False): 43 | super().__init__(name, label=label, required=required, pass_raw=True) 44 | 45 | def match(self, val: str, evt: MessageEvent = None, instance: 'ReminderBot' = None 46 | ) -> Tuple[str, Optional[datetime]]: 47 | tz = pytz.UTC 48 | use_locales = [locales["en_iso"]] 49 | if instance: 50 | tz = instance.db.get_timezone(evt.sender, instance.default_timezone) 51 | locale_ids = instance.db.get_locales(evt.sender) 52 | use_locales = [locales[id] for id in locale_ids if id in locales] 53 | 54 | for locale in use_locales: 55 | match = locale.match(val) 56 | if match: 57 | date = (datetime.now(tz=tz) + relativedelta(**match.params)).astimezone(pytz.UTC) 58 | return match.unconsumed, date 59 | return val, None 60 | 61 | 62 | def parse_timezone(val: str) -> Optional[pytz.timezone]: 63 | if not val: 64 | return None 65 | try: 66 | return pytz.timezone(val) 67 | except pytz.UnknownTimeZoneError as e: 68 | raise ArgumentSyntaxError(f"{val} is not a valid time zone.", show_usage=False) from e 69 | 70 | 71 | def pluralize(val: int, unit: str) -> str: 72 | if val == 1: 73 | return f"{val} {unit}" 74 | return f"{val} {unit}s" 75 | 76 | 77 | def format_time(time: datetime) -> str: 78 | now = datetime.now(tz=pytz.UTC).replace(microsecond=0) 79 | if time - now <= timedelta(days=7): 80 | delta = time - now 81 | parts = [] 82 | if delta.days > 0: 83 | parts.append(pluralize(delta.days, "day")) 84 | hours, seconds = divmod(delta.seconds, 60) 85 | hours, minutes = divmod(hours, 60) 86 | if hours > 0: 87 | parts.append(pluralize(hours, "hour")) 88 | if minutes > 0: 89 | parts.append(pluralize(minutes, "minute")) 90 | if seconds > 0: 91 | parts.append(pluralize(seconds, "second")) 92 | if len(parts) == 1: 93 | return "in " + parts[0] 94 | return "in " + ", ".join(parts[:-1]) + f" and {parts[-1]}" 95 | return time.strftime("at %H:%M:%S %Z on %A, %B %-d %Y") 96 | 97 | 98 | @dataclass 99 | class ReminderInfo: 100 | id: int = None 101 | date: datetime = None 102 | room_id: RoomID = None 103 | event_id: EventID = None 104 | message: str = None 105 | reply_to: EventID = None 106 | users: Union[Dict[UserID, EventID], List[UserID]] = None 107 | --------------------------------------------------------------------------------