commit d66d5f1ac170337a3f422302ce31e1b9422dc485 Author: Robert Carosi Date: Sat Oct 16 18:09:38 2021 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c2065bc --- /dev/null +++ b/.gitignore @@ -0,0 +1,37 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc9a6ab --- /dev/null +++ b/README.md @@ -0,0 +1,88 @@ +![Example article](assets/logo-title.png) + +*Remarkable Pocket* synchronizes articles from [Pocket](https://getpocket.com) to your [Remarkable](https://remarkable.com/) tablet. It can be run on your computer or on a server. Because it does not run on the device itself this approach saves battery life, and is resistant to Remarkable software updates. + +An example run of the program can be found below: + +``` +[2021-11-02 14:21:22] Starting sync... +[2021-11-02 14:21:25] Found 1 read article(s) on Remarkable. +[2021-11-02 14:21:25] (1/1) Marking 'Getting Unstuck' as read on Pocket... +[2021-11-02 14:21:25] (1/1) Deleting 'Getting Unstuck' from Remarkable... +[2021-11-02 14:21:27] Downloading 5 unread article(s) from Pocket (257 in total). +[2021-11-02 14:21:27] (1/5) Downloading: 'What Modules Are About'. +[2021-11-02 14:21:33] (2/5) Downloading: 'Pursue High-quality Leisure'. +[2021-11-02 14:21:39] (3/5) Downloading: 'Hunting down a C memory leak in a Go program'. +[2021-11-02 14:21:45] (4/5) Downloading: 'Beginner's Guide To Abstraction'. +[2021-11-02 14:22:03] (5/5) Downloading: 'Timer Modules in Microcontrollers'. +[2021-11-02 14:22:03] No content found. Skipping... +[2021-11-02 14:22:15] (6/5) Downloading: 'SSH Tunneling Explained'. +[2021-11-02 14:22:33] Uploading 5 article(s) to Remarkable. +[2021-11-02 14:22:33] (1/5) Uploading: 'What Modules Are About.epub'. +[2021-11-02 14:22:34] (2/5) Uploading: 'Pursue High-quality Leisure.epub'. +[2021-11-02 14:22:34] (3/5) Uploading: 'Hunting down a C memory leak in a Go program.epub'. +[2021-11-02 14:22:34] (4/5) Uploading: 'Beginner's Guide To Abstraction.epub'. +[2021-11-02 14:22:34] (5/5) Uploading: 'SSH Tunneling Explained.epub'. +[2021-11-02 14:22:35] Completed sync in 1m 13s. +[2021-11-02 14:22:35] Next sync in 30m. +``` + +
Click here to see what a downloaded article looks like on the Remarkable. +An example article on the Remarkable. +
+ +## Features +- **No installation required.** The application can be run with a single command. +- **Works on Remarkable 1 and 2.** +- **Full support for images, code blocks, and formulas.** +- **Articles are downloaded as epubs.** This allows you to customize the font, font size, margins, etc. +- **Automatically archive read articles on Pocket.** When you finish reading an article and close it while on the last page, it will be automatically deleted from the Remarkable and archived on Pocket. A new unread article will be downloaded in its place. +- **Download articles from Pocket with a given tag.** If a `tag-filter` (see [Configuration](#configuration)) is supplied then only articles with that tag will be downloaded. + +## Usage +The easiest way to run the application is using Docker. First install Docker for your platform from https://docs.docker.com/get-docker/. Then run the following command to start the application on Linux or Mac (I have not tested it on Windows yet): + +``` +touch ~/.remarkable-pocket && docker run -it --env TZ=$(date +%Z) -p 65112:65112 -v ~/.remarkable-pocket:/root/.remarkable-pocket ghcr.io/nov1n/remarkable-pocket:0.0.1 +``` +The first time you run the application, you will be asked to authorize Pocket and Remarkable Cloud. Once you have done this subsequent runs will read the credentials from the `~/.remarkable-pocket` file. + +By default articles are synchronized to the `/Pocket/` directory on the Remarkable every 30 minutes. + + +## Configuration +The default configuration can be changed by providing command-line arguments. Simply append these to the `docker run` command. Below is a list of all available options. +``` +Usage: remarkable-pocket [-hnorV] [-d=] [-f=] [-i=] [-l=] +Synchronizes articles from Pocket to the Remarkable tablet. + -f, --tag-filter= + Only download Pocket articles with the this tag. + -o, --run-once Run the synchronization once and then exit. + -n, --no-archive Don't archive read articles. + -l, --article-limit= + The maximum number of Pocket articles to be present on the Remarkable. + Default: 10 + -i, --interval= The interval between subsequent synchronizations. + Default: 30m + -r, --reset-credentials Reset all credentials. + -d, --storage-dir= + The storage directory on the Remarkable in which to store downloaded Pocket articles. + Default: /Pocket/ + -h, --help Show this help message and exit. + -V, --version Print version information and exit. + +``` + +## Limitations +- Articles behind a paywall cannot be downloaded. +- Articles that use javascript to load the the content cannot be downloaded. + +## Thanks +- https://epub.press/ for providing a free epub generator API. Consider donating to support this project. +- https://github.com/juruen/rmapi for providing a Java API for the Remarkable Cloud. + +## Support +[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/nov1n) if you want to say thanks. :-) + +## Disclaimer +The author(s) and contributor(s) are not associated with reMarkable AS, Norway. reMarkable is a registered trademark of reMarkable AS in some countries. Please see https://remarkable.com for their product. diff --git a/assets/article-small.jpg b/assets/article-small.jpg new file mode 100644 index 0000000..39d8217 Binary files /dev/null and b/assets/article-small.jpg differ diff --git a/assets/article.jpg b/assets/article.jpg new file mode 100644 index 0000000..ce5638c Binary files /dev/null and b/assets/article.jpg differ diff --git a/assets/logo-icon.png b/assets/logo-icon.png new file mode 100644 index 0000000..9701577 Binary files /dev/null and b/assets/logo-icon.png differ diff --git a/assets/logo-title.png b/assets/logo-title.png new file mode 100644 index 0000000..d65ac90 Binary files /dev/null and b/assets/logo-title.png differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..8b2abf7 Binary files /dev/null and b/assets/logo.png differ diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..f9a0e0c --- /dev/null +++ b/build.gradle @@ -0,0 +1,60 @@ +plugins { + id "org.springframework.boot" version "2.5.5" + id "io.spring.dependency-management" version "1.0.11.RELEASE" + id "com.google.cloud.tools.jib" version "3.1.4" + id "com.github.johnrengelman.shadow" version "7.1.0" + id "java" +} + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +jib { + from { + image = "azul/zulu-openjdk-alpine:17-jre-headless" + } + container { + jvmFlags = ["-Xshare:auto", "-XX:TieredStopAtLevel=1", "-XX:CICompilerCount=1", "-XX:+UseSerialGC", "-Xmx512m"] + format = "OCI" + } + to { + image = "ghcr.io/nov1n/remarkable-pocket" + tags = ["0.0.1"] + } +} + +group = "nl.carosi" +version = "0.0.1" + +repositories { + mavenCentral() + mavenLocal() + maven { + url "https://jitpack.io" + } +} + +dependencies { + implementation("com.positiondev.epublib:epublib-core:3.1") { + exclude group: "org.slf4j" + } + implementation("es.jlarriba:jrmapi:0.7") { + exclude group: "org.apache.logging.log4j" + } + implementation "net.lingala.zip4j:zip4j:1.2.4" + implementation "info.picocli:picocli:4.6.1" + implementation "com.fasterxml.jackson.core:jackson-core:2.13.0" + implementation "com.google.guava:guava:31.0.1-jre" + implementation "com.github.tchudyk:pocket-integration:1.2.0" + implementation "org.springframework:spring-aspects:5.3.11" + implementation "org.springframework.retry:spring-retry:1.3.1" + implementation "org.springframework.boot:spring-boot-starter-web:2.5.5" + testImplementation "org.springframework.boot:spring-boot-starter-test:2.5.5" +} + +test { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..7454180 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..ffed3a2 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.2-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..0b64e17 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'remarkable-pocket' diff --git a/src/main/java/nl/carosi/remarkablepocket/ArticleDownloader.java b/src/main/java/nl/carosi/remarkablepocket/ArticleDownloader.java new file mode 100644 index 0000000..85e3019 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/ArticleDownloader.java @@ -0,0 +1,178 @@ +package nl.carosi.remarkablepocket; + +import static java.nio.file.StandardOpenOption.CREATE; +import static java.nio.file.StandardOpenOption.TRUNCATE_EXISTING; +import static java.nio.file.StandardOpenOption.WRITE; + +import com.google.common.annotations.VisibleForTesting; +import com.google.common.io.CharStreams; +import java.io.BufferedReader; +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.io.OutputStream; +import java.io.UncheckedIOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.Optional; +import nl.carosi.remarkablepocket.model.Article; +import nl.siegmann.epublib.domain.Book; +import nl.siegmann.epublib.domain.Resource; +import nl.siegmann.epublib.domain.Resources; +import nl.siegmann.epublib.domain.SpineReference; +import nl.siegmann.epublib.epub.EpubReader; +import nl.siegmann.epublib.epub.EpubWriter; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.web.client.RestTemplateBuilder; +import org.springframework.http.HttpMethod; +import org.springframework.retry.annotation.Backoff; +import org.springframework.retry.annotation.Retryable; +import org.springframework.web.client.RestTemplate; + +class ArticleDownloader { + public static final String POCKET_ID_SEPARATOR = "\t\t\t"; + + private static final Logger LOG = LoggerFactory.getLogger(ArticleDownloader.class); + private static final String BASE_URL = "https://epub.press/api/v1/books"; + private static final String DOWNLOAD_URL_TEMPL = BASE_URL + "/%s/download"; + private static final String STATUS_URL_TEMPL = BASE_URL + "/%s/status"; + // Interval between epub press download retries. + private static final int RETRY_INTERVAL = 5000; + // Minimum character count for an epub to be considered valid. + private static final int MIN_VALID_CONTENT_SIZE = 4000; + private static final List UNWANTED_RESOURCES = + List.of( + "cover.xhtml", + "images/cover.png", + "content/s2.xhtml", // References + "content/toc.xhtml", // Table of contents + "toc.ncx"); + + private final RestTemplate restTemplate; + private final EpubReader epubReader; + private final EpubWriter epubWriter; + // Required to call @Retryable method from the same class. + @Autowired private ArticleDownloader self; + + public ArticleDownloader( + RestTemplateBuilder restTemplateBuilder, EpubReader epubReader, EpubWriter epubWriter) { + this.restTemplate = restTemplateBuilder.build(); + this.epubReader = epubReader; + this.epubWriter = epubWriter; + } + + Optional tryDownload(Article article, Path storageDir) { + Path downloadPath = storageDir.resolve(article.title() + "." + getFileType()); + + DownloadRequest req = + new DownloadRequest( + article.url(), + "Pocket" + + POCKET_ID_SEPARATOR + + article.id(), // Hide Pocket ID from the Remarkable UI. + new String[] {article.url()}); + String downloadId = restTemplate.postForObject(BASE_URL, req, DownloadResponse.class).id(); + self.waitUntilReady(downloadId); + + try (OutputStream downloadStream = + Files.newOutputStream(downloadPath, CREATE, WRITE, TRUNCATE_EXISTING)) { + restTemplate.execute( + String.format(DOWNLOAD_URL_TEMPL, downloadId), + HttpMethod.GET, + null, + res -> res.getBody().transferTo(downloadStream)); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + + try { + formatEpub(downloadPath, article.title()); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + + return isValid(downloadPath) ? Optional.of(downloadPath) : Optional.empty(); + } + + String getFileType() { + return "epub"; + } + + private boolean isValid(Path article) { + Resource resource; + try (InputStream articleStream = Files.newInputStream(article)) { + resource = + epubReader + .readEpub(articleStream) + .getResources() + .getResourceMap() + .get("content/s1.xhtml"); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + + try (BufferedReader contentReader = + new BufferedReader( + new InputStreamReader( + resource.getInputStream(), resource.getInputEncoding()))) { + String content = CharStreams.toString(contentReader); + boolean isValid = content.length() > MIN_VALID_CONTENT_SIZE; + if (!isValid) { + LOG.warn("No content found. Skipping..."); + } + return isValid; + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + + @Retryable( + value = RuntimeException.class, + maxAttempts = 10, + backoff = @Backoff(delay = RETRY_INTERVAL)) + @VisibleForTesting + void waitUntilReady(String downloadId) { + StatusResponse res = + restTemplate.getForObject( + String.format(STATUS_URL_TEMPL, downloadId), StatusResponse.class); + int progress = res.progress(); + LOG.debug( + "Status: {} progress: {}%. Retrying in {}ms.", + res.message(), progress, RETRY_INTERVAL); + if (progress != 100) { + throw new RuntimeException(); + } + } + + private void formatEpub(Path path, String title) throws IOException { + Book book; + try (InputStream epubStream = Files.newInputStream(path)) { + book = epubReader.readEpub(epubStream); + } + book.getMetadata().setTitles(List.of(title)); + Resources resources = book.getResources(); + for (String href : UNWANTED_RESOURCES) { + resources.remove(href); + } + List spineReferences = + book.getSpine().getSpineReferences().stream() + .filter(e -> e.getResourceId().equals("s1")) + .toList(); + book.getSpine().setSpineReferences(spineReferences); + book.setCoverImage(resources.getByHref("content/s1.xhtml")); + // TODO: Remove navpoints and fix play order to start at 1, use a xml parser lib + // TODO: Remove guide element from ocx file + try (OutputStream bookStream = Files.newOutputStream(path)) { + epubWriter.write(book, bookStream); + } + } + + private final record DownloadRequest(String author, String publisher, String[] urls) {} + + private final record DownloadResponse(String id) {} + + private final record StatusResponse(String message, int progress) {} +} diff --git a/src/main/java/nl/carosi/remarkablepocket/DownloadService.java b/src/main/java/nl/carosi/remarkablepocket/DownloadService.java new file mode 100644 index 0000000..bae4c24 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/DownloadService.java @@ -0,0 +1,71 @@ +package nl.carosi.remarkablepocket; + +import com.google.common.collect.Streams; +import java.io.IOException; +import java.io.UncheckedIOException; +import java.nio.file.DirectoryStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.HashSet; +import java.util.List; +import java.util.Optional; +import javax.annotation.PostConstruct; +import nl.carosi.remarkablepocket.model.Article; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +final class DownloadService { + private static final Logger LOG = LoggerFactory.getLogger(DownloadService.class); + + private final ArticleDownloader downloader; + private final HashSet
invalidArticles = new HashSet<>(); + private Path storageDir; + + DownloadService(ArticleDownloader downloader) { + this.downloader = downloader; + } + + @PostConstruct + void createStorageDir() throws IOException { + storageDir = Files.createTempDirectory(null); + } + + @SuppressWarnings("UnstableApiUsage") + List download(List
articles, int limit) { + int pocketCount = articles.size(); + long total = Math.min(pocketCount, limit); + LOG.info("Downloading {} unread article(s) from Pocket ({} in total).", total, pocketCount); + return Streams.mapWithIndex(articles.stream(), (e, i) -> logProgress(e, i, total)) + .filter(e -> !invalidArticles.contains(e)) + .map(this::tryDownload) + .flatMap(Optional::stream) + .limit(limit) + .toList(); + } + + private Optional tryDownload(Article e) { + Optional path = downloader.tryDownload(e, storageDir); + if (path.isEmpty()) { + invalidArticles.add(e); + } + return path; + } + + private Article logProgress(Article article, long index, long total) { + LOG.info("({}/{}) Downloading: '{}'.", index + 1, total, article.title()); + return article; + } + + void clearDownloads() throws IOException { + try (DirectoryStream paths = + Files.newDirectoryStream(storageDir, "*." + downloader.getFileType())) { + for (Path p : paths) { + try { + Files.delete(p); + } catch (IOException e) { + throw new UncheckedIOException(e); + } + } + } + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/MetadataProvider.java b/src/main/java/nl/carosi/remarkablepocket/MetadataProvider.java new file mode 100644 index 0000000..75330f9 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/MetadataProvider.java @@ -0,0 +1,76 @@ +package nl.carosi.remarkablepocket; + +import static nl.carosi.remarkablepocket.ArticleDownloader.POCKET_ID_SEPARATOR; + +import com.fasterxml.jackson.annotation.JsonIgnoreProperties; +import com.fasterxml.jackson.databind.ObjectMapper; +import es.jlarriba.jrmapi.Jrmapi; +import es.jlarriba.jrmapi.model.Document; +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import javax.annotation.PostConstruct; +import net.lingala.zip4j.core.ZipFile; +import net.lingala.zip4j.exception.ZipException; +import net.lingala.zip4j.io.ZipInputStream; +import net.lingala.zip4j.model.FileHeader; +import nl.carosi.remarkablepocket.model.DocumentMetadata; +import nl.siegmann.epublib.epub.EpubReader; + +final class MetadataProvider { + private final Jrmapi rmapi; + private final EpubReader epubReader; + private final ObjectMapper objectMapper; + private Path workDir; + + public MetadataProvider(Jrmapi rmapi, EpubReader epubReader, ObjectMapper objectMapper) { + this.rmapi = rmapi; + this.epubReader = epubReader; + this.objectMapper = objectMapper; + } + + @PostConstruct + void createWorkDir() throws IOException { + workDir = Files.createTempDirectory(null); + } + + DocumentMetadata getMetadata(Document doc) { + ZipFile zip; + String fileHash; + try { + zip = new ZipFile(rmapi.fetchZip(doc, workDir.toString() + File.separator)); + fileHash = getFileHash(zip); + } catch (ZipException e) { + throw new RuntimeException(e); + } + + try (ZipInputStream lines = zip.getInputStream(zip.getFileHeader(fileHash + ".content")); + ZipInputStream epub = zip.getInputStream(zip.getFileHeader(fileHash + ".epub"))) { + int pageCount = objectMapper.readValue(lines, Lines.class).pageCount(); + String pocketId = extractPocketId(epub).split(POCKET_ID_SEPARATOR)[1]; + return new DocumentMetadata(doc, pageCount, pocketId); + } catch (ZipException | IOException e) { + throw new RuntimeException(e); + } + } + + private String getFileHash(ZipFile zip) throws ZipException { + @SuppressWarnings("unchecked") + List fileHeaders = + zip.getFileHeaders().stream().map(FileHeader.class::cast).toList(); + return fileHeaders.stream() + .findFirst() + .map(e -> e.getFileName().split("\\.")[0]) + .orElseThrow(() -> new RuntimeException("Zip file is empty")); + } + + private String extractPocketId(ZipInputStream epub) throws IOException { + // When creating the book the pocket ID was stored in the publisher's metadata field. + return epubReader.readEpub(epub).getMetadata().getPublishers().get(0); + } + + @JsonIgnoreProperties(ignoreUnknown = true) + private final record Lines(int pageCount) {} +} diff --git a/src/main/java/nl/carosi/remarkablepocket/PocketService.java b/src/main/java/nl/carosi/remarkablepocket/PocketService.java new file mode 100644 index 0000000..c90bbf5 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/PocketService.java @@ -0,0 +1,67 @@ +package nl.carosi.remarkablepocket; + +import java.io.IOException; +import java.util.List; +import java.util.function.Consumer; +import java.util.stream.Collectors; +import javax.annotation.PostConstruct; +import nl.carosi.remarkablepocket.model.Article; +import org.springframework.beans.factory.annotation.Value; +import pl.codeset.pocket.Pocket; +import pl.codeset.pocket.PocketAuth; +import pl.codeset.pocket.PocketAuthFactory; +import pl.codeset.pocket.modify.ArchiveAction; +import pl.codeset.pocket.modify.ModifyItemCmd; +import pl.codeset.pocket.read.ContentType; +import pl.codeset.pocket.read.DetailType; +import pl.codeset.pocket.read.GetItemsCmd; +import pl.codeset.pocket.read.ItemState; +import pl.codeset.pocket.read.PocketItem; +import pl.codeset.pocket.read.Sort; + +final class PocketService { + static final String CONSUMER_KEY = "99428-51e4648a4528a1faa799c738"; + + private final String accessToken; + private final String tagFilter; + private Pocket pocket; + + public PocketService( + @Value("${pocket.access-token}") String accessToken, + @Value("${pocket.tag-filter}") String tagFilter) { + this.accessToken = accessToken; + this.tagFilter = tagFilter; + } + + static String getAccessToken(String redirectUrl, Consumer prompt) throws IOException { + PocketAuthFactory factory = PocketAuthFactory.create(CONSUMER_KEY, redirectUrl); + prompt.accept(factory.getAuthUrl()); + PocketAuth pocketAuth = factory.create(); + return pocketAuth.getAccessToken(); + } + + @PostConstruct + private void auth() { + PocketAuth pocketAuth = PocketAuthFactory.createForAccessToken(CONSUMER_KEY, accessToken); + this.pocket = new Pocket(pocketAuth); + } + + List
getArticles() throws IOException { + GetItemsCmd cmd = + new GetItemsCmd.Builder() + .contentType(ContentType.article) + .detailType(DetailType.simple) + .tag(tagFilter) + .state(ItemState.unread) + .sort(Sort.newest) + .build(); + List unreads = pocket.getItems(cmd).getList(); + return unreads.stream() + .map(e -> Article.of(e.getResolvedId(), e.getResolvedUrl(), e.getResolvedTitle())) + .collect(Collectors.toList()); + } + + void archive(String id) throws IOException { + pocket.modify(new ModifyItemCmd.Builder().action(new ArchiveAction(id)).build()); + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/RemarkableService.java b/src/main/java/nl/carosi/remarkablepocket/RemarkableService.java new file mode 100644 index 0000000..5fd6b99 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/RemarkableService.java @@ -0,0 +1,94 @@ +package nl.carosi.remarkablepocket; + +import static com.google.common.base.Preconditions.checkArgument; + +import es.jlarriba.jrmapi.Jrmapi; +import es.jlarriba.jrmapi.model.Document; +import java.nio.file.Path; +import java.util.List; +import java.util.stream.Stream; +import javax.annotation.PostConstruct; +import nl.carosi.remarkablepocket.model.DocumentMetadata; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; + +final class RemarkableService { + private static final Logger LOG = LoggerFactory.getLogger(RemarkableService.class); + private final Jrmapi rmapi; + private final MetadataProvider metadataProvider; + private final String rmStorageDir; + private String rmStorageDirId = ""; + + public RemarkableService( + Jrmapi rmapi, + MetadataProvider metadataProvider, + @Value("${rm.storage-dir}") String rmStorageDir) { + if(!rmStorageDir.endsWith("/")) { + rmStorageDir += "/"; + } + checkArgument( + rmStorageDir.matches("^/([^:/\\\\*\"?|<>.']+/)+$"), + "Invalid Remarkable storage dir. A valid example is: '/Articles/Pocket/'."); + this.rmapi = rmapi; + this.metadataProvider = metadataProvider; + this.rmStorageDir = rmStorageDir; + } + + @PostConstruct + void findParentId() { + String[] dirs = rmStorageDir.substring(1, rmStorageDir.length() - 1).split("/"); + for (final String dir : dirs) { + rmStorageDirId = + rmapi.listDocs().stream() + .filter(e -> e.getParent().equals(rmStorageDirId)) + .filter(e -> e.getVissibleName().equals(dir)) + .findFirst() + .map(Document::getID) + .orElseGet(() -> rmapi.createDir(dir, rmStorageDirId)); + } + } + + List listDocumentNames() { + return docsStream().map(Document::getVissibleName).toList(); + } + + List listReadDocuments() { + return docsStream() + .map(metadataProvider::getMetadata) + .peek(this::logPages) + // Current page starts counting at 0. + .filter(e -> e.doc().getCurrentPage() + 1 == e.pageCount()) + .toList(); + } + + void upload(List paths) { + LOG.info("Uploading {} article(s) to Remarkable.", paths.size()); + int total = paths.size(); + for (int i = 0; i < total; i++) { + Path path = paths.get(i); + LOG.info("({}/{}) Uploading: '{}'.", i + 1, total, path.getFileName()); + upload(path); + } + } + + void delete(Document doc) { + rmapi.deleteEntry(doc); + } + + private void logPages(DocumentMetadata meta) { + LOG.debug( + "{}: Current page: {}, page count: {}", + meta.doc().getVissibleName(), + meta.doc().getCurrentPage() + 1, + meta.pageCount()); + } + + private Stream docsStream() { + return rmapi.listDocs().stream().filter(e -> e.getParent().equals(rmStorageDirId)); + } + + private void upload(Path path) { + rmapi.uploadDoc(path.toFile(), rmStorageDirId); + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/SyncApplication.java b/src/main/java/nl/carosi/remarkablepocket/SyncApplication.java new file mode 100644 index 0000000..c7c3cf1 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/SyncApplication.java @@ -0,0 +1,31 @@ +package nl.carosi.remarkablepocket; + +import es.jlarriba.jrmapi.Jrmapi; +import nl.siegmann.epublib.epub.EpubReader; +import nl.siegmann.epublib.epub.EpubWriter; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Import; +import org.springframework.retry.annotation.EnableRetry; +import org.springframework.scheduling.annotation.EnableScheduling; + +@SpringBootApplication +@EnableScheduling +@EnableRetry +@Import({ + ArticleDownloader.class, + DownloadService.class, + EpubReader.class, + EpubWriter.class, + MetadataProvider.class, + PocketService.class, + RemarkableService.class, + SyncService.class, +}) +public class SyncApplication { + @Bean + Jrmapi jrmapi(@Value("${rm.device-token}") String deviceToken) { + return new Jrmapi(deviceToken); + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/SyncCommand.java b/src/main/java/nl/carosi/remarkablepocket/SyncCommand.java new file mode 100644 index 0000000..da26265 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/SyncCommand.java @@ -0,0 +1,255 @@ +package nl.carosi.remarkablepocket; + +import static java.util.Map.entry; +import static java.util.UUID.randomUUID; +import static java.util.concurrent.TimeUnit.MINUTES; +import static nl.carosi.remarkablepocket.PocketService.getAccessToken; +import static org.springframework.boot.Banner.Mode.OFF; +import static org.springframework.boot.WebApplicationType.NONE; +import static picocli.CommandLine.Help.Visibility.ALWAYS; + +import com.sun.net.httpserver.HttpExchange; +import com.sun.net.httpserver.HttpHandler; +import com.sun.net.httpserver.HttpServer; +import es.jlarriba.jrmapi.Authentication; +import java.io.Console; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; +import java.io.PrintStream; +import java.net.InetSocketAddress; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.Map; +import java.util.Properties; +import java.util.concurrent.Callable; +import java.util.concurrent.ExecutorService; +import java.util.concurrent.Executors; +import java.util.function.Consumer; +import org.springframework.boot.builder.SpringApplicationBuilder; +import picocli.CommandLine; +import picocli.CommandLine.Command; +import picocli.CommandLine.Option; + +@Command( + name = "sync", + description = "Synchronizes articles from Pocket to the Remarkable tablet.", + sortOptions = false, + usageHelpAutoWidth = true, + version = "0.1", + mixinStandardHelpOptions = true) +class SyncCommand implements Callable { + // TODO: Add default error converter + @Option( + names = {"-f", "--tag-filter"}, + description = "Only download Pocket articles with the this tag.", + arity = "1", + defaultValue = "") + private String tagFilter; + + @Option( + names = {"-o", "--run-once"}, + description = "Run the synchronization once and then exit.", + arity = "0") + private boolean runOnce; + + @Option( + names = {"-n", "--no-archive"}, + description = "Don't archive read articles.", + arity = "0") + private boolean noArchive; + + @Option( + names = {"-l", "--article-limit"}, + description = "The maximum number of Pocket articles to be present on the Remarkable.", + arity = "1", + defaultValue = "10", + showDefaultValue = ALWAYS) + private String articleLimit; + + @Option( + names = {"-i", "--interval"}, + description = "The interval between subsequent synchronizations.", + arity = "1", + defaultValue = "30m", + showDefaultValue = ALWAYS) + private String interval; + + @Option( + names = {"-r", "--reset-credentials"}, + description = "Reset all credentials.", + arity = "0") + private boolean resetCredentials; + + @Option( + names = {"-d", "--storage-dir"}, + description = + "The storage directory on the Remarkable in which to store downloaded Pocket articles.", + arity = "1", + defaultValue = "/Pocket/", + showDefaultValue = ALWAYS) + private String storageDir; + + @Option( + names = {"-a", "--auth-file"}, + description = "The file in which to store the authentication credentials.", + arity = "1", + defaultValue = "~/.remarkable-pocket", + hidden = true) + private String authFile; + + @Option( + names = {"-p", "--port"}, + description = "The port for the authorization callback server.", + arity = "1", + defaultValue = "65112", + hidden = true) + private int port; + + public static void main(String... args) { + new CommandLine(new SyncCommand()).execute(args); + } + + @Override + public Integer call() throws IOException { + Map cliProperties = + Map.ofEntries( + entry("pocket.archive-read", Boolean.toString(!noArchive)), + entry("rm.storage-dir", storageDir), + entry("rm.article-limit", articleLimit), + entry("sync.interval", "PT" + interval), + entry("sync.run-once", Boolean.toString(runOnce)), + entry("pocket.tag-filter", tagFilter)); + + new SpringApplicationBuilder(SyncApplication.class) + .logStartupInfo(false) + .profiles("default") + .bannerMode(OFF) + .web(NONE) + .properties(cliProperties) + .properties(authProperties()) + .run(); + + return 0; + } + + private Properties authProperties() throws IOException { + Path authFilePath = Path.of(authFile.replaceFirst("^~", System.getProperty("user.home"))); + Path authDirPath = authFilePath.getParent(); + if (Files.notExists(authDirPath)) { + Files.createDirectories(authDirPath); + } + + if (Files.exists(authFilePath) && Files.size(authFilePath) > 0 && !resetCredentials) { + Properties properties = new Properties(); + try (InputStream authStream = Files.newInputStream(authFilePath)) { + properties.load(authStream); + } + return properties; + } else { + return createAuthProperties(authFilePath); + } + } + + private Properties createAuthProperties(Path authFilePath) throws IOException { + Console console = System.console(); + if (console == null) { + System.out.println( + "No console found. If you're using Docker please add the '-it' flags.\n"); + System.exit(1); + } + + console.printf(""" + Welcome to Remarkable Pocket! + Please follow the next steps to connect your Pocket and Remarkable accounts. You only need to do this once. + + """); + + PrintStream origOut = System.out; + System.setOut(debugFilteringStream()); + String rmDeviceToken = obtainRmDeviceToken(console); + System.setOut(origOut); + + String pocketAccessToken = obtainPocketAccessToken(console); + + Properties properties = new Properties(); + properties.setProperty("pocket.access-token", pocketAccessToken); + properties.setProperty("rm.device-token", rmDeviceToken); + try (OutputStream authStream = Files.newOutputStream(authFilePath)) { + properties.store(authStream, null); + } + return properties; + } + + // Hack to filter and format third-party logging until Spring is initialized. + private PrintStream debugFilteringStream() { + return new PrintStream(System.out) { + @Override + public void write(byte[] buf) { + String msg = new String(buf, StandardCharsets.UTF_8); + if(!msg.contains("DEBUG")) { + super.print(msg.split("- ")[1]); + } + } + + }; + } + + private String obtainRmDeviceToken(Console console) { + String rmDeviceToken = null; + while (rmDeviceToken == null) { + String rmCloudCode = + console.readLine( + "Paste the code from https://my.remarkable.com/device/desktop/connect: "); + console.printf("Verifying... "); + rmDeviceToken = new Authentication().registerDevice(rmCloudCode, randomUUID()); + } + console.printf("Success!\n"); + return rmDeviceToken; + } + + private String obtainPocketAccessToken(Console console) throws IOException { + HttpServer server = HttpServer.create(new InetSocketAddress(port), 0); + ExecutorService execService = Executors.newSingleThreadExecutor(); + server.setExecutor(execService); + server.createContext("/redirect", new RedirectHandler(server, execService)); + server.start(); + Consumer waitForUserAuth = + authUrl -> { + console.printf("Now visit %s and authorize this application.\n\n", authUrl); + try { + boolean terminated = execService.awaitTermination(1, MINUTES); + if (!terminated) { + throw new InterruptedException(); + } + } catch (InterruptedException e) { + console.printf("Pocket authorization timed out. Please try again.\n"); + System.exit(1); + } + }; + return getAccessToken("http://localhost:" + port + "/redirect", waitForUserAuth); + } + + private static final class RedirectHandler implements HttpHandler { + private final HttpServer server; + private final ExecutorService execService; + + RedirectHandler(HttpServer server, ExecutorService execService) { + this.server = server; + this.execService = execService; + } + + @Override + public void handle(HttpExchange exchange) throws IOException { + OutputStream outputStream = exchange.getResponseBody(); + String res = "Authorization completed!"; + exchange.sendResponseHeaders(200, res.length()); + outputStream.write(res.getBytes()); + outputStream.flush(); + outputStream.close(); + server.stop(0); + execService.shutdown(); + } + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/SyncService.java b/src/main/java/nl/carosi/remarkablepocket/SyncService.java new file mode 100644 index 0000000..c42dc47 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/SyncService.java @@ -0,0 +1,123 @@ +package nl.carosi.remarkablepocket; + +import static java.time.temporal.ChronoUnit.SECONDS; + +import java.io.IOException; +import java.nio.file.Path; +import java.time.Duration; +import java.time.Instant; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import nl.carosi.remarkablepocket.model.Article; +import nl.carosi.remarkablepocket.model.DocumentMetadata; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.SpringApplication; +import org.springframework.context.ApplicationContext; +import org.springframework.scheduling.annotation.Scheduled; + +final class SyncService { + private static final Logger LOG = LoggerFactory.getLogger(SyncService.class); + private final PocketService pocketService; + private final DownloadService downloadService; + private final RemarkableService remarkableService; + private final ApplicationContext appContext; + private final int articleLimit; + private final boolean archiveRead; + private final Duration syncInterval; + private final boolean runOnce; + + public SyncService( + PocketService pocketService, + DownloadService downloadService, + RemarkableService remarkableService, + ApplicationContext appContext, + @Value("${rm.article-limit}") int articleLimit, + @Value("${pocket.archive-read}") boolean archiveRead, + @Value("${sync.interval}") Duration syncInterval, + @Value("${sync.run-once}") boolean runOnce) { + this.pocketService = pocketService; + this.downloadService = downloadService; + this.remarkableService = remarkableService; + this.appContext = appContext; + this.articleLimit = articleLimit; + this.archiveRead = archiveRead; + this.syncInterval = syncInterval; + this.runOnce = runOnce; + } + + private static String humanReadable(Duration duration) { + return duration.truncatedTo(SECONDS) + .toString() + .substring(2) + .replaceAll("(\\d[HMS])(?!$)", "$1 ") + .toLowerCase(); + } + + @Scheduled(fixedDelayString = "${sync.interval}") + void sync() { + try { + syncImpl(); + } catch (IOException e) { + LOG.error("Error occurred during sync.", e); + } + + if (runOnce) { + LOG.info("Run-once option was set. Exiting."); + System.exit(SpringApplication.exit(appContext, () -> 0)); + } + + LOG.info("Next sync in {}.\n", humanReadable(syncInterval)); + } + + private void syncImpl() throws IOException { + LOG.info("Starting sync..."); + Instant start = Instant.now(); + if (archiveRead) { + archiveReadArticles(); + } + + Set articlesOnRm = Set.copyOf(remarkableService.listDocumentNames()); + int nArticlesOnRm = articlesOnRm.size(); + if (nArticlesOnRm >= articleLimit) { + LOG.info("No new articles synced. Remarkable already has {} article(s).", articleLimit); + return; + } + List
unsynced = + pocketService.getArticles().stream() + .filter(e -> !articlesOnRm.contains(e.title())) + .collect(Collectors.toList()); + if (unsynced.size() == 0) { + LOG.info("All Pocket articles are synced with Remarkable."); + return; + } + + downloadService.clearDownloads(); + List downloads = downloadService.download(unsynced, articleLimit - nArticlesOnRm); + remarkableService.upload(downloads); + LOG.info("Completed sync in {}.", humanReadable(Duration.between(start, Instant.now()))); + } + + private void archiveReadArticles() throws IOException { + List documents = remarkableService.listReadDocuments(); + int nDocs = documents.size(); + LOG.info("Found {} read article(s) on Remarkable.", nDocs); + for (int i = 0; i < nDocs; i++) { + DocumentMetadata doc = documents.get(i); + LOG.info( + "({}/{}) Marking '{}' as read on Pocket...", + i+1, + nDocs, + doc.doc().getVissibleName()); + pocketService.archive(doc.pocketId()); + LOG.info( + "({}/{}) Deleting '{}' from Remarkable...", + i+1, + nDocs, + doc.doc().getVissibleName()); + remarkableService.delete(doc.doc()); + } + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/model/Article.java b/src/main/java/nl/carosi/remarkablepocket/model/Article.java new file mode 100644 index 0000000..0658477 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/model/Article.java @@ -0,0 +1,12 @@ +package nl.carosi.remarkablepocket.model; + + +public final record Article(String id, String url, String title) { + public static Article of(String id, String url, String title) { + return new Article(id, url, sanitize(title)); + } + + private static String sanitize(String title) { + return title.replaceAll("/", " ").replaceAll(" +", " ").strip(); + } +} diff --git a/src/main/java/nl/carosi/remarkablepocket/model/DocumentMetadata.java b/src/main/java/nl/carosi/remarkablepocket/model/DocumentMetadata.java new file mode 100644 index 0000000..0aad100 --- /dev/null +++ b/src/main/java/nl/carosi/remarkablepocket/model/DocumentMetadata.java @@ -0,0 +1,5 @@ +package nl.carosi.remarkablepocket.model; + +import es.jlarriba.jrmapi.model.Document; + +public final record DocumentMetadata(Document doc, int pageCount, String pocketId) {} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..dd77ebe --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1,3 @@ +logging.level.nl.siegmann.epublib=OFF +#logging.level.nl.carosi.remarkablepocket=DEBUG +logging.pattern.console=[%d{yyyy-MM-dd HH:mm:ss}] %clr(%m){faint}%n diff --git a/src/test/java/nl/carosi/remarkablepocket/SyncCommandTests.java b/src/test/java/nl/carosi/remarkablepocket/SyncCommandTests.java new file mode 100644 index 0000000..ac9125a --- /dev/null +++ b/src/test/java/nl/carosi/remarkablepocket/SyncCommandTests.java @@ -0,0 +1,11 @@ +package nl.carosi.remarkablepocket; + +import org.junit.jupiter.api.Test; + +class SyncCommandTests { + @Test + void contextLoads() {} + + @Test + void test() {} +}