diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6f4f2d9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +__pycache__/ +bluezip.db +flashpoint.sqlite +DB_PATH diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /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/_CONVERT.bat b/_CONVERT.bat new file mode 100644 index 0000000..85fc0c5 --- /dev/null +++ b/_CONVERT.bat @@ -0,0 +1,4 @@ +@echo off +cd /d %~dp0 +cmd /c bluezip.exe %1 -co ..\..\Games --htdocs ..\..\Server\htdocs +pause diff --git a/_ROLLBACK.bat b/_ROLLBACK.bat new file mode 100644 index 0000000..d4be391 --- /dev/null +++ b/_ROLLBACK.bat @@ -0,0 +1,3 @@ +@echo off +bluezip --rollback +pause diff --git a/bin/7za.exe b/bin/7za.exe new file mode 100644 index 0000000..2bdd57d Binary files /dev/null and b/bin/7za.exe differ diff --git a/bin/LICENSE_7zip b/bin/LICENSE_7zip new file mode 100644 index 0000000..fbfc31a --- /dev/null +++ b/bin/LICENSE_7zip @@ -0,0 +1,90 @@ + 7-Zip + ~~~~~ + License for use and distribution + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + 7-Zip Copyright (C) 1999-2020 Igor Pavlov. + + The licenses for files are: + + 1) 7z.dll: + - The "GNU LGPL" as main license for most of the code + - The "GNU LGPL" with "unRAR license restriction" for some code + - The "BSD 3-clause License" for some code + 2) All other files: the "GNU LGPL". + + Redistributions in binary form must reproduce related license information from this file. + + Note: + You can use 7-Zip on any computer, including a computer in a commercial + organization. You don't need to register or pay for 7-Zip. + + + GNU LGPL information + -------------------- + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library 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 + Lesser General Public License for more details. + + You can receive a copy of the GNU Lesser General Public License from + http://www.gnu.org/ + + + + + BSD 3-clause License + -------------------- + + The "BSD 3-clause License" is used for the code in 7z.dll that implements LZFSE data decompression. + That code was derived from the code in the "LZFSE compression library" developed by Apple Inc, + that also uses the "BSD 3-clause License": + + ---- + Copyright (c) 2015-2016, Apple Inc. All rights reserved. + + Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + + 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + + 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the distribution. + + 3. Neither the name of the copyright holder(s) nor the names of any contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE + COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + ---- + + + + + unRAR license restriction + ------------------------- + + The decompression engine for RAR archives was developed using source + code of unRAR program. + All copyrights to original unRAR code are owned by Alexander Roshal. + + The license for original unRAR code has the following restriction: + + The unRAR sources cannot be used to re-create the RAR compression algorithm, + which is proprietary. Distribution of modified unRAR sources in separate form + or as a part of other software is permitted, provided that it is clearly + stated in the documentation and source comments that the code may + not be used to develop a RAR (WinRAR) compatible archiver. + + + -- + Igor Pavlov diff --git a/bin/LICENSE_TrrntZipNET b/bin/LICENSE_TrrntZipNET new file mode 100644 index 0000000..84e6db4 --- /dev/null +++ b/bin/LICENSE_TrrntZipNET @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/bin/trrntzip.exe b/bin/trrntzip.exe new file mode 100644 index 0000000..76166d1 Binary files /dev/null and b/bin/trrntzip.exe differ diff --git a/bluezip.py b/bluezip.py new file mode 100644 index 0000000..63986d1 --- /dev/null +++ b/bluezip.py @@ -0,0 +1,365 @@ +from dataclasses import dataclass +import subprocess +import tempfile +import argparse +import datetime +import sqlite3 +import hashlib +import getpass +import zipfile +import fnmatch +import shutil +import socket +import json +import time +import sys +import os + +import yaml +import bluezip_dat +import bluezip_hook +from util import TermColor, pcolor +import util + +DATABASE_VERSION = '1' +DIST_DIR = os.path.abspath('dist') + +class Settings: + def __init__(self, db): + self.db = db + + def get(self, key, default=None): + try: + return self[key] + except IndexError: + return default + + def __contains__(self, key): + try: + _ = self[key] + return True + except IndexError: + return False + + def setdefault(self, key, value): + if key not in self: + self[key] = value + return value + + def __getitem__(self, key): + c = self.db.cursor() + c.execute('SELECT value FROM setting WHERE key = ?', (key,)) + value = c.fetchone() + if not value: + raise IndexError() + return value[0] + + def __setitem__(self, key, value): + self.db.execute('REPLACE INTO setting (key, value) VALUES (?,?)', (key, value)) + self.db.commit() + + def __iter__(self): + c = self.db.cursor() + c.execute('SELECT key, value FROM setting') + for key, value in c: + yield key, value + +@dataclass +class Game: + uid: str + title: str + platform: str + content_path: str + +def game_from_curation(uid, curation): + content = os.path.join(curation, 'content') + if not os.path.isdir(content): + raise ValueError('Missing content folder') + meta = util.find(curation, ['meta.txt', 'meta.yml', 'meta.yaml']) + if not meta: + raise ValueError('Missing metadata') + + with open(meta, 'r', encoding='utf-8') as f: + try: + meta = yaml.safe_load(f) + except yaml.YAMLError as e: + raise ValueError('Malformed metadata') from e + if not 'Title' in meta or not 'Platform' in meta: + raise ValueError('Incomplete metadata') + return Game(uid, meta['Title'], meta['Platform'], content) + +def game_from_fp_database(uid, content_path): + fp_db = util.open_db() + c = fp_db.cursor() + c.execute('SELECT title, platform FROM game WHERE id = ?', (uid,)) + game = c.fetchone() + fp_db.close() + if not game: + raise ValueError(f'No game found by UUID: {uid}') + + title, platform = game + return Game(uid, title, platform, content_path) + +def create_torrentzip(uid, platform, build_dir, dist_file): + content_meta = { + 'version': 1, + 'uniqueId': uid, + 'platform': platform + } + with open(os.path.join(build_dir, 'content.json'), 'w', encoding='utf-8') as f: + json.dump(content_meta, f, indent=4) + with zipfile.ZipFile(dist_file, 'w') as z: + for r, _, f in os.walk(build_dir): + for fname in f: + path = os.path.join(r, fname) + rel = os.path.relpath(path, build_dir).replace(os.path.sep, '/') + z.write(path, arcname=rel) + subprocess.check_call(['bin/trrntzip', dist_file], stdout=subprocess.DEVNULL) + return util.digest(dist_file, hashlib.sha256()) + +def delete_paths(root, paths): + for path in paths: + os.remove(path) + for path in paths: + while True: + try: + path = os.path.abspath(os.path.join(path, os.pardir)) + os.rmdir(path) + print('Removed empty folder:', os.path.relpath(path, root)) + except OSError: + break + +def rollback(db, session): + c = db.cursor() + c.execute("SELECT id, time FROM session WHERE operation != 'ROLLBACK' AND rollback IS NULL ORDER BY time DESC LIMIT 1") + data = c.fetchone() + if not data: + print('Nothing to rollback.') + return + prev_session, tstamp = data + date = datetime.datetime.fromtimestamp(tstamp) + print(f'Rolling back database to {date}') + if not util.prompt('Proceed?'): + sys.exit(0) + db.execute('DELETE FROM file WHERE game_sha IN (SELECT sha256 FROM game WHERE session = ?)', (prev_session,)) + db.execute('DELETE FROM game WHERE session = ?', (prev_session,)) + db.execute('UPDATE session SET rollback = ? WHERE id = ?', (session, prev_session)) + db.commit() + +class Bluezip: + def __init__(self, db, settings, session, args): + self.db = db + self.settings = settings + self.session = session + self.args = args + + def cleanup_obsolete(self, game, sha): + htdocs = self.args.htdocs + if not htdocs: + return + c = self.db.cursor() + c.execute('SELECT file FROM file WHERE game_sha = ?', (sha,)) + exclude = self.settings['obsolete_exclude'].split(',') + obsolete = list() + for (fname,) in c: + contentless = fname.replace('content/', '') + path = os.path.abspath(os.path.join(htdocs, contentless)) + rel = os.path.relpath(path, htdocs) + if os.path.isfile(path): + if any([fnmatch.fnmatch(rel, rule) for rule in exclude]): + print('Obsolete (excluded):', rel) + continue + obsolete.append(path) + print('Obsolete:', rel) + if len(obsolete) < int(self.settings['obsolete_threshold']): + message = f'only {len(obsolete)}' if obsolete else 'no' + pcolor('yellow', f'Warning: An htdocs path was provided but {message} files were found. Possibly a bad conversion?') + if not obsolete: + sys.exit(0) + if util.prompt(f'Delete {len(obsolete)} files?'): + delete_paths(htdocs, obsolete) + + def process_game(self, game): + tmp = tempfile.mkdtemp() + build_dir = os.path.join(tmp, 'build') + dist = os.path.join(tmp, 'dist.zip') + c = self.db.cursor() + c.execute('SELECT revision, sha256, title FROM game WHERE id = ? ORDER BY revision DESC LIMIT 1', (game.uid,)) + revision, prev_sha256, prev_title = c.fetchone() or (1, None, None) + os.mkdir(build_dir) + shutil.move(game.content_path, os.path.join(build_dir, 'content')) + sha256 = create_torrentzip(game.uid, game.platform, build_dir, dist) + if prev_sha256: + if prev_sha256 == sha256: + pcolor('green', 'no change') + return + revision += 1 + for r, _, f in os.walk(build_dir): + for fname in f: + path = os.path.join(r, fname) + rel = os.path.relpath(path, build_dir).replace(os.path.sep, '/') + crc = util.crc32(path) + md5 = util.digest(path, hashlib.md5()) + sha = util.digest(path, hashlib.sha1()) + size = os.stat(path).st_size + self.db.execute('INSERT INTO file VALUES (?,?,?,?,?,?)', (sha256, rel, size, crc, md5, sha)) + short_sha = sha256.hex()[:6].upper() + pcolor('green', f'[rev {revision}: {short_sha}]') + if prev_title and prev_title != game.title: + pcolor('yellow', f'Warning: {game.uid} has been renamed ({prev_title} -> {game.title})') + try: + self.db.execute('INSERT INTO game VALUES (?,?,?,?,?,?)', (game.uid, revision, sha256, game.title, game.platform, self.session)) + except sqlite3.IntegrityError as e: + pcolor('red', f'Error: {e} when storing {game.title}. Skipped.') + return + self.db.commit() + outfile = os.path.join(DIST_DIR, f'{game.uid}.zip') + shutil.move(dist, outfile) + shutil.rmtree(tmp) + if revision == 1: + self.cleanup_obsolete(game, sha256) + + def process_game_from_path(self, uid, path, from_db): + if from_db: + game = game_from_fp_database(uid, path) + else: + game = game_from_curation(uid, path) + self.process_game(game) + + def process_archive(self, fname, from_db=False): + tmp = tempfile.mkdtemp() + curation = os.path.join(tmp, 'curation') + subprocess.check_call(['bin/7za', 'x', f'-o{curation}', fname], stdout=subprocess.DEVNULL) + uid = os.listdir(curation)[0] + if not util.validate_uuid(uid): + pcolor('red', f'\nError: Root folder in {fname} not a valid UUID. Skipped.') + return + path = os.path.join(curation, uid) + try: + self.process_game_from_path(uid, path, from_db) + finally: + shutil.rmtree(tmp) + + def process_auto(self, path, from_db=False): + kind = 'Content' if from_db else 'Curation' + fname = os.path.basename(path) + exts = self.settings['archive_extensions'].split(',') + ext = util.extension(fname, exts) + if os.path.isfile(path) and ext: + print(f'{kind} archive ({ext}): {fname}'.ljust(80), end='', flush=True) + self.process_archive(path, from_db) + return + if not os.path.isdir(path): + return + if not util.validate_uuid(fname): + return + print(f'{kind} folder: {fname}'.ljust(80), end='', flush=True) + self.process_game_from_path(fname, path, from_db) + + def process_all(self, path): + for name in os.listdir(path): + try: + self.process_auto(os.path.join(path, name)) + except ValueError as e: + pcolor('red', f'Error: {e} in {name}. Skipped.') + +def main(): + global DIST_DIR + parser = argparse.ArgumentParser() + parser.add_argument('path', nargs='?') + parser.add_argument('-c', '--convert', action='store_true') + parser.add_argument('-b', '--batch', action='store_true') + parser.add_argument('-o', '--output', metavar='PATH') + parser.add_argument('--htdocs', metavar='PATH') + parser.add_argument('--hooks', choices=['add', 'remove']) + parser.add_argument('--rollback', action='store_true') + parser.add_argument('--dat', metavar='FILE') + parser.add_argument('--set', nargs='?', metavar='KEY=VALUE', const=[]) + parser.add_argument('-n', '--no-color', action='store_true') + args = parser.parse_args() + + if args.no_color: + TermColor.ENABLE = False + elif os.name == 'nt': + os.system('color') + + db = sqlite3.connect('bluezip.db') + db.execute('CREATE TABLE IF NOT EXISTS setting (key TEXT PRIMARY KEY, value TEXT)') + db.execute('CREATE TABLE IF NOT EXISTS session (id TEXT PRIMARY KEY, user TEXT, operation TEXT, time INTEGER, rollback TEXT)') + db.execute('CREATE TABLE IF NOT EXISTS file (game_sha BLOB, file TEXT, size INTEGER, crc INTEGER, md5 BLOB, sha1 BLOB)') + db.execute('CREATE TABLE IF NOT EXISTS game (id TEXT, revision INTEGER, sha256 BLOB UNIQUE, title TEXT, platform TEXT, session TEXT, PRIMARY KEY (id, revision))') + session = os.urandom(6).hex() + user = '%s@%s' % (getpass.getuser(), socket.gethostname()) + settings = Settings(db) + settings.setdefault('version', DATABASE_VERSION) + settings.setdefault('set_altapps', '1') + settings.setdefault('archive_extensions', 'zip,7z') + settings.setdefault('obsolete_threshold', '1') + settings.setdefault('obsolete_exclude', '') + + if settings['version'] > DATABASE_VERSION: + pcolor('yellow', 'The database was created in a newer version of bluezip. Bluezip might not work correctly and could cause data loss.') + if not util.prompt('Proceed?'): + sys.exit(0) + + def log_session(operation): + db.execute('INSERT INTO session (id, user, operation, time) VALUES (?,?,?,?)', (session, user, operation, int(time.time()))) + db.commit() + + if args.output: + DIST_DIR = args.output + + try: + os.mkdir(DIST_DIR) + except FileExistsError: + pass + + bluezip = Bluezip(db, settings, session, args) + if args.path: + if args.batch: + log_session('BUILD') + bluezip.process_all(args.path) + else: + log_session('BUILD') + try: + bluezip.process_auto(args.path, args.convert) + except ValueError as e: + pcolor('red', f'\nError: {e}') + sys.exit(1) + sys.exit(0) + + if args.dat: + bluezip_dat.export_dat(db, args.dat) + elif args.hooks: + bluezip_hook.run(db, args.hooks) + elif args.rollback: + log_session('ROLLBACK') + rollback(db, session) + elif args.set != None: + pcolor('yellow', 'This command allows modification of internal database attributes. Be careful!') + if args.set: + if '=' not in args.set: + parser.error('use KEY=VALUE') + sys.exit(1) + key, value = args.set.split('=') + append = False + if key.endswith('+'): + append = True + key = key[:-1] + if key not in settings: + parser.error(f'unknown attribute: {key}') + sys.exit(1) + old = settings[key] + if append: + settings[key] += value + else: + settings[key] = value + print(f'Set {key}: "{old}" -> "{settings[key]}"') + else: + for key, value in settings: + print(f'{key}={value}') + else: + parser.error('no flags specified') + +if __name__ == '__main__': + main() diff --git a/bluezip_dat.py b/bluezip_dat.py new file mode 100644 index 0000000..08124d5 --- /dev/null +++ b/bluezip_dat.py @@ -0,0 +1,34 @@ +import lxml.etree as ET +from collections import namedtuple + +DOCTYPE = '' + +def namedtuple_factory(cursor, row): + """Returns sqlite rows as named tuples.""" + fields = [col[0] for col in cursor.description] + Row = namedtuple("Row", fields) + return Row(*row) + +def export_dat(db, filename): + db.row_factory = namedtuple_factory + root = ET.Element('datafile') + header = ET.SubElement(root, 'header') + ET.SubElement(header, 'name').text = 'BlueMaxima\'s Flashpoint' + ET.SubElement(header, 'description').text = 'BlueMaxima\'s Flashpoint' + ET.SubElement(header, 'author').text = 'Flashpoint contributors' + ET.SubElement(header, 'homepage').text = 'BlueMaxima\'s Flashpoint' + ET.SubElement(header, 'url').text = 'https://bluemaxima.org/flashpoint/' + c = db.cursor() + c.execute('SELECT * FROM game') + for game in c: + f = db.cursor() + f.execute("SELECT file, size, printf('%X', crc) AS crc, hex(md5) AS md5, hex(sha1) AS sha1 FROM file WHERE game_sha = ?", (game.sha256,)) + elem = ET.SubElement(root, 'game', name=game.id) + ET.SubElement(elem, 'description').text = game.title + for entry in f: + ET.SubElement(elem, 'rom', name=f'{entry.file}', size=str(entry.size), crc=entry.crc, md5=entry.md5, sha1=entry.sha1, status='verified') + + tree = ET.ElementTree(root) + xml = ET.tostring(tree, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype=DOCTYPE) + with open(filename, 'wb') as f: + f.write(xml) diff --git a/bluezip_hook.py b/bluezip_hook.py new file mode 100644 index 0000000..8c4693b --- /dev/null +++ b/bluezip_hook.py @@ -0,0 +1,45 @@ +import uuid +import util + +def in_bluezip(db, uid): + c = db.cursor() + c.execute('SELECT 1 FROM game WHERE id = ?', (uid,)) + return bool(c.fetchone()) + +def ensure_hook(db, fp_db, uid): + if not in_bluezip(db, uid): + return + c = fp_db.cursor() + c = fp_db.execute("SELECT id FROM additional_app WHERE parentGameId = ? AND name = 'Mount'", (uid,)) + row = c.fetchone() + if row: + mode = 'REPLACE' + app_id, = row + else: + mode = 'INSERT' + app_id = str(uuid.uuid4()) + fp_db.execute(f'{mode} INTO additional_app (id, applicationPath, autoRunBefore, launchCommand, name, waitForExit, parentGameId) VALUES (?,?,?,?,?,?,?)', + (app_id, 'FPSoftware\\fpmount\\fpmount.exe', 1, uid, 'Mount', 1, uid)) + +def hooks_add(db, fp_db): + hooks_remove(db, fp_db) + print('Adding Mount hooks, please wait..') + games = fp_db.cursor() + games.execute('SELECT id FROM game') + for (uid,) in games: + ensure_hook(db, fp_db, uid) + fp_db.commit() + +def hooks_remove(db, fp_db): + print('Removing Mount hooks, please wait..') + fp_db.execute("DELETE FROM additional_app WHERE name = 'Mount'") + fp_db.commit() + +OPERATIONS = { + 'add': hooks_add, + 'remove': hooks_remove +} + +def run(db, arg): + fp_db = util.open_db() + OPERATIONS[arg](db, fp_db) diff --git a/bluezip_test.py b/bluezip_test.py new file mode 100644 index 0000000..f036fd8 --- /dev/null +++ b/bluezip_test.py @@ -0,0 +1,101 @@ +from unittest.mock import patch +import unittest +import tempfile +import sqlite3 +import shutil +import os + +import yaml + +import bluezip + +# chosen by fair dice roll +RANDOM_UUID = 'c27c7809-d79b-4db0-94da-df8f89955aff' + +class TestTempFile(unittest.TestCase): + DUMMY = b'LOREM IPSUM DOLOR SIT AMET' + + def setUp(self): + self.tmp = tempfile.mkdtemp() + self.cwd = self.tmp + + def tearDown(self): + shutil.rmtree(self.tmp) + + def join(self, path): + return os.path.abspath(os.path.join(self.cwd, path)) + + def chdir(self, path): + self.cwd = self.join(path) + + def mkdir(self, path): + os.makedirs(self.join(path), exist_ok=True) + + def write(self, path, content=None): + path = self.join(path) + parent = os.path.dirname(path) + os.makedirs(parent, exist_ok=True) + with open(path, 'wb') as f: + f.write(content or self.DUMMY) + +class Test_game_from_curation(TestTempFile): + def test_empty(self): + self.assertRaisesRegex(ValueError, 'Missing content folder', bluezip.game_from_curation, RANDOM_UUID, self.cwd) + + def test_no_meta(self): + self.mkdir('content') + self.assertRaisesRegex(ValueError, 'Missing metadata', bluezip.game_from_curation, RANDOM_UUID, self.cwd) + + def test_bad_meta(self): + self.mkdir('content') + self.write('meta.yaml', b'"') + self.assertRaisesRegex(ValueError, 'Malformed metadata', bluezip.game_from_curation, RANDOM_UUID, self.cwd) + + def test_incomplete_meta(self): + self.mkdir('content') + self.write('meta.yaml', b'') + self.assertRaisesRegex(ValueError, 'Incomplete metadata', bluezip.game_from_curation, RANDOM_UUID, self.cwd) + + def test_integrity(self): + self.mkdir('content') + title = 'Alien Hominid' + platform = 'Flash' + meta = { 'Title': title, 'Platform': platform } + expect = bluezip.Game(RANDOM_UUID, title, platform, self.join('content')) + with open(self.join('meta.yaml'), 'w') as f: + yaml.dump(meta, f) + game = bluezip.game_from_curation(RANDOM_UUID, self.cwd) + self.assertEqual(expect, game) + +class Test_game_from_fp_db(unittest.TestCase): + def setUp(self): + self.db = sqlite3.connect(':memory:') + self.db.execute('CREATE TABLE game (id TEXT PRIMARY KEY, title TEXT, platform TEXT)') + + @patch('bluezip.util') + def test_nonexistant(self, util): + util.open_db.return_value = self.db + self.assertRaises(ValueError, bluezip.game_from_fp_database, RANDOM_UUID, '') + + @patch('bluezip.util') + def test_ok(self, util): + util.open_db.return_value = self.db + args = (RANDOM_UUID, 'Alien Hominid', 'Flash') + self.db.execute('INSERT INTO game VALUES (?,?,?)', args) + expect = bluezip.Game(*args, '') + self.assertEqual(expect, bluezip.game_from_fp_database(RANDOM_UUID, '')) + +class Test_create_torrentzip(TestTempFile): + def test_ok(self): + expect = '815bf52d71d9db68fbd1218297a363859034e5e6ed8f1dd6cd1c3313900ff927' + dist = self.join('game.zip') + build = self.join('build') + self.chdir('build/content/www.example.com') + self.write('game.swf') + self.write('assets/data.xml') + self.mkdir('music') + digest = bluezip.create_torrentzip(RANDOM_UUID, 'Flash', build, dist) + self.assertEqual(expect, digest.hex()) + +if __name__ == '__main__': + unittest.main() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9a6d88d --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +pyyaml +lxml diff --git a/util.py b/util.py new file mode 100644 index 0000000..e427127 --- /dev/null +++ b/util.py @@ -0,0 +1,86 @@ +import sqlite3 +import zlib +import re +import os + +def open_db(): + try: + with open('DB_PATH', 'r', encoding='utf-8') as f: + path = f.read() + except FileNotFoundError: + print('\033[31mError: Please specify the path to the Flashpint database in DB_PATH.\033[0m') + return None + if not os.path.isfile(path): + print('\033[31mError: Flashpoint database in DB_PATH not found.\033[0m') + return None + return sqlite3.connect(path) + +def crc32(fname): + prev = 0 + for line in open(fname, 'rb'): + prev = zlib.crc32(line, prev) + return prev & 0xFFFFFFFF + +def digest(fname, h): + with open(fname, 'rb') as f: + for chunk in iter(lambda: f.read(4096), b''): + h.update(chunk) + return h.digest() + +def find(path, fnames): + for r, _, f in os.walk(path): + for fname in f: + if fname.lower() in fnames: + return os.path.join(r, fname) + return None + +def validate_uuid(uid): + return re.match('[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$', uid) + +def suffix(fname, suffixes): + pattern = '|'.join(suffixes) + return re.match(f'.*({pattern})$', fname) + +def extension(fname, extensions): + m = suffix(fname, [r'\.' + ext for ext in extensions]) + if m: + return m.group(1)[1:] + return None + +def prompt(text, default=False): + default_dict = { + True: '[Y/n]', + False: '[y/N]' + } + default_str = default_dict[default] + while True: + choice = input(f'{text} {default_str} ') + if not choice: + return default + if choice.lower() in ['y', 'yes']: + return True + if choice.lower() in ['n', 'no']: + return False + + print('Please respond with "y" or "n".') + +class TermColor: + ENABLE = True + RED = '\033[31m' + GREEN = '\033[32m' + YELLOW = '\033[33m' + RESET = '\033[0m' + +def pcolor(color, *args, sep=' ', **kwargs): + color = getattr(TermColor, color.upper()) + text = sep.join(args) + if TermColor.ENABLE: + text = color + text + TermColor.RESET + print(text, **kwargs) + +def pcolor_off(color, *args, **kwargs): + print(*args, **kwargs) + +def no_color(): + global pcolor + pcolor = pcolor_off