diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE.md @@ -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/comicmetadata.py b/comicmetadata.py new file mode 100644 index 0000000..f90773d --- /dev/null +++ b/comicmetadata.py @@ -0,0 +1,670 @@ +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2015, dloraine' +__docformat__ = 'restructuredtext en' + +from functools import partial +from zipfile import ZipFile +from calibre.utils.zipfile import ZipFile as ZFile, safe_replace +from calibre.ptempfile import TemporaryFile, TemporaryDirectory + +from calibre_plugins.EmbedComicMetadata.config import prefs +from calibre_plugins.EmbedComicMetadata.genericmetadata import GenericMetadata +from calibre_plugins.EmbedComicMetadata.comicinfoxml import ComicInfoXml +from calibre_plugins.EmbedComicMetadata.comicbookinfo import ComicBookInfo + +import os +import sys + +python3 = sys.version_info[0] > 2 + + +# synonyms for artists +WRITER = ['writer', 'plotter', 'scripter'] +PENCILLER = ['artist', 'penciller', 'penciler', 'breakdowns'] +INKER = ['inker', 'artist', 'finishes'] +COLORIST = ['colorist', 'colourist', 'colorer', 'colourer'] +LETTERER = ['letterer'] +COVER_ARTIST = ['cover', 'covers', 'coverartist', 'cover artist'] +EDITOR = ['editor'] +TRANSLATOR = ['translator'] + +# image file extensions +IMG_EXTENSIONS = ["jpg", "png", "jpeg", "gif", "bmp", "tiff", "tif", "webp", + "svg", "bpg", "psd"] + + +class ComicMetadata: + ''' + An object for calibre to interact with comic metadata. + ''' + + def __init__(self, book_id, ia): + # initialize the attributes + self.book_id = book_id + self.ia = ia + self.db = ia.gui.current_db.new_api + self.calibre_metadata = self.db.get_metadata(book_id) + self.cbi_metadata = None + self.cix_metadata = None + self.calibre_md_in_comic_format = None + self.comic_md_in_calibre_format = None + self.comic_metadata = None + self.checked_for_metadata = False + self.file = None + self.zipinfo = None + + # get the comic formats + if self.db.has_format(book_id, "cbz"): + self.format = "cbz" + elif self.db.has_format(book_id, "cbr"): + self.format = "cbr" + elif self.db.has_format(book_id, "zip"): + self.format = "zip" + elif self.db.has_format(book_id, "rar"): + self.format = "rar" + else: + self.format = None + + # generate a string with the books info, to show in the completion dialog + self.info = "{} - {}".format(self.calibre_metadata.title, self.calibre_metadata.authors[0]) + if self.calibre_metadata.series: + self.info = "{}: {} - ".format(self.calibre_metadata.series, self.calibre_metadata.series_index) + self.info + + def __del__(self): + delete_temp_file(self.file) + + def get_comic_metadata_from_file(self): + if self.checked_for_metadata: + return + if self.format == "cbz": + self.get_comic_metadata_from_cbz() + elif self.format == "cbr": + self.get_comic_metadata_from_cbr() + self.checked_for_metadata = True + + def add_updated_comic_to_calibre(self): + self.db.add_format(self.book_id, "cbz", self.file) + + def import_comic_metadata_to_calibre(self, comic_metadata): + self.convert_comic_md_to_calibre_md(comic_metadata) + self.db.set_metadata(self.book_id, self.comic_md_in_calibre_format) + + def overlay_metadata(self): + # make sure we have the metadata + self.get_comic_metadata_from_file() + # make the metadata generic, if none exists now + if self.comic_metadata is None: + self.comic_metadata = GenericMetadata() + self.convert_calibre_md_to_comic_md() + self.comic_metadata.overlay(self.calibre_md_in_comic_format) + + def embed_cix_metadata(self): + ''' + Embeds the cix_metadata + ''' + from io import StringIO + + cix_string = ComicInfoXml().stringFromMetadata(self.comic_metadata) + + # ensure we have a temp file + self.make_temp_cbz_file() + + if not python3: + cix_string = cix_string.decode('utf-8', 'ignore') + # use the safe_replace function from calibre to prevent coruption + if self.zipinfo is not None: + with open(self.file, 'r+b') as zf: + safe_replace(zf, self.zipinfo, StringIO(cix_string)) + # save the metadata in the file + else: + zf = ZipFile(self.file, "a") + zf.writestr("ComicInfo.xml", cix_string) + zf.close() + + def embed_cbi_metadata(self): + ''' + Embeds the cbi_metadata + ''' + cbi_string = ComicBookInfo().stringFromMetadata(self.comic_metadata) + + # ensure we have a temp file + self.make_temp_cbz_file() + # save the metadata in the comment + zf = ZipFile(self.file, 'a') + zf.comment = cbi_string.encode("utf-8") + zf._didModify = True + zf.close() + + def convert_calibre_md_to_comic_md(self): + ''' + Maps the entries in the calibre metadata to comictagger metadata + ''' + from calibre.utils.html2text import html2text + from calibre.utils.date import UNDEFINED_DATE + from calibre.utils.localization import lang_as_iso639_1 + + if self.calibre_md_in_comic_format: + return + + self.calibre_md_in_comic_format = GenericMetadata() + mi = self.calibre_metadata + + # shorten some functions + role = partial(set_role, credits=self.calibre_md_in_comic_format.credits) + update_field = partial(update_comic_field, target=self.calibre_md_in_comic_format) + + # update the fields of comic metadata + update_field("title", mi.title) + role("Writer", mi.authors) + update_field("series", mi.series) + update_field("issue", mi.series_index) + update_field("tags", mi.tags) + update_field("publisher", mi.publisher) + update_field("criticalRating", mi.rating) + # need to check for None + if mi.comments: + update_field("comments", html2text(mi.comments)) + if mi.language: + update_field("language", lang_as_iso639_1(mi.language)) + if mi.pubdate != UNDEFINED_DATE: + update_field("year", mi.pubdate.year) + update_field("month", mi.pubdate.month) + update_field("day", mi.pubdate.day) + + # check for gtin in identifiers + if 'gtin' in mi.identifiers: + update_field("gtin", mi.identifiers['gtin']) + # if no gtin use isbn + elif 'isbn' in mi.identifiers: + update_field("gtin", mi.identifiers['isbn']) + + # custom columns + field = partial(self.db.field_for, book_id=self.book_id) + + # artists + role("Penciller", field(prefs['penciller_column'])) + role("Inker", field(prefs['inker_column'])) + role("Colorist", field(prefs['colorist_column'])) + role("Letterer", field(prefs['letterer_column'])) + role("CoverArtist", field(prefs['cover_artist_column'])) + role("Editor", field(prefs['editor_column'])) + role("Translator", field(prefs['translator_column'])) + # others + update_field("storyArc", field(prefs['storyarc_column'])) + update_field("characters", field(prefs['characters_column'])) + update_field("teams", field(prefs['teams_column'])) + update_field("locations", field(prefs['locations_column'])) + update_field("volume", field(prefs['volume_column'])) + update_field("genre", field(prefs['genre_column'])) + update_field("issueCount", field(prefs['count_column'])) + update_field("pageCount", field(prefs['pages_column'])) + update_field("webLink", get_link(field(prefs['comicvine_column']))) + update_field("manga", field(prefs['manga_column'])) + + def convert_comic_md_to_calibre_md(self, comic_metadata): + ''' + Maps the entries in the comic_metadata to calibre metadata + ''' + import unicodedata + from calibre.ebooks.metadata import MetaInformation + from calibre.utils.date import parse_only_date + from datetime import date + from calibre.utils.localization import calibre_langcode_to_name + + if self.comic_md_in_calibre_format: + return + + # start with a fresh calibre metadata + mi = MetaInformation(None, None) + co = comic_metadata + + # shorten some functions + role = partial(get_role, credits=co.credits) + update_field = partial(update_calibre_field, target=mi) + + # Get title, if no title, try to assign series infos + if co.title: + mi.title = co.title + elif co.series: + mi.title = co.series + if co.issue: + mi.title += " " + str(co.issue) + else: + mi.title = "" + + # tags + if co.tags != [] and prefs['import_tags']: + if prefs['overwrite_calibre_tags']: + mi.tags = co.tags + else: + mi.tags = list(set(self.calibre_metadata.tags + co.tags)) + + # simple metadata + update_field("authors", role(WRITER)) + update_field("series", co.series) + update_field("rating", co.criticalRating) + update_field("publisher", co.publisher) + # special cases + if co.language: + update_field("language", calibre_langcode_to_name(co.language)) + if co.comments: + update_field("comments", co.comments.strip()) + # issue + if co.issue: + try: + if not python3 and isinstance(co.issue, unicode): + mi.series_index = unicodedata.numeric(co.issue) + else: + mi.series_index = float(co.issue) + except ValueError: + pass + # pub date + puby = co.year + pubm = co.month + pubd = co.day + if puby is not None: + try: + dt = date( + int(puby), + 6 if pubm is None else int(pubm), + 15 if pubd is None else int(pubd) + ) + dt = parse_only_date(str(dt)) + mi.pubdate = dt + except: + pass + # gtin + if co.gtin: + mi.set_identifiers({"gtin": co.gtin}) + + # custom columns + update_column = partial(update_custom_column, calibre_metadata=mi, + custom_cols=self.db.field_metadata.custom_field_metadata()) + # artists + update_column(prefs['penciller_column'], role(PENCILLER)) + update_column(prefs['inker_column'], role(INKER)) + update_column(prefs['colorist_column'], role(COLORIST)) + update_column(prefs['letterer_column'], role(LETTERER)) + update_column(prefs['cover_artist_column'], role(COVER_ARTIST)) + update_column(prefs['editor_column'], role(EDITOR)) + update_column(prefs['translator_column'], role(TRANSLATOR)) + # others + update_column(prefs['storyarc_column'], co.storyArc) + update_column(prefs['characters_column'], co.characters) + update_column(prefs['teams_column'], co.teams) + update_column(prefs['locations_column'], co.locations) + update_column(prefs['genre_column'], co.genre) + ensure_int(co.issueCount, update_column, prefs['count_column'], co.issueCount) + ensure_int(co.volume, update_column, prefs['volume_column'], co.volume) + if prefs['auto_count_pages']: + update_column(prefs['pages_column'], self.count_pages()) + else: + update_column(prefs['pages_column'], co.pageCount) + if prefs['get_image_sizes']: + update_column(prefs['image_size_column'], self.get_picture_size()) + update_column(prefs['comicvine_column'], 'Comic Vine'.format(co.webLink)) + update_column(prefs['manga_column'], co.manga) + + self.comic_md_in_calibre_format = mi + + def make_temp_cbz_file(self): + if not self.file and self.format == "cbz": + self.file = self.db.format(self.book_id, "cbz", as_path=True) + + def convert_cbr_to_cbz(self): + ''' + Converts a rar or cbr-comic to a cbz-comic + ''' + from calibre.utils.unrar import extract, comment + + with TemporaryDirectory('_cbr2cbz') as tdir: + # extract the rar file + ffile = self.db.format(self.book_id, self.format, as_path=True) + extract(ffile, tdir) + comments = comment(ffile) + delete_temp_file(ffile) + + # make the cbz file + with TemporaryFile("comic.cbz") as tf: + zf = ZipFile(tf, "w") + add_dir_to_zipfile(zf, tdir) + if comments: + zf.comment = comments.encode("utf-8") + zf.close() + # add the cbz format to calibres library + self.db.add_format(self.book_id, "cbz", tf) + self.format = "cbz" + + def convert_zip_to_cbz(self): + import os + + zf = self.db.format(self.book_id, "zip", as_path=True) + new_fname = os.path.splitext(zf)[0] + ".cbz" + os.rename(zf, new_fname) + self.db.add_format(self.book_id, "cbz", new_fname) + delete_temp_file(new_fname) + self.format = "cbz" + + def update_cover(self): + # get the calibre cover + cover_path = self.db.cover(self.book_id, as_path=True) + fmt = cover_path.rpartition('.')[-1] + new_cover_name = "00000000_cover." + fmt + + self.make_temp_cbz_file() + + # search for a previously embeded cover + zf = ZipFile(self.file) + cover_info = "" + for name in zf.namelist(): + if name.rsplit(".", 1)[0] == "00000000_cover": + cover_info = name + break + zf.close() + + # delete previous cover + if cover_info != "": + with open(self.file, 'r+b') as zf, open(cover_path, 'r+b') as cp: + safe_replace(zf, cover_info, cp) + + # save the cover in the file + else: + zf = ZipFile(self.file, "a") + zf.write(cover_path, new_cover_name) + zf.close() + + delete_temp_file(cover_path) + + def count_pages(self): + self.make_temp_cbz_file() + zf = ZipFile(self.file) + pages = 0 + for name in zf.namelist(): + if name.lower().rpartition('.')[-1] in IMG_EXTENSIONS: + pages += 1 + zf.close() + return pages + + def action_count_pages(self): + pages = self.count_pages() + if pages == 0: + return False + update_custom_column(prefs['pages_column'], str(pages), self.calibre_metadata, + self.db.field_metadata.custom_field_metadata()) + self.db.set_metadata(self.book_id, self.calibre_metadata) + return True + + def get_picture_size(self): + from calibre.utils.magick import Image + + self.make_temp_cbz_file() + zf = ZipFile(self.file) + files = zf.namelist() + + size_x, size_y = 0, 0 + index = 1 + while index < 10 and index < len(files): + fname = files[index] + if fname.lower().rpartition('.')[-1] in IMG_EXTENSIONS: + with zf.open(fname) as ffile: + img = Image() + try: + img.open(ffile) + size_x, size_y = img.size + except: + pass + if size_x < size_y: + break + index += 1 + zf.close() + size = round(size_x * size_y / 1000000, 2) + return size + + def action_picture_size(self): + size = self.get_picture_size() + if not size: + return False + update_custom_column(prefs['image_size_column'], size, self.calibre_metadata, + self.db.field_metadata.custom_field_metadata()) + self.db.set_metadata(self.book_id, self.calibre_metadata) + return True + + def remove_embedded_metadata(self): + # Ensure we have a temp file + self.make_temp_cbz_file() + + ''' + Remove the cix_metadata + ''' + # search for ComicInfo.xml + zf = ZipFile(self.file) + cix_name = None + for name in zf.namelist(): + if name.lower() == "comicinfo.xml": + cix_name = name + break + zf.close() + + # Remove ComicInfo.xml from the file + if cix_name is not None: + with open(self.file, 'r+b') as zf: + safe_delete(zf, cix_name) + + ''' + Removes the cbi_metadata + ''' + # open the zipfile + zf = ZipFile(self.file, 'a') + + # Remove the metadata from the comment + cbi_string = '' + + zf.comment = cbi_string.encode("utf-8") + zf._didModify = True + zf.close() + + return True + + def get_comic_metadata_from_cbz(self): + ''' + Reads the comic metadata from the comic cbz file as comictagger metadata + ''' + self.make_temp_cbz_file() + # open the zipfile + zf = ZipFile(self.file) + + # get cix metadata + for name in zf.namelist(): + if name.lower() == "comicinfo.xml": + self.cix_metadata = ComicInfoXml().metadataFromString(zf.read(name)) + self.zipinfo = name + break + + # get the cbi metadata + if ComicBookInfo().validateString(zf.comment): + self.cbi_metadata = ComicBookInfo().metadataFromString(zf.comment) + zf.close() + + # get combined metadata + self._get_combined_metadata() + + def get_comic_metadata_from_cbr(self): + ''' + Reads the comic metadata from the comic cbr file as comictagger metadata + and returns the metadata depending on do_action + ''' + from calibre.utils.unrar import extract_member, names, comment + + ffile = self.db.format(self.book_id, "cbr", as_path=True) + with open(ffile, 'rb') as stream: + # get the cix metadata + fnames = list(names(stream)) + for name in fnames: + if name.lower() == "comicinfo.xml": + self.cix_metadata = extract_member(stream, match=None, name=name)[1] + self.cix_metadata = ComicInfoXml().metadataFromString(self.cix_metadata) + break + + # get the cbi metadata + comments = comment(ffile) + if ComicBookInfo().validateString(comments): + self.cbi_metadata = ComicBookInfo().metadataFromString(comments) + + delete_temp_file(ffile) + self._get_combined_metadata() + + def _get_combined_metadata(self): + ''' + Combines the metadata from both sources + ''' + self.comic_metadata = GenericMetadata() + if self.cbi_metadata is not None: + self.comic_metadata.overlay(self.cbi_metadata, False) + if self.cix_metadata is not None: + self.comic_metadata.overlay(self.cix_metadata, False) + if self.cbi_metadata is None and self.cix_metadata is None: + self.comic_metadata = None + + +# Helper Functions +# ------------------------------------------------------------------------------ + +def update_comic_field(field, source, target): + ''' + Sets the attribute field of target to the value of source + ''' + if source: + setattr(target, field, source) + + +def update_calibre_field(field, source, target): + ''' + Sets the attribute field of target to the value of source + ''' + if source: + target.set(field, source) + + +def update_custom_column(col_name, value, calibre_metadata, custom_cols): + ''' + Updates the given custom column with the name of col_name to value + ''' + if col_name and value: + col = custom_cols[col_name] + col['#value#'] = value + calibre_metadata.set_user_metadata(col_name, col) + + +def get_role(role, credits): + ''' + Gets a list of persons with the given role. + ''' + from calibre.ebooks.metadata import author_to_author_sort + + if prefs['swap_names']: + return [author_to_author_sort(credit['person']) for credit in credits + if credit['role'].lower() in role] + return [credit['person'] for credit in credits + if credit['role'].lower() in role] + + +def set_role(role, persons, credits): + ''' + Sets all persons with the given role to credits + ''' + if persons and len(persons) > 0: + for person in persons: + credits.append({'person': swap_author_names_back(person), + 'role': role}) + + +def swap_author_names_back(author): + if author is None: + return author + if ',' in author: + parts = author.split(',') + if len(parts) <= 1: + return author + surname = parts[0] + return '%s %s' % (' '.join(parts[1:]), surname) + return author + + +def delete_temp_file(ffile): + try: + import os + if os.path.exists(ffile): + os.remove(ffile) + except: + pass + + +def get_link(text): + import re + + if text: + link = re.findall(']*)', text) + if link: + return link[0] + return "" + + +def ensure_int(value, func, *args): + try: + _ = int(value) + func(*args) + except (ValueError, TypeError): + pass + + +# from calibres zipfile utility +def add_dir_to_zipfile(zf, path, prefix=''): + ''' + Add a directory recursively to the zip file with an optional prefix. + ''' + if prefix: + zf.writestr(prefix+'/', b'') + fp = (prefix + ('/' if prefix else '')).replace('//', '/') + for f in os.listdir(path): + arcname = fp + f + f = os.path.join(path, f) + if os.path.isdir(f): + add_dir_to_zipfile(zf, f, prefix=arcname) + else: + zf.write(f, arcname) + + +def safe_delete(zipstream, name): + ''' + Delete a file in a zip file in a safe manner. This proceeds by extracting + and re-creating the zipfile. This is necessary because :method:`ZipFile.delete` + sometimes created corrupted zip files. + + + :param zipstream: Stream from a zip file + :param name: The name of the file to delete + + ''' + from calibre.ptempfile import SpooledTemporaryFile + import shutil + + z = ZFile(zipstream, 'r') + + with SpooledTemporaryFile(max_size=100*1024*1024) as temp: + ztemp = ZFile(temp, 'a') + for obj in z.infolist(): + if isinstance(obj.filename, str): + obj.flag_bits |= 0x16 # Set isUTF-8 bit + # Write all files to new zipfile except the deleted file + if obj.filename != name: + ztemp.writestr(obj, z.read_raw(obj), raw_bytes=True) + ztemp.close() + z.close() + temp.seek(0) + zipstream.seek(0) + zipstream.truncate() + shutil.copyfileobj(temp, zipstream) + zipstream.flush() diff --git a/config.py b/config.py new file mode 100644 index 0000000..a76357e --- /dev/null +++ b/config.py @@ -0,0 +1,191 @@ +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2015, dloraine' +__docformat__ = 'restructuredtext en' + +try: + from PyQt5.Qt import (QWidget, QCheckBox, QGridLayout, QVBoxLayout, + QGroupBox, QComboBox, QLabel, QButtonGroup, QScrollArea) +except ImportError: + from PyQt4.Qt import (QWidget, QCheckBox, QGridLayout, QScrollArea, + QVBoxLayout, QGroupBox, QComboBox, QLabel, QButtonGroup) + +from functools import partial + +from calibre.utils.config import JSONConfig +from calibre_plugins.EmbedComicMetadata.ini import ( + get_configuration, CONFIG_NAME, CONFIG_TITLE, CONFIG_DEFAULT, CONFIG_COLUMN_TYPE) + +import sys + +python3 = sys.version_info[0] > 2 + +# python 2/3 compatibility +def iteritems(d): + if python3: + return iter(d.items()) + return iter(d.iteritems()) + + +# This is where all preferences for this plugin will be stored +# Remember that this name (i.e. plugins/interface_demo) is also +# in a global namespace, so make it as unique as possible. +# You should always prefix your config file name with plugins/, +# so as to ensure you dont accidentally clobber a calibre config file +prefs = JSONConfig('plugins/EmbedComicMetadata') + +config = get_configuration() + +# set defaults +prefs.defaults = {item[CONFIG_NAME]: item[CONFIG_DEFAULT] + for group in config for item in group["Items"]} + + +class ConfigWidget(QWidget): + + def __init__(self, ia): + QWidget.__init__(self) + self.ia = ia + self.layout = QVBoxLayout() + self.setLayout(self.layout) + + # make the config menu as a widget + self.config_menu = self.make_menu() + + # make a scroll area to hold the menu and add it to the layout + self.scroll = QScrollArea() + self.scroll.setWidget(self.config_menu) + self.layout.addWidget(self.scroll) + + def save_settings(self): + for group in config: + if group["Type"] == "columnboxes": + func = self.CustomColumnComboBox.get_selected_column + else: + func = QCheckBox.isChecked + for item in group["Items"]: + name = getattr(self, item[CONFIG_NAME]) + prefs[item[CONFIG_NAME]] = func(name) + # rebuild the menu + self.ia.toggle_menu_items() + + def make_menu(self): + config_menu = QWidget() + self.l = QVBoxLayout() + config_menu.setLayout(self.l) + + # add the menu items + for group in config: + self.make_submenu(group, self.l) + + return config_menu + + def make_submenu(self, group, parent): + lo = self.make_groupbox(group, parent) + + # get the right builder function for the group type + if group["Type"] == "checkboxes": + func = partial(self.make_checkbox, lo, group["Columns"]) + else: + func = partial(self.make_columnbox, lo, group["Columns"]) + + # loop through the items and build the entries + grid_row, grid_column = 1, 0 + for item in group["Items"]: + grid_row, grid_column = func(item, grid_row, grid_column) + + # make buttons exclusive + if "Exclusive_Items" in group: + for item_list in group["Exclusive_Items"]: + self.make_exclusive(item_list) + + def make_exclusive(self, item_list): + excl_group = QButtonGroup(self) + for item in item_list: + item = getattr(self, item) + excl_group.addButton(item) + + def make_groupbox(self, group, parent): + groupbox = QGroupBox(group["Title"], self) + setattr(self, group["Name"] + "_box", groupbox) + parent.addWidget(groupbox) + groupbox_layout = QGridLayout() + setattr(self, group["Name"] + "_layout", groupbox_layout) + groupbox.setLayout(groupbox_layout) + return groupbox_layout + + def make_checkbox(self, parent, columns, item, grid_row, grid_column): + checkbox = QCheckBox(item[CONFIG_TITLE], self) + setattr(self, item[CONFIG_NAME], checkbox) + checkbox.setChecked(prefs[item[CONFIG_NAME]]) + parent.addWidget(checkbox, grid_row, grid_column) + + # check for new row + if grid_column < columns - 1: + return grid_row, grid_column + 1 + return grid_row + 1, 0 + + def make_columnbox(self, parent, columns, item, grid_row, grid_column): + # label + column_label = QLabel(item[CONFIG_TITLE], self) + setattr(self, item[CONFIG_NAME] + "label", column_label) + + # columnbox + available_columns = self.get_custom_columns(item[CONFIG_COLUMN_TYPE]) + column_box = self.CustomColumnComboBox(self, available_columns, prefs[item[CONFIG_NAME]]) + setattr(self, item[CONFIG_NAME], column_box) + + # put together and add + column_label.setBuddy(column_box) + parent.addWidget(column_label, grid_row, grid_column) + parent.addWidget(column_box, grid_row, grid_column + 1) + + # check for new row + if grid_column < columns / 2: + return grid_row, grid_column + 2 + return grid_row + 1, 0 + + def get_custom_columns(self, column_type): + ''' + Gets matching custom columns for column_type + ''' + custom_columns = self.ia.gui.library_view.model().custom_columns + available_columns = {} + for key, column in iteritems(custom_columns): + if (column["datatype"] in column_type["datatype"] and + bool(column["is_multiple"]) == column_type["is_multiple"] and + column['display'].get('is_names', False) == column_type['is_names']): + available_columns[key] = column + return available_columns + + # modified from CountPages + class CustomColumnComboBox(QComboBox): + + def __init__(self, parent, custom_columns={}, selected_column=''): + QComboBox.__init__(self, parent) + self.populate_combo(custom_columns, selected_column) + + def populate_combo(self, custom_columns, selected_column): + self.clear() + self.column_names = [] + selected_idx = 0 + custom_columns[""] = {"name": ""} + for key in sorted(custom_columns.keys()): + self.column_names.append(key) + self.addItem('%s' % (custom_columns[key]['name'])) + if key == selected_column: + selected_idx = len(self.column_names) - 1 + self.setCurrentIndex(selected_idx) + + def select_column(self, key): + selected_idx = 0 + for i, val in enumerate(self.column_names): + if val == key: + selected_idx = i + break + self.setCurrentIndex(selected_idx) + + def get_selected_column(self): + return self.column_names[self.currentIndex()] diff --git a/genericmetadata.py b/genericmetadata.py new file mode 100644 index 0000000..d2404ef --- /dev/null +++ b/genericmetadata.py @@ -0,0 +1,328 @@ +""" + A python class for internal metadata storage + + The goal of this class is to handle ALL the data that might come from various + tagging schemes and databases, such as ComicVine or GCD. This makes conversion + possible, however lossy it might be + +""" + +""" +Copyright 2012-2014 Anthony Beville + +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. +""" + + +# These page info classes are exactly the same as the CIX scheme, since it's unique +class PageType: + FrontCover = "FrontCover" + InnerCover = "InnerCover" + Roundup = "Roundup" + Story = "Story" + Advertisement = "Advertisement" + Editorial = "Editorial" + Letters = "Letters" + Preview = "Preview" + BackCover = "BackCover" + Other = "Other" + Deleted = "Deleted" + + +class GenericMetadata: + + def __init__(self): + + self.isEmpty = True + self.tagOrigin = None + + self.series = None + self.issue = None + self.title = None + self.publisher = None + self.month = None + self.year = None + self.day = None + self.issueCount = None + self.volume = None + self.genre = None + self.language = None # 2 letter iso code + self.comments = None # use same way as Summary in CIX + + self.volumeCount = None + self.criticalRating = None + self.country = None + + self.alternateSeries = None + self.alternateNumber = None + self.alternateCount = None + self.imprint = None + self.notes = None + self.webLink = None + self.format = None + self.manga = None + self.blackAndWhite = None + self.pageCount = None + self.maturityRating = None + + self.storyArc = None + self.seriesGroup = None + self.scanInfo = None + + self.characters = None + self.teams = None + self.locations = None + + self.credits = list() + self.tags = list() + self.pages = list() + + # Some CoMet-only items + self.price = None + self.isVersionOf = None + self.rights = None + self.identifier = None + self.lastMark = None + self.coverImage = None + + # Anansi Project extensions + self.gtin = None + + def overlay(self, new_md, overwrite=True): # changed for the calibre plugin + # Overlay a metadata object on this one + # that is, when the new object has non-None + # values, over-write them to this one + + def assign(cur, new): + if new is not None: + if type(new) == str and len(new) == 0: + if overwrite: + setattr(self, cur, None) + else: + setattr(self, cur, new) + + if not new_md.isEmpty: + self.isEmpty = False + + assign('series', new_md.series) + assign("issue", new_md.issue) + assign("issueCount", new_md.issueCount) + assign("title", new_md.title) + assign("publisher", new_md.publisher) + assign("day", new_md.day) + assign("month", new_md.month) + assign("year", new_md.year) + assign("volume", new_md.volume) + assign("volumeCount", new_md.volumeCount) + assign("genre", new_md.genre) + assign("language", new_md.language) + assign("country", new_md.country) + assign("criticalRating", new_md.criticalRating) + assign("alternateSeries", new_md.alternateSeries) + assign("alternateNumber", new_md.alternateNumber) + assign("alternateCount", new_md.alternateCount) + assign("imprint", new_md.imprint) + assign("webLink", new_md.webLink) + assign("format", new_md.format) + assign("manga", new_md.manga) + assign("blackAndWhite", new_md.blackAndWhite) + assign("maturityRating", new_md.maturityRating) + assign("storyArc", new_md.storyArc) + assign("seriesGroup", new_md.seriesGroup) + assign("scanInfo", new_md.scanInfo) + assign("characters", new_md.characters) + assign("teams", new_md.teams) + assign("locations", new_md.locations) + assign("comments", new_md.comments) + assign("notes", new_md.notes) + assign("pageCount", new_md.pageCount) + + assign("price", new_md.price) + assign("isVersionOf", new_md.isVersionOf) + assign("rights", new_md.rights) + assign("identifier", new_md.identifier) + assign("lastMark", new_md.lastMark) + assign("gtin", new_md.gtin) + + self.overlayCredits(new_md.credits, overwrite) + # TODO + + # not sure if the tags and pages should broken down, or treated + # as whole lists.... + + # For now, go the easy route, where any overlay + # value wipes out the whole list + if len(new_md.tags) > 0: + assign("tags", new_md.tags) + + if len(new_md.pages) > 0: + assign("pages", new_md.pages) + + # modified for calibre, deletes old writers + def overlayCredits(self, new_credits, overwrite=True): + # changed for the calibre plugin + if overwrite: + roles_to_remove = set(c["role"].lower() for c in new_credits) + self.credits = [r for r in self.credits + if r["role"].lower() not in roles_to_remove] + + for c in new_credits: + if 'primary' in c and c['primary']: + primary = True + else: + primary = False + + # Remove credit role if person is blank + if c['person'] == "": + for r in reversed(self.credits): + if r['role'].lower() == c['role'].lower(): + self.credits.remove(r) + + # otherwise, add it! + else: + self.addCredit(c['person'], c['role'], primary) + + def setDefaultPageList(self, count): + # generate a default page list, with the first page marked as the cover + for i in range(count): + page_dict = dict() + page_dict['Image'] = str(i) + if i == 0: + page_dict['Type'] = PageType.FrontCover + self.pages.append(page_dict) + + def getArchivePageIndex(self, pagenum): + # convert the displayed page number to the page index of the file in the archive + if pagenum < len(self.pages): + return int(self.pages[pagenum]['Image']) + else: + return 0 + + def getCoverPageIndexList(self): + # return a list of archive page indices of cover pages + coverlist = [] + for p in self.pages: + if 'Type' in p and p['Type'] == PageType.FrontCover: + coverlist.append(int(p['Image'])) + + if len(coverlist) == 0: + coverlist.append(0) + + return coverlist + + def addCredit(self, person, role, primary=False): + + credit = dict() + credit['person'] = person + credit['role'] = role + if primary: + credit['primary'] = primary + + # look to see if it's not already there... + found = False + for c in self.credits: + if (c['person'].lower().strip() == person.lower().strip() and + c['role'].lower() == role.lower()): + # no need to add it. just adjust the "primary" flag as needed + c['primary'] = primary + found = True + break + + if not found: + self.credits.append(credit) + + def __str__(self): + vals = [] + if self.isEmpty: + return "No metadata" + + def add_string(tag, val): + if val is not None and u"{0}".format(val) != "": + vals.append((tag, val)) + + def add_attr_string(tag): + add_string(tag, getattr(self, tag)) + + add_attr_string("series") + add_attr_string("issue") + add_attr_string("issueCount") + add_attr_string("title") + add_attr_string("publisher") + add_attr_string("year") + add_attr_string("month") + add_attr_string("day") + add_attr_string("volume") + add_attr_string("volumeCount") + add_attr_string("genre") + add_attr_string("language") + add_attr_string("country") + add_attr_string("criticalRating") + add_attr_string("alternateSeries") + add_attr_string("alternateNumber") + add_attr_string("alternateCount") + add_attr_string("imprint") + add_attr_string("webLink") + add_attr_string("format") + add_attr_string("manga") + add_attr_string("pageCount") + + add_attr_string("price") + add_attr_string("isVersionOf") + add_attr_string("rights") + add_attr_string("identifier") + add_attr_string("lastMark") + add_attr_string("gtin") + + if self.blackAndWhite: + add_attr_string("blackAndWhite") + add_attr_string("maturityRating") + add_attr_string("storyArc") + add_attr_string("seriesGroup") + add_attr_string("scanInfo") + add_attr_string("characters") + add_attr_string("teams") + add_attr_string("locations") + add_attr_string("comments") + add_attr_string("notes") + + add_string("tags", listToString(self.tags)) + + for c in self.credits: + primary = "" + if 'primary' in c and c['primary']: + primary = " [P]" + add_string("credit", c['role'] + ": " + c['person'] + primary) + + # find the longest field name + flen = 0 + for i in vals: + flen = max(flen, len(i[0])) + flen += 1 + + # format the data nicely + outstr = "" + fmt_str = u"{0: <" + str(flen) + "} {1}\n" + for i in vals: + outstr += fmt_str.format(i[0] + ":", i[1]) + + return outstr + + +def listToString(l): + string = "" + if l is not None: + for item in l: + if len(string) > 0: + string += ", " + string += item + return string diff --git a/ini.py b/ini.py new file mode 100644 index 0000000..70b39c0 --- /dev/null +++ b/ini.py @@ -0,0 +1,161 @@ +from __future__ import (unicode_literals, division, absolute_import, + print_function) + +__license__ = 'GPL v3' +__copyright__ = '2015, dloraine' +__docformat__ = 'restructuredtext en' + + +# Define some column types +PERSON_TYPE = {"is_multiple": True, "is_names": True, "datatype": "text"} +TAG_TYPE = {"is_multiple": True, "is_names": False, "datatype": "text"} +FLOAT_TYPE = {"is_multiple": False, "is_names": False, "datatype": "float"} +INT_TYPE = {"is_multiple": False, "is_names": False, "datatype": "int"} +COMMENT_TYPE = {"is_multiple": False, "is_names": False, "datatype": "comments"} +SERIES_TYPE = {"is_multiple": False, "is_names": False, "datatype": "series"} +STORY_ARCH_TYPE = {"is_multiple": False, "is_names": False, "datatype": ["series", "text"]} +NUMBER_TYPE = {"is_multiple": False, "is_names": False, "datatype": ["int", "text"]} +ENUM_TYPE = {"is_multiple": False, "is_names": False, "datatype": ["enumeration", "text"]} + +# Some constants for ease of reading +CONFIG_NAME = 0 +CONFIG_TITLE = 1 +CONFIG_DEFAULT = 2 +CONFIG_COLUMN_TYPE = 3 +CONFIG_DESCRIPTION = 1 +CONFIG_TRIGGER_FUNC = 2 +CONFIG_TRIGGER_ARG = 3 +CONFIG_ARTISTS_COLUMNS = 0 +CONFIG_OTHER_COLUMNS = 1 +CONFIG_OPTIONS = 2 +CONFIG_MAIN_BUTTON = 3 +CONFIG_MENU = 4 + + +def get_configuration(): + ''' + All configuration for preferences and the UI-Menu is made with the + informations given here. No need to change anything in config.py or ui.py, + if new preferences or menu items need to be made. + + Name: The internal name for the preference group + Title: The Label in the config menu + Type: Either "columnboxes" or "checkboxes" + Columns: How many columns the group should have in the config menu + Items: The preferences in the menu group. Has the form: + [preference_name, displayed name, default_state, if column: columntype] + UI_Action_Items: The buttons in the toolbar menu. Has the form: + [name, displayed_text, triggerfunc, triggerfunc_arg] + ''' + from calibre_plugins.EmbedComicMetadata.languages.lang import _L + from calibre_plugins.EmbedComicMetadata.main import (embed_into_comic, + import_to_calibre, embed_cover, convert, count_pages, get_image_size, remove_metadata) + + # configuration + config = [ + { + "Name": "artists_custom_columns", + "Title": _L["Artists Custom Columns:"], + "Type": "columnboxes", + "Columns": 2, + "Items": [ + ["penciller_column", _L['Penciller:'], None, PERSON_TYPE], + ["inker_column", _L['Inker:'], None, PERSON_TYPE], + ["colorist_column", _L['Colorist:'], None, PERSON_TYPE], + ["letterer_column", _L['Letterer:'], None, PERSON_TYPE], + ["cover_artist_column", _L['Cover Artist:'], None, PERSON_TYPE], + ["editor_column", _L['Editor:'], None, PERSON_TYPE], + ["translator_column", _L['Translator:'], None, PERSON_TYPE] + ] + }, + { + "Name": "other_custom_columns", + "Title": _L["Other Custom Columns:"], + "Type": "columnboxes", + "Columns": 2, + "Items": [ + ["storyarc_column", _L['Story Arc:'], None, STORY_ARCH_TYPE], + ["characters_column", _L['Characters:'], None, TAG_TYPE], + ["teams_column", _L['Teams:'], None, TAG_TYPE], + ["locations_column", _L['Locations:'], None, TAG_TYPE], + ["volume_column", _L['Volume:'], None, NUMBER_TYPE], + ["genre_column", _L['Genre:'], None, TAG_TYPE], + ["count_column", _L['Number of issues:'], None, NUMBER_TYPE], + ["pages_column", _L['Pages:'], None, NUMBER_TYPE], + ["image_size_column", _L['Image size:'], None, FLOAT_TYPE], + ["comicvine_column", _L['Comicvine link:'], None, COMMENT_TYPE], + ["manga_column", _L['Manga:'], None, ENUM_TYPE] + ] + }, + { + "Name": "options", + "Title": _L["Options:"], + "Type": "checkboxes", + "Columns": 2, + "Items": [ + ["cbi_embed", _L['Write metadata in zip comment'], True], + ["cix_embed", _L['Write metadata in ComicInfo.xml'], True], + ["read_cbi", _L['Import metadata from zip comment'], True], + ["read_cix", _L['Import metadata from ComicInfo.xml'], True], + ["convert_cbr", _L['Auto convert cbr to cbz'], True], + ["convert_archives", _L['Also convert rar and zip to cbz'], False], + ["convert_reading", _L['Auto convert while importing to calibre'], False], + ["delete_cbr", _L['Delete cbr after conversion'], False], + ["swap_names", _L['Swap names to "LN, FN" when importing metadata'], False], + ["import_tags", _L['Import tags from comic metadata'], False], + ["overwrite_calibre_tags", _L['If checked, overwrites the tags in calibre.'], False], + ["auto_count_pages", _L['Auto count pages if importing'], False], + ["get_image_sizes", _L['Get the image size if importing'], False] + ] + }, + { + "Name": "main_button", + "Title": _L["Main Button Action (needs a calibre restart):"], + "Type": "checkboxes", + "Columns": 2, + "Items": [ + ["main_embed", _L['Embed metadata'], True], + ["main_import", _L['Import metadata'], False], + ], + "Exclusive_Items": [ + ["main_embed", "main_import"] + ] + }, + { + "Name": "menu", + "Title": _L["Menu Buttons:"], + "Type": "checkboxes", + "Columns": 2, + "Items": [ + ["embed", _L['Show embed both button'], True], + ["embedcbi", _L['Show embed cbi button'], False], + ["embedcix", _L['Show embed cix button'], False], + ["read_both", _L['Show import both button'], True], + ["import_cix", _L['Show import cix button'], False], + ["import_cbi", _L['Show import cbi button'], False], + ["convert", _L['Show convert button'], True], + ["count_pages", _L['Show count pages button'], True], + ["image_size", _L['Show get image size button'], False], + ["remove_metadata", _L['Show remove metadata button'], False], + ["cover", _L['Show embed cover button (experimental)'], False] + ], + "UI_Action_Items": [ + ["read_both", _L['Import Metadata from the comic archive into calibre'], import_to_calibre, "both"], + ["import_cix", _L["Import Comic Rack Metadata from the comic archive into calibre"], import_to_calibre, "cix"], + ["import_cbi", _L["Import Comment Metadata from the comic archive into calibre"], import_to_calibre, "cbi"], + ["seperator"], + ["embed", _L["Embed both Comic Metadata types"], embed_into_comic, "both"], + ["embedcbi", _L["Only embed Metadata in zip comment"], embed_into_comic, "cbi"], + ["embedcix", _L["Only embed Metadata in ComicInfo.xml"], embed_into_comic, "cix"], + ["seperator"], + ["convert", _L["Only convert to cbz"], convert, None], + ["cover", _L["Embed the calibre cover"], embed_cover, None], + ["count_pages", _L["Count pages"], count_pages, None], + ["image_size", _L["Get image size"], get_image_size, None], + ["remove_metadata", _L["Remove metadata"], remove_metadata, None], + ["seperator"] + ] + } + ] + + return config