diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..388215d --- /dev/null +++ b/TODO.md @@ -0,0 +1,12 @@ +- [ ] allow downloads of lists of albums, artists and tracks, and set their downloaded status +- [ ] write all metadata from tidal to downloaded tracks + +- [ ] get lists of favorited albums, artists and tracks +- [ ] allow export of these lists (with names, IDs and downloaded status) +- [ ] allow import of these lists + +- [ ] allow configuration with a toml file +- [ ] allow configuration of download path +- [ ] write log of errors + +- [ ] installer or pip package diff --git a/conf.toml b/conf.toml new file mode 100644 index 0000000..a4fee18 --- /dev/null +++ b/conf.toml @@ -0,0 +1,11 @@ +# All options postfixed "_dir" are expected to have a trailing slash! +skip_downloaded = true +error_log = "error.log" + +dest_dir = "./downloads/" +# The following templates are passed an artist, album and track object. +# Possible attributes can be found here: https://tidalapi.netlify.app/api.html +# The artist is derived from the album a track is in rather than the track itself. +dl_dir ="/tmp/tidal-scraper/{track.name}.part" +album_dir = "{artist.name}/{album.name}/" +track_name = "{track.track_num}: {track.name}" diff --git a/conf.yml b/conf.yml deleted file mode 100644 index 8659581..0000000 --- a/conf.yml +++ /dev/null @@ -1,5 +0,0 @@ -user id: -dl dir: 'downloading' -dest dir: 'downloaded' -authfile dir: '' -skip existing: true diff --git a/install.sh b/install.sh deleted file mode 100755 index 7d83814..0000000 --- a/install.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh -path='scrape_pyenv' -python3 -m venv scrape_pyenv -./scrape_pyenv/bin/pip install -r requirements.txt diff --git a/requirements.txt b/requirements.txt index 6d62597..55fc852 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ git+https://github.com/tamland/python-tidal -aigpy pycrypto -pyyaml +tqdm diff --git a/tidal-scraper/account.py b/tidal-scraper/account.py new file mode 100644 index 0000000..e69de29 diff --git a/tidal-scraper/download.py b/tidal-scraper/download.py new file mode 100644 index 0000000..06e6087 --- /dev/null +++ b/tidal-scraper/download.py @@ -0,0 +1,110 @@ +import helper +from helper import CONF, EXTENSIONS +import metadata + +import tidalapi +import os +import json + +from base64 import b64decode +from Crypto.Cipher import AES +from Crypto.Util import Counter +from typing import Tuple, BinaryIO +from shutil import move + + +def __decode_key_id(key_id) -> Tuple[bytes, bytes]: + master_key = b64decode("UIlTTEMmmLfGowo/UC60x2H45W6MdGgTRfo/umg4754=") + decoded_key_id = b64decode(key_id) + init_vector = decoded_key_id[:16] + encrypted_token = decoded_key_id[16:] + + decryptor = AES.new(master_key, AES.MODE_CBC, init_vector) + decrypted_token = decryptor.decrypt(encrypted_token) + + key = decrypted_token[:16] + nonce = decrypted_token[16:24] + + return key, nonce + + +def __decrypt_file( + input_file: BinaryIO, output_file: BinaryIO, key: bytes, nonce: bytes +) -> None: + counter = Counter.new(64, prefix=nonce, initial_value=0) + decryptor = AES.new(key, AES.MODE_CTR, counter=counter) + data = decryptor.decrypt(input_file.read()) + output_file.write(data) + + +def set_metadata(): + pass + + +def download_track( + track: tidalapi.Track, + album: tidalapi.Album, +) -> None: + dl_path = helper.clean_template(CONF["dl_dir"]) + dest_path = helper.clean_template( + CONF["dest_dir"] + CONF["album_dir"] + CONF["track_name"], + track=track, + album=album, + artist=album.artist, + ) + try: + stream = track.stream() + manifest = json.loads(b64decode(stream.manifest)) + url = manifest["urls"][0] + codec = manifest['codecs'] + for ext in EXTENSIONS: + if ext in url and ext is not ".mp4": + dest_path += ext + elif ".mp4" in url: + if "ac4" in stream.codec or "mha1" in stream.codec: + dest_path += ".mp4" + else: + dest_path += ".m4a" + if os.path.exists(dest_path + ext) and CONF["skip_downloaded"]: + print("Skipping downloaded song") + return + + key_id = manifest.get("keyId", None) + os.makedirs(os.path.dirname(dest_path), exist_ok=True) + with open(dest_path, "wb") as f: + # TODO: DOWNLOAD + pass + + if key_id: + key, nonce = __decode_key_id(key_id) + with open(dl_path, "rb") as i, open(dest_path, "wb") as o: + __decrypt_file(i, o, key, nonce) + else: + move(dl_path, dest_path) + + assert track.name is not None + assert album.name is not None + metadata.write(f, codec, track.name, album.name, str(track.track_num), str(album.num_tracks)) + except: + assert album.artist is not None + helper.log_error( + "Failure while downloading {artist} - {album} - {track}:", + artist=album.artist.name, + album=album.name, + track=track.name, + ) + # stack trace is printed by log_error() + + +def download_cover(album: tidalapi.Album) -> None: + dest_path = helper.clean_template( + CONF["dest_dir"] + CONF["album_dir"], + album=album, + artist=album.artist, + ) + url = album.image(1280) + + if os.path.exists(dest_path) and CONF["skip_downloaded"]: + return + + # TODO: DOWNLOAD diff --git a/tidal-scraper/helper.py b/tidal-scraper/helper.py new file mode 100644 index 0000000..5668361 --- /dev/null +++ b/tidal-scraper/helper.py @@ -0,0 +1,19 @@ +import re +import tomllib +import sys +import traceback + +with open("../config.toml", "rb") as conf: + CONF = tomllib.load(conf) + +EXTENSIONS = ['.flac', '.mp4', '.m4a', ''] + +def clean_template(path: str, **kwargs) -> str: + split = path.split("/") + cleaned_split = [re.sub("/", " ", s.format(**kwargs)) for s in split] + return "/".join(cleaned_split) + +def log_error(template: str, **kwargs): + with open(CONF['error_log']) as f: + f.write(template.format(**kwargs)) + traceback.print_exception(*sys.exc_info(), file=f) diff --git a/tidal-scraper/metadata.py b/tidal-scraper/metadata.py new file mode 100644 index 0000000..34a319e --- /dev/null +++ b/tidal-scraper/metadata.py @@ -0,0 +1,132 @@ +from typing import BinaryIO +from mutagen import flac, mp4 # , mp3 + +from mutagen.mp4 import MP4Tags +from mutagen._vorbis import VCommentDict + +# from mutagen.id3._tags import ID3Tags + +# from mutagen.id3._frames import ( +# APIC, +# TALB, +# TCOP, +# TDRC, +# TIT2, +# TPE1, +# TRCK, +# TOPE, +# TCON, +# TCOM, +# TSRC, +# USLT, +# ) + + +def __write_flac(file: flac.FLAC, **kwargs) -> None: + tags = VCommentDict() + tags["title"] = kwargs["title"] + tags["album"] = kwargs["album"] + # There doesn't seem to be a standard way of listing multiple artists in an ID3 tag + # This method seems to be the most widely recognized + tags["albumartist"] = "; ".join(kwargs["albumartist"]) + tags["artist"] = "; ".join(kwargs["artist"]) + tags["copyright"] = kwargs["copyright"] + tags["tracknumber"] = kwargs["tracknumber"] + tags["tracktotal"] = kwargs["tracktotal"] + tags["discnumber"] = kwargs["discnumber"] + tags["disctotal"] = kwargs["disctotal"] + tags["genre"] = kwargs["genre"] + tags["date"] = kwargs["date"] + tags["composer"] = kwargs["composer"] + tags["isrc"] = kwargs["isrc"] + tags["lyrics"] = kwargs["lyrics"] + file.tags = tags + + pic = flac.Picture() + pic.data = kwargs["cover"] + pic.mime = kwargs["cover_mime"] + file.clear_pictures() + file.add_picture(pic) + + file.save() + + +def __write_mp4(file: mp4.MP4, **kwargs) -> None: + tags = MP4Tags() + tags["\xa9nam"] = kwargs["title"] + tags["\xa9alb"] = kwargs["album"] + tags["aART"] = kwargs["albumartist"] + tags["\xa9ART"] = kwargs["artist"] + tags["cprt"] = kwargs["copyright"] + tags["trkn"] = [[kwargs["tracknumber"], kwargs["totaltrack"]]] + tags["disk"] = [[kwargs["discnumber"], kwargs["totaldisc"]]] + tags["\xa9gen"] = kwargs["genre"] + tags["\xa9day"] = kwargs["date"] + tags["\xa9wrt"] = kwargs["composer"] + tags["\xa9lyr"] = kwargs["lyrics"] + + file.tags = tags + file.save + + +# def __write_mp3(file: mp3.MP3, **kwargs) -> None: +# tags = ID3Tags() +# tags.add(TIT2(encoding=3, text=kwargs["title"])) +# tags.add(TALB(encoding=3, text=kwargs["album"])) +# tags.add(TOPE(encoding=3, text=kwargs["albumartist"])) +# tags.add(TPE1(encoding=3, text=kwargs["artist"])) +# tags.add(TCOP(encoding=3, text=kwargs["copyright"])) +# tags.add(TRCK(encoding=3, text=kwargs["tracknumber"])) +# tags.add(TCON(encoding=3, text=kwargs["genre"])) +# tags.add(TDRC(encoding=3, text=kwargs["date"])) +# tags.add(TCOM(encoding=3, text=kwargs["composer"])) +# tags.add(TSRC(encoding=3, text=kwargs["isrc"])) +# tags.add(USLT(encoding=3, text=kwargs["lyrics"])) +# tags.add(APIC(encoding=3, data=kwargs["cover"], mime=kwargs["cover_mime"])) +# +# match kwargs['cover_mime']: +# case 'image/jpeg': +# fmt = mp4.AtomDataType(13) +# case 'image/png': +# fmt = mp4.AtomDataType(14) +# case _: +# fmt = None +# +# if fmt is not None: +# pic = mp4.MP4Cover(kwargs['cover']) +# pic.imageformat = fmt +# +# file.tags = tags +# file.save() + + +def write( + fp: BinaryIO, + codec: str, + title: str, + album: str, + tracknumber: str, + tracktotal: str, + discnumber: str = "", + disctotal: str = "", + artist: list[str] = [""], + albumartist: list[str] = [""], + genre: str = "", + date: str = "", + composer: str = "", + isrc: str = "", + lyrics: str = "", + copyright: str = "", + cover: bytes | None = None, + cover_mime: str | None = None, +): + args = locals() + # TODO: Figure out what codecs are sent in the manifest + # WARN: This match is currently using placeholders + match codec: + case "???flac???": + file = flac.FLAC(fp) + __write_flac(file, *args) + case "???aac???": + file = mp4.MP4(fp) + __write_mp4(file, *args) diff --git a/tidal_cleanup.py b/tidal_cleanup.py deleted file mode 100755 index 6d78378..0000000 --- a/tidal_cleanup.py +++ /dev/null @@ -1,53 +0,0 @@ -#!/bin/env python -import tidalapi - -USER_ID = 188721652 - -def idExists(objects: list, id: int) -> bool: - for obj in objects: - if obj.id == id: - return True - return False - - -config = tidalapi.Config(quality=tidalapi.Quality.lossless) -session = tidalapi.Session(config) -user = session.get_user(USER_ID) -favorites = tidalapi.user.Favorites(session, user.id) - -existing_artists = favorites.artists() -existing_albums = favorites.albums() -existing_tracks = favorites.tracks() -for album in existing_albums: - # ADD ARTIST - print(album.artist.name, end=" ") - if not idExists(existing_artists, album.artist.id): - if favorites.add_artist(album.artist.id): - print("added!") - else: - print("failed!") - pass - else: - print("skipped!") - # ADD TRACKS - for track in album.tracks(): - print(track.name, end=" ") - if not idExists(existing_tracks, track.id): - if favorites.add_track(track.id): - print("added!") - else: - print("failed!") - pass - else: - print("skipped!") - -existing_tracks = favorites.tracks() -for track in existing_tracks: - print(track.album.name, end=" ") - if not idExists(existing_albums, track.album.id): - if favorites.add_album(track.album.id): - print("added!") - else: - print("failed!") - else: - print("skipped!") diff --git a/tidal_scrape.py b/tidal_scrape.py deleted file mode 100755 index d53fded..0000000 --- a/tidal_scrape.py +++ /dev/null @@ -1,185 +0,0 @@ -#!/bin/env python3 -import tidalapi -import aigpy.tagHelper -import aigpy.downloadHelper -import json -import sys -import base64 -import os -import time -import re -import yaml -from Crypto.Cipher import AES -from Crypto.Util import Counter -from typing import Tuple -from datetime import datetime - -with open("conf.yml", "r") as f: - conf = yaml.safe_load(f) - USER_ID = conf["user id"] - DL_PATH = conf["dl dir"] or '.' - DEST_PATH = conf["dest dir"] or '.' - AUTH_PATH = conf["authfile dir"] or '.' - SKIP_DOWNLOADED = conf["skip existing"] - -config = tidalapi.Config(quality=tidalapi.Quality.lossless) -session = tidalapi.Session(config) - - -def decrypt_token(token) -> Tuple[bytes, bytes]: - master_key = "UIlTTEMmmLfGowo/UC60x2H45W6MdGgTRfo/umg4754=" - master_key = base64.b64decode(master_key) - security_token = base64.b64decode(token) - iv = security_token[:16] - encrypted_st = security_token[16:] - - decryptor = AES.new(master_key, AES.MODE_CBC, iv) - decrypted_st = decryptor.decrypt(encrypted_st) - - key = decrypted_st[:16] - nonce = decrypted_st[16:24] - - return key, nonce - - -def decrypt_file(input_file, output_file, key, nonce) -> None: - counter = Counter.new(64, prefix=nonce, initial_value=0) - decryptor = AES.new(key, AES.MODE_CTR, counter=counter) - - with open(input_file, "rb") as i: - data = decryptor.decrypt(i.read()) - - with open(output_file, "wb") as o: - o.write(data) - - -def set_metadata(track: tidalapi.Track, file: str) -> None: - # This function could be more fleshed out (lyrics, covers) - # but I will leave that to external programs - tagger = aigpy.tagHelper.TagTool(file) - - tagger.title = track.name - tagger.artist = list(map(lambda artist: artist.name, track.artists)) # type: ignore[reportOptionalMemberAccess] - tagger.copyright = track.copyright - tagger.tracknumber = track.track_num - tagger.discnumber = track.volume_num - - tagger.album = track.album.name # type: ignore[reportOptionalMemberAccess] - tagger.albumartist = list(map(lambda artist: artist.name, track.album.artists)) # type: ignore[reportOptionalMemberAccess] - tagger.date = track.album.available_release_date # type: ignore[reportOptionalMemberAccess] - tagger.totaldisc = track.album.num_volumes or 0 # type: ignore[reportOptionalMemberAccess] - if tagger.totaldisc <= 1: - tagger.totaltrack = track.album.num_tracks # type: ignore[reportOptionalMemberAccess] - - tagger.save() - - -def download_track( - track: tidalapi.Track, - partSize: int = 1048576, -) -> Tuple[bool, str]: - try: - album_name = re.sub("/", " ", track.album.name) # type: ignore[reportOptionalMemberAccess] - track_name = re.sub("/", " ", track.name) # type: ignore[reportOptionalMemberAccess] - # artist_name = re.sub("/", " ", track.album.artist.name) # type: ignore[reportOptionalMemberAccess] - dl_path = f"{DL_PATH}/{track.track_num} {track_name}.part" # type: ignore[reportOptionalMemberAccess] - dest_path = f"{DEST_PATH}/{album_name}/{track.track_num} {track_name}" # type: ignore[reportOptionalMemberAccess] - - for ext in ['.flac', '.mpf', '.m4a', '']: - if os.path.exists(dest_path + ext) and SKIP_DOWNLOADED: - print("Skipping downloaded song") - return False, "Skipping downloaded song" - - stream = track.stream() - stream.manifest = json.loads(base64.b64decode(stream.manifest)) - url = stream.manifest["urls"][0] - if '.flac' in url: - dest_path += '.flac' - elif '.mp4' in url: - if 'ac4' in stream.codec or 'mha1' in stream.codec: - dest_path += '.mp4' - else: - dest_path += '.m4a' - - try: - key = stream.manifest["keyId"] - except KeyError: - key = None - tool = aigpy.downloadHelper.DownloadTool(dl_path, [url]) - - tool.setPartSize(partSize) - check, err = tool.start(True, 1) - if not check: - return False, str(err) - - os.makedirs(os.path.dirname(dest_path), exist_ok=True) - if key: - key, nonce = decrypt_token(key) - decrypt_file(dl_path, dest_path, key, nonce) - else: - os.replace(dl_path, dest_path) - - set_metadata(track, dest_path) - - return True, "Successfully downloaded!" - except Exception as msg: - print(str(msg)) - return False, str(msg) - - -def download_cover(album: tidalapi.Album) -> None: - album_name = re.sub("/", " ", album.name) # type: ignore[reportOptionalMemberAccess] - # artist_name = re.sub("/", " ", album.artist.name) # type: ignore[reportOptionalMemberAccess] - dest_path = f"{DEST_PATH}/{album_name}/cover.png" # type: ignore[reportOptionalMemberAccess] - url = album.image(1280) - - if os.path.exists(dest_path) and SKIP_DOWNLOADED: - return - - aigpy.net.downloadFile(url, dest_path) - - -auth_path = f"{AUTH_PATH}/auth.json" -try: - with open(auth_path, "rb") as f: - a = json.load(f) - expiry_time = a["expiry_time"].split(".", 1)[0] - expiry_time = datetime.strptime(expiry_time, "%Y-%m-%d %H:%M:%S") - session.load_oauth_session( - a["token_type"], a["access_token"], a["refresh_token"], expiry_time - ) - os.chmod(auth_path, 0o600) -except (OSError, IndexError): - session.login_oauth_simple() - -if session.check_login(): - with open(auth_path, "w") as f: - json.dump( - { - "token_type": session.token_type, - "access_token": session.access_token, - "refresh_token": session.refresh_token, - "expiry_time": str(session.expiry_time), - }, - f, - ) -else: - sys.exit("Failed to log in") - -user = session.get_user(USER_ID) -favorites = tidalapi.user.Favorites(session, user.id) -albums = favorites.albums() -num_albums = len(albums) -for i, album in enumerate(albums): - print(f"Starting {i + 1}/{num_albums}: {album.name} - {album.artist.name}") - download_cover(album) - tracks = album.tracks() - num_tracks = len(tracks) - for j, track in enumerate(tracks): - print(f"Downloading {j + 1}/{num_tracks}: {track.name}") # type: ignore[reportOptionalMemberAccess] - check, _ = download_track(track) - if check: - time.sleep(2) - else: - time.sleep(0.5) - print() diff --git a/todo b/todo deleted file mode 100644 index 828c803..0000000 --- a/todo +++ /dev/null @@ -1,4 +0,0 @@ -configurable sleep timer -add search function -configure what to dl -error log