├── .gitignore ├── LICENSE ├── README.md ├── remhind ├── __init__.py ├── __main__.py ├── events.py ├── monitor.py └── tests │ ├── __init__.py │ └── test_events.py ├── setup.cfg └── setup.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | 53 | # Translations 54 | *.mo 55 | *.pot 56 | 57 | # Django stuff: 58 | *.log 59 | local_settings.py 60 | db.sqlite3 61 | 62 | # Flask stuff: 63 | instance/ 64 | .webassets-cache 65 | 66 | # Scrapy stuff: 67 | .scrapy 68 | 69 | # Sphinx documentation 70 | docs/_build/ 71 | 72 | # PyBuilder 73 | target/ 74 | 75 | # Jupyter Notebook 76 | .ipynb_checkpoints 77 | 78 | # IPython 79 | profile_default/ 80 | ipython_config.py 81 | 82 | # pyenv 83 | .python-version 84 | 85 | # pipenv 86 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 87 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 88 | # having no cross-platform support, pipenv may install dependencies that don’t work, or not 89 | # install all needed dependencies. 90 | #Pipfile.lock 91 | 92 | # celery beat schedule file 93 | celerybeat-schedule 94 | 95 | # SageMath parsed files 96 | *.sage.py 97 | 98 | # Environments 99 | .env 100 | .venv 101 | env/ 102 | venv/ 103 | ENV/ 104 | env.bak/ 105 | venv.bak/ 106 | 107 | # Spyder project settings 108 | .spyderproject 109 | .spyproject 110 | 111 | # Rope project settings 112 | .ropeproject 113 | 114 | # mkdocs documentation 115 | /site 116 | 117 | # mypy 118 | .mypy_cache/ 119 | .dmypy.json 120 | dmypy.json 121 | 122 | # Pyre type checker 123 | .pyre/ 124 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # remhind 2 | 3 | A notification daemon of events stored in directories 4 | 5 | Those directories will be monitored for change in order to allow you to use 6 | solution like [vdirsyncer](https://github.com/pimutils/vdirsyncer) to sync your 7 | CalDAV server with your local filesystem. 8 | 9 | ## Getting Started 10 | 11 | `remhind` use a [toml](https://github.com/toml-lang/toml) configuration file 12 | indicating which directories holds your event files. Here's a simple example: 13 | 14 | ``` 15 | [calendars] 16 | [calendars.test] 17 | name = "Test" 18 | path = "~/projets/perso/remhind/test_calendar" 19 | ``` 20 | 21 | ## Installing 22 | 23 | `remhind` can be installed through PyPI using pip. 24 | 25 | ``` 26 | pip install remhind 27 | ``` 28 | 29 | ## Acknowledgments 30 | 31 | This work has been inspired by the work of the [pimutils group](https://github.com/pimutils) 32 | -------------------------------------------------------------------------------- /remhind/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicoe/remhind/25f6e83913f73a5e7e82636aa79ba524f215fcf3/remhind/__init__.py -------------------------------------------------------------------------------- /remhind/__main__.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import argparse 3 | import logging 4 | import pathlib 5 | 6 | import gi 7 | import toml 8 | from xdg import XDG_CONFIG_HOME, XDG_CACHE_HOME 9 | 10 | from .monitor import monitor_calendars 11 | from .events import check_events, CalendarStore 12 | 13 | gi.require_version('Notify', '0.7') 14 | from gi.repository import Notify # noqa 15 | 16 | 17 | async def monitor_file_events(args): 18 | with args.config.open() as fd: 19 | config = toml.load(fd) 20 | 21 | log_level = max(logging.CRITICAL - args.verbose * 10, logging.NOTSET) 22 | logging.basicConfig( 23 | format='%(asctime)s:%(levelname)s:%(message)s', level=log_level) 24 | Notify.init('remhind') 25 | 26 | calendars = CalendarStore(config['calendars'].values(), args.database) 27 | 28 | events_checker = check_events(calendars) 29 | calendars_monitor = monitor_calendars(config['calendars'], calendars) 30 | await asyncio.gather(events_checker, calendars_monitor) 31 | 32 | 33 | def main(): 34 | parser = argparse.ArgumentParser(description="remind event from vdirs") 35 | parser.add_argument('-c', '--config', type=pathlib.Path, 36 | default=XDG_CONFIG_HOME / 'remhind' / 'config') 37 | parser.add_argument('-d', '--database', type=pathlib.Path, 38 | default=XDG_CACHE_HOME / 'remhind.db') 39 | parser.add_argument('-v', '--verbose', action='count', default=0) 40 | 41 | asyncio.run(monitor_file_events(parser.parse_args())) 42 | 43 | 44 | if __name__ == '__main__': 45 | main() 46 | -------------------------------------------------------------------------------- /remhind/events.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import calendar 3 | import datetime as dt 4 | import logging 5 | import pathlib 6 | import sqlite3 7 | from dataclasses import dataclass, InitVar 8 | from typing import Optional 9 | 10 | import gi 11 | import icalendar 12 | import pytz 13 | from dateutil.rrule import rruleset, rrulestr 14 | from tzlocal import get_localzone 15 | 16 | gi.require_version('Notify', '0.7') 17 | from gi.repository import Notify # noqa 18 | 19 | LOCAL_TZ = get_localzone() 20 | MIN_SEQ = -999 21 | MIN_DT = dt.datetime(1900, 1, 1, tzinfo=LOCAL_TZ) 22 | 23 | 24 | def _date2datetime(date): 25 | if (isinstance(date, dt.date) 26 | and not isinstance(date, dt.datetime)): 27 | # It should be 00:00 UTC per the RFC 28 | date = LOCAL_TZ.localize( 29 | dt.datetime.combine(date, dt.time(12, 0))) 30 | elif isinstance(date, dt.datetime) and date.tzinfo is None: 31 | date = LOCAL_TZ.localize(date) 32 | return date 33 | 34 | 35 | def _to_utc_timestamp(dt): 36 | if dt.tzinfo is not None: 37 | dt = dt.astimezone(pytz.UTC) 38 | return calendar.timegm(dt.timetuple()) 39 | 40 | 41 | def _from_utc_timestamp(timestamp, tz=None): 42 | if tz is None: 43 | tz = LOCAL_TZ 44 | return dt.datetime.fromtimestamp( 45 | timestamp, tz=pytz.UTC).astimezone(tz) 46 | 47 | 48 | def parse_rule(component): 49 | if 'dtstart' in component: 50 | dtstart = _date2datetime(component['dtstart'].dt) 51 | elif 'due' in component: 52 | dtstart = _date2datetime(component['due'].dt) 53 | 54 | rule_set = rruleset() 55 | 56 | rrules = component.get('rrule', []) 57 | if not isinstance(rrules, list): 58 | rrules = [rrules] 59 | for rrule in rrules: 60 | rule_set.rrule(rrulestr( 61 | 'RRULE:%s' % rrule.to_ical().decode(), 62 | dtstart=dtstart)) 63 | 64 | rdates = component.get('rdate', []) 65 | if not isinstance(rdates, list): 66 | rdates = [rdates] 67 | for rdate in rdates: 68 | for rd in rdate.dts: 69 | rule_set.rdate(rd.dt) 70 | 71 | exrules = component.get('exrule', []) 72 | if not isinstance(exrules, list): 73 | exrules = [exrules] 74 | for exrule in exrules: 75 | rule_set.exrule(rrulestr( 76 | 'EXRULE:%s' % exrule.to_ical().decode(), 77 | dtstart=dtstart)) 78 | 79 | exdates = component.get('exdate', []) 80 | if not isinstance(exdates, list): 81 | exdates = [exdates] 82 | for exdate in exdates: 83 | for exd in exdate.dts: 84 | rule_set.exdate(exd.dt) 85 | 86 | return rule_set 87 | 88 | 89 | def get_component_from_ics(uid, ics): 90 | cal = icalendar.Calendar.from_ical(ics) 91 | for component in cal.walk(): 92 | if component.get('uid') == uid: 93 | return component 94 | return None 95 | 96 | 97 | @dataclass 98 | class Alarm: 99 | id: int 100 | event: str 101 | message: str 102 | date_timestamp: InitVar 103 | due_timestamp: InitVar 104 | date: Optional[dt.datetime] = None 105 | due_date: Optional[dt.datetime] = None 106 | 107 | def __post_init__(self, date_timestamp, due_timestamp): 108 | self.date = _from_utc_timestamp(date_timestamp) 109 | self.due_date = _from_utc_timestamp(due_timestamp) 110 | 111 | 112 | class SQLiteDB: 113 | 114 | def __init__(self, db_path=None): 115 | self.db_path = ':memory:' if db_path is None else db_path 116 | init_db = db_path is None or not self.db_path.exists() 117 | self._conn = sqlite3.connect(self.db_path) 118 | if init_db: 119 | self._init_db() 120 | 121 | def _init_db(self): 122 | logging.debug(f'Initializing database {self.db_path}') 123 | self._conn.execute(""" 124 | CREATE TABLE alarms ( 125 | id INTEGER PRIMARY KEY, 126 | event TEXT NOT NULL, 127 | date INTEGER NOT NULL, 128 | due_date INTEGER NOT NULL, 129 | message TEXT NOT NULL, 130 | vtodo INTEGER DEFAULT 0, 131 | done INTEGER DEFAULT 0, 132 | sequence INTEGER DEFAULT 0)""") 133 | self._conn.execute(""" 134 | CREATE TABLE occurences ( 135 | event TEXT PRIMARY KEY, 136 | date INTEGER NOT NULL)""") 137 | self._conn.execute(""" 138 | CREATE TABLE events ( 139 | event TEXT PRIMARY KEY, 140 | sequence INTEGER, 141 | path TEXT)""") 142 | self._conn.commit() 143 | 144 | def remove_event(self, uid): 145 | self._conn.execute("DELETE FROM alarms WHERE event = ?", (uid,)) 146 | self._conn.execute("DELETE FROM occurences WHERE event = ?", (uid,)) 147 | self._conn.execute("DELETE FROM events WHERE event = ?", (uid,)) 148 | self._conn.commit() 149 | 150 | def add_alarm(self, event_uid, date, due_date, message, is_todo, sequence): 151 | date = _to_utc_timestamp(date) 152 | due_date = _to_utc_timestamp(due_date) 153 | cursor = self._conn.cursor() 154 | cursor.execute( 155 | "SELECT 1 FROM alarms" 156 | " WHERE event=? AND date=? AND due_date=? AND message=?", 157 | (event_uid, date, due_date, message)) 158 | if not cursor.fetchone(): 159 | cursor.execute(""" 160 | INSERT INTO alarms 161 | (event, date, due_date, message, vtodo, sequence) 162 | VALUES (?, ?, ?, ?, ?, ?)""", 163 | (event_uid, date, due_date, message, int(is_todo), sequence)) 164 | self._conn.commit() 165 | 166 | def get_alarms(self, start_date, end_date): 167 | if start_date > end_date: 168 | start_date, end_date = end_date, start_date 169 | event_alarms = self.get_event_alarms( 170 | _to_utc_timestamp(start_date), _to_utc_timestamp(end_date)) 171 | todo_alarms = self.get_due_todos(start_date, end_date) 172 | logging.debug( 173 | f'Found {len(event_alarms)} events and {len(todo_alarms)}' 174 | ' todos to display') 175 | return event_alarms + todo_alarms 176 | 177 | def get_event_alarms(self, start, end): 178 | cursor = self._conn.cursor() 179 | cursor.execute(""" 180 | SELECT id, event, message, date, due_date 181 | FROM alarms 182 | WHERE (date >= ?) AND (date < ?) AND (vtodo = 0) 183 | """, (start, end)) 184 | return [Alarm(*r) for r in cursor.fetchall()] 185 | 186 | def get_due_todos(self, start, end): 187 | start = start.astimezone(pytz.UTC) 188 | end = end.astimezone(pytz.UTC) 189 | start_time = (start.hour, start.minute) 190 | end_time = (end.hour, end.minute) 191 | 192 | def match_time(alarm): 193 | date = alarm.due_date.astimezone(pytz.UTC) 194 | if start_time < end_time: 195 | return start_time <= (date.hour, date.minute) < end_time 196 | elif start_time == end_time: 197 | return start != end 198 | else: 199 | return (start_time <= (date.hour, date.minute) 200 | or (date.hour, date.minute) < end_time) 201 | 202 | cursor = self._conn.cursor() 203 | cursor.execute(""" 204 | SELECT id, event, message, date, due_date 205 | FROM alarms 206 | WHERE (date < ?) AND (vtodo = 1) AND (done = 0) 207 | """, (_to_utc_timestamp(end),)) 208 | return list(filter(match_time, (Alarm(*r) for r in cursor.fetchall()))) 209 | 210 | def set_done(self, event_id, status, sequence): 211 | cursor = self._conn.cursor() 212 | if status.upper() in {'COMPLETED', 'CANCELLED'}: 213 | cursor.execute( 214 | "UPDATE alarms SET done=1 WHERE event=?", 215 | (event_id,)) 216 | else: 217 | cursor.execute( 218 | "UPDATE alarms SET done=1 WHERE event=? AND sequence 0: 278 | self.db.set_done( 279 | cal_obj['uid'], cal_obj['status'], obj_sequence) 280 | 281 | if (occurence is not None 282 | and occurence < self._last_occurences[cal_obj['uid']]): 283 | return 284 | obj_sequence = int(cal_obj.get('sequence', 0)) 285 | self.db.add_event(cal_obj['uid'], obj_sequence, ics) 286 | 287 | summary = cal_obj.get('summary', '') 288 | if 'dtstart' in cal_obj: 289 | start_dt = _date2datetime(cal_obj['dtstart'].dt) 290 | elif 'due' in cal_obj: 291 | start_dt = _date2datetime(cal_obj['due'].dt) 292 | else: 293 | start_dt = None 294 | if 'dtend' in cal_obj: 295 | end_dt = _date2datetime(cal_obj['dtend'].dt) 296 | duration = end_dt - start_dt 297 | elif 'duration' in cal_obj: 298 | duration = cal_obj['duration'].dt 299 | else: 300 | duration = dt.timedelta() 301 | latest_occurence = self._last_occurences.get(cal_obj['uid'], start_dt) 302 | if occurence is None: 303 | occurence = latest_occurence 304 | 305 | def _add_occurence(dt, sequence): 306 | is_todo = isinstance(cal_obj, icalendar.Todo) 307 | for component in cal_obj.subcomponents: 308 | if not isinstance(component, icalendar.Alarm): 309 | continue 310 | if component['action'] != 'DISPLAY': 311 | continue 312 | trigger = component['trigger'] 313 | if trigger.params.get('value') == 'DATE-TIME': 314 | alarm_dt = trigger.dt 315 | else: 316 | if trigger.params.get('related') == 'END': 317 | alarm_dt = dt + duration + trigger.dt 318 | else: 319 | alarm_dt = dt + trigger.dt 320 | 321 | message = component.get('description', summary) 322 | if message: 323 | self.db.add_alarm( 324 | cal_obj['uid'], alarm_dt, dt, message, is_todo, 325 | sequence) 326 | 327 | if summary: 328 | self.db.add_alarm( 329 | cal_obj['uid'], dt, dt, summary, is_todo, sequence) 330 | 331 | has_rules = ('rrule' in cal_obj or 'exrule' in cal_obj 332 | or 'rdate' in cal_obj or 'exdate' in cal_obj) 333 | sequence = cal_obj.get('sequence', 0) 334 | if not has_rules: 335 | if start_dt: 336 | _add_occurence(start_dt, sequence) 337 | self.db.add_last_occurence(cal_obj['uid'], start_dt) 338 | else: 339 | now = dt.datetime.now(tz=LOCAL_TZ).replace(second=0, microsecond=0) 340 | if latest_occurence: 341 | now = max(now, latest_occurence) 342 | rules = parse_rule(cal_obj) 343 | for idx, occurence in enumerate(rules.xafter(now, 10, inc=True)): 344 | _add_occurence(occurence, sequence + idx) 345 | self.db.add_last_occurence(cal_obj['uid'], occurence) 346 | latest_occurence = occurence 347 | self._last_occurences[cal_obj['uid']] = latest_occurence 348 | 349 | def remove(self, path): 350 | for uid in self.db.get_uids(path): 351 | self.db.remove_event(uid) 352 | 353 | def get_due_alarms(self, date): 354 | end_date = date + dt.timedelta(minutes=1) 355 | db_alarms = self.db.get_alarms(date, end_date) 356 | alarms2ics = self.db.get_ics_files({a.event for a in db_alarms}) 357 | 358 | max_alarms = {} 359 | for alarm in db_alarms: 360 | if alarm.event in max_alarms: 361 | max_alarms[alarm.event] = max( 362 | max_alarms[alarm.event], alarm.due_date) 363 | else: 364 | max_alarms[alarm.event] = alarm.due_date 365 | to_renew = {event for event, date in max_alarms.items() 366 | if date >= self._last_occurences.get(event, MIN_DT)} 367 | for event_uid, ics in alarms2ics.items(): 368 | if event_uid not in to_renew: 369 | continue 370 | event = get_component_from_ics( 371 | event_uid, pathlib.Path(ics).read_text()) 372 | self.add(event, ics, max_alarms[event_uid]) 373 | 374 | return db_alarms 375 | 376 | 377 | class CalendarStore: 378 | 379 | def __init__(self, sources, db_path): 380 | self.sources = sources 381 | self.events = EventCollection(db_path) 382 | for source in sources: 383 | self.add_source_events(source) 384 | 385 | def add_source_events(self, source): 386 | for cal_file, component in self.get_interesting_components(source): 387 | self.events.add(component, cal_file) 388 | 389 | def get_interesting_components(self, source): 390 | cal_path = pathlib.Path(source['path']) 391 | for ics in cal_path.expanduser().glob('*.ics'): 392 | yield from self._get_components_from_ics(ics) 393 | 394 | def _get_components_from_ics(self, ics): 395 | cal = icalendar.Calendar.from_ical(ics.read_text()) 396 | for component in cal.subcomponents: 397 | if isinstance(component, (icalendar.Event, icalendar.Todo)): 398 | yield (ics, component) 399 | 400 | def add_file(self, ics): 401 | logging.info(f'Adding events from {ics}') 402 | for cal_file, component in self._get_components_from_ics(ics): 403 | self.events.add(component, cal_file) 404 | 405 | def remove_file(self, ics): 406 | logging.info(f'Removing events from {ics}') 407 | self.events.remove(ics) 408 | 409 | def modify_file(self, ics): 410 | logging.info(f'Updating events from {ics}') 411 | for cal_file, component in self._get_components_from_ics(ics): 412 | self.events.add(component, cal_file) 413 | 414 | 415 | async def check_events(calendar_store): 416 | last_check = None 417 | while True: 418 | now = dt.datetime.now(LOCAL_TZ).replace(second=0, microsecond=0) 419 | if last_check is None or (last_check != now): 420 | last_check = now 421 | due_alarms = calendar_store.events.get_due_alarms(now) 422 | for alarm in due_alarms: 423 | logging.debug( 424 | f'Notifying of alarm {alarm.id} "{alarm.message}"') 425 | n = Notify.Notification.new( 426 | "{a.due_date:%H:%M} {a.message}".format(a=alarm), "Alarm") 427 | n.show() 428 | # Take some security to ensure we don't miss any minute 429 | await asyncio.sleep(45) 430 | -------------------------------------------------------------------------------- /remhind/monitor.py: -------------------------------------------------------------------------------- 1 | import asyncio 2 | import logging 3 | import os.path 4 | import pathlib 5 | 6 | import aionotify 7 | 8 | ALL_EVENTS = ( 9 | aionotify.Flags.CREATE 10 | | aionotify.Flags.DELETE 11 | | aionotify.Flags.MOVED_FROM 12 | | aionotify.Flags.MOVED_TO 13 | | aionotify.Flags.MODIFY) 14 | 15 | 16 | async def get_watchers(config_calendars): 17 | watchers = [] 18 | loop = asyncio.get_event_loop() 19 | for calendar in config_calendars.values(): 20 | path = pathlib.Path(calendar['path']) 21 | watcher = aionotify.Watcher() 22 | watcher.watch(str(path.expanduser()), flags=ALL_EVENTS) 23 | await watcher.setup(loop) 24 | logging.info(f'Watcher setup for {path}') 25 | watchers.append(watcher) 26 | return watchers 27 | 28 | 29 | async def monitor_calendars(config_calendars, calendar_store): 30 | watchers = await get_watchers(config_calendars) 31 | while True: 32 | done, pending = await asyncio.wait( 33 | [w.get_event() for w in watchers], 34 | return_when=asyncio.FIRST_COMPLETED) 35 | for task in done: 36 | event = await task 37 | path = pathlib.Path(event.alias) / event.name 38 | logging.debug(f'Received inotify event for {path}') 39 | if os.path.splitext(path)[1] != '.ics': 40 | continue 41 | if (event.flags & ( 42 | aionotify.Flags.CREATE | aionotify.Flags.MOVED_TO)): 43 | calendar_store.add_file(path) 44 | elif (event.flags & ( 45 | aionotify.Flags.DELETE | aionotify.Flags.MOVED_FROM)): 46 | calendar_store.remove_file(path) 47 | elif event.flags & aionotify.Flags.MODIFY: 48 | calendar_store.modify_file(path) 49 | for task in pending: 50 | task.cancel() 51 | -------------------------------------------------------------------------------- /remhind/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/nicoe/remhind/25f6e83913f73a5e7e82636aa79ba524f215fcf3/remhind/tests/__init__.py -------------------------------------------------------------------------------- /remhind/tests/test_events.py: -------------------------------------------------------------------------------- 1 | import datetime as dt 2 | import unittest 3 | from unittest.mock import patch 4 | 5 | import icalendar 6 | import pytz 7 | from tzlocal import get_localzone 8 | from freezegun import freeze_time 9 | 10 | import remhind.events 11 | from ..events import EventCollection, parse_rule, get_component_from_ics 12 | 13 | VEVENT = """ 14 | BEGIN:VEVENT 15 | UID:20190310 16 | DTSTAMP:20190310T150000Z 17 | DTSTART:20190310T150000Z 18 | DTEND:20190310T160000Z 19 | SUMMARY:Annual Employee Review 20 | CLASS:PRIVATE 21 | END:VEVENT 22 | """ 23 | 24 | VEVENT_ALARM = """ 25 | BEGIN:VEVENT 26 | UID:20190310 27 | DTSTAMP:20190310T150000Z 28 | DTSTART:20190310T150000Z 29 | DTEND:20190310T160000Z 30 | SUMMARY:Breakfast Meeting 31 | CLASS:PRIVATE 32 | BEGIN:VALARM 33 | TRIGGER:-PT30M 34 | ACTION:DISPLAY 35 | DESCRIPTION:Breakfast Meeting Reminder 36 | END:VALARM 37 | END:VEVENT 38 | """ 39 | 40 | VEVENT_DATE = """ 41 | BEGIN:VEVENT 42 | UID:20190310 43 | DTSTAMP:20190310T150000Z 44 | DTSTART:20190310 45 | SUMMARY:Birthday 46 | CLASS:PRIVATE 47 | END:VEVENT 48 | """ 49 | 50 | VEVENT_DATE_ALARM = """ 51 | BEGIN:VEVENT 52 | UID:20190310 53 | DTSTAMP:20190310T150000Z 54 | DTSTART:20190310 55 | SUMMARY:Breakfast Meeting 56 | CLASS:PRIVATE 57 | BEGIN:VALARM 58 | TRIGGER:-PT30M 59 | ACTION:DISPLAY 60 | DESCRIPTION:Breakfast Meeting Reminder 61 | END:VALARM 62 | END:VEVENT 63 | """ 64 | 65 | VEVENT_RRULE = """ 66 | BEGIN:VEVENT 67 | UID:20190310 68 | DTSTAMP:20190310T150000Z 69 | DTSTART:20190310T150000Z 70 | SUMMARY:RRULE VEVENT 71 | CLASS:PRIVATE 72 | RRULE:FREQ=DAILY 73 | BEGIN:VALARM 74 | TRIGGER:-PT30M 75 | ACTION:DISPLAY 76 | DESCRIPTION:Breakfast Meeting Reminder 77 | END:VALARM 78 | END:VEVENT 79 | """ 80 | 81 | VTODO = """ 82 | BEGIN:VTODO 83 | UID:20190310 84 | DTSTAMP:20190310T150000Z 85 | DUE:20190310T170000Z 86 | SUMMARY:Income Tax Preparation 87 | PRIORITY:1 88 | STATUS:NEEDS-ACTION 89 | END:VTODO 90 | """ 91 | 92 | VTODO_DATE = """ 93 | BEGIN:VTODO 94 | UID:20190310 95 | DTSTAMP:20190310T150000Z 96 | DUE:20190310 97 | SUMMARY:Income Tax Preparation 98 | PRIORITY:1 99 | STATUS:NEEDS-ACTION 100 | END:VTODO 101 | """ 102 | 103 | VTODO_RRULE = """ 104 | BEGIN:VTODO 105 | UID:20190310 106 | DTSTAMP:20190310T150000Z 107 | DUE:20190310T170000Z 108 | SUMMARY:Income Tax Preparation 109 | PRIORITY:1 110 | SEQUENCE:0 111 | STATUS:NEEDS-ACTION 112 | RRULE:FREQ=DAILY 113 | END:VTODO 114 | """ 115 | 116 | VTODO_NO_DATE = """ 117 | BEGIN:VTODO 118 | UID:20190310 119 | DTSTAMP:20190310T150000Z 120 | SUMMARY:Income Tax Preparation 121 | PRIORITY:1 122 | STATUS:NEEDS-ACTION 123 | END:VTODO 124 | """ 125 | 126 | VTODO_LONG_OVERDUE = """ 127 | BEGIN:VTODO 128 | UID:20190310 129 | DTSTAMP:20190310T150000Z 130 | DUE;TZID=Europe/Brussels:20100310T170000 131 | SUMMARY:Income Tax Preparation 132 | PRIORITY:1 133 | STATUS:NEEDS-ACTION 134 | END:VTODO 135 | """ 136 | 137 | VTODO_STARTING_SEQUENCE = """ 138 | BEGIN:VTODO 139 | UID:20190310 140 | DTSTAMP:20190310T150000Z 141 | DUE:20100310T170000Z 142 | SUMMARY:Income Tax Preparation 143 | PRIORITY:1 144 | SEQUENCE:2 145 | STATUS:NEEDS-ACTION 146 | RRULE:FREQ=DAILY 147 | END:VTODO 148 | """ 149 | 150 | RRULE_EVENT = """ 151 | BEGIN:VEVENT 152 | SUMMARY:Training 153 | DTSTART;TZID=Europe/Brussels:20190207T100000 154 | DTEND;TZID=Europe/Brussels:20190207T120000 155 | DTSTAMP:20190131T153505 156 | UID:BY8RPO6AXKEKM5EFBFN0W9 157 | SEQUENCE:0 158 | RRULE:FREQ=DAILY;COUNT=7;BYDAY=MO,TU,WE,TH,FR 159 | RDATE;TZID=Europe/Brussels:20190401T100000,20190402T100000 160 | EXDATE;TZID=Europe/Brussels:20190212T100000,20190213T100000 161 | CLASS:PUBLIC 162 | CREATED:20190131T153505 163 | LAST-MODIFIED:20190131T153629 164 | STATUS:CONFIRMED 165 | BEGIN:VALARM 166 | ACTION:DISPLAY 167 | DESCRIPTION:Training Reminder 168 | TRIGGER:-PT1H 169 | END:VALARM 170 | END:VEVENT 171 | """ 172 | 173 | RRULE_TODO = """ 174 | BEGIN:VTODO 175 | DTSTAMP:20190114T070828Z 176 | UID:a8f5a030c6f94010a6654d79b8be5372@mirabelle 177 | SEQUENCE:58 178 | CREATED:20180316T230011Z 179 | LAST-MODIFIED:20190114T070827Z 180 | SUMMARY:Check something 181 | STATUS:NEEDS-ACTION 182 | RRULE:FREQ=MONTHLY;INTERVAL=4;BYDAY=3MO 183 | DUE;VALUE=DATE:20190318 184 | END:VTODO 185 | """ 186 | 187 | 188 | def setUpModule(): 189 | remhind.events.LOCAL_TZ = pytz.timezone('Europe/Brussels') 190 | 191 | 192 | def tearDownModule(): 193 | remhind.events.LOCAL_TZ = get_localzone() 194 | 195 | 196 | class TestEventFunction(unittest.TestCase): 197 | 198 | def test_parse_rrule(self): 199 | event = icalendar.Event.from_ical(RRULE_EVENT) 200 | ruleset = parse_rule(event) 201 | occurences = list(ruleset) 202 | 203 | self.assertEqual(len(occurences), 7) 204 | month_days = [ 205 | (2, 7), (2, 8), (2, 11), (2, 14), (2, 15), (4, 1), (4, 2), 206 | ] 207 | for o, (month, day) in zip(occurences, month_days): 208 | with self.subTest(occurence=o): 209 | self.assertEqual((o.year, o.month, o.day), (2019, month, day)) 210 | self.assertEqual((o.hour, o.minute), (10, 0)) 211 | 212 | def test_get_component_from_ics(self): 213 | component = get_component_from_ics('20190310', VEVENT) 214 | self.assertEqual(component['uid'], '20190310') 215 | self.assertEqual( 216 | component['dtstart'].dt, 217 | dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC)) 218 | 219 | component = get_component_from_ics('20190310', RRULE_TODO) 220 | self.assertIsNone(component) 221 | 222 | 223 | class TestEventCollection(unittest.TestCase): 224 | 225 | def test_vevent(self): 226 | event = icalendar.Event.from_ical(VEVENT) 227 | collection = EventCollection() 228 | collection.add(event, None) 229 | 230 | start = dt.datetime(2019, 3, 10, 0, 0) 231 | end = dt.datetime(2019, 3, 11, 0, 0) 232 | alarms = collection.db.get_alarms(start, end) 233 | self.assertEqual(len(alarms), 1) 234 | self.assertEqual(alarms[0].event, '20190310') 235 | self.assertEqual(alarms[0].message, 'Annual Employee Review') 236 | self.assertEqual( 237 | alarms[0].due_date.astimezone(pytz.UTC), 238 | dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC)) 239 | 240 | def test_alarm_vevent(self): 241 | event = icalendar.Event.from_ical(VEVENT_ALARM) 242 | collection = EventCollection() 243 | collection.add(event, None) 244 | 245 | start = dt.datetime(2019, 3, 10, 0, 0) 246 | end = dt.datetime(2019, 3, 11, 0, 0) 247 | alarms = collection.db.get_alarms(start, end) 248 | 249 | self.assertEqual(len(alarms), 2) 250 | self.assertEqual( 251 | alarms[0].due_date.astimezone(pytz.UTC), 252 | dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC)) 253 | self.assertEqual( 254 | alarms[0].date.astimezone(pytz.UTC), 255 | dt.datetime(2019, 3, 10, 14, 30, tzinfo=pytz.UTC)) 256 | self.assertEqual(alarms[0].message, "Breakfast Meeting Reminder") 257 | self.assertEqual( 258 | alarms[1].due_date.astimezone(pytz.UTC), 259 | dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC)) 260 | self.assertEqual( 261 | alarms[1].date.astimezone(pytz.UTC), 262 | dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC)) 263 | self.assertEqual(alarms[1].message, "Breakfast Meeting") 264 | 265 | def test_date_vevent(self): 266 | event = icalendar.Event.from_ical(VEVENT_DATE) 267 | collection = EventCollection() 268 | collection.add(event, None) 269 | 270 | start = dt.datetime(2019, 3, 10, 0, 0) 271 | end = dt.datetime(2019, 3, 11, 0, 0) 272 | alarms = collection.db.get_alarms(start, end) 273 | 274 | self.assertEqual(len(alarms), 1) 275 | self.assertEqual( 276 | alarms[0].due_date.astimezone(pytz.UTC), 277 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 278 | self.assertEqual(alarms[0].message, "Birthday") 279 | 280 | def test_date_alarm_vevent(self): 281 | event = icalendar.Event.from_ical(VEVENT_DATE_ALARM) 282 | collection = EventCollection() 283 | collection.add(event, None) 284 | 285 | start = dt.datetime(2019, 3, 10, 0, 0) 286 | end = dt.datetime(2019, 3, 11, 0, 0) 287 | alarms = collection.db.get_alarms(start, end) 288 | 289 | self.assertEqual(len(alarms), 2) 290 | self.assertEqual( 291 | alarms[0].due_date.astimezone(pytz.UTC), 292 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 293 | self.assertEqual( 294 | alarms[0].date.astimezone(pytz.UTC), 295 | dt.datetime(2019, 3, 10, 10, 30, tzinfo=pytz.UTC)) 296 | self.assertEqual(alarms[0].message, "Breakfast Meeting Reminder") 297 | self.assertEqual( 298 | alarms[1].due_date.astimezone(pytz.UTC), 299 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 300 | self.assertEqual( 301 | alarms[1].date.astimezone(pytz.UTC), 302 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 303 | self.assertEqual(alarms[1].message, "Breakfast Meeting") 304 | 305 | @freeze_time('20190207', tz_offset=0) 306 | def test_rrule_event(self): 307 | event = icalendar.Event.from_ical(RRULE_EVENT) 308 | collection = EventCollection() 309 | collection.add(event, None) 310 | 311 | start = dt.datetime(2019, 2, 7, 0, 0) 312 | end = dt.datetime(2019, 2, 10, 0, 0) 313 | alarms = collection.db.get_alarms(start, end) 314 | 315 | self.assertEqual(len(alarms), 4) 316 | self.assertEqual( 317 | alarms[0].due_date.astimezone(pytz.UTC), 318 | dt.datetime(2019, 2, 7, 9, 0, tzinfo=pytz.UTC)) 319 | self.assertEqual( 320 | alarms[0].date.astimezone(pytz.UTC), 321 | dt.datetime(2019, 2, 7, 8, 0, tzinfo=pytz.UTC)) 322 | self.assertEqual( 323 | alarms[1].due_date.astimezone(pytz.UTC), 324 | dt.datetime(2019, 2, 7, 9, 0, tzinfo=pytz.UTC)) 325 | self.assertEqual( 326 | alarms[1].date.astimezone(pytz.UTC), 327 | dt.datetime(2019, 2, 7, 9, 0, tzinfo=pytz.UTC)) 328 | self.assertEqual( 329 | alarms[2].due_date.astimezone(pytz.UTC), 330 | dt.datetime(2019, 2, 8, 9, 0, tzinfo=pytz.UTC)) 331 | self.assertEqual( 332 | alarms[2].date.astimezone(pytz.UTC), 333 | dt.datetime(2019, 2, 8, 8, 0, tzinfo=pytz.UTC)) 334 | self.assertEqual( 335 | alarms[3].due_date.astimezone(pytz.UTC), 336 | dt.datetime(2019, 2, 8, 9, 0, tzinfo=pytz.UTC)) 337 | self.assertEqual( 338 | alarms[3].date.astimezone(pytz.UTC), 339 | dt.datetime(2019, 2, 8, 9, 0, tzinfo=pytz.UTC)) 340 | 341 | def test_vtodo(self): 342 | event = icalendar.Event.from_ical(VTODO) 343 | collection = EventCollection() 344 | collection.add(event, None) 345 | 346 | start = dt.datetime(2019, 3, 10, 0, 0) 347 | end = dt.datetime(2019, 3, 11, 0, 0) 348 | alarms = collection.db.get_alarms(start, end) 349 | 350 | self.assertEqual(len(alarms), 1) 351 | self.assertEqual( 352 | alarms[0].date.astimezone(pytz.UTC), 353 | dt.datetime(2019, 3, 10, 17, 0, tzinfo=pytz.UTC)) 354 | self.assertEqual( 355 | alarms[0].date.astimezone(pytz.UTC), 356 | dt.datetime(2019, 3, 10, 17, 0, tzinfo=pytz.UTC)) 357 | self.assertEqual(alarms[0].message, "Income Tax Preparation") 358 | 359 | def test_date_vtodo(self): 360 | event = icalendar.Event.from_ical(VTODO_DATE) 361 | collection = EventCollection() 362 | collection.add(event, None) 363 | 364 | start = dt.datetime(2019, 3, 10, 0, 0) 365 | end = dt.datetime(2019, 3, 11, 0, 0) 366 | alarms = collection.db.get_alarms(start, end) 367 | 368 | self.assertEqual(len(alarms), 1) 369 | self.assertEqual( 370 | alarms[0].date.astimezone(pytz.UTC), 371 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 372 | self.assertEqual( 373 | alarms[0].due_date.astimezone(pytz.UTC), 374 | dt.datetime(2019, 3, 10, 11, 0, tzinfo=pytz.UTC)) 375 | 376 | @patch('remhind.events.get_component_from_ics') 377 | @patch('pathlib.Path.read_text') 378 | def test_due_alarms(self, path_mock, component_mock): 379 | event = icalendar.Event.from_ical(VEVENT_ALARM) 380 | component_mock.return_value = event 381 | collection = EventCollection() 382 | collection.add(event, None) 383 | 384 | start = dt.datetime(2019, 3, 10, 12, 0, tzinfo=pytz.UTC) 385 | alarms = collection.get_due_alarms(start) 386 | self.assertEqual(len(alarms), 0) 387 | 388 | start = dt.datetime(2019, 3, 10, 14, 30, tzinfo=pytz.UTC) 389 | alarms = collection.get_due_alarms(start) 390 | self.assertEqual(len(alarms), 1) 391 | 392 | start = dt.datetime(2019, 3, 10, 15, 0, tzinfo=pytz.UTC) 393 | alarms = collection.get_due_alarms(start) 394 | self.assertEqual(len(alarms), 1) 395 | 396 | @patch('remhind.events.get_component_from_ics') 397 | @patch('pathlib.Path.read_text') 398 | @freeze_time('20190310', tz_offset=0) 399 | def test_due_alarms_reccuring(self, path_mock, component_mock): 400 | event = icalendar.Event.from_ical(VEVENT_RRULE) 401 | component_mock.return_value = event 402 | collection = EventCollection() 403 | collection.add(event, None) 404 | 405 | for day in range(15, 31): 406 | start = dt.datetime(2019, 3, day, 15, 0, tzinfo=pytz.UTC) 407 | with self.subTest(start): 408 | alarms = collection.get_due_alarms(start) 409 | self.assertEqual(len(alarms), 1) 410 | 411 | @patch('remhind.events.get_component_from_ics') 412 | @patch('pathlib.Path.read_text') 413 | @freeze_time('20190310', tz_offset=0) 414 | def test_due_todo_with_rrule(self, path_mock, component_mock): 415 | event = icalendar.Event.from_ical(VTODO_RRULE) 416 | component_mock.return_value = event 417 | collection = EventCollection() 418 | collection.add(event, None) 419 | 420 | for idx, day in enumerate(range(10, 15)): 421 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 422 | with self.subTest(start): 423 | alarms = collection.get_due_alarms(start) 424 | self.assertEqual(len(alarms), idx + 1) 425 | 426 | # Simulate completion and the monitoring of the file 427 | completed_event = icalendar.Todo.from_ical( 428 | VTODO_RRULE.replace('NEEDS-ACTION', 'COMPLETED')) 429 | component_mock.return_value = completed_event 430 | collection.add(completed_event, None) 431 | 432 | for day in range(15, 31): 433 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 434 | with self.subTest(start): 435 | alarms = collection.get_due_alarms(start) 436 | self.assertEqual(len(alarms), 0) 437 | 438 | @patch('remhind.events.get_component_from_ics') 439 | @patch('pathlib.Path.read_text') 440 | def test_due_todo_without_rrule(self, path_mock, component_mock): 441 | event = icalendar.Event.from_ical(VTODO) 442 | component_mock.return_value = event 443 | collection = EventCollection() 444 | collection.add(event, None) 445 | 446 | for day in range(10, 15): 447 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 448 | with self.subTest(start): 449 | alarms = collection.get_due_alarms(start) 450 | self.assertEqual(len(alarms), 1) 451 | 452 | # Simulate completion and the monitoring of the file 453 | completed_event = icalendar.Todo.from_ical( 454 | VTODO.replace('NEEDS-ACTION', 'COMPLETED')) 455 | component_mock.return_value = completed_event 456 | collection.add(completed_event, None) 457 | 458 | for day in range(15, 31): 459 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 460 | with self.subTest(start): 461 | alarms = collection.get_due_alarms(start) 462 | self.assertEqual(len(alarms), 0) 463 | 464 | def test_todo_no_start(self): 465 | event = icalendar.Todo.from_ical(VTODO_NO_DATE) 466 | collection = EventCollection() 467 | collection.add(event, None) 468 | 469 | start = dt.datetime(2019, 3, 10, 0, 0) 470 | end = dt.datetime(9999, 12, 31, 0, 0) 471 | alarms = collection.db.get_alarms(start, end) 472 | 473 | self.assertEqual(len(alarms), 0) 474 | 475 | @patch('remhind.events.get_component_from_ics') 476 | @patch('pathlib.Path.read_text') 477 | @freeze_time('20190310', tz_offset=0) 478 | def test_long_overdue_todo(self, path_mock, component_mock): 479 | event = icalendar.Todo.from_ical(VTODO_LONG_OVERDUE) 480 | component_mock.return_value = event 481 | collection = EventCollection() 482 | collection.add(event, None) 483 | 484 | noon = dt.datetime.now(tz=pytz.UTC).replace(hour=12) 485 | alarms = collection.get_due_alarms(noon) 486 | self.assertEqual(len(alarms), 0) 487 | 488 | tea_time = dt.datetime.now(pytz.UTC).replace(hour=16) 489 | alarms = collection.get_due_alarms(tea_time) 490 | self.assertEqual(len(alarms), 1) 491 | 492 | completed_event = icalendar.Todo.from_ical( 493 | VTODO_LONG_OVERDUE.replace('NEEDS-ACTION', 'COMPLETED')) 494 | component_mock.return_value = completed_event 495 | collection.add(completed_event, None) 496 | 497 | alarms = collection.get_due_alarms(tea_time) 498 | self.assertEqual(len(alarms), 0) 499 | 500 | @patch('remhind.events.get_component_from_ics') 501 | @patch('pathlib.Path.read_text') 502 | @freeze_time('20190310', tz_offset=0) 503 | def test_due_todo_with_rrule_complete_some( 504 | self, path_mock, component_mock): 505 | event = icalendar.Event.from_ical(VTODO_RRULE) 506 | component_mock.return_value = event 507 | collection = EventCollection() 508 | collection.add(event, None) 509 | 510 | for idx, day in enumerate(range(10, 15)): 511 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 512 | with self.subTest(start): 513 | alarms = collection.get_due_alarms(start) 514 | self.assertEqual(len(alarms), idx + 1) 515 | 516 | completed_event = icalendar.Todo.from_ical( 517 | VTODO_RRULE.replace('SEQUENCE:0', 'SEQUENCE:5')) 518 | component_mock.return_value = completed_event 519 | collection.add(completed_event, None) 520 | 521 | alarms = collection.get_due_alarms(start) 522 | self.assertEqual(len(alarms), 0) 523 | 524 | for idx, day in enumerate(range(15, 20)): 525 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 526 | with self.subTest(start): 527 | alarms = collection.get_due_alarms(start) 528 | self.assertEqual(len(alarms), idx + 1) 529 | 530 | @patch('remhind.events.get_component_from_ics') 531 | @patch('pathlib.Path.read_text') 532 | @freeze_time('20190310', tz_offset=0) 533 | def test_due_todo_with_sequence(self, path_mock, component_mock): 534 | event = icalendar.Event.from_ical(VTODO_STARTING_SEQUENCE) 535 | component_mock.return_value = event 536 | collection = EventCollection() 537 | collection.add(event, None) 538 | 539 | for idx, day in enumerate(range(10, 15)): 540 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 541 | with self.subTest(start): 542 | alarms = collection.get_due_alarms(start) 543 | self.assertEqual(len(alarms), idx + 1) 544 | 545 | completed_event = icalendar.Todo.from_ical( 546 | VTODO_STARTING_SEQUENCE.replace('SEQUENCE:2', 'SEQUENCE:4')) 547 | component_mock.return_value = completed_event 548 | collection.add(completed_event, None) 549 | 550 | nbr_alarms = idx + 1 - 2 551 | alarms = collection.get_due_alarms(start) 552 | self.assertEqual(len(alarms), nbr_alarms) 553 | 554 | for idx, day in enumerate(range(15, 20)): 555 | start = dt.datetime(2019, 3, day, 17, 0, tzinfo=pytz.UTC) 556 | with self.subTest(start): 557 | alarms = collection.get_due_alarms(start) 558 | self.assertEqual(len(alarms), nbr_alarms + idx + 1) 559 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = remhind 3 | version = 0.1.1 4 | description = A daemon to display notifications of iCalendar events 5 | long-description = file:README.md 6 | long-description-content-type = text/markdown 7 | license = GPL-3 8 | license_file = LICENSE 9 | classifiers = 10 | License :: OSI Approved :: GNU General Public License v3 (GPLv3) 11 | Programming Language :: Python :: 3 12 | Operating System :: POSIX 13 | Topic :: Utilities 14 | Topic :: Office/Business :: Scheduling 15 | author = Nicolas Évrard 16 | author-email = nicoe@openhex.org 17 | test-suite = remhind.tests 18 | 19 | [options] 20 | zip-safe = True 21 | packages = find: 22 | install-requires = 23 | aionotify 24 | icalendar 25 | python-dateutil 26 | pyinotify 27 | PyGObject 28 | toml 29 | tzlocal 30 | xdg 31 | test-require = 32 | freezegun 33 | 34 | [options.entry_points] 35 | console-scripts = 36 | remhind = remhind.__main__:main 37 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup 2 | 3 | setup() 4 | --------------------------------------------------------------------------------