From: Niki Roo Date: Tue, 19 May 2020 19:22:46 +0000 (+0200) Subject: Merge commit '9e7330d793887fe9ee378ca1413141d7761e76ca' X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=commitdiff_plain;h=4a464a06db3158e31c64aa798ddce9df1ec7f5f5;hp=9e7330d793887fe9ee378ca1413141d7761e76ca Merge commit '9e7330d793887fe9ee378ca1413141d7761e76ca' --- diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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/Makefile.base b/Makefile.base new file mode 100644 index 0000000..0d365b8 --- /dev/null +++ b/Makefile.base @@ -0,0 +1,243 @@ +# Makefile base template +# +# Version: +# - 1.0.0: add a version comment +# - 1.1.0: add 'help', 'sjar' +# - 1.2.0: add 'apk' +# - 1.2.1: improve 'apk' and add 'android' +# - 1.3.0: add 'man' for man(ual) pages +# - 1.4.0: remove android stuff (not working anyway) +# - 1.5.0: include sources and readme/changelog in jar +# - 1.5.1: include binaries from libs/bin/ into the jar + +# Required parameters (the commented out ones are supposed to be per project): + +#MAIN = path to main java source to compile +#MORE = path to supplementary needed resources not linked from MAIN +#NAME = name of project (used for jar output file) +#PREFIX = usually /usr/local (where to install the program) +#TEST = path to main test source to compile +#JAR_FLAGS += a list of things to pack, each usually prefixed with "-C bin/" +#SJAR_FLAGS += a list of things to pack, each usually prefixed with "-C src/", +# for *-sources.jar files +#TEST_PARAMS = any parameter to pass to the test runnable when "test-run" + +JAVAC = javac +JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/ +JAVA = java +JAVA_FLAGS += -cp ./bin/ +JAR = jar +RJAR = java +RJAR_FLAGS += -jar + +all: build jar man + +help: + @echo "Usual options:" + @echo "==============" + @echo " make : to build the jar file and man pages IF possible" + @echo " make help : to get this help screen" + @echo " make libs : to update the libraries into src/" + @echo " make build : to update the binaries (not the jar)" + @echo " make test : to update the test binaries" + @echo " make build jar : to update the binaries and jar file" + @echo " make sjar : to create the sources jar file" + @echo " make clean : to clean the directory of intermediate files" + @echo " make mrpropre : to clean the directory of all outputs" + @echo " make run : to run the program from the binaries" + @echo " make run-test : to run the test program from the binaries" + @echo " make jrun : to run the program from the jar file" + @echo " make install : to install the application into $$PREFIX" + @echo " make ifman : to make the manual pages (if pandoc is found)" + @echo " make man : to make the manual pages (requires pandoc)" + +.PHONY: all clean mrproper mrpropre build run jrun jar sjar resources test-resources install libs ifman man love + +bin: + @mkdir -p bin + +jar: $(NAME).jar + +sjar: $(NAME)-sources.jar + +build: resources + @echo Compiling program... + @echo " src/$(MAIN)" + @$(JAVAC) $(JAVAC_FLAGS) "src/$(MAIN).java" + @[ "$(MORE)" = "" ] || for sup in $(MORE); do \ + echo " src/$$sup" ;\ + $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \ + done + +test: test-resources + @[ -e bin/$(MAIN).class ] || echo You need to build the sources + @[ -e bin/$(MAIN).class ] + @echo Compiling test program... + @[ "$(TEST)" != "" ] || echo No test sources defined. + @[ "$(TEST)" = "" ] || for sup in $(TEST); do \ + echo " src/$$sup" ;\ + $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \ + done + +clean: + rm -rf bin/ + @echo Removing sources taken from libs... + @for lib in libs/*-sources.jar libs/*-sources.patch.jar; do \ + if [ "$$lib" != 'libs/*-sources.jar' -a "$$lib" != 'libs/*-sources.patch.jar' ]; then \ + basename "$$lib"; \ + jar tf "$$lib" | while read -r ln; do \ + [ -f "src/$$ln" ] && rm "src/$$ln"; \ + done; \ + jar tf "$$lib" | tac | while read -r ln; do \ + [ -d "src/$$ln" ] && rmdir "src/$$ln" 2>/dev/null || true; \ + done; \ + fi \ + done + +mrproper: mrpropre + +mrpropre: clean + rm -f $(NAME).jar + rm -f $(NAME)-sources.jar + rm -f $(NAME).apk + rm -f $(NAME)-debug.apk + [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`.jar" + [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`-sources.jar" + +love: + @echo " ...not war." + +resources: libs + @echo Copying resources into bin/... + @cd src && find . | grep -v '\.java$$' | grep -v '/test/' | while read -r ln; do \ + if [ -f "$$ln" ]; then \ + dir="`dirname "$$ln"`"; \ + mkdir -p "../bin/$$dir" ; \ + cp "$$ln" "../bin/$$ln" ; \ + fi ; \ + done + @cp VERSION bin/ + +test-resources: resources + @echo Copying test resources into bin/... + @cd src && find . | grep -v '\.java$$' | grep '/test/' | while read -r ln; do \ + if [ -f "$$ln" ]; then \ + dir="`dirname "$$ln"`"; \ + mkdir -p "../bin/$$dir" ; \ + cp "$$ln" "../bin/$$ln" ; \ + fi ; \ + done + +libs: bin + @[ -e bin/libs -o ! -d libs ] || echo Extracting sources from libs... + @[ -e bin/libs -o ! -d libs ] || (cd src && for lib in ../libs/*-sources.jar ../libs/*-sources.patch.jar; do \ + if [ "$$lib" != '../libs/*-sources.jar' -a "$$lib" != '../libs/*-sources.patch.jar' ]; then \ + basename "$$lib"; \ + jar xf "$$lib"; \ + fi \ + done ) + @[ ! -d libs ] || touch bin/libs + +$(NAME)-sources.jar: libs + @ls *.md >/dev/null || cp VERSION README.md + @echo Making sources JAR file... + @echo > bin/manifest + @[ "$(SJAR_FLAGS)" != "" ] || echo No sources JAR file defined, skipping + @[ "$(SJAR_FLAGS)" = "" ] || echo Creating $(NAME)-sources.jar... + @[ "$(SJAR_FLAGS)" = "" ] || $(JAR) cfm $(NAME)-sources.jar bin/manifest -C ./ *.md $(SJAR_FLAGS) + @[ "$(SJAR_FLAGS)" = "" ] || [ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`-sources.jar"... + @[ "$(SJAR_FLAGS)" = "" ] || [ ! -e VERSION ] || cp $(NAME)-sources.jar "$(NAME)-`cat VERSION`-sources.jar" + +$(NAME).jar: resources + @[ -e bin/$(MAIN).class ] || echo You need to build the sources + @[ -e bin/$(MAIN).class ] + @ls *.md >/dev/null || cp VERSION README.md + @echo "Copying documentation into bin/..." + @cp -r *.md bin/ || cp VERSION bin/no-documentation.md + @[ ! -d libs/bin/ ] || echo "Copying additional binaries from libs/bin/ into bin/..." + @[ ! -d libs/bin/ ] || cp -r libs/bin/* bin/ + @echo "Copying sources into bin/..." + @cp -r src/* bin/ + @echo "Making jar..." + @echo "Main-Class: `echo "$(MAIN)" | sed 's:/:.:g'`" > bin/manifest + @echo >> bin/manifest + $(JAR) cfm $(NAME).jar bin/manifest -C ./ *.md $(JAR_FLAGS) + @[ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`.jar"... + @[ ! -e VERSION ] || cp $(NAME).jar "$(NAME)-`cat VERSION`.jar" + +run: + @[ -e bin/$(MAIN).class ] || echo You need to build the sources + @[ -e bin/$(MAIN).class ] + @echo Running "$(NAME)"... + $(JAVA) $(JAVA_FLAGS) $(MAIN) + +jrun: + @[ -e $(NAME).jar ] || echo You need to build the jar + @[ -e $(NAME).jar ] + @echo Running "$(NAME).jar"... + $(RJAR) $(RJAR_FLAGS) $(NAME).jar + +run-test: + @[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ] || echo You need to build the test sources + @[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ] + @echo Running tests for "$(NAME)"... + @[ "$(TEST)" != "" ] || echo No test sources defined. + [ "$(TEST)" = "" ] || ( clear ; $(JAVA) $(JAVA_FLAGS) $(TEST) $(TEST_PARAMS) ) + +install: + @[ -e $(NAME).jar ] || echo You need to build the jar + @[ -e $(NAME).jar ] + mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin" + cp $(NAME).jar "$(PREFIX)/lib/" + echo "#!/bin/sh" > "$(PREFIX)/bin/$(NAME)" + echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"\$$@\"" >> "$(PREFIX)/bin/$(NAME)" + chmod a+rx "$(PREFIX)/bin/$(NAME)" + if [ -e "man/man1/$(NAME).1" ]; then \ + cp -r man/ "$(PREFIX)"/share/; \ + fi + +ifman: + @if pandoc -v >/dev/null 2>&1; then \ + make man; \ + else \ + echo "man pages not generated: "'`'"pandoc' required"; \ + fi + +man: + @echo Checking for possible manual pages... + @if [ -e README.md ]; then \ + echo Sources found for man pages; \ + if pandoc -v >/dev/null 2>&1; then \ + ls README*.md 2>/dev/null \ + | grep 'README\(-..\|\)\.md' \ + | while read man; do \ + echo " Processing page $$lang..."; \ + lang="`echo "$$man" \ + | sed 's:README\.md:en:' \ + | sed 's:README-\(.*\)\.md:\1:'`"; \ + mkdir -p man/"$$lang"/man1; \ + ( \ + echo ".TH \"${NAME}\" 1 `\ + date +%Y-%m-%d\ + ` \"version `cat VERSION`\""; \ + echo; \ + UNAME="`echo "${NAME}" \ + | sed 's:\(.*\):\U\1:g'`"; \ + ( \ + cat "$$man" | head -n1 \ + | sed 's:.*(README\(-fr\|\)\.md).*::g'; \ + cat "$$man" | tail -n+2; \ + ) | sed 's:^#\(#.*\):\1:g' \ + | sed 's:^\(#.*\):\U\1:g;s:# *'"$$UNAME"':# NAME\n'"${NAME}"' \\- :g' \ + | sed 's:--:——:g' \ + | pandoc -f markdown -t man | sed 's:——:--:g' ; \ + ) > man/"$$lang"/man1/"${NAME}.1"; \ + done; \ + mkdir -p "man/man1"; \ + cp man/en/man1/"${NAME}".1 man/man1/; \ + else \ + echo "man pages generation: pandoc required" >&2; \ + false; \ + fi; \ + fi; + diff --git a/README-fr.md b/README-fr.md new file mode 100644 index 0000000..d6dbd8e --- /dev/null +++ b/README-fr.md @@ -0,0 +1,157 @@ +[English](README.md) Français + +# Fanfix + +Fanfix est un petit programme Java qui peut télécharger des histoires sur internet et les afficher hors ligne. + +## 🔴 Ceci est le programme serveur et command-line + +Vous pouvez aussi utiliser : +- le client graphique [Fanfix-swing](https://github.com/nikiroo/fanfix-swing/) +- le client en mode TUI [Fanfix-jexer](https://github.com/nikiroo/fanfix-jexer/) + +## Synopsis + +- ```fanfix``` --import [*URL*] +- ```fanfix``` --export [*id*] [*output_type*] [*target*] +- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info) +- ```fanfix``` --read [*id*] ([*chapter number*]) +- ```fanfix``` --read-url [*URL*] ([*chapter number*]) +- ```fanfix``` --search +- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*]) +- ```fanfix``` --search-tag +- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*]) +- ```fanfix``` --list +- ```fanfix``` --server [*key*] [*port*] +- ```fanfix``` --stop-server [*key*] [*port*] +- ```fanfix``` --remote [*key*] [*host*] [*port*] +- ```fanfix``` --help + +## Description + +(Si vous voulez juste voir les derniers changements, vous pouvez regarder le [Changelog](changelog-fr.md) -- remarquez que le programme affiche le changelog si une version plus récente est détectée depuis la version 1.4.0.) + +Le fonctionnement du programme est assez simple : il converti une URL venant d'un site supporté en un fichier .epub pour les histoires ou .cbz pour les comics (d'autres options d'enregistrement sont disponibles, comme du texte simple, du HTML...) + +Pour vous aider à organiser vos histoires, il peut aussi servir de bibliothèque locale vous permettant : + +- d'importer une histoire depuis son URL (ou depuis un fichier) +- d'exporter une histoire dans un des formats supportés vers un fichier +- d'afficher une histoire en mode texte +- via [fanfix-swing](https://github.com/nikiroo/fanfix-swing/): d'afficher une histoire en mode GUI **lui-même** ([fanfix-swing](https://github.com/nikiroo/fanfix-swing/)) ou **en appelant un programme natif pour lire le fichier** (potentiellement converti en HTML avant, pour que n'importe quel navigateur web puisse l'afficher) + +### Sites supportés + +Pour le moment, les sites suivants sont supportés : + +- http://FimFiction.net/ : fanfictions dévouées à la série My Little Pony +- http://Fanfiction.net/ : fanfictions venant d'une multitude d'univers différents, depuis les shows télévisés aux livres en passant par les jeux-vidéos +- http://mangahub.io/ : un site répertoriant une quantité non négligeable de mangas (English) +- https://e621.net/ : un site Furry proposant des comics, y compris de MLP +- https://sofurry.com/ : même chose, mais orienté sur les histoires plutôt que les images +- https://e-hentai.org/ : support ajouté sur demande : n'hésitez pas à demander un site ! +- http://mangas-lecture-en-ligne.fr/ : un site proposant beaucoup de mangas, en français + +### Types de fichiers supportés + +Nous supportons les types de fichiers suivants (aussi bien en entrée qu'en sortie) : + +- epub : les fichiers .epub créés avec Fanfix (nous ne supportons pas les autres fichiers .epub, du moins pour le moment) +- text : les histoires enregistrées en texte (.txt), avec quelques règles spécifiques : + - le titre doit être sur la première ligne + - l'auteur (précédé de rien, ```Par ```, ```De ``` ou ```©```) doit être sur la deuxième ligne, optionnellement suivi de la date de publication entre parenthèses (i.e., ```Par Quelqu'un (3 octobre 1998)```) + - les chapitres doivent être déclarés avec ```Chapitre x``` ou ```Chapitre x: NOM DU CHAPTITRE```, où ```x``` est le numéro du chapitre + - une description de l'histoire doit être donnée en tant que chaptire 0 + - une image de couverture peut être présente avec le même nom de fichier que l'histoire, mais une extension .png, .jpeg ou .jpg +- info_text : fort proche du format texte, mais avec un fichier .info accompagnant l'histoire pour y enregistrer quelques metadata (le fichier de metadata est supposé être créé par Fanfix, ou être compatible avec) +- cbz : les fichiers .cbz (une collection d'images zipées), de préférence créés avec Fanfix (même si les autres .cbz sont aussi supportés, mais sans la majorité des metadata de Fanfix dans ce cas) +- html : les fichiers HTML que vous pouvez ouvrir avec n'importe quel navigateur ; remarquez que Fanfix créera un répertoire pour y mettre les fichiers nécessaires, dont un fichier ```index.html``` pour afficher le tout -- nous ne supportons en entrée que les fichiers HTML créés par Fanfix + +### Plateformes supportées + +Toute plateforme supportant Java 1.6 devrait suffire. + +Le programme a été testé sur Linux (Debian, Slackware et Ubuntu), MacOS X et Windows pour le moment, mais n'hésitez pas à nous informer si vous l'essayez sur un autre système. + +Si vous avez des difficultés pour le compiler avec une version supportée de Java (1.6+), contactez-nous. + +## Options + +Vous pouvez démarrer le programme de deux façons : + +- ```java -jar fanfix.jar``` +- ```fanfix``` (si vous avez utilisé *make install*) + +Les arguments suivants sont supportés : + +- ```--import [URL]```: importer une histoire dans la librairie +- ```--export [id] [output_type] [target]```: exporter l'histoire "id" vers le fichier donné +- ```--convert [URL] [output_type] [target] (+info)```: convertir l'histoire vers le fichier donné, et forcer l'ajout d'un fichier .info si +info est utilisé +- ```--read [id] ([chapter number])```: afficher l'histoire "id" +- ```--read-url [URL] ([chapter number])```: convertir l'histoire et la lire à la volée, sans la sauver +- ```--search```: liste les sites supportés (```where```) +- ```--search [where] [keywords] (page [page]) (item [item])```: lance une recherche et affiche les résultats de la page ```page``` (page 1 par défaut), et de l'item ```item``` spécifique si demandé +- ```--tag [where]```: liste tous les tags supportés par ce site web +- ```--tag [index 1]... (page [page]) (item [item])```: affine la recherche, tag par tag, et affiche si besoin les sous-tags, les histoires ou les infos précises de l'histoire demandée +- ```--list```: lister les histoires presentes dans la librairie et leurs IDs +- ```--server [key] [port]```: démarrer un serveur d'histoires sur ce port +- ```--stop-server [key] [port]```: arrêter le serveur distant sur ce port (key doit avoir la même valeur) +- ```--remote [key] [host] [port]```: contacter ce server au lieu de la librairie habituelle (key doit avoir la même valeur) +- ```--help```: afficher la liste des options disponibles +- ```--version```: retourne la version du programme + +### Environnement + +Certaines variables d'environnement sont reconnues par le programme : + +- ```LANG=en```: forcer la langue du programme en anglais +- ```CONFIG_DIR=$HOME/.fanfix```: utilise ce répertoire pour les fichiers de configuration du programme (et copie les fichiers de configuration par défaut si besoin) +- ```NOUTF=1```: essaye d'utiliser des caractères non-unicode quand possible (cela peut avoir un impact sur les fichiers générés, pas uniquement sur les messages à l'utilisateur) +- ```DEBUG=1```: force l'option ```DEBUG=true``` du fichier de configuration (pour afficher plus d'information en cas d'erreur) + +## Compilation + +```./configure.sh && make``` + +Vous pouvez aussi importer les sources java dans, par exemple, [Eclipse](https://eclipse.org/), et faire un JAR exécutable depuis celui-ci. + +Quelques tests unitaires sont disponibles : + +```./configure.sh && make build test run-test``` + +Si vous faites tourner les tests unitaires, sachez que certains fichiers flags peuvent les impacter: + +- ```test/VERBOSE``` : active le mode verbeux pour les erreurs +- ```test/OFFLINE``` : ne permet pas au programme de télécharger des données +- ```test/URLS``` : permet au programme de tester des URLs +- ```test/FORCE_REFRESH```: force le nettoyage du cache + +Notez que le répertoire ```test/CACHE``` peut rester en place; il contient tous les fichiers téléchargés au moins une fois depuis le réseau par les tests unitaires (si vous autorisez les tests d'URLs, lancez les tests au moins une fois pour peupler le CACHE, puis activez le mode OFFLINE, ça marchera toujours). + +Les fichiers de test seront: + +- ```test/*.url``` : des URLs à télécharger en fichier texte (le contenu du fichier est l'URL) +- ```test/*.story```: des histoires en mode texte (le contenu du fichier est l'histoire) + +### Librairies dépendantes (incluses) + +Nécessaires : + +- ```libs/nikiroo-utils-sources.jar```: quelques utilitaires partagés +- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): une librairie sympathique pour convertir du texte depuis/vers beaucoup de formats ; utilisée ici pour la partie HTML +- [```libs/jsoup-sources.jar```](https://jsoup.org/): une libraririe pour parser du HTML +- [```libs/JSON-java-20190722-sources.jar```](https://github.com/stleary/JSON-java): une libraririe pour parser du JSON + +Optionnelles : + +- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): une petite librairie qui offre des widgets en mode TUI +- [```pandoc```](http://pandoc.org/): pour générer les man pages depuis les fichiers README + +Rien d'autre, si ce n'est Java 1.6+. + +À noter : ```make libs``` exporte ces librairies dans le répertoire src/. + +## Auteur + +Fanfix a été écrit par Niki Roo + diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ad3339 --- /dev/null +++ b/README.md @@ -0,0 +1,158 @@ +English [Français](README-fr.md) + +# Fanfix + +Fanfix is a small Java program that can download stories from some supported websites and render them offline. + +## 🔴 This is the command line and server program + +You can also use: +- the graphical client [Fanfix-swing](https://github.com/nikiroo/fanfix-swing/) +- the TUI client [Fanfix-jexer](https://github.com/nikiroo/fanfix-jexer/) + +## Synopsis + +- ```fanfix``` --import [*URL*] +- ```fanfix``` --export [*id*] [*output_type*] [*target*] +- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info) +- ```fanfix``` --read [*id*] ([*chapter number*]) +- ```fanfix``` --read-url [*URL*] ([*chapter number*]) +- ```fanfix``` --search +- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*]) +- ```fanfix``` --search-tag +- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*]) +- ```fanfix``` --list +- ```fanfix``` --server [*key*] [*port*] +- ```fanfix``` --stop-server [*key*] [*port*] +- ```fanfix``` --remote [*key*] [*host*] [*port*] +- ```fanfix``` --help + +## Description + +(If you are interested in the recent changes, please check the [Changelog](changelog.md) -- note that starting from version 1.4.0, the changelog is checked at startup.) + +This program will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text, LaTeX, HTML...). + +To help organize your stories, it can also work as a local library so you can: + +- Import a story from its URL (or just from a file) +- Export a story to a file (in any of the supported output types) +- Display a story from the local library in text format in the console +- Via [fanfix-swing](https://github.com/nikiroo/fanfix-swing/): Display a story from the local library graphically **by itself** ([fanfix-swing](https://github.com/nikiroo/fanfix-swing/)) or **by calling a native program to handle it** (potentially converted into HTML before hand, so any browser can open it) + +### Supported websites + +Currently, the following websites are supported: + +- http://FimFiction.net/: fan fictions devoted to the My Little Pony show +- http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games +- http://mangahub.io/: a well filled repository of mangas (English) +- https://e621.net/: a Furry website supporting comics, including MLP +- https://sofurry.com/: same thing, but story-oriented +- https://e-hentai.org/: done upon request (so, feel free to ask for more websites!) +- http://mangas-lecture-en-ligne.fr/: a website offering a lot of mangas (in French) + +### Support file types + +We support a few file types for local story conversion (both as input and as output): + +- epub: .epub files created by this program (we do not support "all" .epub files, at least for now) +- text: local stories encoded in plain text format, with a few specific rules: + - the title must be on the first line + - the author (preceded by nothing, ```by ``` or ```©```) must be on the second line, possibly with the publication date in parenthesis (i.e., ```By Unknown (3rd October 1998)```) + - chapters must be declared with ```Chapter x``` or ```Chapter x: NAME OF THE CHAPTER```, where ```x``` is the chapter number + - a description of the story must be given as chapter number 0 + - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension +- info_text: contains the same information as the text format, but with a companion .info file to store some metadata (the .info file is supposed to be created by Fanfix or compatible with it) +- cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) +- html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` as the main file -- we only support importing HTML files created by Fanfix + +### Supported platforms + +Any platform with at lest Java 1.6 on it should be ok. + +It has been tested on Linux (Debian, Slackware, Ubuntu), MacOS X and Windows for now, but feel free to inform us if you try it on another system. + +If you have any problems to compile it with a supported Java version (1.6+), please contact us. + +## Options + +You can start the program in two ways: + +- ```java -jar fanfix.jar``` +- ```fanfix``` (if you used *make install*) + +The following arguments are allowed: + +- ```--import [URL]```: import the story at URL into the local library +- ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file +- ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed +- ```--read [id] ([chapter number])```: read the given story denoted by ID from the library +- ```--read-url [URL] ([chapter number])```: convert on the fly and read the story at URL, without saving it +- ```--search```: list the supported websites (```where```) +- ```--search [where] [keywords] (page [page]) (item [item])```: search on the supported website and display the given results page of stories it found, or the story details if asked +- ```--tag [where]```: list all the tags supported by this website +- ```--tag [index 1]... (page [page]) (item [item])```: search for the given stories or subtags, tag by tag, and display information about a specific page of results or about a specific item if requested +- ```--list```: list the stories present in the library and their associated IDs +- ```--server [key] [port]```: start a story server on this port +- ```--stop-server [key] [port]```: stop the remote server running on this port (key must be set to the same value) +- ```--remote [key] [host] [port]```: contact this server instead of the usual library (key must be set to the same value) +- ```--help```: display the available options +- ```--version```: return the version of the program + +### Environment + +Some environment variables are recognized by the program: + +- ```LANG=en```: force the language to English +- ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed) +- ```NOUTF=1```: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) +- ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors) + +## Compilation + +```./configure.sh && make``` + +You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. + +There are some unit tests you can run, too: + +```./configure.sh && make build test run-test``` + +If you run the unit tests, note that some flag files can impact them: + +- ```test/VERBOSE``` : enable verbose mode +- ```test/OFFLINE``` : to forbid any downloading +- ```test/URLS``` : to allow testing URLs +- ```test/FORCE_REFRESH```: to force a clear of the cache + +Note that ```test/CACHE``` can be kept, as it will contain all internet related files you need (if you allow URLs, run the test once which will populate the CACHE then go OFFLINE, it will still work). + +The test files will be: + +- ```test/*.url``` : URL to download in text format, content = URL +- ```test/*.story```: text mode story, content = story + + +### Dependant libraries (included) + +Required: + +- ```libs/nikiroo-utils-sources.jar```: some shared utility functions +- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; used here for HTML +- [```libs/jsoup-sources.jar```](https://jsoup.org/): a library to parse HTML +- [```libs/JSON-java-20190722-sources.jar```](https://github.com/stleary/JSON-java): a library to parse JSON + +Optional: + +- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): a small library that offers TUI widgets +- [```pandoc```](http://pandoc.org/): to generate the man pages from the README files + +Nothing else but Java 1.6+. + +Note that calling ```make libs``` will export the libraries into the src/ directory. + +## Author + +Fanfix was written by Niki Roo + diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..85f2deb --- /dev/null +++ b/TODO.md @@ -0,0 +1,106 @@ +My current planning for Fanfix (but not everything appears on this list): + +- [ ] Support new websites + - [x] YiffStar + - [ ] [Two Kinds](http://twokinds.keenspot.com/) + - [ ] [Slightly damned](http://www.sdamned.com/) + - [x] New API on FimFiction.net (faster) + - [x] Replace MangaFox which is causing issues all the time + - [ ] Others? Any ideas? I'm open for requests + - [x] [e-Hentai](https://e-hentai.org/) requested + - [x] Find some FR comics/manga websites + - [ ] Find more FR thingies +- [ ] Support videos (anime)? +- [x] A GUI library + - [x] Make one + - [x] Make it run when no args passed + - [x] Fix the UI, it is ugly + - [x] Work on the UI thread is BAD + - [x] Allow export + - [x] Allow delete/refresh + - [x] Show a list of types + - [x] ..in the menu + - [x] ..as a screen view + - [x] options screen + - [x] support progress events + - [x] Real menus + - [x] Store the long lists in [A-B], [BA-BB], ... +- [ ] A TUI library + - [x] Choose an output (Jexer) + - [x] Implement it from --set-reader to the actual window + - [x] List the stories + - [x] Fix the UI layout + - [x] Status bar + - [x] Real menus + - [ ] Store the long lists in [A-B], [BA-BB], ... + - [x] Open a story in the reader and/or natively + - [ ] Update the screenshots + - [ ] Remember the current chapter and current read status of stories + - [ ] Support progress events + - [x] Add a properties pages + - [ ] Deal with comics + - [x] properties page + - [x] external launcher + - [ ] jexer sixels? +- [ ] Move the GUI parts out of fanfix itself (see fanfix-swing) + - [x] Make new project: fanfix-swing + - [x] Fix the UI issues we had (UI thread) + - [x] Make it able to browse already downloaded stories + - [x] Make it able to download stories + - [ ] See what config options to use + - [ ] Import all previous menus end functions + - [ ] Feature parity with original GUI +- [ ] Move the TUI parts out of fanfix itself + - [ ] Make new project +- [x] Network support + - [x] A server that can send the stories + - [x] A network implementation of the Library + - [x] Write access to the library + - [x] Access rights (a simple "key") + - [x] More tests, especially with the GUI + - [x] ..even more + - [x] support progress events +- [x] Check if it can work on Android + - [x] First checks: it should work, but with changes + - [x] Adapt work on images :( + - [x] Partial/Conditional compilation + - [x] APK export +- [ ] Android + - [x] Android support + - [x] Show current stories + - [x] Download new stories + - [ ] Sort stories by Source/Author + - [ ] Fix UI + - [ ] support progress events + - [x] give up and ask a friend... +- [ ] Translations + - [x] i18n system in place + - [x] Make use of it in text + - [x] Make use of it in gui + - [ ] Make use of it in tui + - [ ] Use it for all user output + - [x] French translation + - [x] French manual/readme +- [x] Install a mechanism to handle stories import/export progress update + - [x] Progress system + - [x] in support classes (import) + - [x] in output classes (export) +- [x] Version + - [x] Use a version number + - [x] Show it in UI + - [x] A check-update feature + - [x] ..translated +- [ ] Improve GUI library + - [x] Allow launching a custom application instead of Desktop.start + - [ ] Add the resume next to the cover icon if available (as an option) + - [ ] Add the resume in the Properties page (maybe a second tab?) +- [ ] Bugs + - [x] Fix "Redownload also reset the source" + - [x] Fix "Redownload remote does not show the new item before restart of client app" + - [x] Fix eHentai "content warning" access (see 455) + - [ ] Fix the configuration system (for new or changed options, new or changed languages) + - [x] remote import also download the file in cache, why? + - [x] import file in remote mode tries to import remote file!! + - [ ] import file does not find author in cbz with SUMMARY file + - [x] import file:// creates a tmp without auto-deletion in /tmp/fanfic-... + diff --git a/VERSION b/VERSION new file mode 100644 index 0000000..47ae1f7 --- /dev/null +++ b/VERSION @@ -0,0 +1 @@ +3.1.2-dev diff --git a/changelog-fr.md b/changelog-fr.md new file mode 100644 index 0000000..4633d62 --- /dev/null +++ b/changelog-fr.md @@ -0,0 +1,288 @@ +# Fanfix + +# Version WIP + +- new: bibliothèque http/https + +# Version 3.1.2 + +- fix: date de publication/création formatée +- e621: correction sur l'ordre, encore +- e621: possibilité d'utiliser un Login/API key pour éviter les blacklists +- e621: meilleures meta-data + +# Version 3.1.1 + +- e621: correction pour les chapitres des pools dans l'ordre inverse +- fix: trie les histores par nom et plus par date +- fix: affiche le nom de l'histoire dans les barres de progrès + +# Version 3.1.0 + +- MangaHub: un nouvau site de manga (English) +- MangaFox: retrait du support (site désagréable) +- e621: correction pour la cover non sauvée + +# Version 3.0.1 + +- fix: en cas d'URL non supportée, n'affiche plus un message d'erreur relatif à "file://" +- e621: update pour e621 (et ce n'est plus un BasicSupport_Deprecated) + +# Version 3.0.0 + +- new: maintenant compatible Android (voir [companion project](https://gitlab.com/Rayman22/fanfix-android)) +- new: recherche d'histoires (pas encore toutes les sources) +- new: support d'un proxy +- fix: support des CBZ contenant du texte +- fix: correction de DEBUG=0 +- fix: correction des histoires importées qui n'arrivent pas immédiatement à l'affichage +- gui: correction pour le focus +- gui: fix pour la couleur d'arrière plan +- gui: fix pour la navigation au clavier (haut et bas) +- gui: configuration beaucoup plus facile +- gui: peut maintenant télécharger toutes les histoires d'un groupe en cache en une fois +- MangaLEL: site web changé +- search: supporte MangaLEL +- search: supporte Fanfiction.net +- FimFictionAPI: correction d'une NPE +- remote: changement du chiffrement because Google +- remote: incompatible avec 2.x +- remote: moins bonnes perfs mais meilleure utilisation de la mémoire +- remote: le log inclus maintenant la date des évènements +- remote: le mot de passe se configure maintenant dans le fichier de configuration + +# Version 2.0.3 + +SoFurry: correction pour les histoires disponibles uniquement aux utilisateurs inscrits sur le site + +# Version 2.0.2 + +- i18n: changer la langue dans les options fonctionne aussi quand $LANG existe +- gui: traduction en français +- gui: ReDownloader ne supprime plus le livre original +- fix: corrections pour le visionneur interne +- fix: quelques corrections pour les traductions + +# Version 2.0.1 + +- core: un changement de titre/source/author n'était pas toujours visible en runtime +- gui: ne recharger les histoires que quand nécessaire + +# Version 2.0.0 + +- new: les sources peuvent contenir "/" (et utiliseront des sous-répertoires en fonction) +- gui: nouvelle page pour voir les propriétés d'une histoire +- gui: renommer les histoires, changer l'auteur +- gui: permet de lister les auteurs ou les sources en mode "tout" ou "listing" +- gui: lecteur intégré pour les histoires (texte et images) +- tui: fonctionne maintenant assez bien que pour être déclaré stable +- cli: permet maintenant de changer la source, le titre ou l'auteur +- remote: fix de setSourceCover (ce n'était pas vu par le client) +- remote: on peut maintenant importer un fichier local +- remote: meilleures perfs +- remote: incompatible avec 1.x +- fix: deadlock dans certains cas rares (nikiroo-utils) +- fix: le résumé n'était pas visibe dans certains cas +- fix: update de nikiroo-utils, meilleures perfs pour le remote +- fix: eHentai content warning + +# Version 1.8.1 + +- e621: les images étaient rangées à l'envers pour les recherches (/post/) +- e621: correction pour /post/search/ +- remote: correction de certains problèmes de timeout +- remote: amélioration des perfs +- fix: permettre les erreurs I/O pour les CBZ (ignore l'image) +- fix: corriger le répertoire des covers par défaut + +# Version 1.8.0 + +- FimfictionAPI: les noms des chapitres sont maintenant triés correctement +- e621: supporte aussi les recherches (/post/) +- remote: la cover est maintenant envoyée au client pour les imports +- MangaLel: support pour MangaLel + +# Version 1.7.1 + +- GUI: fichiers tmp supprimés trop vite en mode GUI +- fix: une histoire sans cover pouvait planter le programme +- ePub: erreur d'import pour un EPUB local sans cover + +# Version 1.7.0 + +- new: utilisation de jsoup pour parser le HTML (pas encore partout) +- update: mise à jour de nikiroo-utils +- android: compatibilité Android +- MangaFox: fix après une mise-à-jour du site +- MangaFox: l'ordre des tomes n'était pas toujours bon +- ePub: correction pour la compatibilité avec certains lecteurs ePub +- remote: correction pour l'utilisation du cache +- fix: TYPE= était parfois mauvais dans l'info-file +- fix: les guillemets n'étaient pas toujours bien ordonnés +- fix: amélioration du lanceur externe (lecteur natif) +- test: plus de tests unitaires +- doc: changelog disponible en français +- doc: man pages (en, fr) +- doc: SysV init script + +# Version 1.6.3 + +- fix: corrections de bugs +- remote: notification de l'état de progression des actions +- remote: possibilité d'envoyer des histoires volumineuses +- remote: détection de l'état du serveur +- remote: import and change source on server +- CBZ: meilleur support de certains CBZ (si SUMMARY ou URL est présent dans le CBZ) +- Library: correction pour les pages de couvertures qui n'étaient pas toujours effacées quand l'histoire l'était +- fix: correction pour certains cas où les images ne pouvaient pas être sauvées (quand on demande un jpeg mais que l'image n'est pas supportée, nous essayons maintenant ensuite en png) +- remote: correction pour certaines images de couvertures qui n'étaient pas trouvées (nikiroo-utils) +- remote: correction pour les images de couvertures qui n'étaient pas transmises + +## Version 1.6.2 + +- GUI: amélioration des barres de progression +- GUI: meilleures performances pour l'ouverture d'une histoire si le type de l'histoire est déjà le type demandé pour l'ouverture (CBZ -> CBZ ou HTML -> HTML par exemple) + +## Version 1.6.1 + +- GUI: nouvelle option (désactivée par défaut) pour afficher un élément par source (type) sur la page de démarrage au lieu de tous les éléments triés par source (type) +- fix: correction de la source (type) qui était remis à zéro après un re-téléchargement +- GUI: affichage du nombre d'images présentes au lieu du nombre de mots pour les histoires en images + +## Version 1.6.0 + +- TUI: un nouveau TUI (mode texte mais avec des fenêtres et des menus en texte) -- cette option n'est pas compilée par défaut (configure.sh) +- remote: un serveur pour offrir les histoires téléchargées sur le réseau +- remote: une Library qui reçoit les histoires depuis un serveur distant +- update: mise à jour de nikiroo-utils +- FimFiction: support for the new API +- new: mise à jour du cache (effacer le cache actuel serait une bonne idée) +- GUI: correction pour le déplacement d'une histoire qui n'est pas encore dans le cache + +## Version 1.5.3 + +- FimFiction: correction pour les tags dans les metadata et la gestion des chapitres pour certaines histoires + +## Version 1.5.2 + +- FimFiction: correction pour les tags dans les metadata + +## Version 1.5.1 + +- FimFiction: mise à jour pour supporter FimFiction 4 +- eHentai: correction pour quelques metadata qui n'étaient pas reprises + +## Version 1.5.0 + +- eHentai: nouveau site supporté sur demande (n'hésitez pas !) : e-hentai.org +- Library: amélioration des performances quand on récupère une histoire (la page de couverture n'est plus chargée quand cela n'est pas nécessaire) +- Library: correction pour les pages de couvertures qui n'étaient pas toujours effacées quand l'histoire l'était +- GUI: amélioration des performances pour l'affichage des histoires (la page de couverture est re-dimensionnée en cache) +- GUI: on peut maintenant éditer la source d'une histoire ("Déplacer vers...") + +## Version 1.4.2 + +- GUI: nouveau menu Options pour configurer le programme (très minimaliste pour le moment) +- new: gestion de la progression des actions plus fluide et avec plus de détails +- fix: meilleur support des couvertures pour les fichiers en cache + +## Version 1.4.1 + +- fix: correction de UpdateChecker qui affichait les nouveautés de TOUTES les versions du programme au lieu de se limiter aux versions plus récentes +- fix: correction de la gestion de certains sauts de ligne pour le support HTML (entre autres, FanFiction.net) +- GUI: les barres de progrès fonctionnent maintenant correctement +- update: mise à jour de nikiroo-utils pour récupérer toutes les étapes dans les barres de progrès +- ( --Fin des nouveautés de la version 1.4.1-- ) + +## Version 1.4.0 + +- new: sauvegarde du nombre de mots et de la date de création des histoires dans les fichiers mêmes +- GUI: nouvelle option pour afficher le nombre de mots plutôt que le nom de l'auteur sous le nom de l'histoire +- CBZ: la première page n'est plus doublée sur les sites n'offrant pas de page de couverture +- GUI: recherche de mise à jour (le programme cherche maintenant si une mise à jour est disponible pour en informer l'utilisateur) + +## Version 1.3.1 + +- GUI: on peut maintenant trier les histoires par auteur + +## Version 1.3.0 + +- YiffStar: le site YiffStar (SoFurry.com) est maintenant supporté +- new: support des sites avec login/password +- GUI: les URLs copiées (ctrl+C) sont maintenant directement proposées par défaut quand on importe une histoire +- GUI: la version est maintenant visible (elle peut aussi être récupérée avec --version) + +## Version 1.2.4 + +- GUI: nouvelle option re-télécharger +- GUI: les histoires sont maintenant triées (et ne changeront plus d'ordre après chaque re-téléchargement) +- fix: corrections sur l'utilisation des guillemets +- fix: corrections sur la détection des chapitres +- new: de nouveaux tests unitaires + +## Version 1.2.3 + +- HTML: les fichiers originaux (info_text) sont maintenant rajoutés quand on sauve +- HTML: support d'un nouveau type de fichiers à l'import: HTML (si fait par Fanfix) + +## Version 1.2.2 + +- GUI: nouvelle option "Sauver sous..." +- GUI: corrections (rafraîchissement des icônes) +- fix: correction de la gestion du caractère TAB dans les messages utilisateurs +- GUI: LocalReader supporte maintenant "--read" +- ePub: corrections sur le CSS + +## Version 1.2.1 + +- GUI: de nouvelles fonctions ont été ajoutées dans le menu +- GUI: popup avec un clic droit sur les histoires +- GUI: corrections, particulièrement pour LocalLibrary +- GUI: nouvelle icône (un rond vert) pour dénoter qu'une histoire est "cachée" (dans le LocalReader) + +## Version 1.2.0 + +- GUI: système de notification de la progression des actions +- ePub: changements sur le CSS +- new: de nouveaux tests unitaires +- GUI: de nouvelles fonctions ont été ajoutées dans le menu (supprimer, rafraîchir, un bouton exporter qui ne fonctionne pas encore) + +## Version 1.1.0 + +- CLI: nouveau système de notification de la progression des actions +- e621: correction pour les "pending pools" qui ne fonctionnaient pas avant +- new: système de tests unitaires ajouté (pas encore de tests propres à Fanfix) + +## Version 1.0.0 + +- GUI: état acceptable pour une 1.0.0 (l'export n'est encore disponible qu'en CLI) +- fix: bugs fixés +- GUI: (forte) amélioration +- new: niveau fonctionnel acceptable pour une 1.0.0 + +## Version 0.9.5 + +- fix: bugs fixés +- new: compatibilité avec WIN32 (testé sur Windows 10) + +## Version 0.9.4 + +- fix: (beaucoup de) bugs fixés +- new: amélioration des performances +- new: moins de fichiers cache utilisés +- GUI: amélioration (pas encore parfait, mais utilisable) + +## Version 0.9.3 + +- fix: (beaucoup de) bugs fixés +- GUI: première implémentation graphique (laide et buggée) + +## Version 0.9.2 + +- new: version minimum de la JVM : Java 1.6 (tous les JAR binaires ont été compilés en Java 1.6) +- fix: bugs fixés + +## Version 0.9.1 + +- version initiale + diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..1a8630d --- /dev/null +++ b/changelog.md @@ -0,0 +1,288 @@ +# Fanfix + +# Version WIP + +- new: http/https remote library + +# Version 3.1.2 + +- fix: publication/creation date formated +- e621: fix order again +- e621: option to use a Login/API key to evade blacklists +- e621: better metadata + +# Version 3.1.1 + +- e621: fix chapters in reverse order for pools +- fix: sort the stories by title and not by date +- fix: expose the story name on progress bars + +# Version 3.1.0 + +- MangaHub: a manga website (English) +- MangaFox: removed (too many unfriendly changes, bye) +- e621: fix cover not saved + +# Version 3.0.1 + +- fix: update for e621 (and it is no more a BasicSupport_Deprecated) +- fix: for unsupported URL, do not errors out with a "file://" related message + +# Version 3.0.0 + +- new: now Android-compatible (see [companion project](https://gitlab.com/Rayman22/fanfix-android)) +- new: story search (not all sources yet) +- new: proxy support +- fix: support hybrid CBZ (with text) +- fix: fix DEBUG=0 +- fix: fix imported stories that don't immediatly appear on screen +- gui: focus fix +- gui: bg colour fix +- gui: fix keyboard navigation support (up and down) +- gui: configuration is now much easier +- gui: can now prefetch to cache all the sories of a group at once +- MangaLEL: website has changed +- search: Fanfiction.net support +- search: MangaLEL support +- FimFictionAPI: fix NPE +- remote: encryption mode changed because Google +- remote: not compatible with 2.x +- remote: can now use password from config file +- remote: worse perfs but much better memory usage +- remote: log now includes the time of events + +# Version 2.0.3 + +SoFurry: fix for stories only available to registrated users + +# Version 2.0.2 + +- i18n: setting the language in the option panel now works even with $LANG set +- gui: translated into French +- gui: ReDownload does not delete the original book anymore +- gui: internal viewer fixes +- gui: some translation fixes + +# Version 2.0.1 + +- core: a change of title/source/author was not always visible at runtime +- gui: only reload the stoies when needed + +# Version 2.0.0 + +- new: sources can contain "/" (and will use subdirectories) +- gui: new Properties page for stories +- gui: rename stories, change author +- gui: allow "all" and "listing" modes for sources and authors +- gui: integrated viewer for stories (both text and images) +- tui: now working well enough to be considered stable +- cli: now allow changing the source, title and author +- remote: fix setSourceCover (was not seen by client) +- remote: can now import local files into a remote library +- remote: better perfs +- remote: not compatible with 1.x +- fix: deadlock in some rare cases (nikiroo-utils) +- fix: the resume was not visible in some cases +- fix: update nikiroo-utils, better remote perfs +- fix: eHentai content warning + +# Version 1.8.1 + +- e621: the images were stored in reverse order for searches (/post/) +- e621: fix for /post/search/ +- remote: fix some timeout issues +- remote: improve perfs +- fix: allow I/O errors on CBZ files (skip image) +- fix: fix the default covers directory + +# Version 1.8.0 + +- FimfictionAPI: chapter names are now correctly ordered +- e621: now supports searches (/post/) +- remote: cover is now sent over the network for imported stories +- MangaLel: new support for MangaLel + +# Version 1.7.1 + +- GUI: tmp files deleted too soon in GUI mode +- fix: unavailable cover could cause a crash +- ePub: local EPUB import error when no cover + +# Version 1.7.0 + +- new: use jsoup for parsing HTML (not everywhere yet) +- update nikiroo-utils +- android: Android compatibility +- MangaFox: fix after website update +- MangaFox: tomes order was not always correct +- ePub: fix for compatibility with some ePub viewers +- remote: cache usage fix +- fix: TYPE= not always correct in info-file +- fix: quotes error +- fix: improve external launcher (native viewer) +- test: more unit tests +- doc: changelog available in French +- doc: man pages (en, fr) +- doc: SysV init script + +# Version 1.6.3 + +- fix: bug fixes +- remote: progress report +- remote: can send large files +- remote: detect server state +- remote: import and change source on server +- CBZ: better support for some CBZ files (if SUMMARY or URL files are present in it) +- Library: fix cover images not deleted on story delete +- fix: some images not supported because not jpeg-able (now try again in png) +- remote: fix some covers not found over the wire (nikiroo-utils) +- remote: fix cover image files not sent over the wire + +## Version 1.6.2 + +- GUI: better progress bars +- GUI: can now open files much quicker if they are stored in both library and cache with the same output type + +## Version 1.6.1 + +- GUI: new option (disabled by default) to show one item per source type instead of one item per story when showing ALL sources (which is also the start page) +- fix: source/type reset when redownloading +- GUI: show the number of images instead of the number of words for images documents + +## Version 1.6.0 + +- TUI: new TUI (text with windows and menus) -- not compiled by default (configure.sh) +- remote: a server option to offer stories on the network +- remote: a remote library to get said stories from the network +- update to latest version of nikiroo-utils +- FimFiction: support for the new API +- new: cache update (you may want to clear your current cache) +- GUI: bug fixed (moving an unopened book does not fail any more) + +## Version 1.5.3 + +- FimFiction: Fix tags and chapter handling for some stories + +## Version 1.5.2 + +- FimFiction: Fix tags metadata on FimFiction 4 + +## Version 1.5.1 + +- FimFiction: Update to FimFiction 4 +- eHentai: Fix some meta data that were missing + +## Version 1.5.0 + +- eHentai: new website supported on request (do not hesitate!): e-hentai.org +- Library: perf improvement when retrieving the stories (cover not loaded when not needed) +- Library: fix the covers that were not always removed when deleting a story +- GUI: perf improvement when displaying books (cover resized then cached) +- GUI: sources are now editable ("Move to...") + +## Version 1.4.2 + +- GUI: new Options menu to configure the program (minimalist for now) +- new: improve progress reporting (smoother updates, more details) +- fix: better cover support for local files + +## Version 1.4.1 + +- fix: UpdateChecker which showed the changes of ALL versions instead of the newer ones only +- fix: some bad line breaks on HTML support (including FanFiction.net) +- GUI: progress bar now working correctly +- update: nikiroo-utils update to show all steps in the progress bars +- ( --End of changes for version 1.4.1-- ) + +## Version 1.4.0 + +- new: remember the word count and the date of creation of Fanfix stories +- GUI: option to show the word count instead of the author below the book title +- CBZ: do not include the first page twice anymore for no-cover websites +- GUI: update version check (we now check for new versions) + +## Version 1.3.1 + +- GUI: can now display books by Author + +## Version 1.3.0 + +- YiffStar: YiffStar (SoFurry.com) is now supported +- new: supports login/password websites +- GUI: copied URLs (ctrl+C) are selected by default when importing a URL +- GUI: version now visible (also with --version) + +## Version 1.2.4 + +- GUI: new option: Re-download +- GUI: books are now sorted (will not jump around after refresh/redownload) +- fix: quote character handling +- fix: chapter detection +- new: more tests included + +## Version 1.2.3 + +- HTML: include the original (info_text) files when saving +- HTML: new input type supported: HTML files made by Fanfix + +## Version 1.2.2 + +- GUI: new "Save as..." option +- GUI: fixes (icon refresh) +- fix: handling of TABs in user messages +- GUI: LocalReader can now be used with --read +- ePub: CSS style fixes + +## Version 1.2.1 + +- GUI: some menu functions added +- GUI: right-click popup menu added +- GUI: fixes, especially for the LocalReader library +- GUI: new green round icon to denote "cached" (into LocalReader library) files + +## Version 1.2.0 + +- GUI: progress reporting system +- ePub: CSS style changes +- new: unit tests added +- GUI: some menu functions added (delete, refresh, a place-holder for export) + +## Version 1.1.0 + +- CLI: new Progress reporting system +- e621: fix on "pending" pools, which were not downloaded before +- new: unit tests system added (but no test yet, as all tests were moved into nikiroo-utils) + +## Version 1.0.0 + +- GUI: it is now good enough to be released (export is still CLI-only though) +- fix: bug fixes +- GUI: improved (a lot) +- new: should be good enough for 1.0.0 + +## Version 0.9.5 + +- fix: bug fixes +- new: WIN32 compatibility (tested on Windows 10) + +## Version 0.9.4 + +- fix: bug fixes (lots of) +- new: perf improved +- new: use less cache files +- GUI: improvement (still not really OK, but OK enough I guess) + +## Version 0.9.3 + +- fix: bug fixes (lots of) +- GUI: first implementation (which is ugly and buggy -- the buggly GUI) + +## Version 0.9.2 + +- new: minimum JVM version: Java 1.6 (all binary JAR files will be released in 1.6) +- fix: bug fixes + +## Version 0.9.1 + +- initial version + diff --git a/configure.sh b/configure.sh new file mode 100755 index 0000000..8c5dbdd --- /dev/null +++ b/configure.sh @@ -0,0 +1,72 @@ +#!/bin/sh + +# default: +PREFIX=/usr/local +PROGS="java javac jar make sed" + +IMG=be/nikiroo/utils/ui/ImageUtilsAwt + +valid=true +while [ "$*" != "" ]; do + key=`echo "$1" | cut -f1 -d=` + val=`echo "$1" | cut -f2 -d=` + case "$key" in + --) + ;; + --help) # This help message + echo The following arguments can be used: + cat "$0" | grep '^\s*--' | grep '#' | while read ln; do + cmd=`echo "$ln" | cut -f1 -d')'` + msg=`echo "$ln" | cut -f2 -d'#'` + echo " $cmd$msg" + done + ;; + --prefix) #=PATH Change the prefix to the given path + PREFIX="$val" + ;; + *) + echo "Unsupported parameter: '$1'" >&2 + echo >&2 + sh "$0" --help >&2 + valid=false + ;; + esac + shift +done + +[ $valid = false ] && exit 1 + +MESS="A required program cannot be found:" +for prog in $PROGS; do + out="`whereis -b "$prog" 2>/dev/null`" + if [ "$out" = "$prog:" ]; then + echo "$MESS $prog" >&2 + valid=false + fi +done + +[ $valid = false ] && exit 2 + +if [ "`whereis tput`" = "tput:" ]; then + ok='"[ ok ]"'; + ko='"[ !! ]"'; + cols=80; +else + #ok='"`tput bold`[`tput setf 2` OK `tput init``tput bold`]`tput init`"'; + #ko='"`tput bold`[`tput setf 4` !! `tput init``tput bold`]`tput init`"'; + ok='"`tput bold`[`tput setaf 2` OK `tput init``tput bold`]`tput init`"'; + ko='"`tput bold`[`tput setaf 1` !! `tput init``tput bold`]`tput init`"'; + cols='"`tput cols`"'; +fi; + +echo "MAIN = be/nikiroo/fanfix/Main" > Makefile +echo "MORE = $IMG" >> Makefile +echo "TEST = be/nikiroo/fanfix/test/Test" >> Makefile +echo "TEST_PARAMS = $cols $ok $ko" >> Makefile +echo "NAME = fanfix" >> Makefile +echo "PREFIX = $PREFIX" >> Makefile +echo "JAR_FLAGS += -C bin/ org -C bin/ be -C ./ LICENSE -C ./ VERSION -C libs/ licenses" >> Makefile +echo "SJAR_FLAGS += -C src/ org -C src/ be" >> Makefile + +cat Makefile.base >> Makefile + diff --git a/derename.sh b/derename.sh new file mode 100755 index 0000000..6c8cbff --- /dev/null +++ b/derename.sh @@ -0,0 +1,11 @@ +#!/bin/sh + +git status | grep renamed: | sed 's/[^:]*: *\([^>]*\) -> \(.*\)/\1>\2/g' | while read -r ln; do + old="`echo "$ln" | cut -f1 -d'>'`" + new="`echo "$ln" | cut -f2 -d'>'`" + mkdir -p "`dirname "$old"`" + git mv "$new" "$old" + rmdir "`dirname "$new"`" 2>/dev/null + true +done + diff --git a/docs/android/android.md b/docs/android/android.md new file mode 100644 index 0000000..f3d2775 --- /dev/null +++ b/docs/android/android.md @@ -0,0 +1,289 @@ +# Android UI mock-up + +## Concepts + +### Story + +We have **Stories** in Fanfix, which represent a story (an "epub", ...) or a comics (a "CBZ" file, ...). + +A story is written by an author, comes from a source and is dentified by a LUID (Local Unique ID). +It can be a text story or an image story. + +The source can actually be changed by the user (this is the main sorting key). + +### Book + +We also have **Books**. + +Books can be used to display: + +- All the sources present in the library +- All the authors known in the lbrary +- Stories sharing a source or an author + +### All and Listing modes + +When representing sources or authors, books can be arranged in two modes: + +- "All" mode : all the sources/authors are represented by a book and displayed in the UI +- "Listing" mode : for each source/author, a group of books representing the corresponding story is present with the name of the source/author to group them (for instance, a JLabel on top of the group) + +Note: Listing mode can be left out of the Android version if needed (but the all mode is really needed). + +### Destination + +What I call here a destination is a specific group of books. + +Examples : + +- All the sources +- All the books of author "Tulipe, F." +- A listing of all the authors and their stories + +## Core + +### Library (main screen) + +![Main library](screens/main_lib.jpg) + +#### Header + +The header has a title, a navigation icon on the left and a search icon. + +Title can vary upon the current displayed books: + +- All sources +- Sources listing +- Source: xxx +- All authors +- Authors listing +- Author: xxx + +The navigation icon open the Navigation drawer. + +##### Search + +![Search/Filter](screens/search.jpg) + +The search icon is actually a filter: it will hide all the books that don't contain the given text (search on LUID, title and author). + +#### List + +This list will hold books. Each item will be represented by : + +- a cover image (which is provided by fanfix.jar) +- a main info, which can be: + - for stories, the story title + - for source books, the source name + - for author books, the author name +- a secondary info, which can vary via a setting (see the Options page) between: + - author name (for a book representing an author, it is left blank) + - a count (a word count for text stories, an image count for images stories, a stories count for sources and authors books) + +#### UI + +Material.IO: + +- Title, navigation icon, search icon : [App bar top](https://material.io/design/components/app-bars-top.html) +- List : [Cards](https://material.io/design/components/cards.html) + +A tap will open the target book in full-screen mode (i.e., the details about the card). + +On the detailed card, you will see the description (see Description Page) and 3 buttons : + +- Open +- Delete +- "..." for a menu + +### Navigation drawer + +![Navigation Drawer](screens/navigation.jpg) + +The navigation drawer will list 4 destinations: + +- All the sources +- Listing of the sources +- All the authors +- Listing of the authors +- By source + +...and 2 foldable "panels" with more destinations: + +- By source +- By author + +Those subpanels will either contain the sources/authors **or** sub-subpanels with sources/authors. +See fanfix.jar (BasicLibrary.getSourcesGrouped() and BasicLibrary.getAuthorsGrouped()). + +Note: if those last two cause problems, they can be removed; the first four options would be enough to cover the main use cases. + +#### UI + +Material.IO: + +- Navigation drawer: navigation drawer + +### Context menu + +![Context Menu](screens/menu.jpg) + +The context menu options are as follow for stories: + +- Open : open the book (= internal or external reader) +- Rename... : ask the user for a new title for the story (default is current name) +- Move to >> : show a "new source..." option as well as the current ones fo quick select (BasicLibrary.getSourcesGrouped() will return all the sources on only one level if their number is small enough) + - * + - [new source...] + - [A-H] + - Anima + - Fanfiction.NET + - [I-Z] + - MangaFox +- Change author to >> : show a "new author..." option as well as the current ones fo quick select (BasicLibrary.getAuthorsGrouped() will return all the authors on only one level if their number is small enough) + - * + - [new author...] + - [0-9] + - 5-stars + - [A-H] + - Albert + - Béatrice + - Hakan + - [I-Z] + - Irma + - Zoul +- Delete : delete the story +- Redownload : redownload the story (will **not** delete the original) +- Properties : open the properties page + +For other books (sources and authors): + +- Open: open the book (= go to the selected destination) + +#### UI + +Material.IO: + +- menu: [menu](https://developer.android.com/guide/topics/ui/menus.html) + +The menu will NOT use sublevels but link to a [list](https://material.io/design/components/lists.html) instead. + +### Description page + +![Description Page](screens/desc.jpg) + +#### Header + +Use the same cover image as the books, and the description key/values comes from BasicReader.getMetaDesc(MetaData). + +#### Description + +Simply display Story.getMeta().getResume(), without adding the chapter number (it is always 0 for description). + +An example can be seen in be.nikiroo.fanfix.ui.GuiReaderViewerTextOutput.java. + +### Options page + +![Options Page](screens/options.jpg) + +It consists of a "Remote Library" panel: + +- enable : an option to enable/disable the remote library (if disabled, use the local library instead) +- server : (only enabled if the remote library is) the remote server host +- port : (only enabled if the remote library is) the remote server port +- key : (only enabled if the remote library is) the remote server secret key + +...and 5 other options: + +- Open CBZ files internally : open CBZ files with the internal viewer +- Open epub files internally : open EPUB files with the internal viewer +- Show handles on image viewer : can hide the handles used as cues in the image viewer to know where to click +- Startup screen : select the destination to show on application startup +- Language : select the language to use + +#### Startup screen + +Can be: + +- Sources + - All + - Listing +- Authors + - All + - Listing + +...but will have to be presented in a better way to the user (i.e., better names). + +#### UI + +Material.IO: + +- the page itself : Temporary UI Region +- the options : Switch +- the languages : Exposed Dropdown Menu +- the text fields : the default for text fields +- the scret key field : the default for passwords (with * * * ) + +## Internal viewer + +The program will have an internal viewer that will be able to display the 2 kinds of stories (images and text). + +### Base viewer + +This is common to both of the viewer (this is **not** an architectural directives, I only speak about the concept here). + +![Base Viewer](screens/viewer.jpg) + +#### Header + +The title is the title of the story, shortened with "..." if too long. + +#### Content + +This area will host the text viewer or the image viewer. + +#### Navigator + +It contains 4 action buttons (first, previous, next and last chapter) and the title of the current chapter: + +- Descripton : for the properties page (same layout as the actual Properties page) +- Chapter X/Y: title : for the normal chapters (note that "Chapter X/Y" should be bold, and "X" should be coloured) + +#### UI + +Matrial.IO: + +- Header : Header +- Navigator : [Sheets bottom](https://material.io/design/components/sheets-bottom.html) + +### Text viewer + +![Text Viewer](screens/viewer-text.jpg) + +It will contain the content of the current chapter (Story.getChapters().get(index - 1)). + +Same layout as the Properties page uses for the resume, with just a small difference: the chapter name is now prefixed by "Chaper X: ". + +### Image viewer + +![Image Viewer](screens/viewer-image.jpg) + +#### Image + +Auto-zoom and fit (keep aspect ratio). + +#### Image counter + +Just display "Image X/Y" + +#### Handles + +This is a simple cue to show the user where to click. + +It can be hidden via the option "Show handles on image viewer" from the Options page. + +#### UI + +Pinch & Zoom should be allowed. + +Drag-to-pan should be allowed. + diff --git a/docs/android/screens/desc.jpg b/docs/android/screens/desc.jpg new file mode 100755 index 0000000..766b746 Binary files /dev/null and b/docs/android/screens/desc.jpg differ diff --git a/docs/android/screens/main_lib.jpg b/docs/android/screens/main_lib.jpg new file mode 100755 index 0000000..e105824 Binary files /dev/null and b/docs/android/screens/main_lib.jpg differ diff --git a/docs/android/screens/menu.jpg b/docs/android/screens/menu.jpg new file mode 100755 index 0000000..ea67163 Binary files /dev/null and b/docs/android/screens/menu.jpg differ diff --git a/docs/android/screens/navigation.jpg b/docs/android/screens/navigation.jpg new file mode 100755 index 0000000..997cb32 Binary files /dev/null and b/docs/android/screens/navigation.jpg differ diff --git a/docs/android/screens/options.jpg b/docs/android/screens/options.jpg new file mode 100755 index 0000000..b4ad836 Binary files /dev/null and b/docs/android/screens/options.jpg differ diff --git a/docs/android/screens/search.jpg b/docs/android/screens/search.jpg new file mode 100755 index 0000000..f32257e Binary files /dev/null and b/docs/android/screens/search.jpg differ diff --git a/docs/android/screens/viewer-image.jpg b/docs/android/screens/viewer-image.jpg new file mode 100755 index 0000000..8f5c742 Binary files /dev/null and b/docs/android/screens/viewer-image.jpg differ diff --git a/docs/android/screens/viewer-text.jpg b/docs/android/screens/viewer-text.jpg new file mode 100755 index 0000000..574f688 Binary files /dev/null and b/docs/android/screens/viewer-text.jpg differ diff --git a/docs/android/screens/viewer.jpg b/docs/android/screens/viewer.jpg new file mode 100755 index 0000000..d8b130a Binary files /dev/null and b/docs/android/screens/viewer.jpg differ diff --git a/fanfix.sysv b/fanfix.sysv new file mode 100755 index 0000000..5ab6912 --- /dev/null +++ b/fanfix.sysv @@ -0,0 +1,91 @@ +#!/bin/sh +# +# fanfix This starts the Fanfix remote service. +# +# description: Starts the Fanfix remote service +# +### BEGIN INIT INFO +# Default-Start: 3 4 5 +# Short-Description: Fanfix service +# Description: Starts the Fanfix remote service +### END INIT INFO + +ENABLED=true +USER=fanfix +JAR=/path/to/fanfix.jar + +FPID=/tmp/fanfix.pid +OUT=/var/log/fanfix +ERR=/var/log/fanfix.err + +if [ "$ENABLED" != true ]; then + [ "$1" != status ] + exit $? +fi + +if [ ! -e "$JAR" ]; then + echo "Canot find main jar file: $JAR" >&2 + exit 4 +fi + +case "$1" in +start) + if sh "$0" status --quiet; then + echo "Fanfix is already running." >&2 + false + else + [ -e "$OUT" ] && mv "$OUT" "$OUT".previous + [ -e "$ERR" ] && mv "$ERR" "$ERR".previous + sudo -u "$USER" -- java -jar "$JAR" --server > "$OUT" 2> "$ERR" & + echo $! > "$FPID" + fi + + sleep 0.1 + sh "$0" status --quiet +;; +stop) + if sh "$0" status --quiet; then + sudo -u "$USER" -- java -jar "$JAR" --stop-server + fi + + i=1 + while [ $i -lt 100 ]; do + if sh "$0" status --quiet; then + echo -n . >&2 + sleep 1 + fi + i=`expr $i + 1` + done + echo >&2 + + if sh "$0" status --quiet; then + echo "Process not responding, killing it..." >&2 + kill "`cat "$FPID"`" + sleep 10 + kill -9 "`cat "$FPID"`" 2>/dev/null + fi + + rm -f "$FPID" +;; +restart) + sh "$0" stop + sh "$0" start +;; +status) + if [ -e "$FPID" ]; then + if [ "$2" = "--quiet" ]; then + ps "`cat "$FPID"`" >/dev/null + else + ps "`cat "$FPID"`" >/dev/null \ + && echo service is running >&2 + fi + else + false + fi +;; +*) + echo $"Usage: $0 {start|stop|status|restart}" >&2 + false +;; +esac + diff --git a/icons/fanfix-alt.png b/icons/fanfix-alt.png new file mode 100644 index 0000000..4ab0957 Binary files /dev/null and b/icons/fanfix-alt.png differ diff --git a/icons/fanfix.png b/icons/fanfix.png new file mode 100644 index 0000000..983b344 Binary files /dev/null and b/icons/fanfix.png differ diff --git a/icons/mlpfim-icons.deviantart.com/janswer.deviantart.com/fanfix-d.png b/icons/mlpfim-icons.deviantart.com/janswer.deviantart.com/fanfix-d.png new file mode 100644 index 0000000..1798dd3 Binary files /dev/null and b/icons/mlpfim-icons.deviantart.com/janswer.deviantart.com/fanfix-d.png differ diff --git a/icons/mlpfim-icons.deviantart.com/laceofthemoon.deviantart.com/fanfix-e.png b/icons/mlpfim-icons.deviantart.com/laceofthemoon.deviantart.com/fanfix-e.png new file mode 100644 index 0000000..fb6fe0d Binary files /dev/null and b/icons/mlpfim-icons.deviantart.com/laceofthemoon.deviantart.com/fanfix-e.png differ diff --git a/icons/mlpfim-icons.deviantart.com/pink618.deviantart.com/fanfix-c.png b/icons/mlpfim-icons.deviantart.com/pink618.deviantart.com/fanfix-c.png new file mode 100644 index 0000000..a56a4d2 Binary files /dev/null and b/icons/mlpfim-icons.deviantart.com/pink618.deviantart.com/fanfix-c.png differ diff --git a/libs/JSON-java-20190722-sources.jar b/libs/JSON-java-20190722-sources.jar new file mode 100644 index 0000000..22a416d Binary files /dev/null and b/libs/JSON-java-20190722-sources.jar differ diff --git a/libs/jexer-0.0.4_README.md b/libs/jexer-0.0.4_README.md new file mode 100644 index 0000000..7cfe9b4 --- /dev/null +++ b/libs/jexer-0.0.4_README.md @@ -0,0 +1,220 @@ +Jexer - Java Text User Interface library +======================================== + +This library implements a text-based windowing system reminiscient of +Borland's [Turbo Vision](http://en.wikipedia.org/wiki/Turbo_Vision) +system. (For those wishing to use the actual C++ Turbo Vision +library, see [Sergio Sigala's C++ version based on the public domain +sources released by Borland.](http://tvision.sourceforge.net/) ) + +Jexer currently supports three backends: + +* System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal + (tested on Linux + xterm). I/O is handled through terminal escape + sequences generated by the library itself: ncurses is not required + or linked to. xterm mouse tracking using UTF8 and SGR coordinates + are supported. For the demo application, this is the default + backend on non-Windows/non-Mac platforms. + +* The same command-line ECMA-48 / ANSI X3.64 type terminal as above, + but to any general InputStream/OutputStream or Reader/Writer. See + the file jexer.demos.Demo2 for an example of running the demo over a + TCP socket. jexer.demos.Demo3 demonstrates how one might use a + character encoding than the default UTF-8. + +* Java Swing UI. This backend can be selected by setting + jexer.Swing=true. The default window size for Swing is 80x25, which + is set in jexer.session.SwingSession. For the demo application, + this is the default backend on Windows and Mac platforms. + +Additional backends can be created by subclassing +jexer.backend.Backend and passing it into the TApplication +constructor. + +The Jexer homepage, which includes additional information and binary +release downloads, is at: https://jexer.sourceforge.io . The Jexer +source code is hosted at: https://github.com/klamonte/jexer . + + + +License +------- + +This project is licensed under the MIT License. See the file LICENSE +for the full license text. + + + +Acknowledgements +---------------- + +Jexer makes use of the Terminus TrueType font [made available +here](http://files.ax86.net/terminus-ttf/) . + + + +Usage +----- + +Simply subclass TApplication and then run it in a new thread: + +```Java +import jexer.*; + +class MyApplication extends TApplication { + + public MyApplication() throws Exception { + super(BackendType.SWING); // Could also use BackendType.XTERM + + // Create standard menus for File and Window + addFileMenu(); + addWindowMenu(); + + // Add a custom window, see below for its code. + addWindow(new MyWindow(this)); + } + + public static void main(String [] args) { + try { + MyApplication app = new MyApplication(); + (new Thread(app)).start(); + } catch (Throwable t) { + t.printStackTrace(); + } + } +} +``` + +Similarly, subclass TWindow and add some widgets: + +```Java +class MyWindow extends TWindow { + + public MyWindow(TApplication application) { + // See TWindow's API for several constructors. This one uses the + // application, title, width, and height. Note that the window width + // and height include the borders. The widgets inside the window + // will see (0, 0) as the top-left corner inside the borders, + // i.e. what the window would see as (1, 1). + super(application, "My Window", 30, 20); + + // See TWidget's API for convenience methods to add various kinds of + // widgets. Note that ANY widget can be a container for other + // widgets: TRadioGroup for example has TRadioButtons as child + // widgets. + + // We will add a basic label, text entry field, and button. + addLabel("This is a label", 5, 3); + addField(5, 5, 20, false, "enter text here"); + // For the button, we will pop up a message box if the user presses + // it. + addButton("Press &Me!", 5, 8, new TAction() { + public void DO() { + MyWindow.this.messageBox("Box Title", "You pressed me, yay!"); + } + } ); + } +} +``` + +Put these into a file, compile it with jexer.jar in the classpath, run +it and you'll see an application like this: + +![The Example Code Above](/screenshots/readme_application.png?raw=true "The application in the text of README.md") + +See the files in jexer.demos for many more detailed examples showing +all of the existing UI controls. The demo can be run in three +different ways: + + * 'java -jar jexer.jar' . This will use System.in/out with + xterm-like sequences on non-Windows platforms. On Windows it will + use a Swing JFrame. + + * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use + Swing on any platform. + + * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a + number to run the TCP daemon on). This will use the telnet + protocol to establish an 8-bit clean channel and be aware of + screen size changes. + + + +More Screenshots +---------------- + +![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal") + +![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.") + + + +System Properties +----------------- + +The following properties control features of Jexer: + + jexer.Swing + ----------- + + Used only by jexer.demos.Demo1. If true, use the Swing interface + for the demo application. Default: true on Windows platforms + (os.name starts with "Windows"), false on non-Windows platforms. + + jexer.Swing.cursorStyle + ----------------------- + + Used by jexer.io.SwingScreen. Selects the cursor style to draw. + Valid values are: underline, block, outline. Default: underline. + + + +Known Issues / Arbitrary Decisions +---------------------------------- + +Some arbitrary design decisions had to be made when either the +obviously expected behavior did not happen or when a specification was +ambiguous. This section describes such issues. + + - See jexer.tterminal.ECMA48 for more specifics of terminal + emulation limitations. + + - TTerminalWindow uses cmd.exe on Windows. Output will not be seen + until enter is pressed, due to cmd.exe's use of line-oriented + input (see the ENABLE_LINE_INPUT flag for GetConsoleMode() and + SetConsoleMode()). + + - TTerminalWindow launches 'script -fqe /dev/null' or 'script -q -F + /dev/null' on non-Windows platforms. This is a workaround for the + C library behavior of checking for a tty: script launches $SHELL + in a pseudo-tty. This works on Linux and Mac but might not on + other Posix-y platforms. + + - Closing a TTerminalWindow without exiting the process inside it + may result in a zombie 'script' process. + + - Java's InputStreamReader as used by the ECMA48 backend requires a + valid UTF-8 stream. The default X10 encoding for mouse + coordinates outside (160,94) can corrupt that stream, at best + putting garbage keyboard events in the input queue but at worst + causing the backend reader thread to throw an Exception and exit + and make the entire UI unusable. Mouse support therefore requires + a terminal that can deliver either UTF-8 coordinates (1005 mode) + or SGR coordinates (1006 mode). Most modern terminals can do + this. + + - jexer.session.TTYSession calls 'stty size' once every second to + check the current window size, performing the same function as + ioctl(TIOCGWINSZ) but without requiring a native library. + + - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of + cfmakeraw() when using System.in/out. System.out is also + (blindly!) put in 'stty sane cooked' mode when exiting. + + + +Roadmap +------- + +Many tasks remain before calling this version 1.0. See docs/TODO.md +for the complete list of tasks. diff --git a/libs/jsoup-1.10.3-sources.jar b/libs/jsoup-1.10.3-sources.jar new file mode 100644 index 0000000..1fe0db4 Binary files /dev/null and b/libs/jsoup-1.10.3-sources.jar differ diff --git a/libs/licenses/JSON-java-20190722_LICENSE.txt b/libs/licenses/JSON-java-20190722_LICENSE.txt new file mode 100644 index 0000000..02ee0ef --- /dev/null +++ b/libs/licenses/JSON-java-20190722_LICENSE.txt @@ -0,0 +1,23 @@ +============================================================================ + +Copyright (c) 2002 JSON.org + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +The Software shall be used for Good, not Evil. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/libs/licenses/jexer-0.0.4_LICENSE.txt b/libs/licenses/jexer-0.0.4_LICENSE.txt new file mode 100644 index 0000000..09bbfe0 --- /dev/null +++ b/libs/licenses/jexer-0.0.4_LICENSE.txt @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2016 Kevin Lamonte + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/libs/licenses/nanohttpd-2.3.1-LICENSE.md b/libs/licenses/nanohttpd-2.3.1-LICENSE.md new file mode 100644 index 0000000..8dc4ca7 --- /dev/null +++ b/libs/licenses/nanohttpd-2.3.1-LICENSE.md @@ -0,0 +1,12 @@ +Copyright (c) 2012-2013 by Paul S. Hawke, 2001,2005-2013 by Jarno Elonen, 2010 by Konstantinos Togias +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + +* Neither the name of the NanoHttpd organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/libs/licenses/unbescape-1.1.4_LICENSE.txt b/libs/licenses/unbescape-1.1.4_LICENSE.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/libs/licenses/unbescape-1.1.4_LICENSE.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/libs/nanohttpd-nanohttpd-project-2.3.1.tar.gz b/libs/nanohttpd-nanohttpd-project-2.3.1.tar.gz new file mode 100644 index 0000000..250f05f Binary files /dev/null and b/libs/nanohttpd-nanohttpd-project-2.3.1.tar.gz differ diff --git a/libs/subtree.txt b/libs/subtree.txt new file mode 100755 index 0000000..aea12d8 --- /dev/null +++ b/libs/subtree.txt @@ -0,0 +1,16 @@ +# Subtrees + +# The subtrees used for this program: +# ```git subtree add -P src/be/nikiroo/utils git@github.com:nikiroo/nikiroo-utils.git subtree``` +# ```git subtree add -P src/jexer git@github.com:nikiroo/jexer.git subtree``` + +# Update all subtrees: + +#git subtree pull -P src/be/nikiroo/utils git@github.com:nikiroo/nikiroo-utils.git subtree +#git subtree pull -P src/jexer git@github.com:nikiroo/jexer.git subtree + +# Push all subtrees: + +git subtree push -P src/be/nikiroo/utils git@github.com:nikiroo/nikiroo-utils.git subtree +git subtree push -P src/jexer git@github.com:nikiroo/jexer.git subtree + diff --git a/libs/unbescape-1.1.4-sources.jar b/libs/unbescape-1.1.4-sources.jar new file mode 100644 index 0000000..01ddb56 Binary files /dev/null and b/libs/unbescape-1.1.4-sources.jar differ diff --git a/libs/unbescape-1.1.4_ChangeLog.txt b/libs/unbescape-1.1.4_ChangeLog.txt new file mode 100644 index 0000000..9cec6ec --- /dev/null +++ b/libs/unbescape-1.1.4_ChangeLog.txt @@ -0,0 +1,32 @@ +1.1.4.RELEASE +============= +- Added ampersand (&) to the list of characters to be escaped in LEVEL 1 for JSON, JavaScript and CSS literals + in order to make escaped code safe against code injection attacks in XHTML scenarios (browsers using XHTML + processing mode) performed by means of including XHTML escape codes in literals. + +1.1.3.RELEASE +============= +- Improved performance of String-based unescape methods for HTML, XML, JS, JSON and others when the + text to be unescaped actually needs no unescaping. + +1.1.2.RELEASE +============= +- Added support for stream-based (String-to-Writer and Reader-to-Writer) escape and unescape operations. + +1.1.1.RELEASE +============= +- Fixed HTML unescape for codepoints > U+10FFFF (was throwing IllegalArgumentException). +- Fixed HTML unescape for codepoints > Integer.MAX_VALUE (was throwing ArrayIndexOutOfBounds). +- Simplified and improved performance of codepoint-computing code by using Character.codePointAt(...) instead + of a complex conditional structure based on Character.isHighSurrogate(...) and Character.isLowSurrogate(...). +- [doc] Fixed description of MSExcel-compatible CSV files. + + +1.1.0.RELEASE +============= +- Added URI/URL escape and unescape operations. + + +1.0 +=== +- First release of unbescape. diff --git a/screenshots/README-fr.md b/screenshots/README-fr.md new file mode 100644 index 0000000..7e77e61 --- /dev/null +++ b/screenshots/README-fr.md @@ -0,0 +1,50 @@ +# Fanfix + +## Screenshots + +Fanfix peut utiliser plusieurs interfaces : + +- GUI: une interface basée sur Swing, pour afficher le programme sur votre PC graphiquement +- TUI: une interface basée sur [jexer](https://gitlab.com/klamonte/jexer/), pour afficher des fenêtre et des boutons en mode texte +- CLI: une interface purement en lignes de commandes, facile à automatiser dans un script ou pour utiliser dans un terminal texte + +Cette gallerie reprend des screenshots de plusieurs versions de Fanfix, mais les versions les plus récentes sont affichées en premier. + +### Version 2.0.0 + +#### GUI + +![Fenêtre principale](fanfix-2.0.0-gui-library.png) + +![Propriétés d'une histoire](fanfix-2.0.0-gui-properties.png) + +![Menu](fanfix-2.0.0-gui-menu.png) + +#### TUI + +![Fenêtre principale](fanfix-2.0.0-tui-library.png) + +![Propriétés d'une histoire](fanfix-2.0.0-tui-properties.png) + +![Menu](fanfix-2.0.0-tui-menu.png) + +#### CLI + +![Fenêtre principale](fanfix-2.0.0-cli-library.png) + +![Propriétés d'une histoire](fanfix-2.0.0-cli-properties.png) + +![Menu](fanfix-2.0.0-cli-menu.png) + +### Version 1.3.2 + +#### GUI + +![Fenêtre principale](fanfix-1.3.2.png) + +### Version 1.0.0 + +#### GUI + +![Fenêtre principale](fanfix-1.0.0.png) + diff --git a/screenshots/README.md b/screenshots/README.md new file mode 100644 index 0000000..d1500ae --- /dev/null +++ b/screenshots/README.md @@ -0,0 +1,49 @@ +# Fanfix + +## Screenshots + +Fanfix can use different interfaces: + +- GUI: a Swing-based interface to display on your desktop +- TUI: a [jexer](https://gitlab.com/klamonte/jexer/)-based interface to display in text mode, but still with window, buttons and other widgets +- CLI: a fully automated CLI mode that can be used for scripts or to read on a terminal screen + +This screenshots gallery shows screenshots of different versions of Fanfix, but shows the more recent ones on top. + +### Version 2.0.0 + +#### GUI + +![Main window](fanfix-2.0.0-gui-library.png) + +![Properties page](fanfix-2.0.0-gui-properties.png) + +![Menu](fanfix-2.0.0-gui-menu.png) + +#### TUI + +![Main window](fanfix-2.0.0-tui-library.png) + +![Properties page](fanfix-2.0.0-tui-properties.png) + +![Menu](fanfix-2.0.0-tui-menu.png) + +#### CLI + +![Main window](fanfix-2.0.0-cli-library.png) + +![Properties page](fanfix-2.0.0-cli-properties.png) + +![Menu](fanfix-2.0.0-cli-menu.png) + +### Version 1.3.2 + +#### GUI + +![Main window](fanfix-1.3.2.png) + +### Version 1.0.0 + +#### GUI + +![Main window](fanfix-1.0.0.png) diff --git a/screenshots/fanfix-1.0.0.png b/screenshots/fanfix-1.0.0.png new file mode 100644 index 0000000..d4d6c26 Binary files /dev/null and b/screenshots/fanfix-1.0.0.png differ diff --git a/screenshots/fanfix-1.3.2.png b/screenshots/fanfix-1.3.2.png new file mode 100644 index 0000000..6ea39ce Binary files /dev/null and b/screenshots/fanfix-1.3.2.png differ diff --git a/src/be/nikiroo/fanfix/DataLoader.java b/src/be/nikiroo/fanfix/DataLoader.java new file mode 100644 index 0000000..901e8da --- /dev/null +++ b/src/be/nikiroo/fanfix/DataLoader.java @@ -0,0 +1,396 @@ +package be.nikiroo.fanfix; + +import java.io.File; +import java.io.IOException; +import java.io.InputStream; +import java.net.URL; +import java.util.Map; + +import be.nikiroo.fanfix.bundles.Config; +import be.nikiroo.fanfix.supported.BasicSupport; +import be.nikiroo.utils.Cache; +import be.nikiroo.utils.CacheMemory; +import be.nikiroo.utils.Downloader; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.ImageUtils; +import be.nikiroo.utils.TraceHandler; + +/** + * This cache will manage Internet (and local) downloads, as well as put the + * downloaded files into a cache. + *

+ * As long the cached resource is not too old, it will use it instead of + * retrieving the file again. + * + * @author niki + */ +public class DataLoader { + private Downloader downloader; + private Downloader downloaderNoCache; + private Cache cache; + private boolean offline; + + /** + * Create a new {@link DataLoader} object. + * + * @param dir + * the directory to use as cache + * @param UA + * the User-Agent to use to download the resources + * @param hoursChanging + * the number of hours after which a cached file that is thought + * to change ~often is considered too old (or -1 for + * "never too old") + * @param hoursStable + * the number of hours after which a LARGE cached file that is + * thought to change rarely is considered too old (or -1 for + * "never too old") + * + * @throws IOException + * in case of I/O error + */ + public DataLoader(File dir, String UA, int hoursChanging, int hoursStable) + throws IOException { + downloader = new Downloader(UA, new Cache(dir, hoursChanging, + hoursStable)); + downloaderNoCache = new Downloader(UA); + + cache = downloader.getCache(); + } + + /** + * Create a new {@link DataLoader} object without disk cache (will keep a + * memory cache for manual cache operations). + * + * @param UA + * the User-Agent to use to download the resources + */ + public DataLoader(String UA) { + downloader = new Downloader(UA); + downloaderNoCache = downloader; + cache = new CacheMemory(); + } + + /** + * This {@link Downloader} is forbidden to try and connect to the network. + *

+ * If TRUE, it will only check the cache (even in no-cache mode!). + *

+ * Default is FALSE. + * + * @return TRUE if offline + */ + public boolean isOffline() { + return offline; + } + + /** + * This {@link Downloader} is forbidden to try and connect to the network. + *

+ * If TRUE, it will only check the cache (even in no-cache mode!). + *

+ * Default is FALSE. + * + * @param offline TRUE for offline, FALSE for online + */ + public void setOffline(boolean offline) { + this.offline = offline; + downloader.setOffline(offline); + downloaderNoCache.setOffline(offline); + + // If we don't, we cannot support no-cache using code in OFFLINE mode + if (offline) { + downloaderNoCache.setCache(cache); + } else { + downloaderNoCache.setCache(null); + } + } + + /** + * The traces handler for this {@link Cache}. + * + * @param tracer + * the new traces handler + */ + public void setTraceHandler(TraceHandler tracer) { + downloader.setTraceHandler(tracer); + downloaderNoCache.setTraceHandler(tracer); + cache.setTraceHandler(tracer); + if (downloader.getCache() != null) { + downloader.getCache().setTraceHandler(tracer); + } + + } + + /** + * Open a resource (will load it from the cache if possible, or save it into + * the cache after downloading if not). + *

+ * The cached resource will be assimilated to the given original {@link URL} + * + * @param url + * the resource to open + * @param support + * the support to use to download the resource (can be NULL) + * @param stable + * TRUE for more stable resources, FALSE when they often change + * + * @return the opened resource, NOT NULL + * + * @throws IOException + * in case of I/O error + */ + public InputStream open(URL url, BasicSupport support, boolean stable) + throws IOException { + return open(url, url, support, stable, null, null, null); + } + + /** + * Open a resource (will load it from the cache if possible, or save it into + * the cache after downloading if not). + *

+ * The cached resource will be assimilated to the given original {@link URL} + * + * @param url + * the resource to open + * @param originalUrl + * the original {@link URL} before any redirection occurs, which + * is also used for the cache ID if needed (so we can retrieve + * the content with this URL if needed) + * @param support + * the support to use to download the resource + * @param stable + * TRUE for more stable resources, FALSE when they often change + * + * @return the opened resource, NOT NULL + * + * @throws IOException + * in case of I/O error + */ + public InputStream open(URL url, URL originalUrl, BasicSupport support, + boolean stable) throws IOException { + return open(url, originalUrl, support, stable, null, null, null); + } + + /** + * Open a resource (will load it from the cache if possible, or save it into + * the cache after downloading if not). + *

+ * The cached resource will be assimilated to the given original {@link URL} + * + * @param url + * the resource to open + * @param originalUrl + * the original {@link URL} before any redirection occurs, which + * is also used for the cache ID if needed (so we can retrieve + * the content with this URL if needed) + * @param support + * the support to use to download the resource (can be NULL) + * @param stable + * TRUE for more stable resources, FALSE when they often change + * @param postParams + * the POST parameters + * @param getParams + * the GET parameters (priority over POST) + * @param oauth + * OAuth authorization (aka, "bearer XXXXXXX") + * + * @return the opened resource, NOT NULL + * + * @throws IOException + * in case of I/O error + */ + public InputStream open(URL url, URL originalUrl, BasicSupport support, + boolean stable, Map postParams, + Map getParams, String oauth) throws IOException { + + Map cookiesValues = null; + URL currentReferer = url; + + if (support != null) { + cookiesValues = support.getCookies(); + currentReferer = support.getCurrentReferer(); + // priority: arguments + if (oauth == null) { + oauth = support.getOAuth(); + } + } + + return downloader.open(url, originalUrl, currentReferer, cookiesValues, + postParams, getParams, oauth, stable); + } + + /** + * Open the given {@link URL} without using the cache, but still using and + * updating the cookies. + * + * @param url + * the {@link URL} to open + * @param support + * the {@link BasicSupport} used for the cookies + * @param postParams + * the POST parameters + * @param getParams + * the GET parameters (priority over POST) + * @param oauth + * OAuth authorization (aka, "bearer XXXXXXX") + * + * @return the {@link InputStream} of the opened page + * + * @throws IOException + * in case of I/O error + */ + public InputStream openNoCache(URL url, BasicSupport support, + Map postParams, Map getParams, + String oauth) throws IOException { + + Map cookiesValues = null; + URL currentReferer = url; + if (support != null) { + cookiesValues = support.getCookies(); + currentReferer = support.getCurrentReferer(); + // priority: arguments + if (oauth == null) { + oauth = support.getOAuth(); + } + } + + return downloaderNoCache.open(url, currentReferer, cookiesValues, + postParams, getParams, oauth); + } + + /** + * Refresh the resource into cache if needed. + * + * @param url + * the resource to open + * @param support + * the support to use to download the resource (can be NULL) + * @param stable + * TRUE for more stable resources, FALSE when they often change + * + * @throws IOException + * in case of I/O error + */ + public void refresh(URL url, BasicSupport support, boolean stable) + throws IOException { + if (!check(url, stable)) { + open(url, url, support, stable, null, null, null).close(); + } + } + + /** + * Check the resource to see if it is in the cache. + * + * @param url + * the resource to check + * @param stable + * a stable file (that dones't change too often) -- parameter + * used to check if the file is too old to keep or not + * + * @return TRUE if it is + * + */ + public boolean check(URL url, boolean stable) { + return downloader.getCache() != null + && downloader.getCache().check(url, false, stable); + } + + /** + * Save the given resource as an image on disk using the default image + * format for content or cover -- will automatically add the extension, too. + * + * @param img + * the resource + * @param target + * the target file without extension + * @param cover + * use the cover image format instead of the content image format + * + * @throws IOException + * in case of I/O error + */ + public void saveAsImage(Image img, File target, boolean cover) + throws IOException { + String format; + if (cover) { + format = Instance.getInstance().getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); + } else { + format = Instance.getInstance().getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_CONTENT) + .toLowerCase(); + } + saveAsImage(img, new File(target.toString() + "." + format), format); + } + + /** + * Save the given resource as an image on disk using the given image format + * for content, or with "png" format if it fails. + * + * @param img + * the resource + * @param target + * the target file + * @param format + * the file format ("png", "jpeg", "bmp"...) + * + * @throws IOException + * in case of I/O error + */ + public void saveAsImage(Image img, File target, String format) + throws IOException { + ImageUtils.getInstance().saveAsImage(img, target, format); + } + + /** + * Manually add this item to the cache. + * + * @param in + * the input data + * @param uniqueID + * a unique ID for this resource + * + * + * @throws IOException + * in case of I/O error + */ + public void addToCache(InputStream in, String uniqueID) throws IOException { + cache.save(in, uniqueID); + } + + /** + * Return the {@link InputStream} corresponding to the given unique ID, or + * NULL if none found. + * + * @param uniqueID + * the unique ID + * + * @return the content or NULL + */ + public InputStream getFromCache(String uniqueID) { + return cache.load(uniqueID, true, true); + } + + /** + * Remove the given resource from the cache. + * + * @param uniqueID + * a unique ID used to locate the cached resource + * + * @return TRUE if it was removed + */ + public boolean removeFromCache(String uniqueID) { + return cache.remove(uniqueID); + } + + /** + * Clean the cache (delete the cached items). + * + * @param onlyOld + * only clean the files that are considered too old + * + * @return the number of cleaned items + */ + public int cleanCache(boolean onlyOld) { + return cache.clean(onlyOld); + } +} diff --git a/src/be/nikiroo/fanfix/Instance.java b/src/be/nikiroo/fanfix/Instance.java new file mode 100644 index 0000000..e0a0727 --- /dev/null +++ b/src/be/nikiroo/fanfix/Instance.java @@ -0,0 +1,704 @@ +package be.nikiroo.fanfix; + +import java.io.File; +import java.io.IOException; +import java.util.Date; + +import be.nikiroo.fanfix.bundles.Config; +import be.nikiroo.fanfix.bundles.ConfigBundle; +import be.nikiroo.fanfix.bundles.StringId; +import be.nikiroo.fanfix.bundles.StringIdBundle; +import be.nikiroo.fanfix.bundles.StringIdGuiBundle; +import be.nikiroo.fanfix.bundles.UiConfig; +import be.nikiroo.fanfix.bundles.UiConfigBundle; +import be.nikiroo.fanfix.library.BasicLibrary; +import be.nikiroo.fanfix.library.CacheLibrary; +import be.nikiroo.fanfix.library.LocalLibrary; +import be.nikiroo.fanfix.library.RemoteLibrary; +import be.nikiroo.fanfix.library.WebLibrary; +import be.nikiroo.utils.Cache; +import be.nikiroo.utils.IOUtils; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.Proxy; +import be.nikiroo.utils.TempFiles; +import be.nikiroo.utils.TraceHandler; +import be.nikiroo.utils.resources.Bundles; + +/** + * Global state for the program (services and singletons). + * + * @author niki + */ +public class Instance { + static private Instance instance; + static private Object instancelock = new Object(); + + private ConfigBundle config; + private UiConfigBundle uiconfig; + private StringIdBundle trans; + private DataLoader cache; + private StringIdGuiBundle transGui; + private BasicLibrary lib; + private File coverDir; + private File readerTmp; + private File remoteDir; + private String configDir; + private TraceHandler tracer; + private TempFiles tempFiles; + + /** + * Initialise the instance -- if already initialised, nothing will happen. + *

+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + *

+ * Note that this method will honour some environment variables, the 3 most + * important ones probably being: + *

    + *
  • DEBUG: will enable DEBUG output if set to 1 (or Y or TRUE or + * ON, case insensitive)
    • + *
  • CONFIG_DIR: will use this directory as configuration + * directory (supports $HOME notation, defaults to $HOME/.fanfix
    • + *
  • BOOKS_DIR: will use this directory as library directory + * (supports $HOME notation, defaults to $HOME/Books
    • + *
+ */ + static public void init() { + init(false); + } + + /** + * Initialise the instance -- if already initialised, nothing will happen + * unless you pass TRUE to force. + *

+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + *

+ * Note: forcing the initialisation can be dangerous, so make sure to only + * make it under controlled circumstances -- for instance, at the start of + * the program, you could call {@link Instance#init()}, change some settings + * because you want to force those settings (it will also forbid users to + * change them!) and then call {@link Instance#init(boolean)} with + * force set to TRUE. + * + * @param force + * force the initialisation even if already initialised + */ + static public void init(boolean force) { + synchronized (instancelock) { + if (instance == null || force) { + instance = new Instance(); + } + } + + } + + /** + * Force-initialise the {@link Instance} to a known value. + *

+ * Usually for DEBUG/Test purposes. + * + * @param instance + * the actual Instance to use + */ + static public void init(Instance instance) { + Instance.instance = instance; + } + + /** + * The (mostly unique) instance of this {@link Instance}. + * + * @return the (mostly unique) instance + */ + public static Instance getInstance() { + return instance; + } + + /** + * Actually initialise the instance. + *

+ * Before calling this method, you may call + * {@link Bundles#setDirectory(String)} if wanted. + */ + protected Instance() { + // Before we can configure it: + Boolean debug = checkEnv("DEBUG"); + boolean trace = debug != null && debug; + tracer = new TraceHandler(true, trace, trace); + + // config dir: + configDir = getConfigDir(); + if (!new File(configDir).exists()) { + new File(configDir).mkdirs(); + } + + // Most of the rest is dependent upon this: + createConfigs(configDir, false); + + // Proxy support + Proxy.use(config.getString(Config.NETWORK_PROXY)); + + // update tracer: + if (debug == null) { + debug = config.getBoolean(Config.DEBUG_ERR, false); + trace = config.getBoolean(Config.DEBUG_TRACE, false); + } + + tracer = new TraceHandler(true, debug, trace); + + // default Library + remoteDir = new File(configDir, "remote"); + lib = createDefaultLibrary(remoteDir); + + // create cache and TMP + File tmp = getFile(Config.CACHE_DIR, configDir, "tmp"); + Image.setTemporaryFilesRoot(new File(tmp.getParent(), "tmp.images")); + + String ua = config.getString(Config.NETWORK_USER_AGENT, ""); + try { + int hours = config.getInteger(Config.CACHE_MAX_TIME_CHANGING, 0); + int hoursLarge = config.getInteger(Config.CACHE_MAX_TIME_STABLE, 0); + cache = new DataLoader(tmp, ua, hours, hoursLarge); + } catch (IOException e) { + tracer.error(new IOException( + "Cannot create cache (will continue without cache)", e)); + cache = new DataLoader(ua); + } + + cache.setTraceHandler(tracer); + + // readerTmp / coverDir + readerTmp = getFile(UiConfig.CACHE_DIR_LOCAL_READER, configDir, + "tmp-reader"); + coverDir = getFile(Config.DEFAULT_COVERS_DIR, configDir, "covers"); + coverDir.mkdirs(); + + try { + tempFiles = new TempFiles("fanfix"); + } catch (IOException e) { + tracer.error( + new IOException("Cannot create temporary directory", e)); + } + } + + /** + * The traces handler for this {@link Cache}. + *

+ * It is never NULL. + * + * @return the traces handler (never NULL) + */ + public TraceHandler getTraceHandler() { + return tracer; + } + + /** + * The traces handler for this {@link Cache}. + * + * @param tracer + * the new traces handler or NULL + */ + public void setTraceHandler(TraceHandler tracer) { + if (tracer == null) { + tracer = new TraceHandler(false, false, false); + } + + this.tracer = tracer; + cache.setTraceHandler(tracer); + } + + /** + * Get the (unique) configuration service for the program. + * + * @return the configuration service + */ + public ConfigBundle getConfig() { + return config; + } + + /** + * Get the (unique) UI configuration service for the program. + * + * @return the configuration service + */ + public UiConfigBundle getUiConfig() { + return uiconfig; + } + + /** + * Reset the configuration. + * + * @param resetTrans + * also reset the translation files + */ + public void resetConfig(boolean resetTrans) { + String dir = Bundles.getDirectory(); + Bundles.setDirectory(null); + try { + try { + ConfigBundle config = new ConfigBundle(); + config.updateFile(configDir); + } catch (IOException e) { + tracer.error(e); + } + try { + UiConfigBundle uiconfig = new UiConfigBundle(); + uiconfig.updateFile(configDir); + } catch (IOException e) { + tracer.error(e); + } + + if (resetTrans) { + try { + StringIdBundle trans = new StringIdBundle(null); + trans.updateFile(configDir); + } catch (IOException e) { + tracer.error(e); + } + } + } finally { + Bundles.setDirectory(dir); + } + } + + /** + * Get the (unique) {@link DataLoader} for the program. + * + * @return the {@link DataLoader} + */ + public DataLoader getCache() { + return cache; + } + + /** + * Get the (unique) {link StringIdBundle} for the program. + *

+ * This is used for the translations of the core parts of Fanfix. + * + * @return the {link StringIdBundle} + */ + public StringIdBundle getTrans() { + return trans; + } + + /** + * Get the (unique) {link StringIdGuiBundle} for the program. + *

+ * This is used for the translations of the GUI parts of Fanfix. + * + * @return the {link StringIdGuiBundle} + */ + public StringIdGuiBundle getTransGui() { + return transGui; + } + + /** + * Get the (unique) {@link BasicLibrary} for the program. + * + * @return the {@link BasicLibrary} + */ + public BasicLibrary getLibrary() { + if (lib == null) { + throw new NullPointerException("We don't have a library to return"); + } + + return lib; + } + + /** + * Change the default {@link BasicLibrary} for this program. + *

+ * Be careful. + * + * @param lib + * the new {@link BasicLibrary} + */ + public void setLibrary(BasicLibrary lib) { + this.lib = lib; + } + + /** + * Return the directory where to look for default cover pages. + * + * @return the default covers directory + */ + public File getCoverDir() { + return coverDir; + } + + /** + * Return the directory where to store temporary files for the local reader. + * + * @return the directory + */ + public File getReaderDir() { + return readerTmp; + } + + /** + * Return the directory where to store temporary files for the remote + * {@link LocalLibrary}. + * + * @param host + * the remote for this host + * + * @return the directory + */ + public File getRemoteDir(String host) { + return getRemoteDir(remoteDir, host); + } + + /** + * Return the directory where to store temporary files for the remote + * {@link LocalLibrary}. + * + * @param remoteDir + * the base remote directory + * @param host + * the remote for this host + * + * @return the directory + */ + private File getRemoteDir(File remoteDir, String host) { + remoteDir.mkdirs(); + + if (host != null) { + host = host.replace("fanfix://", ""); + host = host.replace("http://", ""); + host = host.replace("https://", ""); + host = host.replaceAll("[^a-zA-Z0-9=+.-]", "_"); + + return new File(remoteDir, host); + } + + return remoteDir; + } + + /** + * Check if we need to check that a new version of Fanfix is available. + * + * @return TRUE if we need to + */ + public boolean isVersionCheckNeeded() { + try { + long wait = config.getInteger(Config.NETWORK_UPDATE_INTERVAL, 0) + * 24 * 60 * 60 * 1000; + if (wait >= 0) { + String lastUpString = IOUtils + .readSmallFile(new File(configDir, "LAST_UPDATE")); + long delay = new Date().getTime() + - Long.parseLong(lastUpString); + if (delay > wait) { + return true; + } + } else { + return false; + } + } catch (Exception e) { + // No file or bad file: + return true; + } + + return false; + } + + /** + * Notify that we checked for a new version of Fanfix. + */ + public void setVersionChecked() { + try { + IOUtils.writeSmallFile(new File(configDir), "LAST_UPDATE", + Long.toString(new Date().getTime())); + } catch (IOException e) { + tracer.error(e); + } + } + + /** + * The facility to use temporary files in this program. + *

+ * MUST be closed at end of program. + * + * @return the facility + */ + public TempFiles getTempFiles() { + return tempFiles; + } + + /** + * The configuration directory (will check, in order of preference, the + * system properties, the environment and then defaults to + * {@link Instance#getHome()}/.fanfix). + * + * @return the config directory + */ + private String getConfigDir() { + String configDir = System.getProperty("CONFIG_DIR"); + + if (configDir == null) { + configDir = System.getenv("CONFIG_DIR"); + } + + if (configDir == null) { + configDir = new File(getHome(), ".fanfix").getPath(); + } + + return configDir; + } + + /** + * Create the config variables ({@link Instance#config}, + * {@link Instance#uiconfig}, {@link Instance#trans} and + * {@link Instance#transGui}). + * + * @param configDir + * the directory where to find the configuration files + * @param refresh + * TRUE to reset the configuration files from the default + * included ones + */ + private void createConfigs(String configDir, boolean refresh) { + if (!refresh) { + Bundles.setDirectory(configDir); + } + + try { + config = new ConfigBundle(); + config.updateFile(configDir); + } catch (IOException e) { + tracer.error(e); + } + + try { + uiconfig = new UiConfigBundle(); + uiconfig.updateFile(configDir); + } catch (IOException e) { + tracer.error(e); + } + + // No updateFile for this one! (we do not want the user to have custom + // translations that won't accept updates from newer versions) + trans = new StringIdBundle(getLang()); + transGui = new StringIdGuiBundle(getLang()); + + // Fix an old bug (we used to store custom translation files by + // default): + if (trans.getString(StringId.INPUT_DESC_CBZ) == null) { + trans.deleteFile(configDir); + } + + Boolean noutf = checkEnv("NOUTF"); + if (noutf != null && noutf) { + trans.setUnicode(false); + transGui.setUnicode(false); + } + + Bundles.setDirectory(configDir); + } + + /** + * Create the default library as specified by the config. + * + * @param remoteDir + * the base remote directory if needed + * + * @return the default {@link BasicLibrary} + */ + private BasicLibrary createDefaultLibrary(File remoteDir) { + BasicLibrary lib = null; + + boolean useRemote = config.getBoolean(Config.REMOTE_LIBRARY_ENABLED, + false); + if (useRemote) { + String host = null; + int port = -1; + try { + host = config.getString(Config.REMOTE_LIBRARY_HOST, + "fanfix://localhost"); + port = config.getInteger(Config.REMOTE_LIBRARY_PORT, -1); + String key = config.getString(Config.REMOTE_LIBRARY_KEY); + + if (!host.startsWith("http://") && !host.startsWith("https://") + && !host.startsWith("fanfix://")) { + host = "fanfix://" + host; + } + + tracer.trace("Selecting remote library " + host + ":" + port); + + if (host.startsWith("fanfix://")) { + lib = new RemoteLibrary(key, host, port); + } else { + lib = new WebLibrary(key, host, port); + } + + lib = new CacheLibrary(getRemoteDir(remoteDir, host), lib, + uiconfig); + } catch (Exception e) { + tracer.error( + new IOException("Cannot create remote library for: " + + host + ":" + port, e)); + } + } else { + String libDir = System.getenv("BOOKS_DIR"); + if (libDir == null || libDir.isEmpty()) { + libDir = getFile(Config.LIBRARY_DIR, configDir, "$HOME/Books") + .getPath(); + } + try { + lib = new LocalLibrary(new File(libDir), config); + } catch (Exception e) { + tracer.error(new IOException( + "Cannot create library for directory: " + libDir, e)); + } + } + + return lib; + } + + /** + * Return a path, but support the special $HOME variable. + * + * @param id + * the key for the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @param def + * the default value if none (will be configDir-rooted if needed) + * @return the path, with expanded "$HOME" if needed + */ + protected File getFile(Config id, String configDir, String def) { + String path = config.getString(id, def); + return getFile(path, configDir); + } + + /** + * Return a path, but support the special $HOME variable. + * + * @param id + * the key for the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @param def + * the default value if none (will be configDir-rooted if needed) + * @return the path, with expanded "$HOME" if needed + */ + protected File getFile(UiConfig id, String configDir, String def) { + String path = uiconfig.getString(id, def); + return getFile(path, configDir); + } + + /** + * Return a path, but support the special $HOME variable. + * + * @param path + * the path, which may contain "$HOME" + * @param configDir + * the directory to use as base if not absolute + * @return the path, with expanded "$HOME" if needed + */ + protected File getFile(String path, String configDir) { + File file = null; + if (path != null && !path.isEmpty()) { + path = path.replace('/', File.separatorChar); + if (path.contains("$HOME")) { + path = path.replace("$HOME", getHome()); + } else if (!path.startsWith("/")) { + path = new File(configDir, path).getPath(); + } + + file = new File(path); + } + + return file; + } + + /** + * Return the home directory from the environment (FANFIX_DIR) or the system + * properties. + *

+ * The environment variable is tested first. Then, the custom property + * "fanfix.home" is tried, followed by the usual "user.home" then + * "java.io.tmp" if nothing else is found. + * + * @return the home + */ + protected String getHome() { + String home = System.getenv("FANFIX_DIR"); + if (home != null && new File(home).isFile()) { + home = null; + } + + if (home == null || home.trim().isEmpty()) { + home = System.getProperty("fanfix.home"); + if (home != null && new File(home).isFile()) { + home = null; + } + } + + if (home == null || home.trim().isEmpty()) { + home = System.getProperty("user.home"); + if (!new File(home).isDirectory()) { + home = null; + } + } + + if (home == null || home.trim().isEmpty()) { + home = System.getProperty("java.io.tmpdir"); + if (!new File(home).isDirectory()) { + home = null; + } + } + + if (home == null) { + home = ""; + } + + return home; + } + + /** + * The language to use for the application (NULL = default system language). + * + * @return the language + */ + protected String getLang() { + String lang = config.getString(Config.LANG); + + if (lang == null || lang.isEmpty()) { + if (System.getenv("LANG") != null + && !System.getenv("LANG").isEmpty()) { + lang = System.getenv("LANG"); + } + } + + if (lang != null && lang.isEmpty()) { + lang = null; + } + + return lang; + } + + /** + * Check that the given environment variable is "enabled". + * + * @param key + * the variable to check + * + * @return TRUE if it is + */ + protected Boolean checkEnv(String key) { + String value = System.getenv(key); + if (value != null) { + value = value.trim().toLowerCase(); + if ("yes".equals(value) || "true".equals(value) + || "on".equals(value) || "1".equals(value) + || "y".equals(value)) { + return true; + } + + return false; + } + + return null; + } +} diff --git a/src/be/nikiroo/fanfix/Main.java b/src/be/nikiroo/fanfix/Main.java new file mode 100644 index 0000000..3536544 --- /dev/null +++ b/src/be/nikiroo/fanfix/Main.java @@ -0,0 +1,1141 @@ +package be.nikiroo.fanfix; + +import java.io.File; +import java.io.IOException; +import java.net.MalformedURLException; +import java.net.URL; +import java.util.ArrayList; +import java.util.List; + +import javax.net.ssl.SSLException; + +import be.nikiroo.fanfix.bundles.Config; +import be.nikiroo.fanfix.bundles.StringId; +import be.nikiroo.fanfix.data.Chapter; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.fanfix.library.BasicLibrary; +import be.nikiroo.fanfix.library.CacheLibrary; +import be.nikiroo.fanfix.library.LocalLibrary; +import be.nikiroo.fanfix.library.RemoteLibrary; +import be.nikiroo.fanfix.library.RemoteLibraryServer; +import be.nikiroo.fanfix.library.WebLibrary; +import be.nikiroo.fanfix.library.WebLibraryServer; +import be.nikiroo.fanfix.output.BasicOutput; +import be.nikiroo.fanfix.output.BasicOutput.OutputType; +import be.nikiroo.fanfix.reader.BasicReader; +import be.nikiroo.fanfix.reader.CliReader; +import be.nikiroo.fanfix.searchable.BasicSearchable; +import be.nikiroo.fanfix.supported.BasicSupport; +import be.nikiroo.fanfix.supported.SupportType; +import be.nikiroo.utils.Progress; +import be.nikiroo.utils.Version; +import be.nikiroo.utils.VersionCheck; + +/** + * Main program entry point. + * + * @author niki + */ +public class Main { + private enum MainAction { + IMPORT, EXPORT, CONVERT, READ, READ_URL, LIST, HELP, START, VERSION, SERVER, STOP_SERVER, REMOTE, SET_SOURCE, SET_TITLE, SET_AUTHOR, SEARCH, SEARCH_TAG + } + + /** + * Main program entry point. + *

+ * Known environment variables: + *

    + *
  • NOUTF: if set to 1 or 'true', the program will prefer non-unicode + * {@link String}s when possible
    • + *
  • CONFIG_DIR: a path where to look for the .properties files + * before taking the usual ones; they will also be saved/updated into this + * path when the program starts
    • + *
  • DEBUG: if set to 1 or 'true', the program will override the DEBUG_ERR + * configuration value with 'true'
    • + *
+ *

+ *

    + *
  • --import [URL]: import into library
    • + *
  • --export [id] [output_type] [target]: export story to target
    • + *
  • --convert [URL] [output_type] [target] (+info): convert URL into + * target
    • + *
  • --read [id] ([chapter number]): read the given story from the library + *
    • + *
  • --read-url [URL] ([chapter number]): convert on the fly and read the + * story, without saving it
    • + *
  • --search: list the supported websites (where)
    • + *
  • --search [where] [keywords] (page [page]) (item [item]): search on + * the supported website and display the given results page of stories it + * found, or the story details if asked
    • + *
  • --search-tag [where]: list all the tags supported by this website
    • + *
  • --search-tag [index 1]... (page [page]) (item [item]): search for the + * given stories or subtags, tag by tag, and display information about a + * specific page of results or about a specific item if requested
    • + *
  • --list ([type]): list the stories present in the library
    • + *
  • --set-source [id] [new source]: change the source of the given story
    • + *
  • --set-title [id] [new title]: change the title of the given story
    • + *
  • --set-author [id] [new author]: change the author of the given story
    • + *
  • --version: get the version of the program
    • + *
  • --server: start the server mode (see config file for parameters)
    • + *
  • --stop-server: stop the running server on this port if any
    • + *
  • --remote [key] [host] [port]: use the given remote library
    • + *
+ * + * @param args + * see method description + */ + public static void main(String[] args) { + new Main().start(args); + } + + /** + * Start the default handling for the application. + *

+ * If specific actions were asked (with correct parameters), they will be + * forwarded to the different protected methods that you can override. + *

+ * At the end of the method, {@link Main#exit(int)} will be called; by + * default, it calls {@link System#exit(int)} if the status is not 0. + * + * @param args + * the arguments received from the system + */ + public void start(String [] args) { + // Only one line, but very important: + Instance.init(); + + String urlString = null; + String luid = null; + String sourceString = null; + String titleString = null; + String authorString = null; + String chapString = null; + String target = null; + String key = null; + MainAction action = MainAction.START; + Boolean plusInfo = null; + String host = null; + Integer port = null; + SupportType searchOn = null; + String search = null; + List tags = new ArrayList(); + Integer page = null; + Integer item = null; + + boolean noMoreActions = false; + + int exitCode = 0; + for (int i = 0; exitCode == 0 && i < args.length; i++) { + if (args[i] == null) + continue; + + // Action (--) handling: + if (!noMoreActions && args[i].startsWith("--")) { + if (args[i].equals("--")) { + noMoreActions = true; + } else { + try { + action = MainAction.valueOf(args[i].substring(2) + .toUpperCase().replace("-", "_")); + } catch (Exception e) { + Instance.getInstance().getTraceHandler() + .error(new IllegalArgumentException("Unknown action: " + args[i], e)); + exitCode = 255; + } + } + + continue; + } + + switch (action) { + case IMPORT: + if (urlString == null) { + urlString = args[i]; + } else { + exitCode = 255; + } + break; + case EXPORT: + if (luid == null) { + luid = args[i]; + } else if (sourceString == null) { + sourceString = args[i]; + } else if (target == null) { + target = args[i]; + } else { + exitCode = 255; + } + break; + case CONVERT: + if (urlString == null) { + urlString = args[i]; + } else if (sourceString == null) { + sourceString = args[i]; + } else if (target == null) { + target = args[i]; + } else if (plusInfo == null) { + if ("+info".equals(args[i])) { + plusInfo = true; + } else { + exitCode = 255; + } + } else { + exitCode = 255; + } + break; + case LIST: + if (sourceString == null) { + sourceString = args[i]; + } else { + exitCode = 255; + } + break; + case SET_SOURCE: + if (luid == null) { + luid = args[i]; + } else if (sourceString == null) { + sourceString = args[i]; + } else { + exitCode = 255; + } + break; + case SET_TITLE: + if (luid == null) { + luid = args[i]; + } else if (sourceString == null) { + titleString = args[i]; + } else { + exitCode = 255; + } + break; + case SET_AUTHOR: + if (luid == null) { + luid = args[i]; + } else if (sourceString == null) { + authorString = args[i]; + } else { + exitCode = 255; + } + break; + case READ: + if (luid == null) { + luid = args[i]; + } else if (chapString == null) { + chapString = args[i]; + } else { + exitCode = 255; + } + break; + case READ_URL: + if (urlString == null) { + urlString = args[i]; + } else if (chapString == null) { + chapString = args[i]; + } else { + exitCode = 255; + } + break; + case SEARCH: + if (searchOn == null) { + searchOn = SupportType.valueOfAllOkUC(args[i]); + + if (searchOn == null) { + Instance.getInstance().getTraceHandler().error("Website not known: <" + args[i] + ">"); + exitCode = 41; + break; + } + + if (BasicSearchable.getSearchable(searchOn) == null) { + Instance.getInstance().getTraceHandler().error("Website not supported: " + searchOn); + exitCode = 42; + break; + } + } else if (search == null) { + search = args[i]; + } else if (page != null && page == -1) { + try { + page = Integer.parseInt(args[i]); + } catch (Exception e) { + page = -2; + } + } else if (item != null && item == -1) { + try { + item = Integer.parseInt(args[i]); + } catch (Exception e) { + item = -2; + } + } else if (page == null || item == null) { + if (page == null && "page".equals(args[i])) { + page = -1; + } else if (item == null && "item".equals(args[i])) { + item = -1; + } else { + exitCode = 255; + } + } else { + exitCode = 255; + } + break; + case SEARCH_TAG: + if (searchOn == null) { + searchOn = SupportType.valueOfAllOkUC(args[i]); + + if (searchOn == null) { + Instance.getInstance().getTraceHandler().error("Website not known: <" + args[i] + ">"); + exitCode = 255; + } + + if (BasicSearchable.getSearchable(searchOn) == null) { + Instance.getInstance().getTraceHandler().error("Website not supported: " + searchOn); + exitCode = 255; + } + } else if (page == null && item == null) { + if ("page".equals(args[i])) { + page = -1; + } else if ("item".equals(args[i])) { + item = -1; + } else { + try { + int index = Integer.parseInt(args[i]); + tags.add(index); + } catch (NumberFormatException e) { + Instance.getInstance().getTraceHandler().error("Invalid tag index: " + args[i]); + exitCode = 255; + } + } + } else if (page != null && page == -1) { + try { + page = Integer.parseInt(args[i]); + } catch (Exception e) { + page = -2; + } + } else if (item != null && item == -1) { + try { + item = Integer.parseInt(args[i]); + } catch (Exception e) { + item = -2; + } + } else if (page == null || item == null) { + if (page == null && "page".equals(args[i])) { + page = -1; + } else if (item == null && "item".equals(args[i])) { + item = -1; + } else { + exitCode = 255; + } + } else { + exitCode = 255; + } + break; + case HELP: + exitCode = 255; + break; + case START: + exitCode = 255; // not supposed to be selected by user + break; + case VERSION: + exitCode = 255; // no arguments for this option + break; + case SERVER: + exitCode = 255; // no arguments for this option + break; + case STOP_SERVER: + exitCode = 255; // no arguments for this option + break; + case REMOTE: + if (key == null) { + key = args[i]; + } else if (host == null) { + host = args[i]; + } else if (port == null) { + port = Integer.parseInt(args[i]); + + BasicLibrary lib; + if (host.startsWith("http://") + || host.startsWith("https://")) { + lib = new WebLibrary(key, host, port); + } else { + lib = new RemoteLibrary(key, host, port); + } + + lib = new CacheLibrary( + Instance.getInstance().getRemoteDir(host), lib, + Instance.getInstance().getUiConfig()); + + Instance.getInstance().setLibrary(lib); + + action = MainAction.START; + } else { + exitCode = 255; + } + break; + } + } + + final Progress mainProgress = new Progress(0, 80); + mainProgress.addProgressListener(new Progress.ProgressListener() { + private int current = mainProgress.getMin(); + + @Override + public void progress(Progress progress, String name) { + int diff = progress.getProgress() - current; + current += diff; + + if (diff <= 0) + return; + + StringBuilder builder = new StringBuilder(); + for (int i = 0; i < diff; i++) { + builder.append('.'); + } + + System.err.print(builder.toString()); + + if (progress.isDone()) { + System.err.println(""); + } + } + }); + Progress pg = new Progress(); + mainProgress.addProgress(pg, mainProgress.getMax()); + + VersionCheck updates = checkUpdates(); + + if (exitCode == 0) { + switch (action) { + case IMPORT: + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + try { + exitCode = imprt(BasicReader.getUrl(urlString), pg); + } catch (MalformedURLException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 1; + } + + break; + case EXPORT: + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + OutputType exportType = OutputType.valueOfNullOkUC(sourceString, null); + if (exportType == null) { + Instance.getInstance().getTraceHandler().error(new Exception(trans(StringId.OUTPUT_DESC, sourceString))); + exitCode = 1; + break; + } + + exitCode = export(luid, exportType, target, pg); + + break; + case CONVERT: + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + OutputType convertType = OutputType.valueOfAllOkUC(sourceString, null); + if (convertType == null) { + Instance.getInstance().getTraceHandler() + .error(new IOException(trans(StringId.ERR_BAD_OUTPUT_TYPE, sourceString))); + + exitCode = 2; + break; + } + + exitCode = convert(urlString, convertType, target, + plusInfo == null ? false : plusInfo, pg); + + break; + case LIST: + exitCode = list(sourceString); + break; + case SET_SOURCE: + try { + Instance.getInstance().getLibrary().changeSource(luid, sourceString, pg); + } catch (IOException e1) { + Instance.getInstance().getTraceHandler().error(e1); + exitCode = 21; + } + break; + case SET_TITLE: + try { + Instance.getInstance().getLibrary().changeTitle(luid, titleString, pg); + } catch (IOException e1) { + Instance.getInstance().getTraceHandler().error(e1); + exitCode = 22; + } + break; + case SET_AUTHOR: + try { + Instance.getInstance().getLibrary().changeAuthor(luid, authorString, pg); + } catch (IOException e1) { + Instance.getInstance().getTraceHandler().error(e1); + exitCode = 23; + } + break; + case READ: + if (luid == null || luid.isEmpty()) { + syntax(false); + exitCode = 255; + break; + } + + try { + Integer chap = null; + if (chapString != null) { + try { + chap = Integer.parseInt(chapString); + } catch (NumberFormatException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + "Chapter number cannot be parsed: " + chapString, e)); + exitCode = 2; + break; + } + } + + BasicLibrary lib = Instance.getInstance().getLibrary(); + exitCode = read(lib.getStory(luid, null), chap); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException("Failed to read book", e)); + exitCode = 2; + } + + break; + case READ_URL: + if (urlString == null || urlString.isEmpty()) { + syntax(false); + exitCode = 255; + break; + } + + try { + Integer chap = null; + if (chapString != null) { + try { + chap = Integer.parseInt(chapString); + } catch (NumberFormatException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + "Chapter number cannot be parsed: " + chapString, e)); + exitCode = 2; + break; + } + } + + BasicSupport support = BasicSupport + .getSupport(BasicReader.getUrl(urlString)); + if (support == null) { + Instance.getInstance().getTraceHandler() + .error("URL not supported: " + urlString); + exitCode = 2; + break; + } + + exitCode = read(support.process(null), chap); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException("Failed to read book", e)); + exitCode = 2; + } + + break; + case SEARCH: + page = page == null ? 1 : page; + if (page < 0) { + Instance.getInstance().getTraceHandler().error("Incorrect page number"); + exitCode = 255; + break; + } + + item = item == null ? 0 : item; + if (item < 0) { + Instance.getInstance().getTraceHandler().error("Incorrect item number"); + exitCode = 255; + break; + } + + if (searchOn == null) { + try { + search(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 1; + } + } else if (search != null) { + try { + searchKeywords(searchOn, search, page, item); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 20; + } + } else { + exitCode = 255; + } + + break; + case SEARCH_TAG: + if (searchOn == null) { + exitCode = 255; + break; + } + + page = page == null ? 1 : page; + if (page < 0) { + Instance.getInstance().getTraceHandler().error("Incorrect page number"); + exitCode = 255; + break; + } + + item = item == null ? 0 : item; + if (item < 0) { + Instance.getInstance().getTraceHandler().error("Incorrect item number"); + exitCode = 255; + break; + } + + try { + searchTags(searchOn, page, item, + tags.toArray(new Integer[] {})); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + + break; + case HELP: + syntax(true); + exitCode = 0; + break; + case VERSION: + if (updates != null) { + // we consider it read + Instance.getInstance().setVersionChecked(); + } + + System.out + .println(String.format("Fanfix version %s" + + "%nhttps://github.com/nikiroo/fanfix/" + + "%n\tWritten by Nikiroo", + Version.getCurrentVersion())); + break; + case START: + try { + start(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 66; + } + break; + case SERVER: + try { + startServer(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + + break; + case STOP_SERVER: + // Can be given via "--remote XX XX XX" + if (key == null) { + key = Instance.getInstance().getConfig() + .getString(Config.SERVER_KEY); + + // If a subkey in RW mode exists, use it + for (String subkey : Instance.getInstance().getConfig() + .getList(Config.SERVER_ALLOWED_SUBKEYS, + new ArrayList())) { + if ((subkey + "|").contains("|rw|")) { + key = key + "|" + subkey; + break; + } + } + } + + if (port == null) { + port = Instance.getInstance().getConfig().getInteger(Config.SERVER_PORT); + } + + if (host == null) { + String mode = Instance.getInstance().getConfig() + .getString(Config.SERVER_MODE, "fanfix"); + if ("http".equals(mode)) { + host = "http://localhost"; + } else if ("https".equals(mode)) { + host = "https://localhost"; + } else if ("fanfix".equals(mode)) { + host = "fanfix://localhost"; + } + } + + if (port == null) { + System.err.println("No port given nor configured in the config file"); + exitCode = 15; + break; + } + try { + stopServer(key, host, port); + } catch (SSLException e) { + Instance.getInstance().getTraceHandler().error( + "Bad access key for remote library"); + exitCode = 43; + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + exitCode = 44; + } + + break; + case REMOTE: + exitCode = 255; // should not be reachable (REMOTE -> START) + break; + } + } + + try { + Instance.getInstance().getTempFiles().close(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + "Cannot dispose of the temporary files", e)); + } + + if (exitCode == 255) { + syntax(false); + } + + exit(exitCode); + } + + /** + * A normal invocation of the program (without parameters or at least + * without "action" parameters). + *

+ * You will probably want to override that one if you offer a user + * interface. + * + * @throws IOException + * in case of I/O error + */ + protected void start() throws IOException { + new CliReader().listBooks(null); + } + + /** + * Will check if updates are available, synchronously. + *

+ * For this, it will simply forward the call to + * {@link Main#checkUpdates(String)} with a value of "nikiroo/fanfix". + *

+ * You may want to override it so you call the forward method with the right + * parameters (or also if you want it to be asynchronous). + * + * @return the newer version information or NULL if nothing new + */ + protected VersionCheck checkUpdates() { + return checkUpdates("nikiroo/fanfix"); + } + + /** + * Will check if updates are available on a specific GitHub project. + *

+ * Will be called by {@link Main#checkUpdates()}, but if you override that + * one you mall call it with another project. + * + * @param githubProject + * the GitHub project, for instance "nikiroo/fanfix" + * + * @return the newer version information or NULL if nothing new + */ + protected VersionCheck checkUpdates(String githubProject) { + try { + VersionCheck updates = VersionCheck.check(githubProject, + Instance.getInstance().getTrans().getLocale()); + if (updates.isNewVersionAvailable()) { + notifyUpdates(updates); + return updates; + } + } catch (IOException e) { + // Maybe no internet. Do not report any update. + } + + return null; + } + + /** + * Notify the user about available updates. + *

+ * Will only be called when a version is available. + *

+ * Note that you can call {@link Instance#setVersionChecked()} on it if the + * user has read the information (by default, it is marked read only on + * certain other actions). + * + * @param updates + * the new version information + */ + protected void notifyUpdates(VersionCheck updates) { + // Sent to syserr so not to cause problem if one tries to capture a + // story content in text mode + System.err.println( + "A new version of the program is available at https://github.com/nikiroo/fanfix/releases"); + System.err.println(""); + for (Version v : updates.getNewer()) { + System.err.println("\tVersion " + v); + System.err.println("\t-------------"); + System.err.println(""); + for (String it : updates.getChanges().get(v)) { + System.err.println("\t- " + it); + } + System.err.println(""); + } + } + + /** + * Import the given resource into the {@link LocalLibrary}. + * + * @param url + * the resource to import + * @param pg + * the optional progress reporter + * + * @return the exit return code (0 = success) + */ + protected static int imprt(URL url, Progress pg) { + try { + MetaData meta = Instance.getInstance().getLibrary().imprt(url, pg); + System.out.println(meta.getLuid() + ": \"" + meta.getTitle() + "\" imported."); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + return 1; + } + + return 0; + } + + /** + * Export the {@link Story} from the {@link LocalLibrary} to the given + * target. + * + * @param luid + * the story LUID + * @param type + * the {@link OutputType} to use + * @param target + * the target + * @param pg + * the optional progress reporter + * + * @return the exit return code (0 = success) + */ + protected static int export(String luid, OutputType type, String target, + Progress pg) { + try { + Instance.getInstance().getLibrary().export(luid, type, target, pg); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + return 4; + } + + return 0; + } + + /** + * List the stories of the given source from the {@link LocalLibrary} + * (unless NULL is passed, in which case all stories will be listed). + * + * @param source + * the source to list the known stories of, or NULL to list all + * stories + * + * @return the exit return code (0 = success) + */ + protected int list(String source) { + try { + new CliReader().listBooks(source); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + return 66; + } + + return 0; + } + + /** + * Start the current reader for this {@link Story}. + * + * @param story + * the story to read + * @param chap + * which {@link Chapter} to read (starting at 1), or NULL to get + * the {@link Story} description + * + * @return the exit return code (0 = success) + */ + protected int read(Story story, Integer chap) { + if (story != null) { + try { + if (chap == null) { + new CliReader().listChapters(story); + } else { + new CliReader().printChapter(story, chap); + } + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException("Failed to read book", e)); + return 2; + } + } else { + Instance.getInstance().getTraceHandler() + .error("Cannot find book: " + story); + return 2; + } + + return 0; + } + + /** + * Convert the {@link Story} into another format. + * + * @param urlString + * the source {@link Story} to convert + * @param type + * the {@link OutputType} to convert to + * @param target + * the target file + * @param infoCover + * TRUE to also export the cover and info file, even if the given + * {@link OutputType} does not usually save them + * @param pg + * the optional progress reporter + * + * @return the exit return code (0 = success) + */ + protected int convert(String urlString, OutputType type, + String target, boolean infoCover, Progress pg) { + int exitCode = 0; + + Instance.getInstance().getTraceHandler().trace("Convert: " + urlString); + String sourceName = urlString; + try { + URL source = BasicReader.getUrl(urlString); + sourceName = source.toString(); + if (sourceName.startsWith("file://")) { + sourceName = sourceName.substring("file://".length()); + } + + try { + BasicSupport support = BasicSupport.getSupport(source); + + if (support != null) { + Instance.getInstance().getTraceHandler() + .trace("Support found: " + support.getClass()); + Progress pgIn = new Progress(); + Progress pgOut = new Progress(); + if (pg != null) { + pg.setMax(2); + pg.addProgress(pgIn, 1); + pg.addProgress(pgOut, 1); + } + + Story story = support.process(pgIn); + try { + target = new File(target).getAbsolutePath(); + BasicOutput.getOutput(type, infoCover, infoCover) + .process(story, target, pgOut); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException( + trans(StringId.ERR_SAVING, target), e)); + exitCode = 5; + } + } else { + Instance.getInstance().getTraceHandler() + .error(new IOException( + trans(StringId.ERR_NOT_SUPPORTED, source))); + + exitCode = 4; + } + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(new IOException( + trans(StringId.ERR_LOADING, sourceName), e)); + exitCode = 3; + } + } catch (MalformedURLException e) { + Instance.getInstance().getTraceHandler().error(new IOException(trans(StringId.ERR_BAD_URL, sourceName), e)); + exitCode = 1; + } + + return exitCode; + } + + /** + * Display the correct syntax of the program to the user to stdout, or an + * error message if the syntax used was wrong on stderr. + * + * @param showHelp + * TRUE to show the syntax help, FALSE to show "syntax error" + */ + protected void syntax(boolean showHelp) { + if (showHelp) { + StringBuilder builder = new StringBuilder(); + for (SupportType type : SupportType.values()) { + builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(), + type.getDesc())); + builder.append('\n'); + } + + String typesIn = builder.toString(); + builder.setLength(0); + + for (OutputType type : OutputType.values()) { + builder.append(trans(StringId.ERR_SYNTAX_TYPE, type.toString(), + type.getDesc(true))); + builder.append('\n'); + } + + String typesOut = builder.toString(); + + System.out.println(trans(StringId.HELP_SYNTAX, typesIn, typesOut)); + } else { + System.err.println(trans(StringId.ERR_SYNTAX)); + } + } + + /** + * Starts a search operation (i.e., list the available web sites we can + * search on). + * + * @throws IOException + * in case of I/O errors + */ + protected void search() throws IOException { + new CliReader().listSearchables(); + } + + /** + * Search for books by keywords on the given supported web site. + * + * @param searchOn + * the web site to search on + * @param search + * the keyword to look for + * @param page + * the page of results to get, or 0 to inquire about the number + * of pages + * @param item + * the index of the book we are interested by, or 0 to query + * about how many books are in that page of results + * + * @throws IOException + * in case of I/O error + */ + protected void searchKeywords(SupportType searchOn, String search, + int page, Integer item) throws IOException { + new CliReader().searchBooksByKeyword(searchOn, search, page, item); + } + + /** + * Search for books by tags on the given supported web site. + * + * @param searchOn + * the web site to search on + * @param page + * the page of results to get, or 0 to inquire about the number + * of pages + * @param item + * the index of the book we are interested by, or 0 to query + * about how many books are in that page of results + * @param tags + * the tags to look for + * + * @throws IOException + * in case of I/O error + */ + protected void searchTags(SupportType searchOn, Integer page, Integer item, + Integer[] tags) throws IOException { + new CliReader().searchBooksByTag(searchOn, page, item, tags); + } + + /** + * Start a Fanfix server. + * + * @throws IOException + * in case of I/O errors + * @throws SSLException + * when the key was not accepted + */ + private void startServer() throws IOException { + String mode = Instance.getInstance().getConfig() + .getString(Config.SERVER_MODE, "fanfix"); + if (mode.equals("fanfix")) { + RemoteLibraryServer server = new RemoteLibraryServer(); + server.setTraceHandler(Instance.getInstance().getTraceHandler()); + server.run(); + } else if (mode.equals("http")) { + WebLibraryServer server = new WebLibraryServer(false); + server.setTraceHandler(Instance.getInstance().getTraceHandler()); + server.run(); + } else if (mode.equals("https")) { + WebLibraryServer server = new WebLibraryServer(true); + server.setTraceHandler(Instance.getInstance().getTraceHandler()); + server.run(); + } else { + throw new IOException("Unknown server mode: " + mode); + } + } + + /** + * Stop a running Fanfix server. + * + * @param key + * the key to contact the Fanfix server + * @param host + * the host on which it runs + * @param port + * the port on which it runs + * + * @throws IOException + * in case of I/O errors + * @throws SSLException + * when the key was not accepted + */ + private void stopServer(String key, String host, int port) + throws IOException, SSLException { + if (host.startsWith("http://") || host.startsWith("https://")) { + new WebLibrary(key, host, port).stop(); + } else { + new RemoteLibrary(key, host, port).stop(); + } + } + + /** + * We are done and ready to exit. + *

+ * By default, it will call {@link System#exit(int)} if the status is not 0. + * + * @param status + * the exit status + */ + protected void exit(int status) { + if (status != 0) { + System.exit(status); + } + } + + /** + * Simple shortcut method to call {link Instance#getTrans()#getString()}. + * + * @param id + * the ID to translate + * + * @return the translated result + */ + static private String trans(StringId id, Object... params) { + return Instance.getInstance().getTrans().getString(id, params); + } +} diff --git a/src/be/nikiroo/fanfix/bundles/Config.java b/src/be/nikiroo/fanfix/bundles/Config.java new file mode 100644 index 0000000..86744b4 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/Config.java @@ -0,0 +1,188 @@ +package be.nikiroo.fanfix.bundles; + +import be.nikiroo.utils.resources.Meta; +import be.nikiroo.utils.resources.Meta.Format; + +/** + * The configuration options. + * + * @author niki + */ +@SuppressWarnings("javadoc") +public enum Config { + + // Note: all hidden values are subject to be removed in a later version + + @Meta(description = "The language to use for in the program (example: en-GB, fr-BE...) or nothing for default system language (can be overwritten with the variable $LANG)",// + format = Format.LOCALE, list = { "en-GB", "fr-BE" }) + LANG, // + @Meta(description = "File format options",// + group = true) + FILE_FORMAT, // + @Meta(description = "How to save non-images documents in the library",// + format = Format.FIXED_LIST, list = { "INFO_TEXT", "EPUB", "HTML", "TEXT" }, def = "INFO_TEXT") + FILE_FORMAT_NON_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "How to save images documents in the library",// + format = Format.FIXED_LIST, list = { "CBZ", "HTML" }, def = "CBZ") + FILE_FORMAT_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "How to save cover images",// + format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "PNG") + FILE_FORMAT_IMAGE_FORMAT_COVER, // + @Meta(description = "How to save content images",// + format = Format.FIXED_LIST, list = { "PNG", "JPG", "BMP" }, def = "JPG") + FILE_FORMAT_IMAGE_FORMAT_CONTENT, // + + @Meta(description = "Cache management",// + group = true) + CACHE, // + @Meta(description = "The directory where to store temporary files; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// + format = Format.DIRECTORY, def = "tmp/") + CACHE_DIR, // + @Meta(description = "The delay in hours after which a cached resource that is thought to change ~often is considered too old and triggers a refresh delay (or 0 for no cache, or -1 for infinite time)", // + format = Format.INT, def = "24") + CACHE_MAX_TIME_CHANGING, // + @Meta(description = "The delay in hours after which a cached resource that is thought to change rarely is considered too old and triggers a refresh delay (or 0 for no cache, or -1 for infinite time)", // + format = Format.INT, def = "720") + CACHE_MAX_TIME_STABLE, // + + @Meta(description = "The directory where to get the default story covers; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// + format = Format.DIRECTORY, def = "covers/") + DEFAULT_COVERS_DIR, // + @Meta(description = "The directory where to store the library (can be overriden by the environment variable \"BOOKS_DIR\"; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// + format = Format.DIRECTORY, def = "$HOME/Books/") + LIBRARY_DIR, // + + @Meta(description = "Remote library\nA remote library can be configured to fetch the stories from a remote Fanfix server",// + group = true) + REMOTE_LIBRARY, // + @Meta(description = "Use the remote Fanfix server configured here instead of the local library (if FALSE, the local library will be used instead)",// + format = Format.BOOLEAN, def = "false") + REMOTE_LIBRARY_ENABLED, // + @Meta(description = "The remote Fanfix server to connect to (fanfix://, http://, https:// -- if not specified, fanfix:// is assumed)",// + format = Format.STRING) + REMOTE_LIBRARY_HOST, // + @Meta(description = "The port to use for the remote Fanfix server",// + format = Format.INT, def = "58365") + REMOTE_LIBRARY_PORT, // + @Meta(description = "The key is structured: \"KEY|SUBKEY|wl|rw\"\n- \"KEY\" is the actual encryption key (it can actually be empty, which will still encrypt the messages but of course it will be easier to guess the key)\n- \"SUBKEY\" is the (optional) subkey to use to get additional privileges\n- \"wl\" is a special privilege that allows that subkey to ignore white lists\n- \"rw\" is a special privilege that allows that subkey to modify the library, even if it is not in RW (by default) mode\n\nSome examples:\n- \"super-secret\": a normal key, no special privileges\n- \"you-will-not-guess|azOpd8|wl\": a white-list ignoring key\n- \"new-password|subpass|rw\": a key that allows modifications on the library",// + format = Format.PASSWORD) + REMOTE_LIBRARY_KEY, // + + @Meta(description = "Network configuration",// + group = true) + NETWORK, // + @Meta(description = "The user-agent to use to download files",// + def = "Mozilla/5.0 (X11; Linux x86_64; rv:44.0) Gecko/20100101 Firefox/44.0 -- ELinks/0.9.3 (Linux 2.6.11 i686; 80x24) -- Fanfix (https://github.com/nikiroo/fanfix/)") + NETWORK_USER_AGENT, // + @Meta(description = "The proxy server to use under the format 'user:pass@proxy:port', 'user@proxy:port', 'proxy:port' or ':' alone (system proxy); an empty String means no proxy",// + format = Format.STRING, def = "") + NETWORK_PROXY, // + @Meta(description = "If the last update check was done at least that many days ago, check for updates at startup (-1 for 'no checks')", // + format = Format.INT, def = "1") + NETWORK_UPDATE_INTERVAL, // + + @Meta(description = "Remote Server configuration\nNote that the key is structured: \"KEY|SUBKEY|wl|rw\"\n- \"KEY\" is the actual encryption key (it can actually be empty, which will still encrypt the messages but of course it will be easier to guess the key)\n- \"SUBKEY\" is the (optional) subkey to use to get additional privileges\n- \"wl\" is a special privilege that allows that subkey to ignore white lists\n- \"rw\" is a special privilege that allows that subkey to modify the library, even if it is not in RW (by default) mode\n\nSome examples:\n- \"super-secret\": a normal key, no special privileges\n- \"you-will-not-guess|azOpd8|wl\": a white-list ignoring key\n- \"new-password|subpass|rw\": a key that allows modifications on the library",// + group = true) + SERVER, // + @Meta(description = "Remote Server mode: you can use the fanfix protocol (which is encrypted), http (which is not) or https (which requires a keystore.jks file)",// + format = Format.FIXED_LIST, list = { "fanfix", "http", "https" }, def = "fanfix") + SERVER_MODE, + @Meta(description = "The port on which we can start the server (must be a valid port, from 1 to 65535)", // + format = Format.INT, def = "58365") + SERVER_PORT, // + @Meta(description = "A keystore.jks file, required to use HTTPS (the server will refuse to start in HTTPS mode without this file)", // + format = Format.STRING, def = "") + SERVER_SSL_KEYSTORE, + @Meta(description = "The pass phrase required to open the keystore.jks file (required for HTTPS mode)", // + format = Format.PASSWORD, def = "") + SERVER_SSL_KEYSTORE_PASS, + @Meta(description = "The encryption key for the server (NOT including a subkey), it cannot contain the pipe character \"|\" but can be empty -- is used to encrypt the traffic in fanfix mode (even if empty, traffic will be encrypted in fanfix mode), and used as a password for HTTP (clear text protocol) and HTTPS modes",// + format = Format.PASSWORD, def = "") + SERVER_KEY, // + @Meta(description = "Allow write access to the clients (download story, move story...) without RW subkeys", // + format = Format.BOOLEAN, def = "true") + SERVER_RW, // + @Meta(description = "If not empty, only the EXACT listed sources will be available for clients without a WL subkey",// + array = true, format = Format.STRING, def = "") + SERVER_WHITELIST, // + @Meta(description = "Those sources will not be available for clients without a BL subkey",// + array = true, format = Format.STRING, def = "") + SERVER_BLACKLIST, // + @Meta(description = "The subkeys that the server will allow, including the modes\nA subkey is used as a login for HTTP (clear text protocol) and HTTPS modes", // + array = true, format = Format.STRING, def = "") + SERVER_ALLOWED_SUBKEYS, // + @Meta(description = "The maximum size of the cache, in MegaBytes, for HTTP and HTTPS servers", // + format = Format.INT, def = "100") + SERVER_MAX_CACHE_MB, + + @Meta(description = "DEBUG options",// + group = true) + DEBUG, // + @Meta(description = "Show debug information on errors",// + format = Format.BOOLEAN, def = "false") + DEBUG_ERR, // + @Meta(description = "Show debug trace information",// + format = Format.BOOLEAN, def = "false") + DEBUG_TRACE, // + + @Meta(description = "Internal configuration\nThose options are internal to the program and should probably not be changed",// + hidden = true, group = true) + CONF, // + @Meta(description = "LaTeX configuration",// + hidden = true, group = true) + CONF_LATEX_LANG, // + @Meta(description = "LaTeX output language (full name) for \"English\"",// + hidden = true, format = Format.STRING, def = "english") + CONF_LATEX_LANG_EN, // + @Meta(description = "LaTeX output language (full name) for \"French\"",// + hidden = true, format = Format.STRING, def = "french") + CONF_LATEX_LANG_FR, // + @Meta(description = "other 'by' prefixes before author name, used to identify the author",// + hidden = true, array = true, format = Format.STRING, def = "\"by\",\"par\",\"de\",\"©\",\"(c)\"") + CONF_BYS, // + @Meta(description = "List of languages codes used for chapter identification (should not be changed)", // + hidden = true, array = true, format = Format.STRING, def = "\"EN\",\"FR\"") + CONF_CHAPTER, // + @Meta(description = "Chapter identification string in English, used to identify a starting chapter in text mode",// + hidden = true, format = Format.STRING, def = "Chapter") + CONF_CHAPTER_EN, // + @Meta(description = "Chapter identification string in French, used to identify a starting chapter in text mode",// + hidden = true, format = Format.STRING, def = "Chapitre") + CONF_CHAPTER_FR, // + + @Meta(description = "YiffStar/SoFurry credentials\nYou can give your YiffStar credentials here to have access to all the stories, though it should not be necessary anymore (some stories used to beblocked for anonymous viewers)",// + group = true) + LOGIN_YIFFSTAR, // + @Meta(description = "Your YiffStar/SoFurry login",// + format = Format.STRING) + LOGIN_YIFFSTAR_USER, // + @Meta(description = "Your YiffStar/SoFurry password",// + format = Format.PASSWORD) + LOGIN_YIFFSTAR_PASS, // + + @Meta(description = "FimFiction APIKEY credentials\nFimFiction can be queried via an API, but requires an API key to do that. One has been created for this program, but if you have another API key you can set it here. You can also set a login and password instead, in that case, a new API key will be generated (and stored) if you still haven't set one.",// + group = true) + LOGIN_FIMFICTION_APIKEY, // + @Meta(description = "The login of the API key used to create a new token from FimFiction", // + format = Format.STRING) + LOGIN_FIMFICTION_APIKEY_CLIENT_ID, // + @Meta(description = "The password of the API key used to create a new token from FimFiction", // + format = Format.PASSWORD) + LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET, // + @Meta(description = "Do not use the new API, even if we have a token, and force HTML scraping",// + format = Format.BOOLEAN, def = "false") + LOGIN_FIMFICTION_APIKEY_FORCE_HTML, // + @Meta(description = "The token required to use the beta APIv2 from FimFiction (see APIKEY_CLIENT_* if you want to generate a new one from your own API key)", // + format = Format.PASSWORD, def = "Bearer WnZ5oHlzQoDocv1GcgHfcoqctHkSwL-D") + LOGIN_FIMFICTION_APIKEY_TOKEN, // + + @Meta(description = "e621.net credentials\nYou can give your e621.net credentials here to have access to all the comics and ignore the default blacklist",// + group = true) + LOGIN_E621, // + @Meta(description = "Your e621.net login",// + format = Format.STRING) + LOGIN_E621_LOGIN, // + @Meta(description = "Your e621.net API KEY",// + format = Format.PASSWORD) + LOGIN_E621_APIKEY, // +} diff --git a/src/be/nikiroo/fanfix/bundles/ConfigBundle.java b/src/be/nikiroo/fanfix/bundles/ConfigBundle.java new file mode 100644 index 0000000..ce72b3d --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/ConfigBundle.java @@ -0,0 +1,41 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.File; +import java.io.IOException; + +import be.nikiroo.utils.resources.Bundle; + +/** + * This class manages the configuration of the application. + * + * @author niki + */ +public class ConfigBundle extends Bundle { + /** + * Create a new {@link ConfigBundle}. + */ + public ConfigBundle() { + super(Config.class, Target.config5, null); + } + + /** + * Update resource file. + * + * @param args + * not used + * + * @throws IOException + * in case of I/O error + */ + public static void main(String[] args) throws IOException { + String path = new File(".").getAbsolutePath() + + "/src/be/nikiroo/fanfix/bundles/"; + new ConfigBundle().updateFile(path); + System.out.println("Path updated: " + path); + } + + @Override + protected String getBundleDisplayName() { + return "Configuration options"; + } +} diff --git a/src/be/nikiroo/fanfix/bundles/StringId.java b/src/be/nikiroo/fanfix/bundles/StringId.java new file mode 100644 index 0000000..9772248 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/StringId.java @@ -0,0 +1,151 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.IOException; +import java.io.Writer; + +import be.nikiroo.utils.resources.Bundle; +import be.nikiroo.utils.resources.Meta; + +/** + * The {@link Enum} representing textual information to be translated to the + * user as a key. + * + * Note that each key that should be translated must be annotated with a + * {@link Meta} annotation. + * + * @author niki + */ +@SuppressWarnings("javadoc") +public enum StringId { + /** + * A special key used for technical reasons only, without annotations so it + * is not visible in .properties files. + *

+ * Use it when you need NO translation. + */ + NULL, // + /** + * A special key used for technical reasons only, without annotations so it + * is not visible in .properties files. + *

+ * Use it when you need a real translation but still don't have a key. + */ + DUMMY, // + @Meta(info = "%s = supported input, %s = supported output", description = "help message for the syntax") + HELP_SYNTAX, // + @Meta(description = "syntax error message") + ERR_SYNTAX, // + @Meta(info = "%s = support name, %s = support desc", description = "an input or output support type description") + ERR_SYNTAX_TYPE, // + @Meta(info = "%s = input string", description = "Error when retrieving data") + ERR_LOADING, // + @Meta(info = "%s = save target", description = "Error when saving to given target") + ERR_SAVING, // + @Meta(info = "%s = bad output format", description = "Error when unknown output format") + ERR_BAD_OUTPUT_TYPE, // + @Meta(info = "%s = input string", description = "Error when converting input to URL/File") + ERR_BAD_URL, // + @Meta(info = "%s = input url", description = "URL/File not supported") + ERR_NOT_SUPPORTED, // + @Meta(info = "%s = cover URL", description = "Failed to download cover : %s") + ERR_BS_NO_COVER, // + @Meta(def = "`", info = "single char", description = "Canonical OPEN SINGLE QUOTE char (for instance: ‘)") + OPEN_SINGLE_QUOTE, // + @Meta(def = "‘", info = "single char", description = "Canonical CLOSE SINGLE QUOTE char (for instance: ’)") + CLOSE_SINGLE_QUOTE, // + @Meta(def = "“", info = "single char", description = "Canonical OPEN DOUBLE QUOTE char (for instance: “)") + OPEN_DOUBLE_QUOTE, // + @Meta(def = "”", info = "single char", description = "Canonical CLOSE DOUBLE QUOTE char (for instance: ”)") + CLOSE_DOUBLE_QUOTE, // + @Meta(def = "Description", description = "Name of the description fake chapter") + DESCRIPTION, // + @Meta(def = "Chapter %d: %s", info = "%d = number, %s = name", description = "Name of a chapter with a name") + CHAPTER_NAMED, // + @Meta(def = "Chapter %d", info = "%d = number, %s = name", description = "Name of a chapter without name") + CHAPTER_UNNAMED, // + @Meta(info = "%s = type", description = "Default description when the type is not known by i18n") + INPUT_DESC, // + @Meta(description = "Description of this input type") + INPUT_DESC_EPUB, // + @Meta(description = "Description of this input type") + INPUT_DESC_TEXT, // + @Meta(description = "Description of this input type") + INPUT_DESC_INFO_TEXT, // + @Meta(description = "Description of this input type") + INPUT_DESC_FANFICTION, // + @Meta(description = "Description of this input type") + INPUT_DESC_FIMFICTION, // + @Meta(description = "Description of this input type") + INPUT_DESC_MANGAFOX, // + @Meta(description = "Description of this input type") + INPUT_DESC_E621, // + @Meta(description = "Description of this input type") + INPUT_DESC_E_HENTAI, // + @Meta(description = "Description of this input type") + INPUT_DESC_YIFFSTAR, // + @Meta(description = "Description of this input type") + INPUT_DESC_CBZ, // + @Meta(description = "Description of this input type") + INPUT_DESC_HTML, // + @Meta(info = "%s = type", description = "Default description when the type is not known by i18n") + OUTPUT_DESC, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_EPUB, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_TEXT, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_INFO_TEXT, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_CBZ, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_HTML, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_LATEX, // + @Meta(description = "Description of this output type") + OUTPUT_DESC_SYSOUT, // + @Meta(group = true, info = "%s = type", description = "Default description when the type is not known by i18n") + OUTPUT_DESC_SHORT, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_EPUB, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_TEXT, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_INFO_TEXT, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_CBZ, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_LATEX, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_SYSOUT, // + @Meta(description = "Short description of this output type") + OUTPUT_DESC_SHORT_HTML, // + @Meta(info = "%s = the unknown 2-code language", description = "Error message for unknown 2-letter LaTeX language code") + LATEX_LANG_UNKNOWN, // + @Meta(def = "by", description = "'by' prefix before author name used to output the author, make sure it is covered by Config.BYS for input detection") + BY, // + + ; + + /** + * Write the header found in the configuration .properties file of + * this {@link Bundle}. + * + * @param writer + * the {@link Writer} to write the header in + * @param name + * the file name + * + * @throws IOException + * in case of IO error + */ + static public void writeHeader(Writer writer, String name) + throws IOException { + writer.write("# " + name + " translation file (UTF-8)\n"); + writer.write("# \n"); + writer.write("# Note that any key can be doubled with a _NOUTF suffix\n"); + writer.write("# to use when the NOUTF env variable is set to 1\n"); + writer.write("# \n"); + writer.write("# Also, the comments always refer to the key below them.\n"); + writer.write("# \n"); + } +} diff --git a/src/be/nikiroo/fanfix/bundles/StringIdBundle.java b/src/be/nikiroo/fanfix/bundles/StringIdBundle.java new file mode 100644 index 0000000..b9a0d79 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/StringIdBundle.java @@ -0,0 +1,40 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.File; +import java.io.IOException; + +import be.nikiroo.utils.resources.TransBundle; + +/** + * This class manages the translation resources of the application (Core). + * + * @author niki + */ +public class StringIdBundle extends TransBundle { + /** + * Create a translation service for the given language (will fall back to + * the default one if not found). + * + * @param lang + * the language to use + */ + public StringIdBundle(String lang) { + super(StringId.class, Target.resources_core, lang); + } + + /** + * Update resource file. + * + * @param args + * not used + * + * @throws IOException + * in case of I/O error + */ + public static void main(String[] args) throws IOException { + String path = new File(".").getAbsolutePath() + + "/src/be/nikiroo/fanfix/bundles/"; + new StringIdBundle(null).updateFile(path); + System.out.println("Path updated: " + path); + } +} diff --git a/src/be/nikiroo/fanfix/bundles/StringIdGui.java b/src/be/nikiroo/fanfix/bundles/StringIdGui.java new file mode 100644 index 0000000..c109f42 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/StringIdGui.java @@ -0,0 +1,199 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.IOException; +import java.io.Writer; + +import be.nikiroo.utils.resources.Bundle; +import be.nikiroo.utils.resources.Meta; +import be.nikiroo.utils.resources.Meta.Format; + +/** + * The {@link Enum} representing textual information to be translated to the + * user as a key. + * + * Note that each key that should be translated must be annotated with a + * {@link Meta} annotation. + * + * @author niki + */ +@SuppressWarnings("javadoc") +public enum StringIdGui { + /** + * A special key used for technical reasons only, without annotations so it + * is not visible in .properties files. + *

+ * Use it when you need NO translation. + */ + NULL, // + /** + * A special key used for technical reasons only, without annotations so it + * is not visible in .properties files. + *

+ * Use it when you need a real translation but still don't have a key. + */ + DUMMY, // + @Meta(def = "Fanfix %s", format = Format.STRING, description = "the title of the main window of Fanfix, the library", info = "%s = current Fanfix version") + // The titles/subtitles: + TITLE_LIBRARY, // + @Meta(def = "Fanfix %s", format = Format.STRING, description = "the title of the main window of Fanfix, the library, when the library has a name (i.e., is not local)", info = "%s = current Fanfix version, %s = library name") + TITLE_LIBRARY_WITH_NAME, // + @Meta(def = "Fanfix Configuration", format = Format.STRING, description = "the title of the configuration window of Fanfix, also the name of the menu button") + TITLE_CONFIG, // + @Meta(def = "This is where you configure the options of the program.", format = Format.STRING, description = "the subtitle of the configuration window of Fanfix") + SUBTITLE_CONFIG, // + @Meta(def = "UI Configuration", format = Format.STRING, description = "the title of the UI configuration window of Fanfix, also the name of the menu button") + TITLE_CONFIG_UI, // + @Meta(def = "This is where you configure the graphical appearence of the program.", format = Format.STRING, description = "the subtitle of the UI configuration window of Fanfix") + SUBTITLE_CONFIG_UI, // + @Meta(def = "Save", format = Format.STRING, description = "the title of the 'save to/export to' window of Fanfix") + TITLE_SAVE, // + @Meta(def = "Moving story", format = Format.STRING, description = "the title of the 'move to' window of Fanfix") + TITLE_MOVE_TO, // + @Meta(def = "Move to:", format = Format.STRING, description = "the subtitle of the 'move to' window of Fanfix") + SUBTITLE_MOVE_TO, // + @Meta(def = "Delete story", format = Format.STRING, description = "the title of the 'delete' window of Fanfix") + TITLE_DELETE, // + @Meta(def = "Delete %s: %s", format = Format.STRING, description = "the subtitle of the 'delete' window of Fanfix", info = "%s = LUID of the story, %s = title of the story") + SUBTITLE_DELETE, // + @Meta(def = "Library error", format = Format.STRING, description = "the title of the 'library error' dialogue") + TITLE_ERROR_LIBRARY, // + @Meta(def = "Importing from URL", format = Format.STRING, description = "the title of the 'import URL' dialogue") + TITLE_IMPORT_URL, // + @Meta(def = "URL of the story to import:", format = Format.STRING, description = "the subtitle of the 'import URL' dialogue") + SUBTITLE_IMPORT_URL, // + @Meta(def = "Error", format = Format.STRING, description = "the title of general error dialogues") + TITLE_ERROR, // + @Meta(def = "%s: %s", format = Format.STRING, description = "the title of a story for the properties dialogue, the viewers...", info = "%s = LUID of the story, %s = title of the story") + TITLE_STORY, // + + // + + @Meta(def = "A new version of the program is available at %s", format = Format.STRING, description = "HTML text used to notify of a new version", info = "%s = url link in HTML") + NEW_VERSION_AVAILABLE, // + @Meta(def = "Updates available", format = Format.STRING, description = "text used as title for the update dialogue") + NEW_VERSION_TITLE, // + @Meta(def = "Version %s", format = Format.STRING, description = "HTML text used to specify a newer version title and number, used for each version newer than the current one", info = "%s = the newer version number") + NEW_VERSION_VERSION, // + @Meta(def = "%s words", format = Format.STRING, description = "show the number of words of a book", info = "%s = the number") + BOOK_COUNT_WORDS, // + @Meta(def = "%s images", format = Format.STRING, description = "show the number of images of a book", info = "%s = the number") + BOOK_COUNT_IMAGES, // + @Meta(def = "%s stories", format = Format.STRING, description = "show the number of stories of a meta-book (a book representing allthe types/sources or all the authors present)", info = "%s = the number") + BOOK_COUNT_STORIES, // + + // Menu (and popup) items: + + @Meta(def = "File", format = Format.STRING, description = "the file menu") + MENU_FILE, // + @Meta(def = "Exit", format = Format.STRING, description = "the file/exit menu button") + MENU_FILE_EXIT, // + @Meta(def = "Import File...", format = Format.STRING, description = "the file/import_file menu button") + MENU_FILE_IMPORT_FILE, // + @Meta(def = "Import URL...", format = Format.STRING, description = "the file/import_url menu button") + MENU_FILE_IMPORT_URL, // + @Meta(def = "Save as...", format = Format.STRING, description = "the file/export menu button") + MENU_FILE_EXPORT, // + @Meta(def = "Move to", format = Format.STRING, description = "the file/move to menu button") + MENU_FILE_MOVE_TO, // + @Meta(def = "Set author", format = Format.STRING, description = "the file/set author menu button") + MENU_FILE_SET_AUTHOR, // + @Meta(def = "New source...", format = Format.STRING, description = "the file/move to/new type-source menu button, that will trigger a dialogue to create a new type/source") + MENU_FILE_MOVE_TO_NEW_TYPE, // + @Meta(def = "New author...", format = Format.STRING, description = "the file/move to/new author menu button, that will trigger a dialogue to create a new author") + MENU_FILE_MOVE_TO_NEW_AUTHOR, // + @Meta(def = "Rename...", format = Format.STRING, description = "the file/rename menu item, that will trigger a dialogue to ask for a new title for the story") + MENU_FILE_RENAME, // + @Meta(def = "Properties", format = Format.STRING, description = "the file/Properties menu item, that will trigger a dialogue to show the properties of the story") + MENU_FILE_PROPERTIES, // + @Meta(def = "Open", format = Format.STRING, description = "the file/open menu item, that will open the story or fake-story (an author or a source/type)") + MENU_FILE_OPEN, // + @Meta(def = "Edit", format = Format.STRING, description = "the edit menu") + MENU_EDIT, // + @Meta(def = "Prefetch to cache", format = Format.STRING, description = "the edit/send to cache menu button, to download the story into the cache if not already done") + MENU_EDIT_DOWNLOAD_TO_CACHE, // + @Meta(def = "Clear cache", format = Format.STRING, description = "the clear cache menu button, to clear the cache for a single book") + MENU_EDIT_CLEAR_CACHE, // + @Meta(def = "Redownload", format = Format.STRING, description = "the edit/redownload menu button, to download the latest version of the book") + MENU_EDIT_REDOWNLOAD, // + @Meta(def = "Delete", format = Format.STRING, description = "the edit/delete menu button") + MENU_EDIT_DELETE, // + @Meta(def = "Set as cover for source", format = Format.STRING, description = "the edit/Set as cover for source menu button") + MENU_EDIT_SET_COVER_FOR_SOURCE, // + @Meta(def = "Set as cover for author", format = Format.STRING, description = "the edit/Set as cover for author menu button") + MENU_EDIT_SET_COVER_FOR_AUTHOR, // + @Meta(def = "Search", format = Format.STRING, description = "the search menu to open the earch stories on one of the searchable websites") + MENU_SEARCH, + @Meta(def = "View", format = Format.STRING, description = "the view menu") + MENU_VIEW, // + @Meta(def = "Word count", format = Format.STRING, description = "the view/word_count menu button, to show the word/image/story count as secondary info") + MENU_VIEW_WCOUNT, // + @Meta(def = "Author", format = Format.STRING, description = "the view/author menu button, to show the author as secondary info") + MENU_VIEW_AUTHOR, // + @Meta(def = "Sources", format = Format.STRING, description = "the sources menu, to select the books from a specific source; also used as a title for the source books") + MENU_SOURCES, // + @Meta(def = "Authors", format = Format.STRING, description = "the authors menu, to select the books of a specific author; also used as a title for the author books") + MENU_AUTHORS, // + @Meta(def = "Options", format = Format.STRING, description = "the options menu, to configure Fanfix from the GUI") + MENU_OPTIONS, // + @Meta(def = "All", format = Format.STRING, description = "a special menu button to select all the sources/types or authors, by group (one book = one group)") + MENU_XXX_ALL_GROUPED, // + @Meta(def = "Listing", format = Format.STRING, description = "a special menu button to select all the sources/types or authors, in a listing (all the included books are listed, grouped by source/type or author)") + MENU_XXX_ALL_LISTING, // + @Meta(def = "[unknown]", format = Format.STRING, description = "a special menu button to select the books without author") + MENU_AUTHORS_UNKNOWN, // + + // Progress names + @Meta(def = "Reload books", format = Format.STRING, description = "progress bar caption for the 'reload books' step of all outOfUi operations") + PROGRESS_OUT_OF_UI_RELOAD_BOOKS, // + @Meta(def = "Change the source of the book to %s", format = Format.STRING, description = "progress bar caption for the 'change source' step of the ReDownload operation", info = "%s = new source name") + PROGRESS_CHANGE_SOURCE, // + + // Error messages + @Meta(def = "An error occured when contacting the library", format = Format.STRING, description = "default description if the error is not known") + ERROR_LIB_STATUS, // + @Meta(def = "You are not allowed to access this library", format = Format.STRING, description = "library access not allowed") + ERROR_LIB_STATUS_UNAUTHORIZED, // + @Meta(def = "Library not valid", format = Format.STRING, description = "the library is invalid (not correctly set up)") + ERROR_LIB_STATUS_INVALID, // + @Meta(def = "Library currently unavailable", format = Format.STRING, description = "the library is out of commission") + ERROR_LIB_STATUS_UNAVAILABLE, // + @Meta(def = "Cannot open the selected book", format = Format.STRING, description = "cannot open the book, internal or external viewer") + ERROR_CANNOT_OPEN, // + @Meta(def = "URL not supported: %s", format = Format.STRING, description = "URL is not supported by Fanfix", info = "%s = URL") + ERROR_URL_NOT_SUPPORTED, // + @Meta(def = "Failed to import %s:\n%s", format = Format.STRING, description = "cannot import the URL", info = "%s = URL, %s = reasons") + ERROR_URL_IMPORT_FAILED, + + // Others + @Meta(def = "  Chapitre %d / %d", format = Format.STRING, description = "(html) the chapter progression value used on the viewers", info = "%d = chapter number, %d = total chapters") + CHAPTER_HTML_UNNAMED, // + @Meta(def = "  Chapitre %d / %d: %s", format = Format.STRING, description = "(html) the chapter progression value used on the viewers", info = "%d = chapter number, %d = total chapters, %s = chapter name") + CHAPTER_HTML_NAMED, // + @Meta(def = "Image %d / %d", format = Format.STRING, description = "(NO html) the chapter progression value used on the viewers", info = "%d = current image number, %d = total images") + IMAGE_PROGRESSION, // + + ; + + /** + * Write the header found in the configuration .properties file of + * this {@link Bundle}. + * + * @param writer + * the {@link Writer} to write the header in + * @param name + * the file name + * + * @throws IOException + * in case of IO error + */ + static public void writeHeader(Writer writer, String name) + throws IOException { + writer.write("# " + name + " translation file (UTF-8)\n"); + writer.write("# \n"); + writer.write("# Note that any key can be doubled with a _NOUTF suffix\n"); + writer.write("# to use when the NOUTF env variable is set to 1\n"); + writer.write("# \n"); + writer.write("# Also, the comments always refer to the key below them.\n"); + writer.write("# \n"); + } +} diff --git a/src/be/nikiroo/fanfix/bundles/StringIdGuiBundle.java b/src/be/nikiroo/fanfix/bundles/StringIdGuiBundle.java new file mode 100644 index 0000000..c036381 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/StringIdGuiBundle.java @@ -0,0 +1,40 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.File; +import java.io.IOException; + +import be.nikiroo.utils.resources.TransBundle; + +/** + * This class manages the translation resources of the application (GUI). + * + * @author niki + */ +public class StringIdGuiBundle extends TransBundle { + /** + * Create a translation service for the given language (will fall back to + * the default one if not found). + * + * @param lang + * the language to use + */ + public StringIdGuiBundle(String lang) { + super(StringIdGui.class, Target.resources_gui, lang); + } + + /** + * Update resource file. + * + * @param args + * not used + * + * @throws IOException + * in case of I/O error + */ + public static void main(String[] args) throws IOException { + String path = new File(".").getAbsolutePath() + + "/src/be/nikiroo/fanfix/bundles/"; + new StringIdGuiBundle(null).updateFile(path); + System.out.println("Path updated: " + path); + } +} diff --git a/src/be/nikiroo/fanfix/bundles/Target.java b/src/be/nikiroo/fanfix/bundles/Target.java new file mode 100644 index 0000000..64284c6 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/Target.java @@ -0,0 +1,27 @@ +package be.nikiroo.fanfix.bundles; + +import be.nikiroo.utils.resources.Bundle; + +/** + * The type of configuration information the associated {@link Bundle} will + * convey. + *

+ * Those values can change when the file is not compatible anymore. + * + * @author niki + */ +public enum Target { + /** + * Configuration options that the user can change in the + * .properties file + */ + config5, + /** Translation resources (Core) */ + resources_core, + /** Translation resources (GUI) */ + resources_gui, + /** UI resources (from colours to behaviour) */ + ui, + /** Description of UI resources. */ + ui_description, +} diff --git a/src/be/nikiroo/fanfix/bundles/UiConfig.java b/src/be/nikiroo/fanfix/bundles/UiConfig.java new file mode 100644 index 0000000..2122ccf --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/UiConfig.java @@ -0,0 +1,59 @@ +package be.nikiroo.fanfix.bundles; + +import be.nikiroo.utils.resources.Meta; +import be.nikiroo.utils.resources.Meta.Format; + +/** + * The configuration options. + * + * @author niki + */ +@SuppressWarnings("javadoc") +public enum UiConfig { + @Meta(description = "The directory where to store temporary files for the GUI reader; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator",// + format = Format.DIRECTORY, def = "tmp-reader/") + CACHE_DIR_LOCAL_READER, // + @Meta(description = "How to save the cached stories for the GUI Reader (non-images documents) -- those files will be sent to the reader",// + format = Format.COMBO_LIST, list = { "INFO_TEXT", "EPUB", "HTML", "TEXT" }, def = "EPUB") + GUI_NON_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "How to save the cached stories for the GUI Reader (images documents) -- those files will be sent to the reader",// + format = Format.COMBO_LIST, list = { "CBZ", "HTML" }, def = "CBZ") + GUI_IMAGES_DOCUMENT_TYPE, // + @Meta(description = "Use the internal reader for images documents",// + format = Format.BOOLEAN, def = "true") + IMAGES_DOCUMENT_USE_INTERNAL_READER, // + @Meta(description = "The external viewer for images documents (or empty to use the system default program for the given file type)",// + format = Format.STRING) + IMAGES_DOCUMENT_READER, // + @Meta(description = "Use the internal reader for non-images documents",// + format = Format.BOOLEAN, def = "true") + NON_IMAGES_DOCUMENT_USE_INTERNAL_READER, // + @Meta(description = "The external viewer for non-images documents (or empty to use the system default program for the given file type)",// + format = Format.STRING) + NON_IMAGES_DOCUMENT_READER, // + @Meta(description = "The icon to use for the program",// + format = Format.FIXED_LIST, def = "default", list = { "default", "alternative", "magic-book", "pony-book", "pony-library" }) + PROGRAM_ICON, // + // + // GUI settings (hidden in config) + // + @Meta(description = "Show the side panel by default",// + hidden = true, format = Format.BOOLEAN, def = "true") + SHOW_SIDE_PANEL, // + @Meta(description = "Show the details panel by default",// + hidden = true, format = Format.BOOLEAN, def = "true") + SHOW_DETAILS_PANEL, // + @Meta(description = "Show thumbnails by default in the books view",// + hidden = true, format = Format.BOOLEAN, def = "false") + SHOW_THUMBNAILS, // + @Meta(description = "Show a words/images count instead of the author by default in the books view",// + hidden = true, format = Format.BOOLEAN, def = "false") + SHOW_WORDCOUNT, // + // + // Deprecated + // + @Meta(description = "The background colour of the library if you don't like the default system one",// + hidden = true, format = Format.COLOR) + @Deprecated + BACKGROUND_COLOR, // +} diff --git a/src/be/nikiroo/fanfix/bundles/UiConfigBundle.java b/src/be/nikiroo/fanfix/bundles/UiConfigBundle.java new file mode 100644 index 0000000..8b2c008 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/UiConfigBundle.java @@ -0,0 +1,39 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.File; +import java.io.IOException; + +import be.nikiroo.utils.resources.Bundle; + +/** + * This class manages the configuration of UI of the application (colours and + * behaviour) + * + * @author niki + */ +public class UiConfigBundle extends Bundle { + public UiConfigBundle() { + super(UiConfig.class, Target.ui, new UiConfigBundleDesc()); + } + + /** + * Update resource file. + * + * @param args + * not used + * + * @throws IOException + * in case of I/O error + */ + public static void main(String[] args) throws IOException { + String path = new File(".").getAbsolutePath() + + "/src/be/nikiroo/fanfix/bundles/"; + new UiConfigBundle().updateFile(path); + System.out.println("Path updated: " + path); + } + + @Override + protected String getBundleDisplayName() { + return "UI configuration options"; + } +} diff --git a/src/be/nikiroo/fanfix/bundles/UiConfigBundleDesc.java b/src/be/nikiroo/fanfix/bundles/UiConfigBundleDesc.java new file mode 100644 index 0000000..da42950 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/UiConfigBundleDesc.java @@ -0,0 +1,39 @@ +package be.nikiroo.fanfix.bundles; + +import java.io.File; +import java.io.IOException; + +import be.nikiroo.utils.resources.TransBundle; + +/** + * This class manages the configuration of UI of the application (colours and + * behaviour) + * + * @author niki + */ +public class UiConfigBundleDesc extends TransBundle { + public UiConfigBundleDesc() { + super(UiConfig.class, Target.ui_description); + } + + /** + * Update resource file. + * + * @param args + * not used + * + * @throws IOException + * in case of I/O error + */ + public static void main(String[] args) throws IOException { + String path = new File(".").getAbsolutePath() + + "/src/be/nikiroo/fanfix/bundles/"; + new UiConfigBundleDesc().updateFile(path); + System.out.println("Path updated: " + path); + } + + @Override + protected String getBundleDisplayName() { + return "UI configuration options description"; + } +} diff --git a/src/be/nikiroo/fanfix/bundles/package-info.java b/src/be/nikiroo/fanfix/bundles/package-info.java new file mode 100644 index 0000000..80cdd15 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/package-info.java @@ -0,0 +1,8 @@ +/** + * This package encloses the different + * {@link be.nikiroo.utils.resources.Bundle} and their associated + * {@link java.lang.Enum}s used by the application. + * + * @author niki + */ +package be.nikiroo.fanfix.bundles; \ No newline at end of file diff --git a/src/be/nikiroo/fanfix/bundles/resources_core.properties b/src/be/nikiroo/fanfix/bundles/resources_core.properties new file mode 100644 index 0000000..dc7881a --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/resources_core.properties @@ -0,0 +1,207 @@ +# United Kingdom (en_GB) resources_core translation file (UTF-8) +# +# Note that any key can be doubled with a _NOUTF suffix +# to use when the NOUTF env variable is set to 1 +# +# Also, the comments always refer to the key below them. +# + + +# help message for the syntax +# (FORMAT: STRING) +HELP_SYNTAX = Valid options:\n\ +\t--import [URL]: import into library\n\ +\t--export [id] [output_type] [target]: export story to target\n\ +\t--convert [URL] [output_type] [target] (+info): convert URL into target\n\ +\t--read [id] ([chapter number]): read the given story from the library\n\ +\t--read-url [URL] ([chapter number]): convert on the fly and read the \n\ +\t\tstory, without saving it\n\ +\t--search WEBSITE [free text] ([page] ([item])): search for the given terms, show the\n\ +\t\tgiven page (page 0 means "how many page do we have", starts at page 1)\n\ +\t--search-tag WEBSITE ([tag 1] [tag2...] ([page] ([item]))): list the known tags or \n\ +\t\tsearch the stories for the given tag(s), show the given page of results\n\ +\t--search: list the supported websites (where)\n\ +\t--search [where] [keywords] (page [page]) (item [item]): search on the supported \n\ +\t\twebsite and display the given results page of stories it found, or the story \n\ +\t\tdetails if asked\n\ +\t--search-tag [where]: list all the tags supported by this website\n\ +\t--search-tag [index 1]... (page [page]) (item [item]): search for the given stories or \n\ +\t\tsubtags, tag by tag, and display information about a specific page of results or \n\ +\t\tabout a specific item if requested\n\ +\t--list ([type]) : list the stories present in the library\n\ +\t--set-source [id] [new source]: change the source of the given story\n\ +\t--set-title [id] [new title]: change the title of the given story\n\ +\t--set-author [id] [new author]: change the author of the given story\n\ +\t--set-reader [reader type]: set the reader type to CLI, TUI or GUI for \n\ +\t\tthis command\n\ +\t--server: start the server mode (see config file for parameters)\n\ +\t--stop-server: stop the remote server running on this port\n\ +\t\tif any (key must be set to the same value)\n\ +\t--remote [key] [host] [port]: select this remote server to get \n\ +\t\t(or update or...) the stories from (key must be set to the \n\ +\t\tsame value)\n\ +\t--help: this help message\n\ +\t--version: return the version of the program\n\ +\n\ +Supported input types:\n\ +%s\n\ +\n\ +Supported output types:\n\ +%s +# syntax error message +# (FORMAT: STRING) +ERR_SYNTAX = Syntax error (try "--help") +# an input or output support type description +# (FORMAT: STRING) +ERR_SYNTAX_TYPE = > %s: %s +# Error when retrieving data +# (FORMAT: STRING) +ERR_LOADING = Error when retrieving data from: %s +# Error when saving to given target +# (FORMAT: STRING) +ERR_SAVING = Error when saving to target: %s +# Error when unknown output format +# (FORMAT: STRING) +ERR_BAD_OUTPUT_TYPE = Unknown output type: %s +# Error when converting input to URL/File +# (FORMAT: STRING) +ERR_BAD_URL = Cannot understand file or protocol: %s +# URL/File not supported +# (FORMAT: STRING) +ERR_NOT_SUPPORTED = URL not supported: %s +# Failed to download cover : %s +# (FORMAT: STRING) +ERR_BS_NO_COVER = Failed to download cover: %s +# Canonical OPEN SINGLE QUOTE char (for instance: ‘) +# (FORMAT: STRING) +OPEN_SINGLE_QUOTE = ‘ +# Canonical CLOSE SINGLE QUOTE char (for instance: ’) +# (FORMAT: STRING) +CLOSE_SINGLE_QUOTE = ’ +# Canonical OPEN DOUBLE QUOTE char (for instance: “) +# (FORMAT: STRING) +OPEN_DOUBLE_QUOTE = “ +# Canonical CLOSE DOUBLE QUOTE char (for instance: ”) +# (FORMAT: STRING) +CLOSE_DOUBLE_QUOTE = ” +# Name of the description fake chapter +# (FORMAT: STRING) +DESCRIPTION = Description +# Name of a chapter with a name +# (FORMAT: STRING) +CHAPTER_NAMED = Chapter %d: %s +# Name of a chapter without name +# (FORMAT: STRING) +CHAPTER_UNNAMED = Chapter %d +# Default description when the type is not known by i18n +# (FORMAT: STRING) +INPUT_DESC = Unknown type: %s +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_EPUB = EPUB files created by this program (we do not support "all" EPUB files) +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_TEXT = Stories encoded in textual format, with a few rules :\n\ +\tthe title must be on the first line, \n\ +\tthe author (preceded by nothing, "by " or "©") must be on the second \n\ +\t\tline, possibly with the publication date in parenthesis\n\ +\t\t(i.e., "By Unknown (3rd October 1998)"), \n\ +\tchapters must be declared with "Chapter x" or "Chapter x: NAME OF THE \n\ +\t\tCHAPTER", where "x" is the chapter number,\n\ +\ta description of the story must be given as chapter number 0,\n\ +\ta cover image may be present with the same filename but a PNG, \n\ +\t\tJPEG or JPG extension. +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_INFO_TEXT = Contains the same information as the TEXT format, but with a \n\ +\tcompanion ".info" file to store some metadata +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_FANFICTION = Fanfictions of many, many different universes, from TV shows to \n\ +\tnovels to games. +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_FIMFICTION = Fanfictions devoted to the My Little Pony show +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_MANGAHUB = A well filled repository of mangas, in English +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_E621 = Furry website supporting comics, including MLP +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_E_HENTAI = Website offering many comics/mangas, mostly but not always NSFW +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_YIFFSTAR = A Furry website, story-oriented +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_CBZ = CBZ files coming from this very program +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_HTML = HTML files coming from this very program +# Default description when the type is not known by i18n +# (FORMAT: STRING) +OUTPUT_DESC = Unknown type: %s +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_EPUB = Standard EPUB file working on most e-book readers and viewers +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_TEXT = Local stories encoded in textual format, with a few rules :\n\ +\tthe title must be on the first line, \n\ +\tthe author (preceded by nothing, "by " or "©") must be on the second \n\ +\t\tline, possibly with the publication date in parenthesis \n\ +\t\t(i.e., "By Unknown (3rd October 1998)"), \n\ +\tchapters must be declared with "Chapter x" or "Chapter x: NAME OF THE \n\ +\t\tCHAPTER", where "x" is the chapter number,\n\ +\ta description of the story must be given as chapter number 0,\n\ +\ta cover image may be present with the same filename but a PNG, JPEG \n\ +\t\tor JPG extension. +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_INFO_TEXT = Contains the same information as the TEXT format, but with a \n\ +\tcompanion ".info" file to store some metadata +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_CBZ = CBZ file (basically a ZIP file containing images -- we store the images \n\ +\tin PNG format by default) +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_HTML = HTML files (a directory containing the resources and "index.html") +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_LATEX = A LaTeX file using the "book" template +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SYSOUT = A simple DEBUG console output +# Default description when the type is not known by i18n +# This item is used as a group, its content is not expected to be used. +OUTPUT_DESC_SHORT = %s +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_EPUB = Electronic book (.epub) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_TEXT = Plain text (.txt) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_INFO_TEXT = Plain text and metadata +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_CBZ = Comic book (.cbz) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_LATEX = LaTeX (.tex) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_SYSOUT = Console output +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_HTML = HTML files with resources (directory, .html) +# Error message for unknown 2-letter LaTeX language code +# (FORMAT: STRING) +LATEX_LANG_UNKNOWN = Unknown language: %s +# 'by' prefix before author name used to output the author, make sure it is covered by Config.BYS for input detection +# (FORMAT: STRING) +BY = by diff --git a/src/be/nikiroo/fanfix/bundles/resources_core_fr.properties b/src/be/nikiroo/fanfix/bundles/resources_core_fr.properties new file mode 100644 index 0000000..a64a5a0 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/resources_core_fr.properties @@ -0,0 +1,192 @@ +# français (fr) resources_core translation file (UTF-8) +# +# Note that any key can be doubled with a _NOUTF suffix +# to use when the NOUTF env variable is set to 1 +# +# Also, the comments always refer to the key below them. +# + + +# help message for the syntax +# (FORMAT: STRING) +HELP_SYNTAX = Options reconnues :\n\ +\t--import [URL]: importer une histoire dans la librairie\n\ +\t--export [id] [output_type] [target]: exporter l'histoire "id" vers le fichier donné\n\ +\t--convert [URL] [output_type] [target] (+info): convertir l'histoire vers le fichier donné, et forcer l'ajout d'un fichier .info si +info est utilisé\n\ +\t--read [id] ([chapter number]): afficher l'histoire "id"\n\ +\t--read-url [URL] ([chapter number]): convertir l'histoire et la lire à la volée, sans la sauver\n\ +\t--search: liste les sites supportés (where)\n\ +\t--search [where] [keywords] (page [page]) (item [item]): lance une recherche et \n\ +\t\taffiche les résultats de la page page (page 1 par défaut), et de l'item item \n\ +\t\tspécifique si demandé\n\ +\t--search-tag [where]: liste tous les tags supportés par ce site web\n\ +\t--search-tag [index 1]... (page [page]) (item [item]): affine la recherche, tag par tag,\n\ +\t\tet affiche si besoin les sous-tags, les histoires ou les infos précises de \n\ +\t\tl'histoire demandée\n\ +\t--list ([type]): lister les histoires presentes dans la librairie et leurs IDs\n\ +\t--set-source [id] [nouvelle source]: change la source de l'histoire\n\ +\t--set-title [id] [nouveau titre]: change le titre de l'histoire\n\ +\t--set-author [id] [nouvel auteur]: change l'auteur de l'histoire\n\ +\t--set-reader [reader type]: changer le type de lecteur pour la commande en cours sur CLI, TUI ou GUI\n\ +\t--server: démarre le mode serveur (les paramètres sont dans le fichier de config)\n\ +\t--stop-server: arrêter le serveur distant sur ce port (key doit avoir la même valeur) \n\ +\t--remote [key] [host] [port]: contacter ce server au lieu de la librairie habituelle (key doit avoir la même valeur)\n\ +\t--help: afficher la liste des options disponibles\n\ +\t--version: retourne la version du programme\n\ +\n\ +Types supportés en entrée :\n\ +%s\n\ +\n\ +Types supportés en sortie :\n\ +%s +# syntax error message +# (FORMAT: STRING) +ERR_SYNTAX = Erreur de syntaxe (essayez "--help") +# an input or output support type description +# (FORMAT: STRING) +ERR_SYNTAX_TYPE = > %s : %s +# Error when retrieving data +# (FORMAT: STRING) +ERR_LOADING = Erreur de récupération des données depuis : %s +# Error when saving to given target +# (FORMAT: STRING) +ERR_SAVING = Erreur lors de la sauvegarde sur : %s +# Error when unknown output format +# (FORMAT: STRING) +ERR_BAD_OUTPUT_TYPE = Type de sortie inconnu : %s +# Error when converting input to URL/File +# (FORMAT: STRING) +ERR_BAD_URL = Protocole ou type de fichier inconnu : %s +# URL/File not supported +# (FORMAT: STRING) +ERR_NOT_SUPPORTED = Site web non supporté : %s +# Failed to download cover : %s +# (FORMAT: STRING) +ERR_BS_NO_COVER = Échec de la récupération de la page de couverture : %s +# Canonical OPEN SINGLE QUOTE char (for instance: ‘) +# (FORMAT: STRING) +OPEN_SINGLE_QUOTE = ‘ +# Canonical CLOSE SINGLE QUOTE char (for instance: ’) +# (FORMAT: STRING) +CLOSE_SINGLE_QUOTE = ’ +# Canonical OPEN DOUBLE QUOTE char (for instance: “) +# (FORMAT: STRING) +OPEN_DOUBLE_QUOTE = “ +# Canonical CLOSE DOUBLE QUOTE char (for instance: ”) +# (FORMAT: STRING) +CLOSE_DOUBLE_QUOTE = ” +# Name of the description fake chapter +# (FORMAT: STRING) +DESCRIPTION = Description +# Name of a chapter with a name +# (FORMAT: STRING) +CHAPTER_NAMED = Chapitre %d : %s +# Name of a chapter without name +# (FORMAT: STRING) +CHAPTER_UNNAMED = Chapitre %d +# Default description when the type is not known by i18n +# (FORMAT: STRING) +INPUT_DESC = Type d'entrée inconnu : %s +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_EPUB = Les fichiers .epub créés avec Fanfix (nous ne supportons pas les autres fichiers .epub, du moins pour le moment) +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_TEXT = Les histoires enregistrées en texte (.txt), avec quelques règles spécifiques : \n\ +\tle titre doit être sur la première ligne\n\ +\tl'auteur (précédé de rien, "Par ", "De " ou "©") doit être sur la deuxième ligne, optionnellement suivi de la date de publication entre parenthèses (i.e., "Par Quelqu'un (3 octobre 1998)")\n\ +\tles chapitres doivent être déclarés avec "Chapitre x" ou "Chapitre x: NOM DU CHAPTITRE", où "x" est le numéro du chapitre\n\ +\tune description de l'histoire doit être donnée en tant que chaptire 0\n\ +\tune image de couverture peut être présente avec le même nom de fichier que l'histoire, mais une extension .png, .jpeg ou .jpg +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_INFO_TEXT = Fort proche du format texte, mais avec un fichier .info accompagnant l'histoire pour y enregistrer quelques metadata (le fichier de metadata est supposé être créé par Fanfix, ou être compatible avec) +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_FANFICTION = Fanfictions venant d'une multitude d'univers différents, depuis les shows télévisés aux livres en passant par les jeux-vidéos +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_FIMFICTION = Fanfictions dévouées à la série My Little Pony +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_MANGAHUB = Un site répertoriant une quantité non négligeable de mangas, en anglais +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_E621 = Un site Furry proposant des comics, y compris de MLP +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_E_HENTAI = Un site web proposant beaucoup de comics/mangas, souvent mais pas toujours NSFW +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_YIFFSTAR = Un site web Furry, orienté sur les histoires plutôt que les images +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_CBZ = Les fichiers .cbz (une collection d'images zipées), de préférence créés avec Fanfix (même si les autres .cbz sont aussi supportés, mais sans la majorité des metadata de Fanfix dans ce cas) +# Description of this input type +# (FORMAT: STRING) +INPUT_DESC_HTML = Les fichiers HTML que vous pouvez ouvrir avec n'importe quel navigateur ; remarquez que Fanfix créera un répertoire pour y mettre les fichiers nécessaires, dont un fichier "index.html" pour afficher le tout -- nous ne supportons en entrée que les fichiers HTML créés par Fanfix +# Default description when the type is not known by i18n +# (FORMAT: STRING) +OUTPUT_DESC = Type de sortie inconnu : %s +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_EPUB = Standard EPUB file working on most e-book readers and viewers +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_TEXT = Local stories encoded in textual format, with a few rules :\n\ +\tthe title must be on the first line, \n\ +\tthe author (preceded by nothing, "by " or "©") must be on the second \n\ +\t\tline, possibly with the publication date in parenthesis \n\ +\t\t(i.e., "By Unknown (3rd October 1998)"), \n\ +\tchapters must be declared with "Chapter x" or "Chapter x: NAME OF THE \n\ +\t\tCHAPTER", where "x" is the chapter number,\n\ +\ta description of the story must be given as chapter number 0,\n\ +\ta cover image may be present with the same filename but a PNG, JPEG \n\ +\t\tor JPG extension. +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_INFO_TEXT = Contains the same information as the TEXT format, but with a \n\ +\tcompanion ".info" file to store some metadata +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_CBZ = CBZ file (basically a ZIP file containing images -- we store the images \n\ +\tin PNG format by default) +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_HTML = HTML files (a directory containing the resources and "index.html") +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_LATEX = A LaTeX file using the "book" template +# Description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SYSOUT = A simple DEBUG console output +# Default description when the type is not known by i18n +# This item is used as a group, its content is not expected to be used. +OUTPUT_DESC_SHORT = %s +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_EPUB = Electronic book (.epub) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_TEXT = Plain text (.txt) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_INFO_TEXT = Plain text and metadata +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_CBZ = Comic book (.cbz) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_LATEX = LaTeX (.tex) +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_SYSOUT = Console output +# Short description of this output type +# (FORMAT: STRING) +OUTPUT_DESC_SHORT_HTML = HTML files with resources (directory, .html) +# Error message for unknown 2-letter LaTeX language code +# (FORMAT: STRING) +LATEX_LANG_UNKNOWN = Unknown language: %s +# 'by' prefix before author name used to output the author, make sure it is covered by Config.BYS for input detection +# (FORMAT: STRING) +BY = by diff --git a/src/be/nikiroo/fanfix/bundles/resources_gui.properties b/src/be/nikiroo/fanfix/bundles/resources_gui.properties new file mode 100644 index 0000000..40be5eb --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/resources_gui.properties @@ -0,0 +1,199 @@ +# United Kingdom (en_GB) resources_gui translation file (UTF-8) +# +# Note that any key can be doubled with a _NOUTF suffix +# to use when the NOUTF env variable is set to 1 +# +# Also, the comments always refer to the key below them. +# + + +# the title of the main window of Fanfix, the library +# (FORMAT: STRING) +TITLE_LIBRARY = Fanfix %s +# the title of the main window of Fanfix, the library, when the library has a name (i.e., is not local) +# (FORMAT: STRING) +TITLE_LIBRARY_WITH_NAME = Fanfix %s +# the title of the configuration window of Fanfix, also the name of the menu button +# (FORMAT: STRING) +TITLE_CONFIG = Fanfix Configuration +# the subtitle of the configuration window of Fanfix +# (FORMAT: STRING) +SUBTITLE_CONFIG = This is where you configure the options of the program. +# the title of the UI configuration window of Fanfix, also the name of the menu button +# (FORMAT: STRING) +TITLE_CONFIG_UI = UI Configuration +# the subtitle of the UI configuration window of Fanfix +# (FORMAT: STRING) +SUBTITLE_CONFIG_UI = This is where you configure the graphical appearence of the program. +# the title of the 'save to/export to' window of Fanfix +# (FORMAT: STRING) +TITLE_SAVE = Save +# the title of the 'move to' window of Fanfix +# (FORMAT: STRING) +TITLE_MOVE_TO = Moving story +# the subtitle of the 'move to' window of Fanfix +# (FORMAT: STRING) +SUBTITLE_MOVE_TO = Move to: +# the title of the 'delete' window of Fanfix +# (FORMAT: STRING) +TITLE_DELETE = Delete story +# the subtitle of the 'delete' window of Fanfix +# (FORMAT: STRING) +SUBTITLE_DELETE = Delete %s: %s +# the title of the 'library error' dialogue +# (FORMAT: STRING) +TITLE_ERROR_LIBRARY = Library error +# the title of the 'import URL' dialogue +# (FORMAT: STRING) +TITLE_IMPORT_URL = Importing from URL +# the subtitle of the 'import URL' dialogue +# (FORMAT: STRING) +SUBTITLE_IMPORT_URL = URL of the story to import: +# the title of general error dialogues +# (FORMAT: STRING) +TITLE_ERROR = Error +# the title of a story for the properties dialogue, the viewers... +# (FORMAT: STRING) +TITLE_STORY = %s: %s +# HTML text used to notify of a new version +# (FORMAT: STRING) +NEW_VERSION_AVAILABLE = A new version of the program is available at %s +# text used as title for the update dialogue +# (FORMAT: STRING) +NEW_VERSION_TITLE = Updates available +# HTML text used to specify a newer version title and number, used for each version newer than the current one +# (FORMAT: STRING) +NEW_VERSION_VERSION = Version %s +# show the number of words of a book +# (FORMAT: STRING) +BOOK_COUNT_WORDS = %s words +# show the number of images of a book +# (FORMAT: STRING) +BOOK_COUNT_IMAGES = %s images +# show the number of stories of a meta-book (a book representing allthe types/sources or all the authors present) +# (FORMAT: STRING) +BOOK_COUNT_STORIES = %s stories +# the file menu +# (FORMAT: STRING) +MENU_FILE = File +# the file/exit menu button +# (FORMAT: STRING) +MENU_FILE_EXIT = Exit +# the file/import_file menu button +# (FORMAT: STRING) +MENU_FILE_IMPORT_FILE = Import File... +# the file/import_url menu button +# (FORMAT: STRING) +MENU_FILE_IMPORT_URL = Import URL... +# the file/export menu button +# (FORMAT: STRING) +MENU_FILE_EXPORT = Save as... +# the file/move to menu button +# (FORMAT: STRING) +MENU_FILE_MOVE_TO = Move to +# the file/set author menu button +# (FORMAT: STRING) +MENU_FILE_SET_AUTHOR = Set author +# the file/move to/new type-source menu button, that will trigger a dialogue to create a new type/source +# (FORMAT: STRING) +MENU_FILE_MOVE_TO_NEW_TYPE = New source... +# the file/move to/new author menu button, that will trigger a dialogue to create a new author +# (FORMAT: STRING) +MENU_FILE_MOVE_TO_NEW_AUTHOR = New author... +# the file/rename menu item, that will trigger a dialogue to ask for a new title for the story +# (FORMAT: STRING) +MENU_FILE_RENAME = Rename... +# the file/Properties menu item, that will trigger a dialogue to show the properties of the story +# (FORMAT: STRING) +MENU_FILE_PROPERTIES = Properties +# the file/open menu item, that will open the story or fake-story (an author or a source/type) +# (FORMAT: STRING) +MENU_FILE_OPEN = Open +# the edit menu +# (FORMAT: STRING) +MENU_EDIT = Edit +# the edit/send to cache menu button, to download the story into the cache if not already done +# (FORMAT: STRING) +MENU_EDIT_DOWNLOAD_TO_CACHE = Prefetch to cache +# the clear cache menu button, to clear the cache for a single book +# (FORMAT: STRING) +MENU_EDIT_CLEAR_CACHE = Clear cache +# the edit/redownload menu button, to download the latest version of the book +# (FORMAT: STRING) +MENU_EDIT_REDOWNLOAD = Redownload +# the edit/delete menu button +# (FORMAT: STRING) +MENU_EDIT_DELETE = Delete +# the edit/Set as cover for source menu button +# (FORMAT: STRING) +MENU_EDIT_SET_COVER_FOR_SOURCE = Set as cover for source +# the edit/Set as cover for author menu button +# (FORMAT: STRING) +MENU_EDIT_SET_COVER_FOR_AUTHOR = Set as cover for author +# the search menu to open the earch stories on one of the searchable websites +# (FORMAT: STRING) +MENU_SEARCH = Search +# the view menu +# (FORMAT: STRING) +MENU_VIEW = View +# the view/word_count menu button, to show the word/image/story count as secondary info +# (FORMAT: STRING) +MENU_VIEW_WCOUNT = Word count +# the view/author menu button, to show the author as secondary info +# (FORMAT: STRING) +MENU_VIEW_AUTHOR = Author +# the sources menu, to select the books from a specific source; also used as a title for the source books +# (FORMAT: STRING) +MENU_SOURCES = Sources +# the authors menu, to select the books of a specific author; also used as a title for the author books +# (FORMAT: STRING) +MENU_AUTHORS = Authors +# the options menu, to configure Fanfix from the GUI +# (FORMAT: STRING) +MENU_OPTIONS = Options +# a special menu button to select all the sources/types or authors, by group (one book = one group) +# (FORMAT: STRING) +MENU_XXX_ALL_GROUPED = All +# a special menu button to select all the sources/types or authors, in a listing (all the included books are listed, grouped by source/type or author) +# (FORMAT: STRING) +MENU_XXX_ALL_LISTING = Listing +# a special menu button to select the books without author +# (FORMAT: STRING) +MENU_AUTHORS_UNKNOWN = [unknown] +# progress bar caption for the 'reload books' step of all outOfUi operations +# (FORMAT: STRING) +PROGRESS_OUT_OF_UI_RELOAD_BOOKS = Reload books +# progress bar caption for the 'change source' step of the ReDownload operation +# (FORMAT: STRING) +PROGRESS_CHANGE_SOURCE = Change the source of the book to %s +# default description if the error is not known +# (FORMAT: STRING) +ERROR_LIB_STATUS = An error occured when contacting the library +# library access not allowed +# (FORMAT: STRING) +ERROR_LIB_STATUS_UNAUTHORIZED = You are not allowed to access this library +# the library is invalid (not correctly set up) +# (FORMAT: STRING) +ERROR_LIB_STATUS_INVALID = Library not valid +# the library is out of commission +# (FORMAT: STRING) +ERROR_LIB_STATUS_UNAVAILABLE = Library currently unavailable +# cannot open the book, internal or external viewer +# (FORMAT: STRING) +ERROR_CANNOT_OPEN = Cannot open the selected book +# URL is not supported by Fanfix +# (FORMAT: STRING) +ERROR_URL_NOT_SUPPORTED = URL not supported: %s +# cannot import the URL +# (FORMAT: STRING) +ERROR_URL_IMPORT_FAILED = Failed to import %s:\n\ +%s +# (html) the chapter progression value used on the viewers +# (FORMAT: STRING) +CHAPTER_HTML_UNNAMED =   Chapter %d/%d +# (html) the chapter progression value used on the viewers +# (FORMAT: STRING) +CHAPTER_HTML_NAMED =   Chapter %d/%d: %s +# (NO html) the chapter progression value used on the viewers +# (FORMAT: STRING) +IMAGE_PROGRESSION = Image %d / %d diff --git a/src/be/nikiroo/fanfix/bundles/resources_gui_fr.properties b/src/be/nikiroo/fanfix/bundles/resources_gui_fr.properties new file mode 100644 index 0000000..25ff542 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/resources_gui_fr.properties @@ -0,0 +1,199 @@ +# français (fr) resources_gui translation file (UTF-8) +# +# Note that any key can be doubled with a _NOUTF suffix +# to use when the NOUTF env variable is set to 1 +# +# Also, the comments always refer to the key below them. +# + + +# the title of the main window of Fanfix, the library +# (FORMAT: STRING) +TITLE_LIBRARY = Fanfix %s +# the title of the main window of Fanfix, the library, when the library has a name (i.e., is not local) +# (FORMAT: STRING) +TITLE_LIBRARY_WITH_NAME = Fanfix %s +# the title of the configuration window of Fanfix, also the name of the menu button +# (FORMAT: STRING) +TITLE_CONFIG = Configuration de Fanfix +# the subtitle of the configuration window of Fanfix +# (FORMAT: STRING) +SUBTITLE_CONFIG = C'est ici que vous pouvez configurer les options du programme. +# the title of the UI configuration window of Fanfix, also the name of the menu button +# (FORMAT: STRING) +TITLE_CONFIG_UI = Configuration de l'interface +# the subtitle of the UI configuration window of Fanfix +# (FORMAT: STRING) +SUBTITLE_CONFIG_UI = C'est ici que vous pouvez configurer les options de l'apparence de l'application. +# the title of the 'save to/export to' window of Fanfix +# (FORMAT: STRING) +TITLE_SAVE = Sauver +# the title of the 'move to' window of Fanfix +# (FORMAT: STRING) +TITLE_MOVE_TO = Déplacer le livre +# the subtitle of the 'move to' window of Fanfix +# (FORMAT: STRING) +SUBTITLE_MOVE_TO = Déplacer vers : +# the title of the 'delete' window of Fanfix +# (FORMAT: STRING) +TITLE_DELETE = Supprimer le livre +# the subtitle of the 'delete' window of Fanfix +# (FORMAT: STRING) +SUBTITLE_DELETE = Supprimer %s : %s +# the title of the 'library error' dialogue +# (FORMAT: STRING) +TITLE_ERROR_LIBRARY = Erreur avec la librairie +# the title of the 'import URL' dialogue +# (FORMAT: STRING) +TITLE_IMPORT_URL = Importer depuis une URL +# the subtitle of the 'import URL' dialogue +# (FORMAT: STRING) +SUBTITLE_IMPORT_URL = L'URL du livre à importer +# the title of general error dialogues +# (FORMAT: STRING) +TITLE_ERROR = Error +# the title of a story for the properties dialogue, the viewers... +# (FORMAT: STRING) +TITLE_STORY = %s: %s +# HTML text used to notify of a new version +# (FORMAT: STRING) +NEW_VERSION_AVAILABLE = Une nouvelle version du programme est disponible sur %s +# text used as title for the update dialogue +# (FORMAT: STRING) +NEW_VERSION_TITLE = Mise-à-jour disponible +# HTML text used to specify a newer version title and number, used for each version newer than the current one +# (FORMAT: STRING) +NEW_VERSION_VERSION = Version %s +# show the number of words of a book +# (FORMAT: STRING) +BOOK_COUNT_WORDS = %s mots +# show the number of images of a book +# (FORMAT: STRING) +BOOK_COUNT_IMAGES = %s images +# show the number of stories of a meta-book (a book representing allthe types/sources or all the authors present) +# (FORMAT: STRING) +BOOK_COUNT_STORIES = %s livres +# the file menu +# (FORMAT: STRING) +MENU_FILE = Fichier +# the file/exit menu button +# (FORMAT: STRING) +MENU_FILE_EXIT = Quiter +# the file/import_file menu button +# (FORMAT: STRING) +MENU_FILE_IMPORT_FILE = Importer un fichier... +# the file/import_url menu button +# (FORMAT: STRING) +MENU_FILE_IMPORT_URL = Importer une URL... +# the file/export menu button +# (FORMAT: STRING) +MENU_FILE_EXPORT = Sauver sous... +# the file/move to menu button +# (FORMAT: STRING) +MENU_FILE_MOVE_TO = Déplacer vers +# the file/set author menu button +# (FORMAT: STRING) +MENU_FILE_SET_AUTHOR = Changer l'auteur +# the file/move to/new type-source menu button, that will trigger a dialogue to create a new type/source +# (FORMAT: STRING) +MENU_FILE_MOVE_TO_NEW_TYPE = Nouvelle source... +# the file/move to/new author menu button, that will trigger a dialogue to create a new author +# (FORMAT: STRING) +MENU_FILE_MOVE_TO_NEW_AUTHOR = Nouvel auteur... +# the file/rename menu item, that will trigger a dialogue to ask for a new title for the story +# (FORMAT: STRING) +MENU_FILE_RENAME = Renommer... +# the file/Properties menu item, that will trigger a dialogue to show the properties of the story +# (FORMAT: STRING) +MENU_FILE_PROPERTIES = Propriétés +# the file/open menu item, that will open the story or fake-story (an author or a source/type) +# (FORMAT: STRING) +MENU_FILE_OPEN = Ouvrir +# the edit menu +# (FORMAT: STRING) +MENU_EDIT = Edition +# the edit/send to cache menu button, to download the story into the cache if not already done +# (FORMAT: STRING) +MENU_EDIT_DOWNLOAD_TO_CACHE = Précharger en cache +# the clear cache menu button, to clear the cache for a single book +# (FORMAT: STRING) +MENU_EDIT_CLEAR_CACHE = Nettoyer le cache +# the edit/redownload menu button, to download the latest version of the book +# (FORMAT: STRING) +MENU_EDIT_REDOWNLOAD = Re-downloader +# the edit/delete menu button +# (FORMAT: STRING) +MENU_EDIT_DELETE = Supprimer +# the edit/Set as cover for source menu button +# (FORMAT: STRING) +MENU_EDIT_SET_COVER_FOR_SOURCE = Utiliser comme cover pour la source +# the edit/Set as cover for author menu button +# (FORMAT: STRING) +MENU_EDIT_SET_COVER_FOR_AUTHOR = Utiliser comme cover pour l'auteur +# the search menu to open the earch stories on one of the searchable websites +# (FORMAT: STRING) +MENU_SEARCH = Recherche +# the view menu +# (FORMAT: STRING) +MENU_VIEW = Affichage +# the view/word_count menu button, to show the word/image/story count as secondary info +# (FORMAT: STRING) +MENU_VIEW_WCOUNT = Nombre de mots +# the view/author menu button, to show the author as secondary info +# (FORMAT: STRING) +MENU_VIEW_AUTHOR = Auteur +# the sources menu, to select the books from a specific source; also used as a title for the source books +# (FORMAT: STRING) +MENU_SOURCES = Sources +# the authors menu, to select the books of a specific author; also used as a title for the author books +# (FORMAT: STRING) +MENU_AUTHORS = Auteurs +# the options menu, to configure Fanfix from the GUI +# (FORMAT: STRING) +MENU_OPTIONS = Options +# a special menu button to select all the sources/types or authors, by group (one book = one group) +# (FORMAT: STRING) +MENU_XXX_ALL_GROUPED = Tout +# a special menu button to select all the sources/types or authors, in a listing (all the included books are listed, grouped by source/type or author) +# (FORMAT: STRING) +MENU_XXX_ALL_LISTING = Listing +# a special menu button to select the books without author +# (FORMAT: STRING) +MENU_AUTHORS_UNKNOWN = [inconnu] +# progress bar caption for the 'reload books' step of all outOfUi operations +# (FORMAT: STRING) +PROGRESS_OUT_OF_UI_RELOAD_BOOKS = Recharger les livres +# progress bar caption for the 'change source' step of the ReDownload operation +# (FORMAT: STRING) +PROGRESS_CHANGE_SOURCE = Change la source du livre en %s +# default description if the error is not known +# (FORMAT: STRING) +ERROR_LIB_STATUS = Une erreur est survenue en contactant la librairie +# library access not allowed +# (FORMAT: STRING) +ERROR_LIB_STATUS_UNAUTHORIZED = Vous n'êtes pas autorisé à accéder à cette librairie +# the library is invalid (not correctly set up) +# (FORMAT: STRING) +ERROR_LIB_STATUS_INVALID = Librairie invalide +# the library is out of commission +# (FORMAT: STRING) +ERROR_LIB_STATUS_UNAVAILABLE = Librairie indisponible +# cannot open the book, internal or external viewer +# (FORMAT: STRING) +ERROR_CANNOT_OPEN = Impossible d'ouvrir le livre sélectionné +# URL is not supported by Fanfix +# (FORMAT: STRING) +ERROR_URL_NOT_SUPPORTED = URL non supportée : %s +# cannot import the URL +# (FORMAT: STRING) +ERROR_URL_IMPORT_FAILED = Erreur lors de l'import de %s:\n\ +%s +# (html) the chapter progression value used on the viewers +# (FORMAT: STRING) +CHAPTER_HTML_UNNAMED =   Chapitre %d / %d +# (html) the chapter progression value used on the viewers +# (FORMAT: STRING) +CHAPTER_HTML_NAMED =   Chapitre %d / %d: %s +# (NO html) the chapter progression value used on the viewers +# (FORMAT: STRING) +IMAGE_PROGRESSION = Image %d / %d diff --git a/src/be/nikiroo/fanfix/bundles/ui_description.properties b/src/be/nikiroo/fanfix/bundles/ui_description.properties new file mode 100644 index 0000000..c8def83 --- /dev/null +++ b/src/be/nikiroo/fanfix/bundles/ui_description.properties @@ -0,0 +1,35 @@ +# United Kingdom (en_GB) UI configuration options description translation file (UTF-8) +# +# Note that any key can be doubled with a _NOUTF suffix +# to use when the NOUTF env variable is set to 1 +# +# Also, the comments always refer to the key below them. +# + + +# The directory where to store temporary files for the GUI reader; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator +# (FORMAT: DIRECTORY) absolute path, $HOME variable supported, / is always accepted as dir separator +CACHE_DIR_LOCAL_READER = The directory where to store temporary files for the GUI reader; any relative path uses the applciation config directory as base, $HOME notation is supported, / is always accepted as directory separator +# The type of output for the GUI Reader for non-images documents +# (FORMAT: COMBO_LIST) One of the known output type +# ALLOWED VALUES: "INFO_TEXT" "EPUB" "HTML" "TEXT" +GUI_NON_IMAGES_DOCUMENT_TYPE = +# The type of output for the GUI Reader for images documents +# (FORMAT: COMBO_LIST) +# ALLOWED VALUES: "CBZ" "HTML" +GUI_IMAGES_DOCUMENT_TYPE = +# Use the internal reader for images documents -- this is TRUE by default +# (FORMAT: BOOLEAN) +IMAGES_DOCUMENT_USE_INTERNAL_READER = +# The command launched for images documents -- default to the system default for the current file type +# (FORMAT: STRING) A command to start +IMAGES_DOCUMENT_READER = +# Use the internal reader for non images documents -- this is TRUE by default +# (FORMAT: BOOLEAN) +NON_IMAGES_DOCUMENT_USE_INTERNAL_READER = +# The command launched for non images documents -- default to the system default for the current file type +# (FORMAT: STRING) A command to start +NON_IMAGES_DOCUMENT_READER = +# The background colour if you don't want the default system one +# (FORMAT: COLOR) +BACKGROUND_COLOR = diff --git a/src/be/nikiroo/fanfix/data/Chapter.java b/src/be/nikiroo/fanfix/data/Chapter.java new file mode 100644 index 0000000..d490058 --- /dev/null +++ b/src/be/nikiroo/fanfix/data/Chapter.java @@ -0,0 +1,154 @@ +package be.nikiroo.fanfix.data; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +/** + * A chapter in the story (or the resume/description). + * + * @author niki + */ +public class Chapter implements Iterable, Cloneable, Serializable { + private static final long serialVersionUID = 1L; + + private String name; + private int number; + private List paragraphs = new ArrayList(); + private List empty = new ArrayList(); + private long words; + + /** + * Empty constructor, not to use. + */ + @SuppressWarnings("unused") + private Chapter() { + // for serialisation purposes + } + + /** + * Create a new {@link Chapter} with the given information. + * + * @param number + * the chapter number, or 0 for the description/resume. + * @param name + * the chapter name + */ + public Chapter(int number, String name) { + this.number = number; + this.name = name; + } + + /** + * The chapter name. + * + * @return the name + */ + public String getName() { + return name; + } + + /** + * The chapter name. + * + * @param name + * the name to set + */ + public void setName(String name) { + this.name = name; + } + + /** + * The chapter number, or 0 for the description/resume. + * + * @return the number + */ + public int getNumber() { + return number; + } + + /** + * The chapter number, or 0 for the description/resume. + * + * @param number + * the number to set + */ + public void setNumber(int number) { + this.number = number; + } + + /** + * The included paragraphs. + * + * @return the paragraphs + */ + public List getParagraphs() { + return paragraphs; + } + + /** + * The included paragraphs. + * + * @param paragraphs + * the paragraphs to set + */ + public void setParagraphs(List paragraphs) { + this.paragraphs = paragraphs; + } + + /** + * Get an iterator on the {@link Paragraph}s. + */ + @Override + public Iterator iterator() { + return paragraphs == null ? empty.iterator() : paragraphs.iterator(); + } + + /** + * The number of words (or images) in this {@link Chapter}. + * + * @return the number of words + */ + public long getWords() { + return words; + } + + /** + * The number of words (or images) in this {@link Chapter}. + * + * @param words + * the number of words to set + */ + public void setWords(long words) { + this.words = words; + } + + /** + * Display a DEBUG {@link String} representation of this object. + */ + @Override + public String toString() { + return "Chapter " + number + ": " + name; + } + + @Override + public Chapter clone() { + Chapter chap = null; + try { + chap = (Chapter) super.clone(); + } catch (CloneNotSupportedException e) { + // Did the clones rebel? + System.err.println(e); + } + + if (paragraphs != null) { + chap.paragraphs = new ArrayList(); + for (Paragraph para : paragraphs) { + chap.paragraphs.add(para.clone()); + } + } + + return chap; + } +} diff --git a/src/be/nikiroo/fanfix/data/JsonIO.java b/src/be/nikiroo/fanfix/data/JsonIO.java new file mode 100644 index 0000000..501a0d9 --- /dev/null +++ b/src/be/nikiroo/fanfix/data/JsonIO.java @@ -0,0 +1,431 @@ +package be.nikiroo.fanfix.data; + +import java.util.ArrayList; +import java.util.List; + +import org.json.JSONArray; +import org.json.JSONException; +import org.json.JSONObject; + +import be.nikiroo.fanfix.data.Paragraph.ParagraphType; +import be.nikiroo.utils.Progress; + +public class JsonIO { + static public JSONObject toJson(MetaData meta) { + if (meta == null) { + return null; + } + + JSONObject json = new JSONObject(); + + put(json, "", MetaData.class.getName()); + put(json, "luid", meta.getLuid()); + put(json, "title", meta.getTitle()); + put(json, "author", meta.getAuthor()); + put(json, "source", meta.getSource()); + put(json, "url", meta.getUrl()); + put(json, "words", meta.getWords()); + put(json, "creation_date", meta.getCreationDate()); + put(json, "date", meta.getDate()); + put(json, "lang", meta.getLang()); + put(json, "publisher", meta.getPublisher()); + put(json, "subject", meta.getSubject()); + put(json, "type", meta.getType()); + put(json, "uuid", meta.getUuid()); + put(json, "fake_cover", meta.isFakeCover()); + put(json, "image_document", meta.isImageDocument()); + + put(json, "resume", toJson(meta.getResume())); + put(json, "tags", new JSONArray(meta.getTags())); + + return json; + } + + /** + * // no image + * + * @param json + * + * @return + * + * @throws JSONException + * when it cannot be converted + */ + static public MetaData toMetaData(JSONObject json) { + if (json == null) { + return null; + } + + MetaData meta = new MetaData(); + + meta.setLuid(getString(json, "luid")); + meta.setTitle(getString(json, "title")); + meta.setAuthor(getString(json, "author")); + meta.setSource(getString(json, "source")); + meta.setUrl(getString(json, "url")); + meta.setWords(getLong(json, "words", 0)); + meta.setCreationDate(getString(json, "creation_date")); + meta.setDate(getString(json, "date")); + meta.setLang(getString(json, "lang")); + meta.setPublisher(getString(json, "publisher")); + meta.setSubject(getString(json, "subject")); + meta.setType(getString(json, "type")); + meta.setUuid(getString(json, "uuid")); + meta.setFakeCover(getBoolean(json, "fake_cover", false)); + meta.setImageDocument(getBoolean(json, "image_document", false)); + + meta.setResume(toChapter(getJson(json, "resume"))); + meta.setTags(toListString(getJsonArr(json, "tags"))); + + return meta; + } + + static public JSONObject toJson(Story story) { + if (story == null) { + return null; + } + + JSONObject json = new JSONObject(); + put(json, "", Story.class.getName()); + put(json, "meta", toJson(story.getMeta())); + + List chapters = new ArrayList(); + for (Chapter chap : story) { + chapters.add(toJson(chap)); + } + put(json, "chapters", new JSONArray(chapters)); + + return json; + } + + /** + * + * @param json + * + * @return + * + * @throws JSONException + * when it cannot be converted + */ + static public Story toStory(JSONObject json) { + if (json == null) { + return null; + } + + Story story = new Story(); + story.setMeta(toMetaData(getJson(json, "meta"))); + story.setChapters(toListChapter(getJsonArr(json, "chapters"))); + + return story; + } + + static public JSONObject toJson(Chapter chap) { + if (chap == null) { + return null; + } + + JSONObject json = new JSONObject(); + put(json, "", Chapter.class.getName()); + put(json, "name", chap.getName()); + put(json, "number", chap.getNumber()); + put(json, "words", chap.getWords()); + + List paragraphs = new ArrayList(); + for (Paragraph para : chap) { + paragraphs.add(toJson(para)); + } + put(json, "paragraphs", new JSONArray(paragraphs)); + + return json; + } + + /** + * + * @param json + * + * @return + * + * @throws JSONException + * when it cannot be converted + */ + static public Chapter toChapter(JSONObject json) { + if (json == null) { + return null; + } + + Chapter chap = new Chapter(getInt(json, "number", 0), + getString(json, "name")); + chap.setWords(getLong(json, "words", 0)); + + chap.setParagraphs(toListParagraph(getJsonArr(json, "paragraphs"))); + + return chap; + } + + // no images + static public JSONObject toJson(Paragraph para) { + if (para == null) { + return null; + } + + JSONObject json = new JSONObject(); + + put(json, "", Paragraph.class.getName()); + put(json, "content", para.getContent()); + put(json, "words", para.getWords()); + + put(json, "type", para.getType().toString()); + + return json; + } + + /** + * // no images + * + * @param json + * + * @return + * + * @throws JSONException + * when it cannot be converted + */ + static public Paragraph toParagraph(JSONObject json) { + if (json == null) { + return null; + } + + Paragraph para = new Paragraph( + ParagraphType.valueOf(getString(json, "type")), + getString(json, "content"), getLong(json, "words", 0)); + + return para; + } + + // only supported option: a MetaData called "meta" + static public JSONObject toJson(Progress pg) { + return toJson(pg, null); + } + + // only supported option: a MetaData called "meta" + static private JSONObject toJson(Progress pg, Double weight) { + if (pg == null) { + return null; + } + + // Supported keys: meta (only keep the key on the main parent, where + // weight is NULL) + MetaData meta = null; + if (weight == null) { + Object ometa = pg.get("meta"); + if (ometa instanceof MetaData) { + meta = getMetaLight((MetaData) ometa); + } + } + // + + JSONObject json = new JSONObject(); + + put(json, "", Progress.class.getName()); + put(json, "name", pg.getName()); + put(json, "min", pg.getMin()); + put(json, "max", pg.getMax()); + put(json, "progress", pg.getRelativeProgress()); + put(json, "weight", weight); + put(json, "meta", meta); + + List children = new ArrayList(); + for (Progress child : pg.getChildren()) { + children.add(toJson(child, pg.getWeight(child))); + } + put(json, "children", new JSONArray(children)); + + return json; + } + + // only supported option: a MetaData called "meta" + static public Progress toProgress(JSONObject json) { + if (json == null) { + return null; + } + + Progress pg = new Progress( // + getString(json, "name"), // + getInt(json, "min", 0), // + getInt(json, "max", 100) // + ); + + pg.setRelativeProgress(getDouble(json, "progress", 0)); + + Object meta = getObject(json, "meta"); + if (meta != null) { + pg.put("meta", meta); + } + + JSONArray jchildren = getJsonArr(json, "children"); + for (int i = 0; i < jchildren.length(); i++) { + try { + JSONObject jchild = jchildren.getJSONObject(i); + Double weight = getDouble(jchild, "weight", 0); + pg.addProgress(toProgress(jchild), weight); + } catch (Exception e) { + } + } + + return pg; + } + + static public List toListString(JSONArray array) { + if (array != null) { + List values = new ArrayList(); + for (int i = 0; i < array.length(); i++) { + values.add(array.getString(i)); + } + return values; + } + + return null; + } + + static public List toListParagraph(JSONArray array) { + if (array != null) { + List values = new ArrayList(); + for (int i = 0; i < array.length(); i++) { + JSONObject value = array.getJSONObject(i); + values.add(toParagraph(value)); + } + return values; + } + + return null; + } + + static private List toListChapter(JSONArray array) { + if (array != null) { + List values = new ArrayList(); + for (int i = 0; i < array.length(); i++) { + JSONObject value = array.getJSONObject(i); + values.add(toChapter(value)); + } + return values; + } + + return null; + } + + static private void put(JSONObject json, String key, Object o) { + json.put(key, o == null ? JSONObject.NULL : o); + } + + static private Object getObject(JSONObject json, String key) { + if (json.has(key)) { + try { + return json.get(key); + } catch (Exception e) { + // Can fail if content was NULL! + } + } + + return null; + } + + static private String getString(JSONObject json, String key) { + Object o = getObject(json, key); + if (o instanceof String) + return (String) o; + + return null; + } + + static private long getLong(JSONObject json, String key, long def) { + Object o = getObject(json, key); + if (o instanceof Byte) + return (Byte) o; + if (o instanceof Short) + return (Short) o; + if (o instanceof Integer) + return (Integer) o; + if (o instanceof Long) + return (Long) o; + + return def; + } + + static private double getDouble(JSONObject json, String key, double def) { + Object o = getObject(json, key); + if (o instanceof Byte) + return (Byte) o; + if (o instanceof Short) + return (Short) o; + if (o instanceof Integer) + return (Integer) o; + if (o instanceof Long) + return (Long) o; + if (o instanceof Float) + return (Float) o; + if (o instanceof Double) + return (Double) o; + + return def; + } + + static private boolean getBoolean(JSONObject json, String key, + boolean def) { + Object o = getObject(json, key); + if (o instanceof Boolean) { + return (Boolean) o; + } + + return def; + } + + static private int getInt(JSONObject json, String key, int def) { + Object o = getObject(json, key); + if (o instanceof Byte) + return (Byte) o; + if (o instanceof Short) + return (Short) o; + if (o instanceof Integer) + return (Integer) o; + if (o instanceof Long) { + try { + return (int) (long) ((Long) o); + } catch (Exception e) { + } + } + + return def; + } + + static private JSONObject getJson(JSONObject json, String key) { + Object o = getObject(json, key); + if (o instanceof JSONObject) { + return (JSONObject) o; + } + + return null; + } + + static private JSONArray getJsonArr(JSONObject json, String key) { + Object o = getObject(json, key); + if (o instanceof JSONArray) { + return (JSONArray) o; + } + + return null; + } + + // null -> null + static private MetaData getMetaLight(MetaData meta) { + MetaData light = null; + if (meta != null) { + if (meta.getCover() == null) { + light = meta; + } else { + light = meta.clone(); + light.setCover(null); + } + } + + return light; + } +} diff --git a/src/be/nikiroo/fanfix/data/MetaData.java b/src/be/nikiroo/fanfix/data/MetaData.java new file mode 100644 index 0000000..2e34ef9 --- /dev/null +++ b/src/be/nikiroo/fanfix/data/MetaData.java @@ -0,0 +1,511 @@ +package be.nikiroo.fanfix.data; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.List; + +import be.nikiroo.utils.Image; +import be.nikiroo.utils.StringUtils; + +/** + * The meta data associated to a {@link Story} object. + *

+ * Note that some earlier version of the program did not save the resume as an + * external file; for those stories, the resume is not fetched until the story + * is. + *

+ * The cover is never fetched until the story is. + * + * @author niki + */ +public class MetaData implements Cloneable, Comparable, Serializable { + private static final long serialVersionUID = 1L; + + private String title; + private String author; + private String date; + private Chapter resume; + private List tags; + private Image cover; + private String subject; + private String source; + private String url; + private String uuid; + private String luid; + private String lang; + private String publisher; + private String type; + private boolean imageDocument; + private long words; + private String creationDate; + private boolean fakeCover; + + /** + * Create an empty {@link MetaData}. + */ + public MetaData() { + } + + /** + * The title of the story. + * + * @return the title + */ + public String getTitle() { + return title; + } + + /** + * The title of the story. + * + * @param title + * the title to set + */ + public void setTitle(String title) { + this.title = title; + } + + /** + * The author of the story. + * + * @return the author + */ + public String getAuthor() { + return author; + } + + /** + * The author of the story. + * + * @param author + * the author to set + */ + public void setAuthor(String author) { + this.author = author; + } + + /** + * The story publication date. + * + * @return the date + */ + public String getDate() { + return date; + } + + /** + * The story publication date. + * + * @param date + * the date to set + */ + public void setDate(String date) { + this.date = date; + } + + /** + * The tags associated with this story. + * + * @return the tags + */ + public List getTags() { + return tags; + } + + /** + * The tags associated with this story. + * + * @param tags + * the tags to set + */ + public void setTags(List tags) { + this.tags = tags; + } + + /** + * The story resume (a.k.a. description). + *

+ * This can be NULL if we don't have a resume for this {@link Story}. + *

+ * Note that some earlier version of the program did not save the resume as + * an external file; for those stories, the resume is not fetched until the + * story is. + * + * @return the resume + */ + public Chapter getResume() { + return resume; + } + + /** + * The story resume (a.k.a. description). + *

+ * Note that some earlier version of the program did not save the resume as + * an external file; for those stories, the resume is not fetched until the + * story is. + * + * @param resume + * the resume to set + */ + public void setResume(Chapter resume) { + this.resume = resume; + } + + /** + * The cover image of the story if any (can be NULL). + *

+ * The cover is not fetched until the story is. + * + * @return the cover + */ + public Image getCover() { + return cover; + } + + /** + * The cover image of the story if any (can be NULL). + *

+ * The cover is not fetched until the story is. + * + * @param cover + * the cover to set + */ + public void setCover(Image cover) { + this.cover = cover; + } + + /** + * The subject of the story (or instance, if it is a fanfiction, what is the + * original work; if it is a technical text, what is the technical + * subject...). + * + * @return the subject + */ + public String getSubject() { + return subject; + } + + /** + * The subject of the story (for instance, if it is a fanfiction, what is + * the original work; if it is a technical text, what is the technical + * subject...). + * + * @param subject + * the subject to set + */ + public void setSubject(String subject) { + this.subject = subject; + } + + /** + * The source of this story (which online library it was downloaded from). + * + * @return the source + */ + public String getSource() { + return source; + } + + /** + * The source of this story (which online library it was downloaded from). + * + * @param source + * the source to set + */ + public void setSource(String source) { + this.source = source; + } + + /** + * The original URL from which this {@link Story} was imported. + * + * @return the url + */ + public String getUrl() { + return url; + } + + /** + * The original URL from which this {@link Story} was imported. + * + * @param url + * the new url to set + */ + public void setUrl(String url) { + this.url = url; + } + + /** + * A unique value representing the story (it is often a URL). + * + * @return the uuid + */ + public String getUuid() { + return uuid; + } + + /** + * A unique value representing the story (it is often a URL). + * + * @param uuid + * the uuid to set + */ + public void setUuid(String uuid) { + this.uuid = uuid; + } + + /** + * A unique value representing the story in the local library. + * + * @return the luid + */ + public String getLuid() { + return luid; + } + + /** + * A unique value representing the story in the local library. + * + * @param luid + * the luid to set + */ + public void setLuid(String luid) { + this.luid = luid; + } + + /** + * The 2-letter code language of this story. + * + * @return the lang + */ + public String getLang() { + return lang; + } + + /** + * The 2-letter code language of this story. + * + * @param lang + * the lang to set + */ + public void setLang(String lang) { + this.lang = lang; + } + + /** + * The story publisher (other the same as the source). + * + * @return the publisher + */ + public String getPublisher() { + return publisher; + } + + /** + * The story publisher (other the same as the source). + * + * @param publisher + * the publisher to set + */ + public void setPublisher(String publisher) { + this.publisher = publisher; + } + + /** + * The output type this {@link Story} is in. + * + * @return the type the type + */ + public String getType() { + return type; + } + + /** + * The output type this {@link Story} is in. + * + * @param type + * the new type to set + */ + public void setType(String type) { + this.type = type; + } + + /** + * Document catering mostly to image files. + * + * @return the imageDocument state + */ + public boolean isImageDocument() { + return imageDocument; + } + + /** + * Document catering mostly to image files. + * + * @param imageDocument + * the imageDocument state to set + */ + public void setImageDocument(boolean imageDocument) { + this.imageDocument = imageDocument; + } + + /** + * The number of words in the related {@link Story}. + * + * @return the number of words + */ + public long getWords() { + return words; + } + + /** + * The number of words in the related {@link Story}. + * + * @param words + * the number of words to set + */ + public void setWords(long words) { + this.words = words; + } + + /** + * The (Fanfix) {@link Story} creation date. + * + * @return the creationDate + */ + public String getCreationDate() { + return creationDate; + } + + /** + * The (Fanfix) {@link Story} creation date. + * + * @param creationDate + * the creationDate to set + */ + public void setCreationDate(String creationDate) { + this.creationDate = creationDate; + } + + /** + * The cover in this {@link MetaData} object is "fake", in the sens that it + * comes from the actual content images. + * + * @return TRUE for a fake cover + */ + public boolean isFakeCover() { + return fakeCover; + } + + /** + * The cover in this {@link MetaData} object is "fake", in the sens that it + * comes from the actual content images + * + * @param fakeCover + * TRUE for a fake cover + */ + public void setFakeCover(boolean fakeCover) { + this.fakeCover = fakeCover; + } + + @Override + public int compareTo(MetaData o) { + if (o == null) { + return 1; + } + + String id = (getTitle() == null ? "" : getTitle()) + + (getUuid() == null ? "" : getUuid()) + + (getLuid() == null ? "" : getLuid()); + String oId = (getTitle() == null ? "" : o.getTitle()) + + (getUuid() == null ? "" : o.getUuid()) + + (o.getLuid() == null ? "" : o.getLuid()); + + return id.compareToIgnoreCase(oId); + } + + @Override + public boolean equals(Object obj) { + if (!(obj instanceof MetaData)) { + return false; + } + + return compareTo((MetaData) obj) == 0; + } + + @Override + public int hashCode() { + String uuid = getUuid(); + if (uuid == null) { + uuid = "" + title + author + source; + } + + return uuid.hashCode(); + } + + @Override + public MetaData clone() { + MetaData meta = null; + try { + meta = (MetaData) super.clone(); + } catch (CloneNotSupportedException e) { + // Did the clones rebel? + System.err.println(e); + } + + if (tags != null) { + meta.tags = new ArrayList(tags); + } + + if (resume != null) { + meta.resume = resume.clone(); + } + + return meta; + } + + /** + * Display a DEBUG {@link String} representation of this object. + *

+ * This is not efficient, nor intended to be. + */ + @Override + public String toString() { + String title = ""; + if (getTitle() != null) { + title = getTitle(); + } + + StringBuilder tags = new StringBuilder(); + if (getTags() != null) { + for (String tag : getTags()) { + if (tags.length() > 0) { + tags.append(", "); + } + tags.append(tag); + } + } + + String resume = ""; + if (getResume() != null) { + for (Paragraph para : getResume()) { + resume += "\n\t"; + resume += para.toString().substring(0, + Math.min(para.toString().length(), 120)); + } + resume += "\n"; + } + + String cover = "none"; + if (getCover() != null) { + cover = StringUtils.formatNumber(getCover().getSize()) + + "bytes"; + } + + return String.format( + "Meta %s:\n\tTitle: [%s]\n\tAuthor: [%s]\n\tDate: [%s]\n\tTags: [%s]\n\tWord count: [%s]" + + "\n\tResume: [%s]\n\tCover: [%s]", + luid, title, getAuthor(), getDate(), tags.toString(), + "" + words, resume, cover); + } +} diff --git a/src/be/nikiroo/fanfix/data/Paragraph.java b/src/be/nikiroo/fanfix/data/Paragraph.java new file mode 100644 index 0000000..d5a0f1c --- /dev/null +++ b/src/be/nikiroo/fanfix/data/Paragraph.java @@ -0,0 +1,182 @@ +package be.nikiroo.fanfix.data; + +import java.io.Serializable; + +import be.nikiroo.utils.Image; + +/** + * A paragraph in a chapter of the story. + * + * @author niki + */ +public class Paragraph implements Cloneable, Serializable { + private static final long serialVersionUID = 1L; + + /** + * A paragraph type, that will dictate how the paragraph will be handled. + * + * @author niki + */ + public enum ParagraphType { + /** Normal paragraph (text) */ + NORMAL, + /** Blank line */ + BLANK, + /** A Break paragraph, i.e.: HR (Horizontal Line) or '* * *' or whatever */ + BREAK, + /** Quotation (dialogue) */ + QUOTE, + /** An image (no text) */ + IMAGE, ; + + /** + * This paragraph type is of a text kind (quote or not). + * + * @param allowEmpty + * allow empty text as text, too (blanks, breaks...) + * @return TRUE if it is + */ + public boolean isText(boolean allowEmpty) { + return (this == NORMAL || this == QUOTE) + || (allowEmpty && (this == BLANK || this == BREAK)); + } + } + + private ParagraphType type; + private String content; + private Image contentImage; + private long words; + + /** + * Empty constructor, not to use. + */ + @SuppressWarnings("unused") + private Paragraph() { + // for serialisation purposes + } + + /** + * Create a new {@link Paragraph} with the given image. + * + * @param contentImage + * the image + */ + public Paragraph(Image contentImage) { + this(ParagraphType.IMAGE, null, 1); + this.contentImage = contentImage; + } + + /** + * Create a new {@link Paragraph} with the given values. + * + * @param type + * the {@link ParagraphType} + * @param content + * the content of this paragraph + * @param words + * the number of words (or images) + */ + public Paragraph(ParagraphType type, String content, long words) { + this.type = type; + this.content = content; + this.words = words; + } + + /** + * The {@link ParagraphType}. + * + * @return the type + */ + public ParagraphType getType() { + return type; + } + + /** + * The {@link ParagraphType}. + * + * @param type + * the type to set + */ + public void setType(ParagraphType type) { + this.type = type; + } + + /** + * The content of this {@link Paragraph} if it is not an image. + * + * @return the content + */ + public String getContent() { + return content; + } + + /** + * The content of this {@link Paragraph}. + * + * @param content + * the content to set + */ + public void setContent(String content) { + this.content = content; + } + + /** + * The content of this {@link Paragraph} if it is an image. + * + * @return the content + */ + public Image getContentImage() { + return contentImage; + } + + /** + * The content of this {@link Paragraph} if it is an image. + * + * @param contentImage + * the content + */ + public void setContentImage(Image contentImage) { + this.contentImage = contentImage; + } + + /** + * The number of words (or images) in this {@link Paragraph}. + * + * @return the number of words + */ + public long getWords() { + return words; + } + + /** + * The number of words (or images) in this {@link Paragraph}. + * + * @param words + * the number of words to set + */ + public void setWords(long words) { + this.words = words; + } + + /** + * Display a DEBUG {@link String} representation of this object. + */ + @Override + public String toString() { + return String.format("%s: [%s]", "" + type, content == null ? "N/A" + : content); + } + + @Override + public Paragraph clone() { + Paragraph para = null; + try { + para = (Paragraph) super.clone(); + } catch (CloneNotSupportedException e) { + // Did the clones rebel? + System.err.println(e); + } + + return para; + } +} diff --git a/src/be/nikiroo/fanfix/data/Story.java b/src/be/nikiroo/fanfix/data/Story.java new file mode 100644 index 0000000..fc3f909 --- /dev/null +++ b/src/be/nikiroo/fanfix/data/Story.java @@ -0,0 +1,101 @@ +package be.nikiroo.fanfix.data; + +import java.io.Serializable; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +/** + * The main data class, where the whole story resides. + * + * @author niki + */ +public class Story implements Iterable, Cloneable, Serializable { + private static final long serialVersionUID = 1L; + + private MetaData meta; + private List chapters = new ArrayList(); + private List empty = new ArrayList(); + + /** + * The metadata about this {@link Story}. + * + * @return the meta + */ + public MetaData getMeta() { + return meta; + } + + /** + * The metadata about this {@link Story}. + * + * @param meta + * the meta to set + */ + public void setMeta(MetaData meta) { + this.meta = meta; + } + + /** + * The chapters of the story. + * + * @return the chapters + */ + public List getChapters() { + return chapters; + } + + /** + * The chapters of the story. + * + * @param chapters + * the chapters to set + */ + public void setChapters(List chapters) { + this.chapters = chapters; + } + + /** + * Get an iterator on the {@link Chapter}s. + */ + @Override + public Iterator iterator() { + return chapters == null ? empty.iterator() : chapters.iterator(); + } + + /** + * Display a DEBUG {@link String} representation of this object. + *

+ * This is not efficient, nor intended to be. + */ + @Override + public String toString() { + if (getMeta() != null) + return "Story: [\n" + getMeta().toString() + "\n]"; + return "Story: [ no metadata found ]"; + } + + @Override + public Story clone() { + Story story = null; + try { + story = (Story) super.clone(); + } catch (CloneNotSupportedException e) { + // Did the clones rebel? + System.err.println(e); + } + + if (meta != null) { + story.meta = meta.clone(); + } + + if (chapters != null) { + story.chapters = new ArrayList(); + for (Chapter chap : chapters) { + story.chapters.add(chap.clone()); + } + } + + return story; + } +} diff --git a/src/be/nikiroo/fanfix/data/package-info.java b/src/be/nikiroo/fanfix/data/package-info.java new file mode 100644 index 0000000..57db36b --- /dev/null +++ b/src/be/nikiroo/fanfix/data/package-info.java @@ -0,0 +1,9 @@ +/** + * This package contains the data structure used by the program, without the + * logic behind them. + *

+ * All the classes inside are serializable. + * + * @author niki + */ +package be.nikiroo.fanfix.data; \ No newline at end of file diff --git a/src/be/nikiroo/fanfix/library/BasicLibrary.java b/src/be/nikiroo/fanfix/library/BasicLibrary.java new file mode 100644 index 0000000..f77d0ed --- /dev/null +++ b/src/be/nikiroo/fanfix/library/BasicLibrary.java @@ -0,0 +1,998 @@ +package be.nikiroo.fanfix.library; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.net.UnknownHostException; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; + +import be.nikiroo.fanfix.Instance; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.fanfix.output.BasicOutput; +import be.nikiroo.fanfix.output.BasicOutput.OutputType; +import be.nikiroo.fanfix.supported.BasicSupport; +import be.nikiroo.fanfix.supported.SupportType; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.Progress; +import be.nikiroo.utils.StringUtils; + +/** + * Manage a library of Stories: import, export, list, modify. + *

+ * Each {@link Story} object will be associated with a (local to the library) + * unique ID, the LUID, which will be used to identify the {@link Story}. + *

+ * Most of the {@link BasicLibrary} functions work on a partial (cover + * MAY not be included) {@link MetaData} object. + * + * @author niki + */ +abstract public class BasicLibrary { + /** + * A {@link BasicLibrary} status. + * + * @author niki + */ + public enum Status { + /** The library is ready and r/w. */ + READ_WRITE, + /** The library is ready, but read-only. */ + READ_ONLY, + /** You are not allowed to access this library. */ + UNAUTHORIZED, + /** The library is invalid, and will never work as is. */ + INVALID, + /** The library is currently out of commission, but may work later. */ + UNAVAILABLE; + + /** + * The library is available (you can query it). + *

+ * It does not specify if it is read-only or not. + * + * @return TRUE if it is + */ + public boolean isReady() { + return (this == READ_WRITE || this == READ_ONLY); + } + + /** + * This library can be modified (= you are allowed to modify it). + * + * @return TRUE if it is + */ + public boolean isWritable() { + return (this == READ_WRITE); + } + } + + /** + * Return a name for this library (the UI may display this). + *

+ * Must not be NULL. + * + * @return the name, or an empty {@link String} if none + */ + public String getLibraryName() { + return ""; + } + + /** + * The library status. + * + * @return the current status + */ + public Status getStatus() { + return Status.READ_WRITE; + } + + /** + * Retrieve the main {@link File} corresponding to the given {@link Story}, + * which can be passed to an external reader or instance. + *

+ * Do NOT alter this file. + * + * @param luid + * the Library UID of the story, can be NULL + * @param pg + * the optional {@link Progress} + * + * @return the corresponding {@link Story} + * + * @throws IOException + * in case of IOException + */ + public abstract File getFile(String luid, Progress pg) throws IOException; + + /** + * Return the cover image associated to this story. + * + * @param luid + * the Library UID of the story + * + * @return the cover image + * + * @throws IOException + * in case of IOException + */ + public abstract Image getCover(String luid) throws IOException; + + /** + * Retrieve the list of {@link MetaData} known by this {@link BasicLibrary} + * in a easy-to-filter version. + * + * @param pg + * the optional {@link Progress} + * @return the list of {@link MetaData} as a {@link MetaResultList} you can + * query + * @throws IOException + * in case of I/O eror + */ + public MetaResultList getList(Progress pg) throws IOException { + // TODO: ensure it is the main used interface + + return new MetaResultList(getMetas(pg)); + } + + // TODO: make something for (normal and custom) non-story covers + + /** + * Return the cover image associated to this source. + *

+ * By default, return the custom cover if any, and if not, return the cover + * of the first story with this source. + * + * @param source + * the source + * + * @return the cover image or NULL + * + * @throws IOException + * in case of IOException + */ + public Image getSourceCover(String source) throws IOException { + Image custom = getCustomSourceCover(source); + if (custom != null) { + return custom; + } + + List metas = getList().filter(source, null, null); + if (metas.size() > 0) { + return getCover(metas.get(0).getLuid()); + } + + return null; + } + + /** + * Return the cover image associated to this author. + *

+ * By default, return the custom cover if any, and if not, return the cover + * of the first story with this author. + * + * @param author + * the author + * + * @return the cover image or NULL + * + * @throws IOException + * in case of IOException + */ + public Image getAuthorCover(String author) throws IOException { + Image custom = getCustomAuthorCover(author); + if (custom != null) { + return custom; + } + + List metas = getList().filter(null, author, null); + if (metas.size() > 0) { + return getCover(metas.get(0).getLuid()); + } + + return null; + } + + /** + * Return the custom cover image associated to this source. + *

+ * By default, return NULL. + * + * @param source + * the source to look for + * + * @return the custom cover or NULL if none + * + * @throws IOException + * in case of IOException + */ + @SuppressWarnings("unused") + public Image getCustomSourceCover(String source) throws IOException { + return null; + } + + /** + * Return the custom cover image associated to this author. + *

+ * By default, return NULL. + * + * @param author + * the author to look for + * + * @return the custom cover or NULL if none + * + * @throws IOException + * in case of IOException + */ + @SuppressWarnings("unused") + public Image getCustomAuthorCover(String author) throws IOException { + return null; + } + + /** + * Set the source cover to the given story cover. + * + * @param source + * the source to change + * @param luid + * the story LUID + * + * @throws IOException + * in case of IOException + */ + public abstract void setSourceCover(String source, String luid) + throws IOException; + + /** + * Set the author cover to the given story cover. + * + * @param author + * the author to change + * @param luid + * the story LUID + * + * @throws IOException + * in case of IOException + */ + public abstract void setAuthorCover(String author, String luid) + throws IOException; + + /** + * Return the list of stories (represented by their {@link MetaData}, which + * MAY not have the cover included). + *

+ * The returned list MUST be a copy, not the original one. + * + * @param pg + * the optional {@link Progress} + * + * @return the list (can be empty but not NULL) + * + * @throws IOException + * in case of IOException + */ + protected abstract List getMetas(Progress pg) throws IOException; + + /** + * Invalidate the {@link Story} cache (when the content should be re-read + * because it was changed). + */ + protected void invalidateInfo() { + invalidateInfo(null); + } + + /** + * Invalidate the {@link Story} cache (when the content is removed). + *

+ * All the cache can be deleted if NULL is passed as meta. + * + * @param luid + * the LUID of the {@link Story} to clear from the cache, or NULL + * for all stories + */ + protected abstract void invalidateInfo(String luid); + + /** + * Invalidate the {@link Story} cache (when the content has changed, but we + * already have it) with the new given meta. + * + * @param meta + * the {@link Story} to clear from the cache + * + * @throws IOException + * in case of IOException + */ + protected abstract void updateInfo(MetaData meta) throws IOException; + + /** + * Return the next LUID that can be used. + * + * @return the next luid + */ + protected abstract String getNextId(); + + /** + * Delete the target {@link Story}. + * + * @param luid + * the LUID of the {@link Story} + * + * @throws IOException + * in case of I/O error or if the {@link Story} wa not found + */ + protected abstract void doDelete(String luid) throws IOException; + + /** + * Actually save the story to the back-end. + * + * @param story + * the {@link Story} to save + * @param pg + * the optional {@link Progress} + * + * @return the saved {@link Story} (which may have changed, especially + * regarding the {@link MetaData}) + * + * @throws IOException + * in case of I/O error + */ + protected abstract Story doSave(Story story, Progress pg) + throws IOException; + + /** + * Refresh the {@link BasicLibrary}, that is, make sure all metas are + * loaded. + * + * @param pg + * the optional progress reporter + */ + public void refresh(Progress pg) { + try { + getMetas(pg); + } catch (IOException e) { + // We will let it fail later + } + } + + /** + * Check if the {@link Story} denoted by this Library UID is present in the + * cache (if we have no cache, we default to true). + * + * @param luid + * the Library UID + * + * @return TRUE if it is + */ + public boolean isCached(@SuppressWarnings("unused") String luid) { + // By default, everything is cached + return true; + } + + /** + * Clear the {@link Story} from the cache, if needed. + *

+ * The next time we try to retrieve the {@link Story}, it may be required to + * cache it again. + * + * @param luid + * the story to clear + * + * @throws IOException + * in case of I/O error + */ + @SuppressWarnings("unused") + public void clearFromCache(String luid) throws IOException { + // By default, this is a noop. + } + + /** + * @return the same as getList() + * @throws IOException + * in case of I/O error + * @deprecated please use {@link BasicLibrary#getList()} and + * {@link MetaResultList#getSources()} instead. + */ + @Deprecated + public List getSources() throws IOException { + return getList().getSources(); + } + + /** + * @return the same as getList() + * @throws IOException + * in case of I/O error + * @deprecated please use {@link BasicLibrary#getList()} and + * {@link MetaResultList#getSourcesGrouped()} instead. + */ + @Deprecated + public Map> getSourcesGrouped() throws IOException { + return getList().getSourcesGrouped(); + } + + /** + * @return the same as getList() + * @throws IOException + * in case of I/O error + * @deprecated please use {@link BasicLibrary#getList()} and + * {@link MetaResultList#getAuthors()} instead. + */ + @Deprecated + public List getAuthors() throws IOException { + return getList().getAuthors(); + } + + /** + * @return the same as getList() + * @throws IOException + * in case of I/O error + * @deprecated please use {@link BasicLibrary#getList()} and + * {@link MetaResultList#getAuthorsGrouped()} instead. + */ + @Deprecated + public Map> getAuthorsGrouped() throws IOException { + return getList().getAuthorsGrouped(); + } + + /** + * List all the stories in the {@link BasicLibrary}. + *

+ * Cover images MAYBE not included. + * + * @return the stories + * + * @throws IOException + * in case of IOException + */ + public MetaResultList getList() throws IOException { + return getList(null); + } + + /** + * Retrieve a {@link MetaData} corresponding to the given {@link Story}, + * cover image MAY not be included. + * + * @param luid + * the Library UID of the story, can be NULL + * + * @return the corresponding {@link Story} or NULL if not found + * + * @throws IOException + * in case of IOException + */ + public MetaData getInfo(String luid) throws IOException { + if (luid != null) { + for (MetaData meta : getMetas(null)) { + if (luid.equals(meta.getLuid())) { + return meta; + } + } + } + + return null; + } + + /** + * Retrieve a specific {@link Story}. + *

+ * Note that it will update both the cover and the resume in meta. + * + * @param luid + * the Library UID of the story + * @param pg + * the optional progress reporter + * + * @return the corresponding {@link Story} or NULL if not found + * + * @throws IOException + * in case of IOException + */ + public Story getStory(String luid, Progress pg) throws IOException { + Progress pgMetas = new Progress(); + Progress pgStory = new Progress(); + if (pg != null) { + pg.setMinMax(0, 100); + pg.addProgress(pgMetas, 10); + pg.addProgress(pgStory, 90); + } + + MetaData meta = null; + for (MetaData oneMeta : getMetas(pgMetas)) { + if (oneMeta.getLuid().equals(luid)) { + meta = oneMeta; + break; + } + } + + pgMetas.done(); + + Story story = getStory(luid, meta, pgStory); + pgStory.done(); + + return story; + } + + /** + * Retrieve a specific {@link Story}. + *

+ * Note that it will update both the cover and the resume in meta. + * + * @param luid + * the LUID of the story + * @param meta + * the meta of the story + * @param pg + * the optional progress reporter + * + * @return the corresponding {@link Story} or NULL if not found + * + * @throws IOException + * in case of IOException + */ + public synchronized Story getStory(String luid, MetaData meta, Progress pg) + throws IOException { + + if (pg == null) { + pg = new Progress(); + } + + Progress pgGet = new Progress(); + Progress pgProcess = new Progress(); + + pg.setMinMax(0, 2); + pg.addProgress(pgGet, 1); + pg.addProgress(pgProcess, 1); + + Story story = null; + File file = null; + + if (luid != null && meta != null) { + file = getFile(luid, pgGet); + } + + pgGet.done(); + try { + if (file != null) { + SupportType type = SupportType.valueOfAllOkUC(meta.getType()); + if (type == null) { + throw new IOException("Unknown type: " + meta.getType()); + } + + URL url = file.toURI().toURL(); + story = BasicSupport.getSupport(type, url) // + .process(pgProcess); + + // Because we do not want to clear the meta cache: + meta.setCover(story.getMeta().getCover()); + meta.setResume(story.getMeta().getResume()); + story.setMeta(meta); + } + } catch (IOException e) { + // We should not have not-supported files in the library + Instance.getInstance().getTraceHandler() + .error(new IOException(String.format( + "Cannot load file of type '%s' from library: %s", + meta.getType(), file), e)); + } finally { + pgProcess.done(); + pg.done(); + } + + return story; + } + + /** + * Import the {@link Story} at the given {@link URL} into the + * {@link BasicLibrary}. + * + * @param url + * the {@link URL} to import + * @param pg + * the optional progress reporter + * + * @return the imported Story {@link MetaData} + * + * @throws UnknownHostException + * if the host is not supported + * @throws IOException + * in case of I/O error + */ + public MetaData imprt(URL url, Progress pg) throws IOException { + return imprt(url, null, pg); + } + + /** + * Import the {@link Story} at the given {@link URL} into the + * {@link BasicLibrary}. + * + * @param url + * the {@link URL} to import + * @param luid + * the LUID to use + * @param pg + * the optional progress reporter + * + * @return the imported Story {@link MetaData} + * + * @throws UnknownHostException + * if the host is not supported + * @throws IOException + * in case of I/O error + */ + MetaData imprt(URL url, String luid, Progress pg) throws IOException { + if (pg == null) + pg = new Progress(); + + pg.setMinMax(0, 1000); + Progress pgProcess = new Progress(); + Progress pgSave = new Progress(); + pg.addProgress(pgProcess, 800); + pg.addProgress(pgSave, 200); + + BasicSupport support = BasicSupport.getSupport(url); + if (support == null) { + throw new UnknownHostException("" + url); + } + + Story story = save(support.process(pgProcess), luid, pgSave); + pg.done(); + + return story.getMeta(); + } + + /** + * Import the story from one library to another, and keep the same LUID. + * + * @param other + * the other library to import from + * @param luid + * the Library UID + * @param pg + * the optional progress reporter + * + * @throws IOException + * in case of I/O error + */ + public void imprt(BasicLibrary other, String luid, Progress pg) + throws IOException { + Progress pgGetStory = new Progress(); + Progress pgSave = new Progress(); + if (pg == null) { + pg = new Progress(); + } + + pg.setMinMax(0, 2); + pg.addProgress(pgGetStory, 1); + pg.addProgress(pgSave, 1); + + Story story = other.getStory(luid, pgGetStory); + if (story != null) { + story = this.save(story, luid, pgSave); + pg.done(); + } else { + pg.done(); + throw new IOException("Cannot find story in Library: " + luid); + } + } + + /** + * Export the {@link Story} to the given target in the given format. + * + * @param luid + * the {@link Story} ID + * @param type + * the {@link OutputType} to transform it to + * @param target + * the target to save to + * @param pg + * the optional progress reporter + * + * @return the saved resource (the main saved {@link File}) + * + * @throws IOException + * in case of I/O error + */ + public File export(String luid, OutputType type, String target, Progress pg) + throws IOException { + Progress pgGetStory = new Progress(); + Progress pgOut = new Progress(); + if (pg != null) { + pg.setMax(2); + pg.addProgress(pgGetStory, 1); + pg.addProgress(pgOut, 1); + } + + BasicOutput out = BasicOutput.getOutput(type, false, false); + if (out == null) { + throw new IOException("Output type not supported: " + type); + } + + Story story = getStory(luid, pgGetStory); + if (story == null) { + throw new IOException("Cannot find story to export: " + luid); + } + + return out.process(story, target, pgOut); + } + + /** + * Save a {@link Story} to the {@link BasicLibrary}. + * + * @param story + * the {@link Story} to save + * @param pg + * the optional progress reporter + * + * @return the same {@link Story}, whose LUID may have changed + * + * @throws IOException + * in case of I/O error + */ + public Story save(Story story, Progress pg) throws IOException { + return save(story, null, pg); + } + + /** + * Save a {@link Story} to the {@link BasicLibrary} -- the LUID must + * be correct, or NULL to get the next free one. + *

+ * Will override any previous {@link Story} with the same LUID. + * + * @param story + * the {@link Story} to save + * @param luid + * the correct LUID or NULL to get the next free one + * @param pg + * the optional progress reporter + * + * @return the same {@link Story}, whose LUID may have changed + * + * @throws IOException + * in case of I/O error + */ + public synchronized Story save(Story story, String luid, Progress pg) + throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Instance.getInstance().getTraceHandler().trace( + this.getClass().getSimpleName() + ": saving story " + luid); + + // Do not change the original metadata, but change the original story + MetaData meta = story.getMeta().clone(); + story.setMeta(meta); + + pg.setName("Saving story"); + + if (luid == null || luid.isEmpty()) { + meta.setLuid(getNextId()); + } else { + meta.setLuid(luid); + } + + if (luid != null && getInfo(luid) != null) { + delete(luid); + } + + story = doSave(story, pg); + + updateInfo(story.getMeta()); + + Instance.getInstance().getTraceHandler() + .trace(this.getClass().getSimpleName() + ": story saved (" + + luid + ")"); + + pg.setName(meta.getTitle()); + pg.done(); + return story; + } + + /** + * Delete the given {@link Story} from this {@link BasicLibrary}. + * + * @param luid + * the LUID of the target {@link Story} + * + * @throws IOException + * in case of I/O error + */ + public synchronized void delete(String luid) throws IOException { + Instance.getInstance().getTraceHandler().trace( + this.getClass().getSimpleName() + ": deleting story " + luid); + + doDelete(luid); + invalidateInfo(luid); + + Instance.getInstance().getTraceHandler() + .trace(this.getClass().getSimpleName() + ": story deleted (" + + luid + ")"); + } + + /** + * Change the type (source) of the given {@link Story}. + * + * @param luid + * the {@link Story} LUID + * @param newSource + * the new source + * @param pg + * the optional progress reporter + * + * @throws IOException + * in case of I/O error or if the {@link Story} was not found + */ + public synchronized void changeSource(String luid, String newSource, + Progress pg) throws IOException { + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + changeSTA(luid, newSource, meta.getTitle(), meta.getAuthor(), pg); + } + + /** + * Change the title (name) of the given {@link Story}. + * + * @param luid + * the {@link Story} LUID + * @param newTitle + * the new title + * @param pg + * the optional progress reporter + * + * @throws IOException + * in case of I/O error or if the {@link Story} was not found + */ + public synchronized void changeTitle(String luid, String newTitle, + Progress pg) throws IOException { + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + changeSTA(luid, meta.getSource(), newTitle, meta.getAuthor(), pg); + } + + /** + * Change the author of the given {@link Story}. + * + * @param luid + * the {@link Story} LUID + * @param newAuthor + * the new author + * @param pg + * the optional progress reporter + * + * @throws IOException + * in case of I/O error or if the {@link Story} was not found + */ + public synchronized void changeAuthor(String luid, String newAuthor, + Progress pg) throws IOException { + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + changeSTA(luid, meta.getSource(), meta.getTitle(), newAuthor, pg); + } + + /** + * Change the Source, Title and Author of the {@link Story} in one single + * go. + * + * @param luid + * the {@link Story} LUID + * @param newSource + * the new source + * @param newTitle + * the new title + * @param newAuthor + * the new author + * @param pg + * the optional progress reporter + * + * @throws IOException + * in case of I/O error or if the {@link Story} was not found + */ + protected synchronized void changeSTA(String luid, String newSource, + String newTitle, String newAuthor, Progress pg) throws IOException { + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + meta.setSource(newSource); + meta.setTitle(newTitle); + meta.setAuthor(newAuthor); + saveMeta(meta, pg); + } + + /** + * Save back the current state of the {@link MetaData} (LUID MUST NOT + * change) for this {@link Story}. + *

+ * By default, delete the old {@link Story} then recreate a new + * {@link Story}. + *

+ * Note that this behaviour can lead to data loss in case of problems! + * + * @param meta + * the new {@link MetaData} (LUID MUST NOT change) + * @param pg + * the optional {@link Progress} + * + * @throws IOException + * in case of I/O error or if the {@link Story} was not found + */ + protected synchronized void saveMeta(MetaData meta, Progress pg) + throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Progress pgGet = new Progress(); + Progress pgSet = new Progress(); + pg.addProgress(pgGet, 50); + pg.addProgress(pgSet, 50); + + Story story = getStory(meta.getLuid(), pgGet); + if (story == null) { + throw new IOException("Story not found: " + meta.getLuid()); + } + + // TODO: this is not safe! + delete(meta.getLuid()); + story.setMeta(meta); + save(story, meta.getLuid(), pgSet); + + pg.done(); + } + + /** + * Describe a {@link Story} from its {@link MetaData} and return a list of + * title/value that represent this {@link Story}. + * + * @param meta + * the {@link MetaData} to represent + * + * @return the information, translated and sorted + */ + static public Map getMetaDesc(MetaData meta) { + Map metaDesc = new LinkedHashMap(); + + // TODO: i18n + + StringBuilder tags = new StringBuilder(); + for (String tag : meta.getTags()) { + if (tags.length() > 0) { + tags.append(", "); + } + tags.append(tag); + } + + // TODO: i18n + metaDesc.put("Author", meta.getAuthor()); + metaDesc.put("Published on", meta.getPublisher()); + metaDesc.put("Publication date", meta.getDate()); + metaDesc.put("Creation date", meta.getCreationDate()); + String count = ""; + if (meta.getWords() > 0) { + count = StringUtils.formatNumber(meta.getWords()); + } + if (meta.isImageDocument()) { + metaDesc.put("Number of images", count); + } else { + metaDesc.put("Number of words", count); + } + metaDesc.put("Source", meta.getSource()); + metaDesc.put("Subject", meta.getSubject()); + metaDesc.put("Language", meta.getLang()); + metaDesc.put("Tags", tags.toString()); + metaDesc.put("URL", meta.getUrl()); + + return metaDesc; + } +} diff --git a/src/be/nikiroo/fanfix/library/CacheLibrary.java b/src/be/nikiroo/fanfix/library/CacheLibrary.java new file mode 100644 index 0000000..e184c1b --- /dev/null +++ b/src/be/nikiroo/fanfix/library/CacheLibrary.java @@ -0,0 +1,435 @@ +package be.nikiroo.fanfix.library; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.util.ArrayList; +import java.util.List; +import java.util.TreeSet; + +import be.nikiroo.fanfix.Instance; +import be.nikiroo.fanfix.bundles.UiConfig; +import be.nikiroo.fanfix.bundles.UiConfigBundle; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.fanfix.output.BasicOutput.OutputType; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.Progress; + +/** + * This library will cache another pre-existing {@link BasicLibrary}. + * + * @author niki + */ +public class CacheLibrary extends BasicLibrary { + private List metasReal; + private List metasMixed; + private Object metasLock = new Object(); + + private BasicLibrary lib; + private LocalLibrary cacheLib; + + /** + * Create a cache library around the given one. + *

+ * It will return the same result, but those will be saved to disk at the + * same time to be fetched quicker the next time. + * + * @param cacheDir + * the cache directory where to save the files to disk + * @param lib + * the original library to wrap + * @param config + * the configuration used to know which kind of default + * {@link OutputType} to use for images and non-images stories + */ + public CacheLibrary(File cacheDir, BasicLibrary lib, + UiConfigBundle config) { + this.cacheLib = new LocalLibrary(cacheDir, // + config.getString(UiConfig.GUI_NON_IMAGES_DOCUMENT_TYPE), + config.getString(UiConfig.GUI_IMAGES_DOCUMENT_TYPE), true); + this.lib = lib; + } + + @Override + public String getLibraryName() { + return lib.getLibraryName(); + } + + @Override + public Status getStatus() { + return lib.getStatus(); + } + + @Override + protected List getMetas(Progress pg) throws IOException { + if (pg == null) { + pg = new Progress(); + } + + List copy; + synchronized (metasLock) { + // We make sure that cached metas have precedence + if (metasMixed == null) { + if (metasReal == null) { + metasReal = lib.getMetas(pg); + } + + metasMixed = new ArrayList(); + TreeSet cachedLuids = new TreeSet(); + for (MetaData cachedMeta : cacheLib.getMetas(null)) { + metasMixed.add(cachedMeta); + cachedLuids.add(cachedMeta.getLuid()); + } + for (MetaData realMeta : metasReal) { + if (!cachedLuids.contains(realMeta.getLuid())) { + metasMixed.add(realMeta); + } + } + } + + copy = new ArrayList(metasMixed); + } + + pg.done(); + return copy; + } + + @Override + public synchronized Story getStory(String luid, MetaData meta, Progress pg) + throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Progress pgImport = new Progress(); + Progress pgGet = new Progress(); + + pg.setMinMax(0, 4); + pg.addProgress(pgImport, 3); + pg.addProgress(pgGet, 1); + + if (!isCached(luid)) { + try { + cacheLib.imprt(lib, luid, pgImport); + updateMetaCache(metasMixed, cacheLib.getInfo(luid)); + pgImport.done(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + + pgImport.done(); + pgGet.done(); + } + + String type = cacheLib.getOutputType(meta.isImageDocument()); + MetaData cachedMeta = meta.clone(); + cachedMeta.setType(type); + + return cacheLib.getStory(luid, cachedMeta, pg); + } + + @Override + public synchronized File getFile(final String luid, Progress pg) + throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Progress pgGet = new Progress(); + Progress pgRecall = new Progress(); + + pg.setMinMax(0, 5); + pg.addProgress(pgGet, 4); + pg.addProgress(pgRecall, 1); + + if (!isCached(luid)) { + getStory(luid, pgGet); + pgGet.done(); + } + + File file = cacheLib.getFile(luid, pgRecall); + pgRecall.done(); + + pg.done(); + return file; + } + + @Override + public Image getCover(final String luid) throws IOException { + if (isCached(luid)) { + return cacheLib.getCover(luid); + } + + // We could update the cache here, but it's not easy + return lib.getCover(luid); + } + + @Override + public Image getSourceCover(String source) throws IOException { + Image custom = getCustomSourceCover(source); + if (custom != null) { + return custom; + } + + Image cached = cacheLib.getSourceCover(source); + if (cached != null) { + return cached; + } + + return lib.getSourceCover(source); + } + + @Override + public Image getAuthorCover(String author) throws IOException { + Image custom = getCustomAuthorCover(author); + if (custom != null) { + return custom; + } + + Image cached = cacheLib.getAuthorCover(author); + if (cached != null) { + return cached; + } + + return lib.getAuthorCover(author); + } + + @Override + public Image getCustomSourceCover(String source) throws IOException { + Image custom = cacheLib.getCustomSourceCover(source); + if (custom == null) { + custom = lib.getCustomSourceCover(source); + if (custom != null) { + cacheLib.setSourceCover(source, custom); + } + } + + return custom; + } + + @Override + public Image getCustomAuthorCover(String author) throws IOException { + Image custom = cacheLib.getCustomAuthorCover(author); + if (custom == null) { + custom = lib.getCustomAuthorCover(author); + if (custom != null) { + cacheLib.setAuthorCover(author, custom); + } + } + + return custom; + } + + @Override + public void setSourceCover(String source, String luid) throws IOException { + lib.setSourceCover(source, luid); + cacheLib.setSourceCover(source, getCover(luid)); + } + + @Override + public void setAuthorCover(String author, String luid) throws IOException { + lib.setAuthorCover(author, luid); + cacheLib.setAuthorCover(author, getCover(luid)); + } + + /** + * Invalidate the {@link Story} cache (when the content has changed, but we + * already have it) with the new given meta. + *

+ * Make sure to always use {@link MetaData} from the cached library in + * priority, here. + * + * @param meta + * the {@link Story} to clear from the cache + * + * @throws IOException + * in case of IOException + */ + @Override + @Deprecated + protected void updateInfo(MetaData meta) throws IOException { + throw new IOException( + "This method is not supported in a CacheLibrary, please use updateMetaCache"); + } + + // relplace the meta in Metas by Meta, add it if needed + // return TRUE = added + private boolean updateMetaCache(List metas, MetaData meta) { + if (meta != null && metas != null) { + synchronized (metasLock) { + boolean changed = false; + for (int i = 0; i < metas.size(); i++) { + if (metas.get(i).getLuid().equals(meta.getLuid())) { + metas.set(i, meta); + changed = true; + } + } + + if (!changed) { + metas.add(meta); + return true; + } + } + } + + return false; + } + + @Override + protected void invalidateInfo(String luid) { + if (luid == null) { + synchronized (metasLock) { + metasReal = null; + metasMixed = null; + } + } else { + invalidateInfo(metasReal, luid); + invalidateInfo(metasMixed, luid); + } + + cacheLib.invalidateInfo(luid); + lib.invalidateInfo(luid); + } + + // luid cannot be null + private void invalidateInfo(List metas, String luid) { + if (metas != null) { + synchronized (metasLock) { + for (int i = 0; i < metas.size(); i++) { + if (metas.get(i).getLuid().equals(luid)) { + metas.remove(i--); + } + } + } + } + } + + @Override + public synchronized Story save(Story story, String luid, Progress pg) + throws IOException { + Progress pgLib = new Progress(); + Progress pgCacheLib = new Progress(); + + if (pg == null) { + pg = new Progress(); + } + + pg.setMinMax(0, 2); + pg.addProgress(pgLib, 1); + pg.addProgress(pgCacheLib, 1); + + story = lib.save(story, luid, pgLib); + updateMetaCache(metasReal, story.getMeta()); + + story = cacheLib.save(story, story.getMeta().getLuid(), pgCacheLib); + updateMetaCache(metasMixed, story.getMeta()); + + return story; + } + + @Override + public synchronized void delete(String luid) throws IOException { + if (isCached(luid)) { + cacheLib.delete(luid); + } + lib.delete(luid); + + invalidateInfo(luid); + } + + @Override + protected synchronized void changeSTA(String luid, String newSource, + String newTitle, String newAuthor, Progress pg) throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Progress pgCache = new Progress(); + Progress pgOrig = new Progress(); + pg.setMinMax(0, 2); + pg.addProgress(pgCache, 1); + pg.addProgress(pgOrig, 1); + + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + if (isCached(luid)) { + cacheLib.changeSTA(luid, newSource, newTitle, newAuthor, pgCache); + } + pgCache.done(); + + lib.changeSTA(luid, newSource, newTitle, newAuthor, pgOrig); + pgOrig.done(); + + meta.setSource(newSource); + meta.setTitle(newTitle); + meta.setAuthor(newAuthor); + pg.done(); + + if (isCached(luid)) { + updateMetaCache(metasMixed, meta); + updateMetaCache(metasReal, lib.getInfo(luid)); + } else { + updateMetaCache(metasReal, meta); + } + } + + @Override + public boolean isCached(String luid) { + try { + return cacheLib.getInfo(luid) != null; + } catch (IOException e) { + return false; + } + } + + @Override + public void clearFromCache(String luid) throws IOException { + if (isCached(luid)) { + cacheLib.delete(luid); + } + } + + @Override + public MetaData imprt(URL url, Progress pg) throws IOException { + if (pg == null) { + pg = new Progress(); + } + + Progress pgImprt = new Progress(); + Progress pgCache = new Progress(); + pg.setMinMax(0, 10); + pg.addProgress(pgImprt, 7); + pg.addProgress(pgCache, 3); + + MetaData meta = lib.imprt(url, pgImprt); + updateMetaCache(metasReal, meta); + metasMixed = null; + + clearFromCache(meta.getLuid()); + + pg.done(); + return meta; + } + + // All the following methods are only used by Save and Delete in + // BasicLibrary: + + @Override + protected String getNextId() { + throw new java.lang.InternalError("Should not have been called"); + } + + @Override + protected void doDelete(String luid) throws IOException { + throw new java.lang.InternalError("Should not have been called"); + } + + @Override + protected Story doSave(Story story, Progress pg) throws IOException { + throw new java.lang.InternalError("Should not have been called"); + } +} diff --git a/src/be/nikiroo/fanfix/library/LocalLibrary.java b/src/be/nikiroo/fanfix/library/LocalLibrary.java new file mode 100644 index 0000000..25f2ec9 --- /dev/null +++ b/src/be/nikiroo/fanfix/library/LocalLibrary.java @@ -0,0 +1,778 @@ +package be.nikiroo.fanfix.library; + +import java.io.File; +import java.io.FileFilter; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.IOException; +import java.io.InputStream; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import be.nikiroo.fanfix.Instance; +import be.nikiroo.fanfix.bundles.Config; +import be.nikiroo.fanfix.bundles.ConfigBundle; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.fanfix.output.BasicOutput; +import be.nikiroo.fanfix.output.BasicOutput.OutputType; +import be.nikiroo.fanfix.output.InfoCover; +import be.nikiroo.fanfix.supported.InfoReader; +import be.nikiroo.utils.HashUtils; +import be.nikiroo.utils.IOUtils; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.Progress; + +/** + * This {@link BasicLibrary} will store the stories locally on disk. + * + * @author niki + */ +public class LocalLibrary extends BasicLibrary { + private int lastId; + private Object lock = new Object(); + private Map stories; // Files: [ infoFile, TargetFile ] + private Map sourceCovers; + private Map authorCovers; + + private File baseDir; + private OutputType text; + private OutputType image; + + /** + * Create a new {@link LocalLibrary} with the given back-end directory. + * + * @param baseDir + * the directory where to find the {@link Story} objects + * @param config + * the configuration used to know which kind of default + * {@link OutputType} to use for images and non-images stories + */ + public LocalLibrary(File baseDir, ConfigBundle config) { + this(baseDir, // + config.getString(Config.FILE_FORMAT_NON_IMAGES_DOCUMENT_TYPE), + config.getString(Config.FILE_FORMAT_IMAGES_DOCUMENT_TYPE), + false); + } + + /** + * Create a new {@link LocalLibrary} with the given back-end directory. + * + * @param baseDir + * the directory where to find the {@link Story} objects + * @param text + * the {@link OutputType} to use for non-image documents + * @param image + * the {@link OutputType} to use for image documents + * @param defaultIsHtml + * if the given text or image is invalid, use HTML by default (if + * not, it will be INFO_TEXT/CBZ by default) + */ + public LocalLibrary(File baseDir, String text, String image, + boolean defaultIsHtml) { + this(baseDir, + OutputType.valueOfAllOkUC(text, + defaultIsHtml ? OutputType.HTML : OutputType.INFO_TEXT), + OutputType.valueOfAllOkUC(image, + defaultIsHtml ? OutputType.HTML : OutputType.CBZ)); + } + + /** + * Create a new {@link LocalLibrary} with the given back-end directory. + * + * @param baseDir + * the directory where to find the {@link Story} objects + * @param text + * the {@link OutputType} to use for non-image documents + * @param image + * the {@link OutputType} to use for image documents + */ + public LocalLibrary(File baseDir, OutputType text, OutputType image) { + this.baseDir = baseDir; + this.text = text; + this.image = image; + + this.lastId = 0; + this.stories = null; + this.sourceCovers = null; + + baseDir.mkdirs(); + } + + @Override + protected List getMetas(Progress pg) { + return new ArrayList(getStories(pg).keySet()); + } + + @Override + public File getFile(String luid, Progress pg) throws IOException { + Instance.getInstance().getTraceHandler().trace( + this.getClass().getSimpleName() + ": get file for " + luid); + + File file = null; + String mess = "no file found for "; + + MetaData meta = getInfo(luid); + if (meta != null) { + File[] files = getStories(pg).get(meta); + if (files != null) { + mess = "file retrieved for "; + file = files[1]; + } + } + + Instance.getInstance().getTraceHandler() + .trace(this.getClass().getSimpleName() + ": " + mess + luid + + " (" + meta.getTitle() + ")"); + + return file; + } + + @Override + public Image getCover(String luid) throws IOException { + MetaData meta = getInfo(luid); + if (meta != null) { + if (meta.getCover() != null) { + return meta.getCover(); + } + + File[] files = getStories(null).get(meta); + if (files != null) { + File infoFile = files[0]; + + try { + meta = InfoReader.readMeta(infoFile, true); + return meta.getCover(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + } + } + + return null; + } + + @Override + protected void updateInfo(MetaData meta) { + invalidateInfo(); + } + + @Override + protected void invalidateInfo(String luid) { + synchronized (lock) { + stories = null; + sourceCovers = null; + } + } + + @Override + protected String getNextId() { + getStories(null); // make sure lastId is set + + synchronized (lock) { + return String.format("%03d", ++lastId); + } + } + + @Override + protected void doDelete(String luid) throws IOException { + for (File file : getRelatedFiles(luid)) { + // TODO: throw an IOException if we cannot delete the files? + IOUtils.deltree(file); + file.getParentFile().delete(); + } + } + + @Override + protected Story doSave(Story story, Progress pg) throws IOException { + MetaData meta = story.getMeta(); + + File expectedTarget = getExpectedFile(meta); + expectedTarget.getParentFile().mkdirs(); + + BasicOutput it = BasicOutput.getOutput(getOutputType(meta), true, true); + it.process(story, expectedTarget.getPath(), pg); + + return story; + } + + @Override + protected synchronized void saveMeta(MetaData meta, Progress pg) + throws IOException { + File newDir = getExpectedDir(meta.getSource()); + if (!newDir.exists()) { + newDir.mkdirs(); + } + + List relatedFiles = getRelatedFiles(meta.getLuid()); + for (File relatedFile : relatedFiles) { + // TODO: this is not safe at all. + // We should copy all the files THEN delete them + // Maybe also adding some rollback cleanup if possible + if (relatedFile.getName().endsWith(".info")) { + try { + String name = relatedFile.getName().replaceFirst("\\.info$", + ""); + relatedFile.delete(); + InfoCover.writeInfo(newDir, name, meta); + relatedFile.getParentFile().delete(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + } else { + relatedFile.renameTo(new File(newDir, relatedFile.getName())); + relatedFile.getParentFile().delete(); + } + } + + updateInfo(meta); + } + + @Override + public Image getCustomSourceCover(String source) { + synchronized (lock) { + if (sourceCovers == null) { + sourceCovers = new HashMap(); + } + } + + synchronized (lock) { + Image img = sourceCovers.get(source); + if (img != null) { + return img; + } + } + + File coverDir = getExpectedDir(source); + if (coverDir.isDirectory()) { + File cover = new File(coverDir, ".cover.png"); + if (cover.exists()) { + InputStream in; + try { + in = new FileInputStream(cover); + try { + synchronized (lock) { + Image img = new Image(in); + if (img.getSize() == 0) { + img.close(); + throw new IOException( + "Empty image not accepted"); + } + sourceCovers.put(source, img); + } + } finally { + in.close(); + } + } catch (FileNotFoundException e) { + e.printStackTrace(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException( + "Cannot load the existing custom source cover: " + + cover, + e)); + } + } + } + + synchronized (lock) { + return sourceCovers.get(source); + } + } + + @Override + public Image getCustomAuthorCover(String author) { + synchronized (lock) { + if (authorCovers == null) { + authorCovers = new HashMap(); + } + } + + synchronized (lock) { + Image img = authorCovers.get(author); + if (img != null) { + return img; + } + } + + File cover = getAuthorCoverFile(author); + if (cover.exists()) { + InputStream in; + try { + in = new FileInputStream(cover); + try { + synchronized (lock) { + Image img = new Image(in); + if (img.getSize() == 0) { + img.close(); + throw new IOException( + "Empty image not accepted"); + } + authorCovers.put(author, img); + } + } finally { + in.close(); + } + } catch (FileNotFoundException e) { + e.printStackTrace(); + } catch (IOException e) { + Instance.getInstance().getTraceHandler() + .error(new IOException( + "Cannot load the existing custom author cover: " + + cover, + e)); + } + } + + synchronized (lock) { + return authorCovers.get(author); + } + } + + @Override + public void setSourceCover(String source, String luid) throws IOException { + setSourceCover(source, getCover(luid)); + } + + @Override + public void setAuthorCover(String author, String luid) throws IOException { + setAuthorCover(author, getCover(luid)); + } + + /** + * Set the source cover to the given story cover. + * + * @param source + * the source to change + * @param coverImage + * the cover image + */ + void setSourceCover(String source, Image coverImage) { + File dir = getExpectedDir(source); + dir.mkdirs(); + File cover = new File(dir, ".cover"); + try { + Instance.getInstance().getCache().saveAsImage(coverImage, cover, + true); + synchronized (lock) { + if (sourceCovers != null) { + sourceCovers.put(source, coverImage); + } + } + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + } + + /** + * Set the author cover to the given story cover. + * + * @param author + * the author to change + * @param coverImage + * the cover image + */ + void setAuthorCover(String author, Image coverImage) { + File cover = getAuthorCoverFile(author); + cover.getParentFile().mkdirs(); + try { + Instance.getInstance().getCache().saveAsImage(coverImage, cover, + true); + synchronized (lock) { + if (authorCovers != null) { + authorCovers.put(author, coverImage); + } + } + } catch (IOException e) { + Instance.getInstance().getTraceHandler().error(e); + } + } + + @Override + public void imprt(BasicLibrary other, String luid, Progress pg) + throws IOException { + if (pg == null) { + pg = new Progress(); + } + + // Check if we can simply copy the files instead of the whole process + if (other instanceof LocalLibrary) { + LocalLibrary otherLocalLibrary = (LocalLibrary) other; + + MetaData meta = otherLocalLibrary.getInfo(luid); + String expectedType = "" + + (meta != null && meta.isImageDocument() ? image : text); + if (meta != null && meta.getType().equals(expectedType)) { + File from = otherLocalLibrary.getExpectedDir(meta.getSource()); + File to = this.getExpectedDir(meta.getSource()); + List relatedFiles = otherLocalLibrary + .getRelatedFiles(luid); + if (!relatedFiles.isEmpty()) { + pg.setMinMax(0, relatedFiles.size()); + } + + for (File relatedFile : relatedFiles) { + File target = new File(relatedFile.getAbsolutePath() + .replace(from.getAbsolutePath(), + to.getAbsolutePath())); + if (!relatedFile.equals(target)) { + target.getParentFile().mkdirs(); + InputStream in = null; + try { + in = new FileInputStream(relatedFile); + IOUtils.write(in, target); + } catch (IOException e) { + if (in != null) { + try { + in.close(); + } catch (Exception ee) { + } + } + + pg.done(); + throw e; + } + } + + pg.add(1); + } + + invalidateInfo(); + pg.done(); + return; + } + } + + super.imprt(other, luid, pg); + } + + /** + * Return the {@link OutputType} for this {@link Story}. + * + * @param meta + * the {@link Story} {@link MetaData} + * + * @return the type + */ + private OutputType getOutputType(MetaData meta) { + if (meta != null && meta.isImageDocument()) { + return image; + } + + return text; + } + + /** + * Return the default {@link OutputType} for this kind of {@link Story}. + * + * @param imageDocument + * TRUE for images document, FALSE for text documents + * + * @return the type + */ + public String getOutputType(boolean imageDocument) { + if (imageDocument) { + return image.toString(); + } + + return text.toString(); + } + + /** + * Get the target {@link File} related to the given .info + * {@link File} and {@link MetaData}. + * + * @param meta + * the meta + * @param infoFile + * the .info {@link File} + * + * @return the target {@link File} + */ + private File getTargetFile(MetaData meta, File infoFile) { + // Replace .info with whatever is needed: + String path = infoFile.getPath(); + path = path.substring(0, path.length() - ".info".length()); + String newExt = getOutputType(meta).getDefaultExtension(true); + + return new File(path + newExt); + } + + /** + * The target (full path) where the {@link Story} related to this + * {@link MetaData} should be located on disk for a new {@link Story}. + * + * @param key + * the {@link Story} {@link MetaData} + * + * @return the target + */ + private File getExpectedFile(MetaData key) { + String title = key.getTitle(); + if (title == null) { + title = ""; + } + title = title.replaceAll("[^a-zA-Z0-9._+-]", "_"); + if (title.length() > 40) { + title = title.substring(0, 40); + } + return new File(getExpectedDir(key.getSource()), + key.getLuid() + "_" + title); + } + + /** + * The directory (full path) where the new {@link Story} related to this + * {@link MetaData} should be located on disk. + * + * @param source + * the type (source) + * + * @return the target directory + */ + private File getExpectedDir(String source) { + String sanitizedSource = source.replaceAll("[^a-zA-Z0-9._+/-]", "_"); + + while (sanitizedSource.startsWith("/") + || sanitizedSource.startsWith("_")) { + if (sanitizedSource.length() > 1) { + sanitizedSource = sanitizedSource.substring(1); + } else { + sanitizedSource = ""; + } + } + + sanitizedSource = sanitizedSource.replace("/", File.separator); + + if (sanitizedSource.isEmpty()) { + sanitizedSource = "_EMPTY"; + } + + return new File(baseDir, sanitizedSource); + } + + /** + * Return the full path to the file to use for the custom cover of this + * author. + *

+ * One or more of the parent directories MAY not exist. + * + * @param author + * the author + * + * @return the custom cover file + */ + private File getAuthorCoverFile(String author) { + File aDir = new File(baseDir, "_AUTHORS"); + String hash = HashUtils.md5(author); + String ext = Instance.getInstance().getConfig() + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER); + return new File(aDir, hash + "." + ext.toLowerCase()); + } + + /** + * Return the list of files/directories on disk for this {@link Story}. + *

+ * If the {@link Story} is not found, and empty list is returned. + * + * @param luid + * the {@link Story} LUID + * + * @return the list of {@link File}s + * + * @throws IOException + * if the {@link Story} was not found + */ + private List getRelatedFiles(String luid) throws IOException { + List files = new ArrayList(); + + MetaData meta = getInfo(luid); + if (meta == null) { + throw new IOException("Story not found: " + luid); + } + + File infoFile = getStories(null).get(meta)[0]; + File targetFile = getStories(null).get(meta)[1]; + + files.add(infoFile); + files.add(targetFile); + + String readerExt = getOutputType(meta).getDefaultExtension(true); + String fileExt = getOutputType(meta).getDefaultExtension(false); + + String path = targetFile.getAbsolutePath(); + if (readerExt != null && !readerExt.equals(fileExt)) { + path = path.substring(0, path.length() - readerExt.length()) + + fileExt; + File relatedFile = new File(path); + + if (relatedFile.exists()) { + files.add(relatedFile); + } + } + + String coverExt = "." + Instance.getInstance().getConfig() + .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase(); + File coverFile = new File(path + coverExt); + if (!coverFile.exists()) { + coverFile = new File( + path.substring(0, path.length() - fileExt.length()) + + coverExt); + } + + if (coverFile.exists()) { + files.add(coverFile); + } + + String summaryExt = ".summary"; + File summaryFile = new File(path + summaryExt); + if (!summaryFile.exists()) { + summaryFile = new File( + path.substring(0, path.length() - fileExt.length()) + + summaryExt); + } + + if (summaryFile.exists()) { + files.add(summaryFile); + } + + return files; + } + + /** + * Fill the list of stories by reading the content of the local directory + * {@link LocalLibrary#baseDir}. + *

+ * Will use a cached list when possible (see + * {@link BasicLibrary#invalidateInfo()}). + * + * @param pg + * the optional {@link Progress} + * + * @return the list of stories (for each item, the first {@link File} is the + * info file, the second file is the target {@link File}) + */ + private Map getStories(Progress pg) { + if (pg == null) { + pg = new Progress(); + } else { + pg.setMinMax(0, 100); + } + + Map stories = this.stories; + if (stories == null) { + stories = getStoriesDo(pg); + synchronized (lock) { + if (this.stories == null) + this.stories = stories; + else + stories = this.stories; + } + } + + pg.done(); + return stories; + + } + + /** + * Actually do the work of {@link LocalLibrary#getStories(Progress)} (i.e., + * do not retrieve the cache). + * + * @param pg + * the optional {@link Progress} + * + * @return the list of stories (for each item, the first {@link File} is the + * info file, the second file is the target {@link File}) + */ + private synchronized Map getStoriesDo(Progress pg) { + if (pg == null) { + pg = new Progress(); + } else { + pg.setMinMax(0, 100); + } + + Map stories = new HashMap(); + + File[] dirs = baseDir.listFiles(new FileFilter() { + @Override + public boolean accept(File file) { + return file != null && file.isDirectory(); + } + }); + + if (dirs != null) { + Progress pgDirs = new Progress(0, 100 * dirs.length); + pg.addProgress(pgDirs, 100); + + for (File dir : dirs) { + Progress pgFiles = new Progress(); + pgDirs.addProgress(pgFiles, 100); + pgDirs.setName("Loading from: " + dir.getName()); + + addToStories(stories, pgFiles, dir); + + pgFiles.setName(null); + } + + pgDirs.setName("Loading directories"); + } + + pg.done(); + + return stories; + } + + private void addToStories(Map stories, Progress pgFiles, + File dir) { + File[] infoFilesAndSubdirs = dir.listFiles(new FileFilter() { + @Override + public boolean accept(File file) { + boolean info = file != null && file.isFile() + && file.getPath().toLowerCase().endsWith(".info"); + boolean dir = file != null && file.isDirectory(); + boolean isExpandedHtml = new File(file, "index.html").isFile(); + return info || (dir && !isExpandedHtml); + } + }); + + if (pgFiles != null) { + pgFiles.setMinMax(0, infoFilesAndSubdirs.length); + } + + for (File infoFileOrSubdir : infoFilesAndSubdirs) { + if (infoFileOrSubdir.isDirectory()) { + addToStories(stories, null, infoFileOrSubdir); + } else { + try { + MetaData meta = InfoReader.readMeta(infoFileOrSubdir, + false); + try { + int id = Integer.parseInt(meta.getLuid()); + if (id > lastId) { + lastId = id; + } + + stories.put(meta, new File[] { infoFileOrSubdir, + getTargetFile(meta, infoFileOrSubdir) }); + } catch (Exception e) { + // not normal!! + throw new IOException("Cannot understand the LUID of " + + infoFileOrSubdir + ": " + meta.getLuid(), e); + } + } catch (IOException e) { + // We should not have not-supported files in the + // library + Instance.getInstance().getTraceHandler().error( + new IOException("Cannot load file from library: " + + infoFileOrSubdir, e)); + } + } + + if (pgFiles != null) { + pgFiles.add(1); + } + } + } +} diff --git a/src/be/nikiroo/fanfix/library/MetaResultList.java b/src/be/nikiroo/fanfix/library/MetaResultList.java new file mode 100644 index 0000000..8b8a167 --- /dev/null +++ b/src/be/nikiroo/fanfix/library/MetaResultList.java @@ -0,0 +1,419 @@ +package be.nikiroo.fanfix.library; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.Comparator; +import java.util.List; +import java.util.Map; +import java.util.TreeMap; + +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.utils.StringUtils; + +public class MetaResultList { + /** Max number of items before splitting in [A-B] etc. for eligible items */ + static private final int MAX = 20; + + private List metas; + + // Lazy lists: + // TODO: sync-protect them? + private List sources; + private List authors; + private List tags; + + // can be null (will consider it empty) + public MetaResultList(List metas) { + if (metas == null) { + metas = new ArrayList(); + } + + Collections.sort(metas); + this.metas = metas; + } + + // not NULL + // sorted + public List getMetas() { + return metas; + } + + public List getSources() { + if (sources == null) { + sources = new ArrayList(); + for (MetaData meta : metas) { + if (!sources.contains(meta.getSource())) + sources.add(meta.getSource()); + } + sort(sources); + } + + return sources; + } + + // A -> (A), A/ -> (A, A/*) if we can find something for "*" + public List getSources(String source) { + List linked = new ArrayList(); + if (source != null && !source.isEmpty()) { + if (!source.endsWith("/")) { + linked.add(source); + } else { + linked.add(source.substring(0, source.length() - 1)); + for (String src : getSources()) { + if (src.startsWith(source)) { + linked.add(src); + } + } + } + } + + sort(linked); + return linked; + } + + /** + * List all the known types (sources) of stories, grouped by directory + * ("Source_1/a" and "Source_1/b" will be grouped into "Source_1"). + *

+ * Note that an empty item in the list means a non-grouped source (type) -- + * e.g., you could have for Source_1: + *

    + *
  • : empty, so source is "Source_1"
    • + *
  • a: empty, so source is "Source_1/a"
    • + *
  • b: empty, so source is "Source_1/b"
    • + *
+ * + * @return the grouped list + * + * @throws IOException + * in case of IOException + */ + public Map> getSourcesGrouped() throws IOException { + Map> map = new TreeMap>(); + for (String source : getSources()) { + String name; + String subname; + + int pos = source.indexOf('/'); + if (pos > 0 && pos < source.length() - 1) { + name = source.substring(0, pos); + subname = source.substring(pos + 1); + + } else { + name = source; + subname = ""; + } + + List list = map.get(name); + if (list == null) { + list = new ArrayList(); + map.put(name, list); + } + list.add(subname); + } + + return map; + } + + public List getAuthors() { + if (authors == null) { + authors = new ArrayList(); + for (MetaData meta : metas) { + if (!authors.contains(meta.getAuthor())) + authors.add(meta.getAuthor()); + } + sort(authors); + } + + return authors; + } + + /** + * Return the list of authors, grouped by starting letter(s) if needed. + *

+ * If the number of authors is not too high, only one group with an empty + * name and all the authors will be returned. + *

+ * If not, the authors will be separated into groups: + *

    + *
  • *: any author whose name doesn't contain letters nor numbers + *
    • + *
  • 0-9: any author whose name starts with a number
    • + *
  • A-C (for instance): any author whose name starts with + * A, B or C
    • + *
+ * Note that the letters used in the groups can vary (except * and + * 0-9, which may only be present or not). + * + * @return the authors' names, grouped by letter(s) + * + * @throws IOException + * in case of IOException + */ + public Map> getAuthorsGrouped() throws IOException { + return group(getAuthors()); + } + + public List getTags() { + if (tags == null) { + tags = new ArrayList(); + for (MetaData meta : metas) { + for (String tag : meta.getTags()) { + if (!tags.contains(tag)) + tags.add(tag); + } + } + sort(tags); + } + + return tags; + } + + /** + * Return the list of tags, grouped by starting letter(s) if needed. + *

+ * If the number of tags is not too high, only one group with an empty name + * and all the tags will be returned. + *

+ * If not, the tags will be separated into groups: + *

    + *
  • *: any tag which name doesn't contain letters nor numbers + *
    • + *
  • 0-9: any tag which name starts with a number
    • + *
  • A-C (for instance): any tag which name starts with + * A, B or C
    • + *
+ * Note that the letters used in the groups can vary (except * and + * 0-9, which may only be present or not). + * + * @return the tags' names, grouped by letter(s) + * + * @throws IOException + * in case of IOException + */ + public Map> getTagsGrouped() throws IOException { + return group(getTags()); + } + + // helper + public List filter(String source, String author, String tag) { + List sources = source == null ? null : Arrays.asList(source); + List authors = author == null ? null : Arrays.asList(author); + List tags = tag == null ? null : Arrays.asList(tag); + + return filter(sources, authors, tags); + } + + // null or empty -> no check, rest = must be included + // source: a source ending in "/" means "this or any source starting with + // this", + // i;e., to enable source hierarchy + // + sorted + public List filter(List sources, List authors, + List tags) { + if (sources != null && sources.isEmpty()) + sources = null; + if (authors != null && authors.isEmpty()) + authors = null; + if (tags != null && tags.isEmpty()) + tags = null; + + // Quick check + if (sources == null && authors == null && tags == null) { + return metas; + } + + // allow "sources/" hierarchy + if (sources != null) { + List folders = new ArrayList(); + List leaves = new ArrayList(); + for (String source : sources) { + if (source.endsWith("/")) { + if (!folders.contains(source)) + folders.add(source); + } else { + if (!leaves.contains(source)) + leaves.add(source); + } + } + + sources = leaves; + for (String folder : folders) { + for (String otherLeaf : getSources(folder)) { + if (!sources.contains(otherLeaf)) { + sources.add(otherLeaf); + } + } + } + } + + List result = new ArrayList(); + for (MetaData meta : metas) { + if (sources != null && !sources.contains(meta.getSource())) { + continue; + } + if (authors != null && !authors.contains(meta.getAuthor())) { + continue; + } + + if (tags != null) { + boolean keep = false; + for (String thisTag : meta.getTags()) { + if (tags.contains(thisTag)) + keep = true; + } + + if (!keep) + continue; + } + + result.add(meta); + } + + Collections.sort(result); + return result; + } + + /** + * Return the list of values, grouped by starting letter(s) if needed. + *

+ * If the number of values is not too high, only one group with an empty + * name and all the values will be returned (see + * {@link MetaResultList#MAX}). + *

+ * If not, the values will be separated into groups: + *

    + *
  • *: any value which name doesn't contain letters nor numbers + *
    • + *
  • 0-9: any value which name starts with a number
    • + *
  • A-C (for instance): any value which name starts with + * A, B or C
    • + *
+ * Note that the letters used in the groups can vary (except * and + * 0-9, which may only be present or not). + * + * @param values + * the values to group + * + * @return the values, grouped by letter(s) + * + * @throws IOException + * in case of IOException + */ + private Map> group(List values) + throws IOException { + Map> groups = new TreeMap>(); + + // If all authors fit the max, just report them as is + if (values.size() <= MAX) { + groups.put("", values); + return groups; + } + + // Create groups A to Z, which can be empty here + for (char car = 'A'; car <= 'Z'; car++) { + groups.put(Character.toString(car), find(values, car)); + } + + // Collapse them + List keys = new ArrayList(groups.keySet()); + for (int i = 0; i + 1 < keys.size(); i++) { + String keyNow = keys.get(i); + String keyNext = keys.get(i + 1); + + List now = groups.get(keyNow); + List next = groups.get(keyNext); + + int currentTotal = now.size() + next.size(); + if (currentTotal <= MAX) { + String key = keyNow.charAt(0) + "-" + + keyNext.charAt(keyNext.length() - 1); + + List all = new ArrayList(); + all.addAll(now); + all.addAll(next); + + groups.remove(keyNow); + groups.remove(keyNext); + groups.put(key, all); + + keys.set(i, key); // set the new key instead of key(i) + keys.remove(i + 1); // remove the next, consumed key + i--; // restart at key(i) + } + } + + // Add "special" groups + groups.put("*", find(values, '*')); + groups.put("0-9", find(values, '0')); + + // Prune empty groups + keys = new ArrayList(groups.keySet()); + for (String key : keys) { + if (groups.get(key).isEmpty()) { + groups.remove(key); + } + } + + return groups; + } + + /** + * Get all the authors that start with the given character: + *
    + *
  • *: any author whose name doesn't contain letters nor numbers + *
    • + *
  • 0: any authors whose name starts with a number
    • + *
  • A (any capital latin letter): any author whose name starts + * with A
    • + *
+ * + * @param values + * the full list of authors + * @param car + * the starting character, *, 0 or a capital + * letter + * + * @return the authors that fulfil the starting letter + */ + private List find(List values, char car) { + List accepted = new ArrayList(); + for (String value : values) { + char first = '*'; + for (int i = 0; first == '*' && i < value.length(); i++) { + String san = StringUtils.sanitize(value, true, true); + char c = san.charAt(i); + if (c >= '0' && c <= '9') { + first = '0'; + } else if (c >= 'a' && c <= 'z') { + first = (char) (c - 'a' + 'A'); + } else if (c >= 'A' && c <= 'Z') { + first = c; + } + } + + if (first == car) { + accepted.add(value); + } + } + + return accepted; + } + + /** + * Sort the given {@link String} values, ignoring case. + * + * @param values + * the values to sort + */ + private void sort(List values) { + Collections.sort(values, new Comparator() { + @Override + public int compare(String o1, String o2) { + return ("" + o1).compareToIgnoreCase("" + o2); + } + }); + } +} diff --git a/src/be/nikiroo/fanfix/library/RemoteLibrary.java b/src/be/nikiroo/fanfix/library/RemoteLibrary.java new file mode 100644 index 0000000..3e0e192 --- /dev/null +++ b/src/be/nikiroo/fanfix/library/RemoteLibrary.java @@ -0,0 +1,589 @@ +package be.nikiroo.fanfix.library; + +import java.io.File; +import java.io.IOException; +import java.net.URL; +import java.net.UnknownHostException; +import java.util.ArrayList; +import java.util.List; + +import javax.net.ssl.SSLException; + +import be.nikiroo.fanfix.Instance; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.utils.Image; +import be.nikiroo.utils.Progress; +import be.nikiroo.utils.Version; +import be.nikiroo.utils.serial.server.ConnectActionClientObject; + +/** + * This {@link BasicLibrary} will access a remote server to list the available + * stories, and download the ones you try to load to the local directory + * specified in the configuration. + *

+ * This remote library uses a custom fanfix:// protocol. + * + * @author niki + */ +public class RemoteLibrary extends BasicLibrary { + interface RemoteAction { + public void action(ConnectActionClientObject action) throws Exception; + } + + class RemoteConnectAction extends ConnectActionClientObject { + public RemoteConnectAction() throws IOException { + super(host, port, key); + } + + @Override + public Object send(Object data) + throws IOException, NoSuchFieldException, NoSuchMethodException, + ClassNotFoundException { + Object rep = super.send(data); + if (rep instanceof RemoteLibraryException) { + RemoteLibraryException remoteEx = (RemoteLibraryException) rep; + throw remoteEx.unwrapException(); + } + + return rep; + } + } + + private String host; + private int port; + private final String key; + private final String subkey; + + // informative only (server will make the actual checks) + private boolean rw; + + /** + * Create a {@link RemoteLibrary} linked to the given server. + *

+ * Note that the key is structured: + * xxx(|yyy(|wl)(|bl)(|rw) + *

+ * Note that anything before the first pipe (|) character is + * considered to be the encryption key, anything after that character is + * called the subkey (including the other pipe characters and flags!). + *

+ * This is important because the subkey (including the pipe characters and + * flags) must be present as-is in the server configuration file to be + * allowed. + *

    + *
  • xxx: the encryption key used to communicate with the + * server
    • + *
  • yyy: the secondary key
    • + *
  • rw: flag to allow read and write access if it is not the + * default on this server
    • + *
  • bl: flag to bypass the blacklist (if it exists)
    • + *
  • wl: flag to bypass the whitelist if it exists
    • + *
+ *

+ * Some examples: + *

    + *
  • my_key: normal connection, will take the default server + * options
    • + *
  • my_key|agzyzz|wl|bl: will ask to bypass the black list and the + * white list (if it exists)
    • + *
  • my_key|agzyzz|rw: will ask read-write access (if the default + * is read-only)
    • + *
  • my_key|agzyzz|wl|rw: will ask both read-write access and white + * list bypass
    • + *
+ * + * @param key + * the key that will allow us to exchange information with the + * server + * @param host + * the host to contact or NULL for localhost + * @param port + * the port to contact it on + */ + public RemoteLibrary(String key, String host, int port) { + int index = -1; + if (key != null) { + index = key.indexOf('|'); + } + + if (index >= 0) { + this.key = key.substring(0, index); + this.subkey = key.substring(index + 1); + } else { + this.key = key; + this.subkey = ""; + } + + if (host.startsWith("fanfix://")) { + host = host.substring("fanfix://".length()); + } + + this.host = host; + this.port = port; + } + + @Override + public String getLibraryName() { + return (rw ? "[READ-ONLY] " : "") + "fanfix://" + host + ":" + port; + } + + @Override + public Status getStatus() { + Instance.getInstance().getTraceHandler() + .trace("Getting remote lib status..."); + Status status = getStatusDo(); + Instance.getInstance().getTraceHandler() + .trace("Remote lib status: " + status); + return status; + } + + private Status getStatusDo() { + final Status[] result = new Status[1]; + + result[0] = null; + try { + new RemoteConnectAction() { + @Override + public void action(Version serverVersion) throws Exception { + Object rep = send(new Object[] { subkey, "PING" }); + + if ("r/w".equals(rep)) { + rw = true; + result[0] = Status.READ_WRITE; + } else if ("r/o".equals(rep)) { + rw = false; + result[0] = Status.READ_ONLY; + } else { + result[0] = Status.UNAUTHORIZED; + } + } + + @Override + protected void onError(Exception e) { + if (e instanceof SSLException) { + result[0] = Status.UNAUTHORIZED; + } else { + result[0] = Status.UNAVAILABLE; + } + } + }.connect(); + } catch (UnknownHostException e) { + result[0] = Status.INVALID; + } catch (IllegalArgumentException e) { + result[0] = Status.INVALID; + } catch (Exception e) { + result[0] = Status.UNAVAILABLE; + } + + return result[0]; + } + + @Override + public Image getCover(final String luid) throws IOException { + final Image[] result = new Image[1]; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Object rep = action + .send(new Object[] { subkey, "GET_COVER", luid }); + result[0] = (Image) rep; + } + }); + + return result[0]; + } + + @Override + public Image getCustomSourceCover(final String source) throws IOException { + return getCustomCover(source, "SOURCE"); + } + + @Override + public Image getCustomAuthorCover(final String author) throws IOException { + return getCustomCover(author, "AUTHOR"); + } + + // type: "SOURCE" or "AUTHOR" + private Image getCustomCover(final String source, final String type) + throws IOException { + final Image[] result = new Image[1]; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Object rep = action.send(new Object[] { subkey, + "GET_CUSTOM_COVER", type, source }); + result[0] = (Image) rep; + } + }); + + return result[0]; + } + + @Override + public synchronized Story getStory(final String luid, Progress pg) + throws IOException { + final Progress pgF = pg; + final Story[] result = new Story[1]; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Progress pg = pgF; + if (pg == null) { + pg = new Progress(); + } + + Object rep = action + .send(new Object[] { subkey, "GET_STORY", luid }); + + MetaData meta = null; + if (rep instanceof MetaData) { + meta = (MetaData) rep; + if (meta.getWords() <= Integer.MAX_VALUE) { + pg.setMinMax(0, (int) meta.getWords()); + } + } + + List list = new ArrayList(); + for (Object obj = action.send(null); obj != null; obj = action + .send(null)) { + list.add(obj); + pg.add(1); + } + + result[0] = RemoteLibraryServer.rebuildStory(list); + pg.done(); + } + }); + + return result[0]; + } + + @Override + public synchronized Story save(final Story story, final String luid, + Progress pg) throws IOException { + + final String[] luidSaved = new String[1]; + Progress pgSave = new Progress(); + Progress pgRefresh = new Progress(); + if (pg == null) { + pg = new Progress(); + } + + pg.setMinMax(0, 10); + pg.addProgress(pgSave, 9); + pg.addProgress(pgRefresh, 1); + + final Progress pgF = pgSave; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Progress pg = pgF; + if (story.getMeta().getWords() <= Integer.MAX_VALUE) { + pg.setMinMax(0, (int) story.getMeta().getWords()); + } + + action.send(new Object[] { subkey, "SAVE_STORY", luid }); + + List list = RemoteLibraryServer.breakStory(story); + for (Object obj : list) { + action.send(obj); + pg.add(1); + } + + luidSaved[0] = (String) action.send(null); + + pg.done(); + } + }); + + // because the meta changed: + MetaData meta = getInfo(luidSaved[0]); + if (story.getMeta().getClass() != null) { + // If already available locally: + meta.setCover(story.getMeta().getCover()); + } else { + // If required: + meta.setCover(getCover(meta.getLuid())); + } + story.setMeta(meta); + + pg.done(); + + return story; + } + + @Override + public synchronized void delete(final String luid) throws IOException { + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + action.send(new Object[] { subkey, "DELETE_STORY", luid }); + } + }); + } + + @Override + public void setSourceCover(final String source, final String luid) + throws IOException { + setCover(source, luid, "SOURCE"); + } + + @Override + public void setAuthorCover(final String author, final String luid) + throws IOException { + setCover(author, luid, "AUTHOR"); + } + + // type = "SOURCE" | "AUTHOR" + private void setCover(final String value, final String luid, + final String type) throws IOException { + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + action.send(new Object[] { subkey, "SET_COVER", type, value, + luid }); + } + }); + } + + @Override + // Could work (more slowly) without it + public MetaData imprt(final URL url, Progress pg) throws IOException { + // Import the file locally if it is actually a file + + if (url == null || url.getProtocol().equalsIgnoreCase("file")) { + return super.imprt(url, pg); + } + + // Import it remotely if it is an URL + + if (pg == null) { + pg = new Progress(); + } + + final Progress pgF = pg; + final String[] luid = new String[1]; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Progress pg = pgF; + + Object rep = action.send( + new Object[] { subkey, "IMPORT", url.toString() }); + + while (true) { + if (!RemoteLibraryServer.updateProgress(pg, rep)) { + break; + } + + rep = action.send(null); + } + + pg.done(); + luid[0] = (String) rep; + } + }); + + if (luid[0] == null) { + throw new IOException("Remote failure"); + } + + pg.done(); + return getInfo(luid[0]); + } + + @Override + // Could work (more slowly) without it + protected synchronized void changeSTA(final String luid, + final String newSource, final String newTitle, + final String newAuthor, Progress pg) throws IOException { + + final Progress pgF = pg == null ? new Progress() : pg; + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Progress pg = pgF; + + Object rep = action.send(new Object[] { subkey, "CHANGE_STA", + luid, newSource, newTitle, newAuthor }); + while (true) { + if (!RemoteLibraryServer.updateProgress(pg, rep)) { + break; + } + + rep = action.send(null); + } + } + }); + } + + @Override + public File getFile(final String luid, Progress pg) { + throw new java.lang.InternalError( + "Operation not supportorted on remote Libraries"); + } + + /** + * Stop the server. + * + * @throws IOException + * in case of I/O errors + * @throws SSLException + * when the key was not accepted + */ + public void stop() throws IOException, SSLException { + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + action.send(new Object[] { subkey, "EXIT" }); + Thread.sleep(100); + } + }); + } + + @Override + public MetaData getInfo(String luid) throws IOException { + List metas = getMetasList(luid, null); + if (!metas.isEmpty()) { + return metas.get(0); + } + + return null; + } + + @Override + protected List getMetas(Progress pg) throws IOException { + return getMetasList("*", pg); + } + + @Override + protected void updateInfo(MetaData meta) { + // Will be taken care of directly server side + } + + @Override + protected void invalidateInfo(String luid) { + // Will be taken care of directly server side + } + + // The following methods are only used by Save and Delete in BasicLibrary: + + @Override + protected String getNextId() { + throw new java.lang.InternalError("Should not have been called"); + } + + @Override + protected void doDelete(String luid) throws IOException { + throw new java.lang.InternalError("Should not have been called"); + } + + @Override + protected Story doSave(Story story, Progress pg) throws IOException { + throw new java.lang.InternalError("Should not have been called"); + } + + // + + /** + * Return the meta of the given story or a list of all known metas if the + * luid is "*". + *

+ * Will not get the covers. + * + * @param luid + * the luid of the story or * + * @param pg + * the optional progress + * + * @return the metas + * + * @throws IOException + * in case of I/O error or bad key (SSLException) + */ + private List getMetasList(final String luid, Progress pg) + throws IOException { + final Progress pgF = pg; + final List metas = new ArrayList(); + + connectRemoteAction(new RemoteAction() { + @Override + public void action(ConnectActionClientObject action) + throws Exception { + Progress pg = pgF; + if (pg == null) { + pg = new Progress(); + } + + Object rep = action + .send(new Object[] { subkey, "GET_METADATA", luid }); + + while (true) { + if (!RemoteLibraryServer.updateProgress(pg, rep)) { + break; + } + + rep = action.send(null); + } + + if (rep instanceof MetaData[]) { + for (MetaData meta : (MetaData[]) rep) { + metas.add(meta); + } + } else if (rep != null) { + metas.add((MetaData) rep); + } + } + }); + + return metas; + } + + private void connectRemoteAction(final RemoteAction runAction) + throws IOException { + final IOException[] err = new IOException[1]; + try { + final RemoteConnectAction[] array = new RemoteConnectAction[1]; + RemoteConnectAction ra = new RemoteConnectAction() { + @Override + public void action(Version serverVersion) throws Exception { + runAction.action(array[0]); + } + + @Override + protected void onError(Exception e) { + if (!(e instanceof IOException)) { + Instance.getInstance().getTraceHandler().error(e); + return; + } + + err[0] = (IOException) e; + } + }; + array[0] = ra; + ra.connect(); + } catch (Exception e) { + err[0] = (IOException) e; + } + + if (err[0] != null) { + throw err[0]; + } + } +} diff --git a/src/be/nikiroo/fanfix/library/RemoteLibraryException.java b/src/be/nikiroo/fanfix/library/RemoteLibraryException.java new file mode 100644 index 0000000..4cbb631 --- /dev/null +++ b/src/be/nikiroo/fanfix/library/RemoteLibraryException.java @@ -0,0 +1,100 @@ +package be.nikiroo.fanfix.library; + +import java.io.IOException; + +/** + * Exceptions sent from remote to local. + * + * @author niki + */ +public class RemoteLibraryException extends IOException { + private static final long serialVersionUID = 1L; + + private boolean wrapped; + + @SuppressWarnings("unused") + private RemoteLibraryException() { + // for serialization purposes + } + + /** + * Wrap an {@link IOException} to allow it to pass across the network. + * + * @param cause + * the exception to wrap + * @param remote + * this exception is used to send the contained + * {@link IOException} to the other end of the network + */ + public RemoteLibraryException(IOException cause, boolean remote) { + this(null, cause, remote); + } + + /** + * Wrap an {@link IOException} to allow it to pass across the network. + * + * @param message + * the error message + * @param wrapped + * this exception is used to send the contained + * {@link IOException} to the other end of the network + */ + public RemoteLibraryException(String message, boolean wrapped) { + this(message, null, wrapped); + } + + /** + * Wrap an {@link IOException} to allow it to pass across the network. + * + * @param message + * the error message + * @param cause + * the exception to wrap + * @param wrapped + * this exception is used to send the contained + * {@link IOException} to the other end of the network + */ + public RemoteLibraryException(String message, IOException cause, + boolean wrapped) { + super(message, cause); + this.wrapped = wrapped; + } + + /** + * Return the actual exception we should return to the client code. It can + * be: + *

    + *
  • the cause if {@link RemoteLibraryException#isWrapped()} is + * TRUE
    • + *
  • this if {@link RemoteLibraryException#isWrapped()} is FALSE + * (
    • + *
  • this if the cause is NULL (so we never return NULL) + *
    • + *
+ * It is never NULL. + * + * @return the unwrapped exception or this, never NULL + */ + public synchronized IOException unwrapException() { + Throwable ex = super.getCause(); + if (!isWrapped() || !(ex instanceof IOException)) { + ex = this; + } + + return (IOException) ex; + } + + /** + * This exception is used to send the contained {@link IOException} to the + * other end of the network. + *

+ * In other words, do not use this exception in client code when it + * has reached the other end of the network, but use its cause instead (see + * {@link RemoteLibraryException#unwrapException()}). + * + * @return TRUE if it is + */ + public boolean isWrapped() { + return wrapped; + } +} diff --git a/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java b/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java new file mode 100644 index 0000000..59819bb --- /dev/null +++ b/src/be/nikiroo/fanfix/library/RemoteLibraryServer.java @@ -0,0 +1,596 @@ +package be.nikiroo.fanfix.library; + +import java.io.IOException; +import java.net.URL; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Date; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import javax.net.ssl.SSLException; + +import be.nikiroo.fanfix.Instance; +import be.nikiroo.fanfix.bundles.Config; +import be.nikiroo.fanfix.data.Chapter; +import be.nikiroo.fanfix.data.MetaData; +import be.nikiroo.fanfix.data.Paragraph; +import be.nikiroo.fanfix.data.Story; +import be.nikiroo.utils.Progress; +import be.nikiroo.utils.Progress.ProgressListener; +import be.nikiroo.utils.StringUtils; +import be.nikiroo.utils.Version; +import be.nikiroo.utils.serial.server.ConnectActionServerObject; +import be.nikiroo.utils.serial.server.ServerObject; + +/** + * Create a new remote server that will listen for orders on the given port. + *

+ * The available commands are given as arrays of objects (first item is the + * command, the rest are the arguments). + *

+ * All the commands are always prefixed by the subkey (which can be EMPTY if + * none). + *

+ *

    + *
  • PING: will return the mode if the key is accepted (mode can be: "r/o" or + * "r/w")
    • + *
  • GET_METADATA *: will return the metadata of all the stories in the + * library (array)
    • * + *
  • GET_METADATA [luid]: will return the metadata of the story of LUID + * luid
    • + *
  • GET_STORY [luid]: will return the given story if it exists (or NULL if + * not)
    • + *
  • SAVE_STORY [luid]: save the story (that must be sent just after the + * command) with the given LUID, then return the LUID
    • + *
  • IMPORT [url]: save the story found at the given URL, then return the LUID + *
    • + *
  • DELETE_STORY [luid]: delete the story of LUID luid
    • + *
  • GET_COVER [luid]: return the cover of the story
    • + *
  • GET_CUSTOM_COVER ["SOURCE"|"AUTHOR"] [source]: return the cover for this + * source/author
    • + *
  • SET_COVER ["SOURCE"|"AUTHOR"] [value] [luid]: set the default cover for + * the given source/author to the cover of the story denoted by luid
    • + *
  • CHANGE_SOURCE [luid] [new source]: change the source of the story of LUID + * luid
    • + *
  • EXIT: stop the server
    • + *
+ * + * @author niki + */ +public class RemoteLibraryServer extends ServerObject { + private Map commands = new HashMap(); + private Map times = new HashMap(); + private Map wls = new HashMap(); + private Map bls = new HashMap(); + private Map rws = new HashMap(); + + /** + * Create a new remote server (will not be active until + * {@link RemoteLibraryServer#start()} is called). + *

+ * Note: the key we use here is the encryption key (it must not contain a + * subkey). + * + * @throws IOException + * in case of I/O error + */ + public RemoteLibraryServer() throws IOException { + super("Fanfix remote library", + Instance.getInstance().getConfig() + .getInteger(Config.SERVER_PORT), + Instance.getInstance().getConfig() + .getString(Config.SERVER_KEY)); + + setTraceHandler(Instance.getInstance().getTraceHandler()); + } + + @Override + protected Object onRequest(ConnectActionServerObject action, + Version clientVersion, Object data, long id) throws Exception { + long start = new Date().getTime(); + + // defaults are positive (as previous versions without the feature) + boolean rw = true; + boolean wl = true; + boolean bl = true; + + String subkey = ""; + String command = ""; + Object[] args = new Object[0]; + if (data instanceof Object[]) { + Object[] dataArray = (Object[]) data; + if (dataArray.length > 0) { + subkey = "" + dataArray[0]; + } + if (dataArray.length > 1) { + command = "" + dataArray[1]; + + args = new Object[dataArray.length - 2]; + for (int i = 2; i < dataArray.length; i++) { + args[i - 2] = dataArray[i]; + } + } + } + + List whitelist = Instance.getInstance().getConfig() + .getList(Config.SERVER_WHITELIST); + if (whitelist == null) { + whitelist = new ArrayList(); + } + List blacklist = Instance.getInstance().getConfig() + .getList(Config.SERVER_BLACKLIST); + if (blacklist == null) { + blacklist = new ArrayList(); + } + + if (whitelist.isEmpty()) { + wl = false; + } + + rw = Instance.getInstance().getConfig().getBoolean(Config.SERVER_RW, + rw); + if (!subkey.isEmpty()) { + List allowed = Instance.getInstance().getConfig() + .getList(Config.SERVER_ALLOWED_SUBKEYS); + if (allowed.contains(subkey)) { + if ((subkey + "|").contains("|rw|")) { + rw = true; + } + if ((subkey + "|").contains("|wl|")) { + wl = false; // |wl| = bypass whitelist + whitelist = new ArrayList(); + } + if ((subkey + "|").contains("|bl|")) { + bl = false; // |bl| = bypass blacklist + blacklist = new ArrayList(); + } + } + } + + String mode = display(wl, bl, rw); + + String trace = mode + "[ " + command + "] "; + for (Object arg : args) { + trace += arg + " "; + } + long now = System.currentTimeMillis(); + System.out.println(StringUtils.fromTime(now) + ": " + trace); + + Object rep = null; + try { + rep = doRequest(action, command, args, rw, whitelist, blacklist); + } catch (IOException e) { + rep = new RemoteLibraryException(e, true); + } + + commands.put(id, command); + wls.put(id, wl); + bls.put(id, bl); + rws.put(id, rw); + times.put(id, (new Date().getTime() - start)); + + return rep; + } + + private String display(boolean whitelist, boolean blacklist, boolean rw) { + String mode = ""; + if (!rw) { + mode += "RO: "; + } + if (whitelist) { + mode += "WL: "; + } + if (blacklist) { + mode += "BL: "; + } + + return mode; + } + + @Override + protected void onRequestDone(long id, long bytesReceived, long bytesSent) { + boolean whitelist = wls.get(id); + boolean blacklist = bls.get(id); + boolean rw = rws.get(id); + wls.remove(id); + bls.remove(id); + rws.remove(id); + + String rec = StringUtils.formatNumber(bytesReceived) + "b"; + String sent = StringUtils.formatNumber(bytesSent) + "b"; + long now = System.currentTimeMillis(); + System.out.println(StringUtils.fromTime(now) + ": " + + String.format("%s[>%s]: (%s sent, %s rec) in %d ms", + display(whitelist, blacklist, rw), commands.get(id), + sent, rec, times.get(id))); + + commands.remove(id); + times.remove(id); + } + + private Object doRequest(ConnectActionServerObject action, String command, + Object[] args, boolean rw, List whitelist, + List blacklist) throws NoSuchFieldException, + NoSuchMethodException, ClassNotFoundException, IOException { + if ("PING".equals(command)) { + return rw ? "r/w" : "r/o"; + } else if ("GET_METADATA".equals(command)) { + List metas = new ArrayList(); + + if ("*".equals(args[0])) { + Progress pg = createPgForwarder(action); + + for (MetaData meta : Instance.getInstance().getLibrary() + .getMetas(pg)) { + metas.add(removeCover(meta)); + } + + forcePgDoneSent(pg); + } else { + MetaData meta = Instance.getInstance().getLibrary() + .getInfo((String) args[0]); + MetaData light; + if (meta.getCover() == null) { + light = meta; + } else { + light = meta.clone(); + light.setCover(null); + } + + metas.add(light); + } + + for (int i = 0; i < metas.size(); i++) { + if (!isAllowed(metas.get(i), whitelist, blacklist)) { + metas.remove(i); + i--; + } + } + + return metas.toArray(new MetaData[0]); + + } else if ("GET_STORY".equals(command)) { + MetaData meta = Instance.getInstance().getLibrary() + .getInfo((String) args[0]); + if (meta == null || !isAllowed(meta, whitelist, blacklist)) { + return null; + } + + meta = meta.clone(); + meta.setCover(null); + + action.send(meta); + action.rec(); + + Story story = Instance.getInstance().getLibrary() + .getStory((String) args[0], null); + for (Object obj : breakStory(story)) { + action.send(obj); + action.rec(); + } + } else if ("SAVE_STORY".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: " + args[0], false); + } + + List list = new ArrayList(); + + action.send(null); + Object obj = action.rec(); + while (obj != null) { + list.add(obj); + action.send(null); + obj = action.rec(); + } + + Story story = rebuildStory(list); + Instance.getInstance().getLibrary().save(story, (String) args[0], + null); + return story.getMeta().getLuid(); + } else if ("IMPORT".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: " + args[0], false); + } + + Progress pg = createPgForwarder(action); + MetaData meta = Instance.getInstance().getLibrary() + .imprt(new URL((String) args[0]), pg); + forcePgDoneSent(pg); + return meta.getLuid(); + } else if ("DELETE_STORY".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: " + args[0], false); + } + + Instance.getInstance().getLibrary().delete((String) args[0]); + } else if ("GET_COVER".equals(command)) { + return Instance.getInstance().getLibrary() + .getCover((String) args[0]); + } else if ("GET_CUSTOM_COVER".equals(command)) { + if ("SOURCE".equals(args[0])) { + return Instance.getInstance().getLibrary() + .getCustomSourceCover((String) args[1]); + } else if ("AUTHOR".equals(args[0])) { + return Instance.getInstance().getLibrary() + .getCustomAuthorCover((String) args[1]); + } else { + return null; + } + } else if ("SET_COVER".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: " + args[0] + ", " + args[1], + false); + } + + if ("SOURCE".equals(args[0])) { + Instance.getInstance().getLibrary() + .setSourceCover((String) args[1], (String) args[2]); + } else if ("AUTHOR".equals(args[0])) { + Instance.getInstance().getLibrary() + .setAuthorCover((String) args[1], (String) args[2]); + } + } else if ("CHANGE_STA".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: " + args[0] + ", " + args[1], + false); + } + + Progress pg = createPgForwarder(action); + Instance.getInstance().getLibrary().changeSTA((String) args[0], + (String) args[1], (String) args[2], (String) args[3], pg); + forcePgDoneSent(pg); + } else if ("EXIT".equals(command)) { + if (!rw) { + throw new RemoteLibraryException( + "Read-Only remote library: EXIT", false); + } + + stop(10000, false); + } + + return null; + } + + @Override + protected void onError(Exception e) { + if (e instanceof SSLException) { + long now = System.currentTimeMillis(); + System.out.println(StringUtils.fromTime(now) + ": " + + "[Client connection refused (bad key)]"); + } else { + getTraceHandler().error(e); + } + } + + /** + * Break a story in multiple {@link Object}s for easier serialisation. + * + * @param story + * the {@link Story} to break + * + * @return the list of {@link Object}s + */ + static List breakStory(Story story) { + List list = new ArrayList(); + + story = story.clone(); + list.add(story); + + if (story.getMeta().isImageDocument()) { + for (Chapter chap : story) { + list.add(chap); + list.addAll(chap.getParagraphs()); + chap.setParagraphs(new ArrayList()); + } + story.setChapters(new ArrayList()); + } + + return list; + } + + /** + * Rebuild a story from a list of broke up {@link Story} parts. + * + * @param list + * the list of {@link Story} parts + * + * @return the reconstructed {@link Story} + */ + static Story rebuildStory(List list) { + Story story = null; + Chapter chap = null; + + for (Object obj : list) { + if (obj instanceof Story) { + story = (Story) obj; + } else if (obj instanceof Chapter) { + chap = (Chapter) obj; + story.getChapters().add(chap); + } else if (obj instanceof Paragraph) { + chap.getParagraphs().add((Paragraph) obj); + } + } + + return story; + } + + /** + * Update the {@link Progress} with the adequate {@link Object} received + * from the network via {@link RemoteLibraryServer}. + * + * @param pg + * the {@link Progress} to update + * @param rep + * the object received from the network + * + * @return TRUE if it was a progress event, FALSE if not + */ + static boolean updateProgress(Progress pg, Object rep) { + boolean updateProgress = false; + if (rep instanceof Integer[] && ((Integer[]) rep).length == 3) + updateProgress = true; + if (rep instanceof Object[] && ((Object[]) rep).length >= 5 + && "UPDATE".equals(((Object[]) rep)[0])) + updateProgress = true; + + if (updateProgress) { + Object[] a = (Object[]) rep; + + int offset = 0; + if (a[0] instanceof String) { + offset = 1; + } + + int min = (Integer) a[0 + offset]; + int max = (Integer) a[1 + offset]; + int progress = (Integer) a[2 + offset]; + + Object meta = null; + if (a.length > (3 + offset)) { + meta = a[3 + offset]; + } + + String name = null; + if (a.length > (4 + offset)) { + name = a[4 + offset] == null ? "" : a[4 + offset].toString(); + } + + if (min >= 0 && min <= max) { + pg.setName(name); + pg.setMinMax(min, max); + pg.setProgress(progress); + if (meta != null) { + pg.put("meta", meta); + } + + return true; + } + } + + return false; + } + + /** + * Create a {@link Progress} that will forward its progress over the + * network. + * + * @param action + * the {@link ConnectActionServerObject} to use to forward it + * + * @return the {@link Progress} + */ + private Progress createPgForwarder(final ConnectActionServerObject action) { + final Boolean[] isDoneForwarded = new Boolean[] { false }; + final Progress pg = new Progress() { + @Override + public boolean isDone() { + return isDoneForwarded[0]; + } + }; + + final Integer[] p = new Integer[] { -1, -1, -1 }; + final Object[] pMeta = new MetaData[1]; + final String[] pName = new String[1]; + final Long[] lastTime = new Long[] { new Date().getTime() }; + pg.addProgressListener(new ProgressListener() { + @Override + public void progress(Progress progress, String name) { + Object meta = pg.get("meta"); + if (meta instanceof MetaData) { + meta = removeCover((MetaData) meta); + } + + int min = pg.getMin(); + int max = pg.getMax(); + int rel = min + (int) Math + .round(pg.getRelativeProgress() * (max - min)); + + boolean samePg = p[0] == min && p[1] == max && p[2] == rel; + + // Do not re-send the same value twice over the wire, + // unless more than 2 seconds have elapsed (to maintain the + // connection) + if (!samePg || !same(pMeta[0], meta) || !same(pName[0], name) // + || (new Date().getTime() - lastTime[0] > 2000)) { + p[0] = min; + p[1] = max; + p[2] = rel; + pMeta[0] = meta; + pName[0] = name; + + try { + action.send(new Object[] { "UPDATE", min, max, rel, + meta, name }); + action.rec(); + } catch (Exception e) { + getTraceHandler().error(e); + } + + lastTime[0] = new Date().getTime(); + } + + isDoneForwarded[0] = (pg.getProgress() >= pg.getMax()); + } + }); + + return pg; + } + + private boolean same(Object obj1, Object obj2) { + if (obj1 == null || obj2 == null) + return obj1 == null && obj2 == null; + + return obj1.equals(obj2); + } + + // with 30 seconds timeout + private void forcePgDoneSent(Progress pg) { + long start = new Date().getTime(); + pg.done(); + while (!pg.isDone() && new Date().getTime() - start < 30000) { + try { + Thread.sleep(100); + } catch (InterruptedException e) { + getTraceHandler().error(e); + } + } + } + + private MetaData removeCover(MetaData meta) { + MetaData light = null; + if (meta != null) { + if (meta.getCover() == null) { + light = meta; + } else { + light = meta.clone(); + light.setCover(null); + } + } + + return light; + } + + private boolean isAllowed(MetaData meta, List whitelist, + List blacklist) { + MetaResultList one = new MetaResultList(Arrays.asList(meta)); + if (!whitelist.isEmpty()) { + if (one.filter(whitelist, null, null).isEmpty()) { + return false; + } + } + if (!blacklist.isEmpty()) { + if (!one.filter(blacklist, null, null).isEmpty()) { + return false; + } + } + + return true; + } +} diff --git a/src/be/nikiroo/fanfix/library/Template.java b/src/be/nikiroo/fanfix/library/Template.java new file mode 100644 index 0000000..e247e27 --- /dev/null +++ b/src/be/nikiroo/fanfix/library/Template.java @@ -0,0 +1,113 @@ +package be.nikiroo.fanfix.library; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +import be.nikiroo.utils.IOUtils; +import be.nikiroo.utils.StringUtils; +import be.nikiroo.utils.streams.ReplaceInputStream; + +public class Template { + private Class location; + private String name; + + private Map values = new HashMap(); + private Map valuesTemplate = new HashMap(); + private Map> valuesTemplateList = new HashMap>(); + + public Template(Class location, String name) { + this.location = location; + this.name = name; + } + + public synchronized InputStream read() throws IOException { + + String from[] = new String[values.size() + valuesTemplate.size() + + valuesTemplateList.size()]; + String to[] = new String[from.length]; + + int i = 0; + + for (String key : values.keySet()) { + from[i] = "${" + key + "}"; + to[i] = values.get(key); + + i++; + } + for (String key : valuesTemplate.keySet()) { + InputStream value = valuesTemplate.get(key).read(); + try { + from[i] = "${" + key + "}"; + to[i] = IOUtils.readSmallStream(value); + } finally { + value.close(); + } + + i++; + } + for (String key : valuesTemplateList.keySet()) { + List