From 37f48e1cd37d90a6527076c63b4b7b44e17507e6 Mon Sep 17 00:00:00 2001 From: pbsds Date: Sun, 2 Feb 2014 00:45:05 +0100 Subject: [PATCH] It's about time I made this into a git. --- License.txt | 661 ++++++++++++++++++++++++++++++++++++++++++++ NTFT.py | 268 ++++++++++++++++++ PPM.py | 776 ++++++++++++++++++++++++++++++++++++++++++++++++++++ ReadMe.txt | 34 +++ UGO.py | 590 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 2329 insertions(+) create mode 100644 License.txt create mode 100644 NTFT.py create mode 100644 PPM.py create mode 100644 ReadMe.txt create mode 100644 UGO.py diff --git a/License.txt b/License.txt new file mode 100644 index 0000000..1ce8758 --- /dev/null +++ b/License.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. \ No newline at end of file diff --git a/NTFT.py b/NTFT.py new file mode 100644 index 0000000..302bed9 --- /dev/null +++ b/NTFT.py @@ -0,0 +1,268 @@ +#NTFT.py by pbsds +#AGPL3 licensed +# +#PIL is required to read and write images to disk +# +#Credits: +# +# -The guys behind TiledGGD. This sped up my work a lit. +# -Jsafive for supplying .ugo files +# +import sys, os +try: + import Image + hasPIL = True +except ImportError: + hasPIL = False + + +#helpers +def AscDec(ascii, LittleEndian=False):#Converts a ascii string into a decimal + ret = 0 + l = map(ord, ascii) + if LittleEndian: l.reverse() + for i in l: + ret = (ret<<8) | i + return ret +def DecAsc(dec, length=None, LittleEndian=False):#Converts a decimal into an ascii string of chosen length + out = [] + while dec <> 0: + out.insert(0, dec&0xFF) + dec >>= 8 + #"".join(map(chr, out)) + + if length: + if len(out) > length: + #return "".join(map(chr, out[-length:])) + out = out[-length:] + if len(out) < length: + #return "".join(map(chr, [0]*(length-len(out)) + out)) + out = [0]*(length-len(out)) + out + + if LittleEndian: out.reverse() + return "".join(map(chr, out)) +def clamp(value, min, max): + if value > max: return max + if value < min: return min + return value + +#Class NTFT: +# +# The NTFT image format stores RGB values as 5 bits each: a value between 0 and 31. +# It has 1 bit of transparancy, which means its either vidssible or invisible. No gradients. +# +# How to use: +# +# Converting to NTFT file: +# +# image = ReadImage(input_path) +# NTFT().SetImage(image).WriteFile(output_path) +# +# Reading NTFT file: +# +# ntft = NTFT().ReadFile(input_path, (width, height)) +# WriteImage(ntft.Image, output_path) +# +class NTFT: + def __init__(self): + self.Loaded = False + def ReadFile(self, path, size): + f = open(path, "rb") + ret = self.Read(f.read(), size) + f.close() + return ret + def Read(self, data, (w, h)): + #the actual stored data is a image with the sizes padded to the nearest power of 2. The image is then clipped out from it. + psize = [] + for i in (w, h): + p = 1 + while 1<

len(data): + print "Invalid sizes" + return False + + #JUST DO IT! + self.Image = [[None for _ in xrange(h)] for _ in xrange(w)] + for y in xrange(h): + for x in xrange(w): + pos = (x + y*pw)*2 + byte = AscDec(data[pos:pos+2], True) + + #ARGB1555 -> RGBA8: + a = (byte >> 15 ) * 0xFF + b = (byte >> 10 & 0x1F) * 0xFF / 0x1F + g = (byte >> 5 & 0x1F) * 0xFF / 0x1F + r = (byte & 0x1F) * 0xFF / 0x1F + + self.Image[x][y] = (r<<24) | (g<<16) | (b<<8) | a#RGBA8 + + self.Loaded = True + return self + def WriteFile(self, path): + if self.Loaded: + f = open(path, "wb") + f.write(self.Pack()) + f.close() + return True + else: + return False + def Pack(self): + if not self.Loaded: + return False + + w = len(self.Image[0]) + h = len(self.Image) + + #the actual stored data is a image with the sizes padded to the nearest power of 2 + psize = [] + for i in size: + p = 1 + while 1<

> 24 + g = (c >> 16) & 0xFF + b = (c >> 8 ) & 0xFF + a = c & 0xFF + + #convert + a = 1 if a >= 0x80 else 0 + r = r * 0x1F / 0xFF + g = g * 0x1F / 0xFF + b = b * 0x1F / 0xFF + + #store + out.append(DecAsc((a<<15) | (b<<10) | (g<<5) | r, 2, True)) + + return "".join(out) + def SetImage(self, Image): + self.Image = Image + self.Loaded = True + return self + +#Function WriteImage: +# +# Writes a 2D list of uint32 RGBA values as a image files. +# Designed to work with NTFT.Image +# +# This function requires the PIl imaging module +def WriteImage(image, outputPath): + if not hasPIL or not image: return False + + out = [] + for y in xrange(len(image[0])): + for x in xrange(len(image)): + out.append(DecAsc(image[x][y], 4)) + + out = Image.fromstring("RGBA", (len(image), len(image[0])), "".join(out)) + + filetype = outputPath[outputPath.rfind(".")+1:] + out.save(outputPath, filetype) + + return True + +#Function ReadImage: +# +# Returns a 2D list of uint32 RGBA values of the image file. +# This can be passed into NTFT().SetImage() +# +# This function requires the PIl imaging module +def ReadImage(path): + if not hasPIL: return False + + image = Image.open(path) + pixeldata = image.getdata() + w, h = image.size + + if len(pixeldata[0]) < 4: + def Combine((r, g, b)): + return (r << 24) | (g << 16) | (b << 8) | 0xFF + else: + def Combine((r, g, b, a)): + return (r << 24) | (g << 16) | (b << 8) | a + + ret = [] + for x in xrange(w): + line = [] + for y in xrange(h): + line.append(Combine(pixeldata[y*w + x])) + ret.append(line) + + return ret + + + +#testing: +# i = NTFT().ReadFile("NTFTtests/kaeru.ntft", (36, 30)) +# WriteImage(i.Image, "NTFTtests/kaeru.png") + +# i = NTFT().ReadFile("NTFTtests/News.ntft", (32, 32)) +# WriteImage(i.Image, "NTFTtests/News.png") + +# i = NTFT().ReadFile("NTFTtests/Special Room.ntft", (32, 32)) +# WriteImage(i.Image, "NTFTtests/Special Room.png") + +#i = NTFT() +#i.Loaded = True +#i.Image = ReadImage("NTFTtests/geh.png") +#i.WriteFile("NTFTtests/geh.ntft") + +if __name__ == "__main__": + print " == NTFT.py ==" + print " == by pbsds ==" + print " == v0.70 ==" + print + + if len(sys.argv) < 3: + print "Usage:" + print " NTFT.py [ [ ]]" + print "" + print "Can convert a NTFT to PNG or the other way around." + print "if isn't spesified it will be set to with an another extention" + print "" + print "The NTFT file contain only the colordata, so it's up to the user to find or" + print "store the resolution of the image. and is required" + print "to convert a NTFT file to a image." + print "32x32 is the normal resolution for button icons in UGO files." + sys.exit() + + input = sys.argv[1] + Encode = True#if false it'll decode + + if input[-4:].lower == "ntft" or len(sys.argv) >= 5: + Encode = False + + if len(sys.argv) >= 3: + output = sys.argv[2] + + if len(sys.argv) >= 5: + if (not sys.argv[3].isdigit()) or (not sys.argv[4].isdigit()): + print "Invalid sizes" + sys.exit() + width = int(sys.argv[3]) + height = int(sys.argv[4]) + else: + width, height = None, None + else: + output = ".".join(input.split(".")[:-1]) + (".ntft" if Encode else ".png") + + print "Converting..." + if Encode: + i = NTFT() + i.Loaded = True + i.Image = ReadImage("NTFTtests/geh.png") + i.WriteFile(output) + else: + WriteImage(NTFT().ReadFile(input, (width, height)).Image, output) + print "Done!" \ No newline at end of file diff --git a/PPM.py b/PPM.py new file mode 100644 index 0000000..b0abb9c --- /dev/null +++ b/PPM.py @@ -0,0 +1,776 @@ +#PPM.py by pbsds for python 2.7 +#AGPL3 licensed +# +#PIL is required to write images to disk +# +#Credits: +# +# -Steven for most of the documentation on DSiBrew and his frame decoding example on his talkpage +# -Remark for help on the 8x8 tiling on the preview image. +# -Jsafive for supplying .tmb files +# +import sys, wave#needs os and time aswell +try: + import Image + hasPIL = True +except ImportError: + hasPIL = False + +#helpers: +def AscDec(ascii, LittleEndian=False):#Converts a ascii string into a decimal + ret = 0 + l = map(ord, ascii) + if LittleEndian: l.reverse() + for i in l: + ret = (ret<<8) | i + return ret +def DecAsc(dec, length=None, LittleEndian=False):#Converts a decimal into an ascii string of chosen length + out = [] + while dec <> 0: + out.insert(0, dec&0xFF) + dec >>= 8 + #"".join(map(chr, out)) + + if length: + if len(out) > length: + #return "".join(map(chr, out[-length:])) + out = out[-length:] + if len(out) < length: + #return "".join(map(chr, [0]*(length-len(out)) + out)) + out = [0]*(length-len(out)) + out + + if LittleEndian: out.reverse() + return "".join(map(chr, out)) +def AddPadding(i,pad = 0x10):#used mainly for zipaligning offsets + if i % pad <> 0: + return i + pad - (i % pad) + return i + +#Class PPM: +# +# With this class you can read a Flipnote PPM file into memory and get its attributes. +# You do so by using either instance.ReadFile() or instance.Read() of your instance of the PPM class. +# When reading the PPM file you can specify what parts you need by passing these parameters: +# - DecodeThumbnail = True: The thumbnail will be predecoded. GetThumbnail() will still work if set to False, only takes a bit longer. Default is False +# - ReadFrames = True: The frames are decoded. Disabling this will speed up the PPM reading a lot. Default is True +# - ReadSound = True: Reads the sound data. Default is False +# +# After reading a PPM file, these values are available: +# +# - instance.FrameCount: The number of frames this flipnote consists of +# - instance.Locked: A boolean telling us wether it's locked or not +# - instance.ThumbnailFrameIndex: Which frame the thumbnail is(starting at 0) +# - instance.OriginalAuthorName: The name of the original author in unicode +# - instance.EditorAuthorName: The name of the (previous?) editing author in unicode +# - instance.Username: The username in unicode +# - instance.OriginalAuthorID: The ID of the original author +# - instance.EditorAuthorID: The ID of the last editor, the last user to save the file +# - instance.PreviousEditAuthorID: The ID of the previous editor +# - instance.OriginalFilename: The original filename +# - instance.CurrentFilename: The current filename +# - instance.Date: The date in seconds since January 1'st 2000 +# - instance.GetThumbnail(): The thumbnail stored in a 2D list of uint32 RGBA values. Will decode it first if not done so already +# - instance.GetFrame(n): Returns the specified frame as a 2D list of uint32 RGBA values. Only works if ReadFrames was true when reading the PPM file +# - instance.Looped: A boolean telling us wether it's looped or not +# - instance.SFXUsage: A list telling us when the different sound effects are used: +# instance.SFXUsage[frame] = [SFX1, SFX2, SFX3] where the SFX's are booleans +# - instance.Framespeed: a value between 1 and 8 telling us the speed +# - instance.BGMFramespeed: The framespeed when the BGM was recorded. used for resampling +# - instance.Frames: A list containing the decoded frames' raw data. Only available if ReadFrames was true when reading the PPM file +# instance.Frames[frame] = [Inverted(boolean), [color #1, color #2], frame] +# color #1 and #2 is a value between 0 and 3, check the palette in instance.GetFrame() to see what they are. +# frame is a 3d list, used like this. frame[layer][x][y] = boolean +# To get a colored image of a frame, use instance.GetFrame() +# - instance.SoundData: A list contaning the raw data of the BGM and the 3 sound effects. Only available if ReadSound was true set to true +class PPM: + def __init__(self): + self.Loaded = [False, False, False]#(Meta, Frames, Sound) + self.Frames = None + self.Thumbnail = None + self.RawThumbnail = None + self.SoundData = None + def ReadFile(self, path, DecodeThumbnail=False, ReadFrames=True, ReadSound=False):#Load: (thumbnail, frames, sound) + f = open(path, "rb") + ret = self.Read(f.read(), DecodeThumbnail, ReadFrames, ReadSound) + f.close() + return ret + def Read(self, data, DecodeThumbnail=False, ReadFrames=True, ReadSound=False):#Load: (thumbnail, frames, sound) + if data[:4] <> "PARA" or len(data) <= 0x6a0: + return False + + + #Read the header: + AudioOffset = AscDec(data[4:8], True) + 0x6a0 + AudioLenght = AscDec(data[8:12], True) + + self.FrameCount = AscDec(data[12:14], True) + 1 + self.Locked = ord(data[0x10]) & 0x01 == 1 + self.ThumbnailFrameIndex = AscDec(data[0x12:0x14], True)#which frame the thumbnnail represents + + self.OriginalAuthorName = data[0x14:0x2A].decode("UTF-16LE").split(u"\0")[0] + self.EditorAuthorName = data[0x2A:0x40].decode("UTF-16LE").split(u"\0")[0] + self.Username = data[0x40:0x56].decode("UTF-16LE").split(u"\0")[0] + + self.OriginalAuthorID = data[0x56:0x5e][::-1].encode("HEX").upper() + self.EditorAuthorID = data[0x5E:0x66][::-1].encode("HEX").upper()#the last user to save the file + + self.OriginalFilenameC = data[0x66:0x78]#compressed + self.CurrentFilenameC = data[0x78:0x8a]#compressed + self.OriginalFilename = "%s_%s_%s.tmb" % (self.OriginalFilenameC[:3].encode("HEX").upper(), self.OriginalFilenameC[3:-2], str(AscDec(self.OriginalFilenameC[-2:], True)).zfill(3)) + self.CurrentFilename = "%s_%s_%s.tmb" % (self.CurrentFilenameC[:3].encode("HEX").upper(), self.CurrentFilenameC[3:-2], str(AscDec(self.CurrentFilenameC[-2:], True)).zfill(3)) + + self.PreviousEditAuthorID = data[0x8a:0x92][::-1].encode("HEX").upper()#don't know what this really is + + #self.PartialFilenameC = data[0x92:0x9a]#compressed + + self.Date = AscDec(data[0x9a:0x9e], True)#in seconds since midnight 1'st january 2000 + + self.RawThumbnail = data[0xa0:0x6a0] + if DecodeThumbnail: + self.GetThumbnail()#self.Thumbnail[x][y] = uint32 RGBA + + self.Loaded[0] = True + + #read the animation sequence header: + self.Looped = ord(data[0x06A6]) >> 1 & 0x01 == 1#Unverified? + AnimationOffset = 0x6a8 + AscDec(data[0x6a0:0x6a4], True) + FrameOffsets = [AnimationOffset + AscDec(data[0x06a8+i*4:0x06a8+i*4+4], True) for i in xrange(self.FrameCount)] + + #Read the audio header: + self.SFXUsage = [(i&0x1<>0, i&0x2<>0, i&0x4<>0) for i in map(ord, data[AudioOffset:AudioOffset+self.FrameCount])]#SFXUsage[frame] = (sfx1, sfx2, sfx2) shere sfxX is either 0 or 1 + SoundSize =(AscDec(data[AddPadding(AudioOffset+self.FrameCount, 4) :AddPadding(AudioOffset+self.FrameCount, 4)+ 4], True),#BG music + AscDec(data[AddPadding(AudioOffset+self.FrameCount, 4)+ 4:AddPadding(AudioOffset+self.FrameCount, 4)+ 8], True),#SFX1 + AscDec(data[AddPadding(AudioOffset+self.FrameCount, 4)+ 8:AddPadding(AudioOffset+self.FrameCount, 4)+12], True),#SFX2 + AscDec(data[AddPadding(AudioOffset+self.FrameCount, 4)+12:AddPadding(AudioOffset+self.FrameCount, 4)+16], True))#SFX3 + self.Framespeed = 8 - ord(data[AddPadding(AudioOffset+self.FrameCount, 4) + 16]) + self.BGMFramespeed = 8 - ord(data[AddPadding(AudioOffset+self.FrameCount, 4) + 17])#framespeed when the bgm was recorded + + #Read the Frames: + if ReadFrames: + self.Frames = []#self.Frames[frame] = [inverted(bool), (color1(0-2), color2(0-2)), frame[layer][x][y] = bool] + for i, offset in enumerate(FrameOffsets): + #Read frame header: + Inverted = ord(data[offset]) & 0x01 == 0 + + #Reads which color that will be used: + Colors = (ord(data[offset]) >> 1 & 0x03, + ord(data[offset]) >> 3 & 0x03) + + Frame = self.ExtractFrame(data, offset, self.Frames[i-1][2] if i else None) + + self.Frames.append([Inverted, Colors, Frame]) + + self.Loaded[1] = True + else: + self.Loaded[1] = False + self.Frames = None + + #Read the Audio: + if ReadSound: + self.SoundData = [] + pos = AddPadding(AudioOffset+self.FrameCount+32, 4) + for i in xrange(4): + self.SoundData.append(data[pos:pos+SoundSize[i]]) + pos += SoundSize[i] + + self.Loaded[2] = True + else: + self.Loaded[2] = False + self.SoundData = None + + #return the results + return self + def WriteFile(self, path):#not implented + pass + #Extracting: + def GetFrame(self, frame):#frame is the index in self.Frames. Only works if ReadFrames was True when reading the PPM file + if not self.Loaded[1]: return None + + Inverted, Colors, Frame = self.Frames[frame] + + #Defines the palette: + Palette = [0xFFFFFFFF,0x000000FF,0xFF0000FF,0x0000FFFF] + if Inverted: + Palette[0] = 0x000000FF + Palette[1] = 0xFFFFFFFF + Color1 = Palette[Colors[0]] + Color2 = Palette[Colors[1]] + + out = [] + for x in xrange(256): + out.append([]) + for y in xrange(192): + if Frame[0][x][y]:#Color 1: + out[-1].append(Color1) + elif Frame[1][x][y]:#Color 2: + out[-1].append(Color2) + else:#background: + out[-1].append(Palette[0]) + + return out + def GetThumbnail(self, force=False): + if (not self.Thumbnail or force) and self.RawThumbnail: + if not self.RawThumbnail: + return False + + out = [[0 for _ in xrange(48)] for _ in xrange(64)] + palette = (0xFEFEFEFF,#0 + 0x4F4F4FFF,#1 + 0xFFFFFFFF,#2 + 0x9F9F9FFF,#3 + 0xFF0000FF,#4 + 0x770000FF,#5 + 0xFF7777FF,#6 + 0x00FF00FF,#7- + 0x0000FFFF,#8 + 0x000077FF,#9 + 0x7777FFFF,#A + 0x00FF00FF,#B- + 0xFF00FFFF,#C + 0x00FF00FF,#D- + 0x00FF00FF,#E- + 0x00FF00FF)#F- + + #8x8 tiling: + for ty in range(6): + for tx in range(8): + for y in range(8): + for x in range(0,8,2): + #two colors stored in each byte: + byte = ord(self.RawThumbnail[(ty*512+tx*64+y*8+x)/2]) + out[x+tx*8 ][y+ty*8] = palette[byte & 0xF] + out[x+tx*8+1][y+ty*8] = palette[byte >> 4] + + self.Thumbnail = out + return self.Thumbnail + #sub functions: + def ExtractFrame(self, data, offset, PrevFrame=None): + #defines line encoding storage: + #Enc1 = [0 for i in range(192)] + #Enc2 = [0 for i in range(192)] + #Defines the frame storage: + #Color1Frame = [[0 for i in range(192)] for i in range(256)] + #Color2Frame = [[0 for i in range(192)] for i in range(256)] + + Encoding = [[], []] + Frame = [[[False for _ in xrange(192)] for _ in xrange(256)] for _ in xrange(2)] + + #Read tags: + NewFrame = ord(data[offset]) & 0x80 <> 0 + Unknown = ord(data[offset]) >> 5 & 0x03 + + offset += 1 + + #WIP - framemove: + FrameMove = [0,0] + if Unknown & 0x2:#doesn't work 100%... + move = AscDec(data[offset:offset+2], True) + if move > 128: + FrameMove[0] = move - 256 + else: + FrameMove[1] = 0-move + offset += 2 + if Unknown: + print "Unknown instance:",Unknown,"at offset ",offset-1 + + + #read the line encoding of the layers: + for layer in xrange(2): + for byte in map(ord, data[offset:offset+48]): + Encoding[layer].append(byte & 0x03) + Encoding[layer].append(byte >> 2 & 0x03) + Encoding[layer].append(byte >> 4 & 0x03) + Encoding[layer].append(byte >> 6 ) + offset += 48 + + #read layers: + for layer in xrange(2): + for y in xrange(192): + if Encoding[layer][y] == 0:#Nothing + pass + elif Encoding[layer][y] == 1:#Normal + UseByte = AscDec(data[offset:offset+4]) + offset += 4 + x = 0 + while UseByte & 0xFFFFFFFF: + if UseByte & 0x80000000: + byte = ord(data[offset]) + offset += 1 + for _ in xrange(8): + if byte & 0x01: + Frame[layer][x][y] = True + x += 1 + byte >>= 1 + else: + x += 8 + UseByte <<= 1 + elif Encoding[layer][y] == 2:#Inverted + UseByte = AscDec(data[offset:offset+4]) + offset += 4 + x = 0 + while UseByte&0xFFFFFFFF: + if UseByte & 0x80000000: + byte = ord(data[offset]) + offset += 1 + for _ in range(8): + if not byte & 0x01: + Frame[layer][x][y] = True + x += 1 + byte >>= 1 + else: + x += 8 + UseByte <<= 1 + for n in range(256): + Frame[layer][n][y] = not Frame[layer][n][y] + elif Encoding[layer][y] == 3:#Raw/full + x = 0 + for _ in range(32): + byte = ord(data[offset]) + offset += 1 + for _ in range(8): + if byte & 0x01: + Frame[layer][x][y] = True + x += 1 + byte >>= 1 + + #Merges this frame with the previous frame if NewFrame isn't true: + if not NewFrame and PrevFrame: + if FrameMove[0] or FrameMove[1]:#Moves the previus frame if specified: + NewPrevFrame = [[[False for _ in xrange(192)] for _ in xrange(256)] for _ in xrange(2)] + + for y in range(192): + for x in range(256): + TempX = x+FrameMove[0] + TempY = y+FrameMove[1] + if 0 <= Tempx < 256 and 0 <= TempY < 192: + NewPrevFrame[0][TempX][TempY] = PrevFrame[0][x][y] + NewPrevFrame[1][TempX][TempY] = PrevFrame[1][x][y] + + PrevFrame = NewPrevFrame + + #Merge the frames: + for y in range(192): + for x in range(256): + Frame[0][x][y] = Frame[0][x][y] <> PrevFrame[0][x][y] + Frame[1][x][y] = Frame[1][x][y] <> PrevFrame[1][x][y] + + return Frame + +#Class TMB: +# +# With this class you can read a Flipnote TMB file into memory and get its attributes. +# You do so by using either instance.ReadFile() or instance.Read() of your instance of the TMB class. +# If you pass DecodeThumbnail=True to these functions, it will decode thumbnail. +# The TMB file is a file containing the metadata to a corresponding PPM file. +# +# After reading a TMB file, these values are available: +# +# - instance.FrameCount: The number of frames this flipnote consists of +# - instance.Locked: A boolean telling us wether it's locked or not +# - instance.ThumbnailFrameIndex: Which frame the thumbnail is(starting at 0) +# - instance.OriginalAuthorName: The name of the original author in unicode +# - instance.EditorAuthorName: The name of the (previous?) editing author in unicode +# - instance.Username: The username in unicode +# - instance.OriginalAuthorID: The ID of the original author +# - instance.EditorAuthorID: The ID of the last editor, the last user to save the file +# - instance.PreviousEditAuthorID: The ID of the previous editor +# - instance.OriginalFilename: The original filename +# - instance.CurrentFilename: The current filename +# - instance.Date: The date in seconds since January 1'st 2000 +# - instance.GetThumbnail(): The thumbnail stored in a 2D list of uint32 RGBA values. Will decode it first if not done so already +class TMB: + def __init__(self): + self.Loaded = False + self.Thumbnail = None + self.RawThumbnail = None + def ReadFile(self, path, DecodeThumbnail=False): + f = open(path, "rb") + ret = self.Read(f.read(), DecodeThumbnail) + f.close() + return ret + def Read(self, data, DecodeThumbnail=False): + if data[:4] <> "PARA" or len(data) < 0x6a0: + return False + + #Read the header: + self.AudioOffset = AscDec(data[4:8], True) + 0x6a0#only stored for self.Pack() + self.AudioLenght = AscDec(data[8:12], True)#only stored for self.Pack() + + self.FrameCount = AscDec(data[12:14], True) + 1 + self.Locked = ord(data[0x10]) & 0x01 == 1 + self.ThumbnailFrameIndex = AscDec(data[0x12:0x14], True)#which frame is in the thumbnnail + + #self.OriginalAuthorName = u"".join(unichr(AscDec(data[0x14+i*2:0x14+i*2+2], True)) for i in xrange(11)).split(u"\0")[0] + #self.EditorAuthorName = u"".join(unichr(AscDec(data[0x2A+i*2:0x2A+i*2+2], True)) for i in xrange(11)).split(u"\0")[0] + #self.Username = u"".join(unichr(AscDec(data[0x40+i*2:0x40+i*2+2], True)) for i in xrange(11)).split(u"\0")[0] + self.OriginalAuthorName = data[0x14:0x2A].decode("UTF-16LE").split(u"\0")[0] + self.EditorAuthorName = data[0x2A:0x40].decode("UTF-16LE").split(u"\0")[0] + self.Username = data[0x40:0x56].decode("UTF-16LE").split(u"\0")[0] + + self.OriginalAuthorID = data[0x56:0x5e][::-1].encode("HEX").upper() + self.EditorAuthorID = data[0x5E:0x66][::-1].encode("HEX").upper()#the last user to save the file + + self.OriginalFilenameC = data[0x66:0x78]#compressed + self.CurrentFilenameC = data[0x78:0x8a]#compressed + self.OriginalFilename = "%s_%s_%s.tmb" % (self.OriginalFilenameC[:3].encode("HEX").upper(), self.OriginalFilenameC[3:-2], str(AscDec(self.OriginalFilenameC[-2:], True)).zfill(3)) + self.CurrentFilename = "%s_%s_%s.tmb" % (self.CurrentFilenameC[:3].encode("HEX").upper(), self.CurrentFilenameC[3:-2], str(AscDec(self.CurrentFilenameC[-2:], True)).zfill(3)) + + self.PreviousEditAuthorID = data[0x8a:0x92][::-1].encode("HEX").upper()#don't know what this really is + + self.PartialFilenameC = data[0x92:0x9a]#compressed + + self.Date = AscDec(data[0x9a:0x9e], True)#in seconds since midnight 1'st january 2000 + + self.RawThumbnail = data[0xa0:0x6a0] + if DecodeThumbnail: + self.GetThumbnail()#self.Thumbnail[x][y] = uint32 RGBA + + self.Loaded = True + #return the results + return self + def WriteFile(self, path):#not implented + out = self.Pack() + if out: + f = open(path, "wb") + f.write(out) + f.close() + return True + else: + return False + def Pack(self, ppm=None):#not implented + if not self.Loaded: return False + + #realself = self + #if ppm: self = ppm + + out = ["PARA",#magic + DecAsc(self.AudioOffset-0x6a0, 4, True),#animation data size + DecAsc(self.AudioLenght, 4, True),#audio data size + DecAsc(self.FrameCount-1, 2, True),#frame count + "\x24\x00",#unknown + chr(self.Locked), "\0",#locked + DecAsc(self.ThumbnailFrameIndex, 2, True),#which frame is in the thumbnnail + self.OriginalAuthorName.encode("UTF-16LE") + "\0\0"*(11-len(self.OriginalAuthorName)),#Original Author Name + self.EditorAuthorName.encode("UTF-16LE") + "\0\0"*(11-len(self.EditorAuthorName)),#Editor Author Name + self.Username.encode("UTF-16LE") + "\0\0"*(11-len(self.Username)),#Username + self.OriginalAuthorID.decode("HEX")[::-1],#OriginalAuthorID + self.EditorAuthorID.decode("HEX")[::-1],#EditorAuthorID + self.OriginalFilenameC,#OriginalFilename + self.CurrentFilenameC,#CurrentFilename + self.PreviousEditAuthorID.decode("HEX")[::-1],#EditorAuthorID + self.PartialFilenameC,#PartialFilename + DecAsc(self.Date, 4, True),#Date in seconds + "\0\0",#padding + self.PackThumbnail()]#thumbnail + + return "".join(out) + def GetThumbnail(self, force=False): + if (not self.Thumbnail or force) and self.RawThumbnail: + if not self.RawThumbnail: + return False + + out = [[0 for _ in xrange(48)] for _ in xrange(64)] + palette = (0xFEFEFEFF,#0 + 0x4F4F4FFF,#1 + 0xFFFFFFFF,#2 + 0x9F9F9FFF,#3 + 0xFF0000FF,#4 + 0x770000FF,#5 + 0xFF7777FF,#6 + 0x00FF00FF,#7- + 0x0000FFFF,#8 + 0x000077FF,#9 + 0x7777FFFF,#A + 0x00FF00FF,#B- + 0xFF00FFFF,#C + 0x00FF00FF,#D- + 0x00FF00FF,#E- + 0x00FF00FF)#F- + + #8x8 tiling: + for ty in range(6): + for tx in range(8): + for y in range(8): + for x in range(0,8,2): + #two colors stored in each byte: + byte = ord(self.RawThumbnail[(ty*512+tx*64+y*8+x)/2]) + out[x+tx*8 ][y+ty*8] = palette[byte & 0xF] + out[x+tx*8+1][y+ty*8] = palette[byte >> 4] + + self.Thumbnail = out + return self.Thumbnail + def PackThumbnail(self, Exact=True, force=False):#more or less a private function for now + palette = (0xFEFEFEFF,#0 + 0x4F4F4FFF,#1 + 0xFFFFFFFF,#2 + 0x9F9F9FFF,#3 + 0xFF0000FF,#4 + 0x770000FF,#5 + 0xFF7777FF,#6 + 0x00FF00FF,#7- + 0x0000FFFF,#8 + 0x000077FF,#9 + 0x7777FFFF,#A + 0x00FF00FF,#B- + 0xFF00FFFF,#C + 0x00FF00FF,#D- + 0x00FF00FF,#E- + 0x00FF00FF)#F- + + + if not self.Thumbnail: + return self.RawThumbnail + else: + if Exact: + out = [] + + #8x8 tiling: + for ty in range(6): + for tx in range(8): + for y in range(8): + for x in range(0,8,2): + #two colors stored in each byte: + #pos = 0xa0+(ty*512+tx*64+y*8+x)/2 + p1 = palette.index(self.Thumbnail[x+tx*8 ][y+ty*8]) + p2 = palette.index(self.Thumbnail[x+tx*8+1][y+ty*8]) + out.append(chr(p2<<4 | p1)) + + self.RawThumbnail = "".join(out) + return self.RawThumbnail + else: + #not yet implented + return False + +#Function WriteImage: +# +# Writes a 2D list if uint32 RGBA values as a image files. +# Designed to work with PPM().Thumbnail or PPM().GetFrame(n) +# +# This function requires the PIl imaging module +def WriteImage(image, outputPath): + if not hasPIL or not image: return False + + out = [] + for y in xrange(len(image[0])): + for x in xrange(len(image)): + out.append(DecAsc(image[x][y], 4)) + + out = Image.fromstring("RGBA", (len(image), len(image[0])), "".join(out)) + + filetype = outputPath[outputPath.rfind(".")+1:] + out.save(outputPath, filetype) + + return True + +#this is just for experimenting with sound decoding: +#not even remotely close to being finished +def DecodeSound(outputpath, data): + f = wave.open(outputpath, "wb") + f.setnchannels(1) + f.setsampwidth(2) + f.setframerate(32000) + for i in data: + i1 = ord(i)&0xF + i2 = (ord(i)>>4)&0xF + #Noise reduction: + #if i1&0x8: i1 = 0xF-(i1&0x7) + #if i2&0x8: i2 = 0xF-(i2&0x7) + i1 = i1&0x7 if i1&0x8 else 0xF-i1 + i2 = i2&0x7 if i2&0x8 else 0xF-i2 + f.writeframes(DecAsc(i1<<12, 2, True)*4) + f.writeframes(DecAsc(i2<<12, 2, True)*4) + f.close() + +#testing: +# p = PPM() +# print "loading ppm..." +# p.ReadFile("PPMtests/test.ppm", (1, 1, 1)) + +# print str(p.OriginalAuthorName), str(p.OriginalAuthorID) +# print str(p.EditorAuthorName), str(p.EditorAuthorID) + +# print "Dumping Thumbnail..." +# WriteImage(p.Thumbnail, "thumbnail.png") + +# print "Dumping frames..." +# for i in xrange(p.FrameCount): + # WriteImage(p.GetFrame(i), "frames/frame %i.png" % i) + +# print "Dumping raw sounds..." +# for i, data in enumerate(p.SoundData): + # f = open("sound %i.bin" % i, "wb") + # f.write(data) + # f.close() + +# print "Extracting sounds...." +# for i, d in enumerate(p.SoundData): DecodeSound("out_%i.wav"%i, d) + +if __name__ == '__main__': + print " == PPM.py ==" + print " == by pbsds ==" + print " == v1.05 ==" + print + + if len(sys.argv) < 3: + print "Usage:" + print " PPM.py [] []" + print "" + print " :" + print " -t: Extracts the thumbnail to the file " + print " -f: Extracts the frame(s) to " + print " -s: Dumps the raw sound data files to the folder " + print " -S: Same as mode 2, but will also dump the experimentally decoded" + print " sounds." + print " -m: Prints out the metadata. Can also write it to which also" + print " supports unicode charactes." + print " Mode -t and -m supports TMB files aswell" + print " " + print " Only used in mode -f" + print " Set this to the exact frame you want to extract(starting at 1) and it" + print " will be saved as a file to ." + print " If not specified, it will extract all frames to the folder " + + sys.exit() + + import os, time + + if sys.argv[1] == "-t": + print "Reading the flipnote file...", + if not os.path.isfile(sys.argv[2]): + print "Error!\nSpecified file doesn't exist!" + sys.exit() + flipnote = TMB().ReadFile(sys.argv[2], True) + if not flipnote: + print "Error!" + print "The given file is not a Flipnote PPM file or TMB file!" + sys.exit() + print "Done!" + + print "Dumping the thumbnail...", + WriteImage(flipnote.GetThumbnail(), sys.argv[3]) + print "Done!" + elif sys.argv[1] == "-f": + if len(sys.argv) < 4: + print "Error!" + print " not specified!" + sys.exit() + + print "Reading the flipnote file...", + if not os.path.isfile(sys.argv[2]): + print "Error!\nSpecified file doesn't exist!" + sys.exit() + flipnote = PPM().ReadFile(sys.argv[2]) + if not flipnote: + print "Error!\nThe given file is not a Flipnote PPM file." + sys.exit() + print "Done!" + + + if len(sys.argv) < 5: + if not os.path.isdir(sys.argv[3]): + print "Error!\nThe specified directory doesn't exist!" + sys.exit() + + for i in xrange(flipnote.FrameCount): + print "Dumping frame #%i..." % (i+1), + WriteImage(flipnote.GetFrame(i), os.path.join(sys.argv[3], "frame %s.png" % str(i+1).zfill(3))) + print "Done!" + else: + try: + int(sys.argv[4]) + except: + print "Error!\nInvalid !" + sys.exit() + + if not (0 <= int(sys.argv[4])-1 < flipnote.FrameCount): + print "Error!\n is out of bounds!" + sys.exit() + + print "Dumping frame #%i..." % int(sys.argv[4]), + WriteImage(flipnote.GetFrame(int(sys.argv[4])-1), sys.argv[3]) + print "Done!" + elif sys.argv[1] in ("-s", "-S"): + if len(sys.argv) < 4: + print "Error!" + print " not specified!" + sys.exit() + + print "Reading the flipnote file...", + if not os.path.isfile(sys.argv[2]): + print "Error!\nSpecified file doesn't exist!" + sys.exit() + flipnote = PPM().ReadFile(sys.argv[2], ReadFrames=False, ReadSound=True) + if not flipnote: + print "Error!\nThe given file is not a Flipnote PPM file." + sys.exit() + print "Done!" + + if not os.path.isdir(sys.argv[3]): + print "Error!\nThe specified directory doesn't exist!" + sys.exit() + + print "Dumping the raw sound data...", + for i, data in enumerate(flipnote.SoundData): + f = open(os.path.join(sys.argv[3], ("BGM.bin", "SFX1.bin", "SFX2.bin", "SFX3.bin")[i]), "wb") + f.write(data) + f.close() + print "Done!" + + if sys.argv[1] == "-S": + print "Dumping the decoded sound data...", + for i, data in enumerate(flipnote.SoundData): + DecodeSound(os.path.join(sys.argv[3], ("BGM decoded.wav", "SFX1 decoded.wav", "SFX2 decoded.wav", "SFX3 decoded.wav")[i]), data) + print "Done!" + + print "Dumping the sound effect usage...", + f = open(os.path.join(sys.argv[3], "SFX usage.txt"), "w") + for i, (s1, s2, s3) in enumerate(flipnote.SFXUsage): + f.write("Frame %i:%s%s%s\n" % (i, " SFX1"*s1, " SFX2"*s2, " SFX3"*s3)) + f.close() + print "Done!" + elif sys.argv[1] == "-m": + epoch = time.mktime(time.struct_time([2000, 1, 1, 0, 0, 0, 5, 1, -1])) + + if not os.path.isfile(sys.argv[2]): + print "Error!\nSpecified file doesn't exist!" + sys.exit() + + filetype = "ppm" if sys.argv[2][-3:] == "ppm" else "tmb" + flipnote = TMB().ReadFile(sys.argv[2]) if filetype == "tmb" else PPM().ReadFile(sys.argv[2], ReadFrames=False) + if not flipnote: + print "Error!\nThe given file is not a Flipnote PPM file or TMB file." + if len(sys.argv) >= 4: + f = open(sys.argv, "wb") + f.write("Error!\nThe given file is not a Flipnote PPM file or TMB file.") + f.close() + sys.exit() + + meta = [] + meta.append(u"Current filename: %s" % flipnote.CurrentFilename[:-3]+filetype) + meta.append(u"Original filename: %s" % flipnote.OriginalFilename[:-3]+filetype) + meta.append(u"Number of frames: %s" % flipnote.FrameCount) + meta.append(u"Locked: %s" % flipnote.Locked) + if filetype == "ppm": + meta.append(u"Frame speed: %s" % flipnote.Framespeed) + meta.append(u"Looped: %s" % flipnote.Looped) + meta.append(u"Thumbnail frame index: %i" % (flipnote.ThumbnailFrameIndex+1)) + meta.append(u"Original author: %s" % flipnote.OriginalAuthorName) + meta.append(u"Editor author: %s" % flipnote.EditorAuthorName) + meta.append(u"Username: %s" % flipnote.Username) + meta.append(u"Original author ID: %s" % flipnote.OriginalAuthorID) + meta.append(u"Editor author ID: %s" % flipnote.EditorAuthorID) + meta.append(u"Date(seconds since 1'st Jan 2000): %s" % flipnote.Date) + meta.append(time.strftime(u"Date: %H:%M %d/%m-%Y", time.gmtime(epoch+flipnote.Date)) + " (faulty)") + + newline = "\n" + if sys.platform in ("win32", "cygwin"): newline = "\r\n" + elif sys.platform in ("darwin"): newline = "\r" + + print newline.join(meta).encode('ascii', 'ignore') + + if len(sys.argv) >= 4: + f = open(sys.argv[3], "wb") + f.write(newline.join(meta).encode("UTF-8")) + f.close() + else: + print "Error!\nThere's no such mode." \ No newline at end of file diff --git a/ReadMe.txt b/ReadMe.txt new file mode 100644 index 0000000..44bd4f7 --- /dev/null +++ b/ReadMe.txt @@ -0,0 +1,34 @@ + == Hatenatools == + == By pbsds == + == aka Peder Bergebakken Sundt == + +--VERSIONS-- +PPM.py: v1.05 +UGO.py: v0.92 +NTFT.py: v0.70 + +--DESCRIPTION-- +PPM.py can read the metadata, thumbnail, frames and the sound of Flipnote Studio files: .ppm +It can also handle .tmb files. + +UGO.py can read and write UGO files, and modify their content. It can also convert UGO files +to and from the XML format + +NTFT.py can read ntft image files and convert them to image files +Warning, it's still in a very crude state. Error will occour + +These are all tested and written in python 2.7 +These are all designed to be usable both as python modules and as stand alone applications. + +--DOCUMENTATION-- +Documentation on the formats can be found here: +https://github.com/pbsds/hatena-server/wiki + +--LICENSE-- +This is licensed by AGPL3 +See License.txt + +--CREDIT-- +-Steven for most of the documentation on DSiBrew and his frame decoding example on his talkpage +-Remark for helping me understanding the 8x8 tiling on the preview images. +-JSAfive for supplying .tmb and .ugo files \ No newline at end of file diff --git a/UGO.py b/UGO.py new file mode 100644 index 0000000..e928a3e --- /dev/null +++ b/UGO.py @@ -0,0 +1,590 @@ +#UGO.py by pbsds +#AGPL3 licensed +# +#This class reads and writes UGO files. +#It can also export and import it in a xml format +#Extended functionality added by PPM.py +# +#Credits: +# +# -Jsafive for supplying .ugo files +# +#Note: +# The current implentation can possibly mess up the files stored in Section #2, but will do for most needs +# Next version will bring a big change in the ugoxml format +# +import sys, os +from base64 import b64encode, b64decode +import xml.etree.ElementTree as ET + +try: + import PPM + HasPPM = True +except ImportError: + HasPPM = False + +#helpers: +def AscDec(ascii, LittleEndian=False):#Converts a ascii string into a decimal + ret = 0 + l = map(ord, ascii) + if LittleEndian: l.reverse() + for i in l: + ret = (ret<<8) | i + return ret +def DecAsc(dec, length=None, LittleEndian=False):#Converts a decimal into an ascii string of chosen length + out = [] + while dec <> 0: + out.insert(0, dec&0xFF) + dec >>= 8 + #"".join(map(chr, out)) + + if length: + if len(out) > length: + #return "".join(map(chr, out[-length:])) + out = out[-length:] + if len(out) < length: + #return "".join(map(chr, [0]*(length-len(out)) + out)) + out = [0]*(length-len(out)) + out + + if LittleEndian: out.reverse() + return "".join(map(chr, out)) +def zipalign(length, r=4): + return length + (4 - length % r) if length % r else length +def indentXML(elem, level=0):#"borrowed" from: http://effbot.org/zone/element-lib.htm#prettyprint + i = "\n" + level*"\t" + if len(elem): + if not elem.text or not elem.text.strip(): + elem.text = i + "\t" + if not elem.tail or not elem.tail.strip(): + elem.tail = i + for elem in elem: + indentXML(elem, level+1) + if not elem.tail or not elem.tail.strip(): + elem.tail = i + else: + if level and (not elem.tail or not elem.tail.strip()): + elem.tail = i + +#class UGO: +class UGO: + def __init__(self): + self.Loaded = False + def ReadFile(self, path): + f = open(path, "rb") + ret = self.Read(f.read()) + f.close() + return ret + def Read(self, data): + #Filestructure: + # - Header + # - Table of Contents + # - Padding, normally of length 2 + # - Extra Data + # - Padding + #The padding seems to do zipaligning to a length of 4 + global HasPPM + + #Header: + if data[:4] <> "UGAR": return False#The file isn't a UGO file + Sections = AscDec(data[ 4: 8], True)#could also be version + if Sections >= 1: + self.TableLength = AscDec(data[ 8:12], True) + if Sections >= 2: + self.ExtraLength = AscDec(data[12:16], True) + if Sections > 2: + print "Warning: This UGO file has more than the 2 known sections:",Sections + print "Please send this UGO file to pbsds over at pbsds.net" + print "This file could possibly be read incorrectly..." + headerlength = 8 + Sections*4 + + #Read table of contents: + #A table where the rows are seperated with newlines, and colons with tabs + if Sections >= 1: + TableOfContents = tuple((i.split("\t") for i in data[headerlength:headerlength+self.TableLength].split("\n"))) + else: + TableOfContents = [] + + #Extra data: + if Sections >= 2: + ExtraData = data[zipalign(headerlength+self.TableLength) : zipalign(headerlength+self.TableLength)+self.ExtraLength] + + #Parse data: + self.Items = [] + + #todo: implement this: + self.Files = []#[i] = (filename, filecontent) + #see todo.txt + + pos = 0#Extra Data position + tmbcount = 1#used if HasPPM is False + ntftcount = 1#used if no label + names = [] + for i in TableOfContents: + type = int(i[0]) + if type == 0:#layout + #I've always seen just numbers here. + #The amount of numbers also differ. + #maybe related to color scheme? or the button scheme/layout + + #all pages containing TMBs have so far been: i = ["0", "2", "1"] + self.Items.append(("layout", map(int, i[1:]))) + continue + elif type == 1:#Text on topscreen + num = int(i[1])#always seen as 0, unknown purpose + labels = [b64decode(i[n]).decode("UTF-16LE") for n in xrange(2,7)]#5 labels probably one label for each line of text + + self.Items.append(("topscreen text", labels, num)) + continue + elif type == 2:#catogories(like "reccomended" and "new flipnotes" and "most popular") + #this one may change greatly depending on what layout is set in type==0 + + link = i[1] + label = b64decode(i[2]).decode("UTF-16LE") + selected = int(i[3]) <> 0#bool + + self.Items.append(("category", link, label, selected)) + continue + elif type == 3:#POST button? "Post Flipnote" + pass + elif type == 4:#Button + link = i[1] + trait = int(i[2]) + label = b64decode(i[3]).decode("UTF-16LE") + other = i[4:]#varies + + #extra data + file = None#== ("filename", "filedata") + if trait < 100 and ExtraData: + if ExtraData == "\x20":#empty + pass#no files + elif ExtraData[pos:pos+4] == "PARA":#tmb file + file = ExtraData[pos:pos+0x6A0] + pos += 0x6A0 + + if HasPPM: + tmb = PPM.TMB().Read(file) + name = tmb.CurrentFilename[:-4] + del tmb + else: + name = "embedded tmb #%i" % tmbcount + tmbcount += 1 + + if name+".tmb" in names: + j = 2 + while "%s_%i.tmb" % (name, j) not in names: + j += 1 + name = "%s_%i" % (name, j) + + file = (name+".tmb", file) + names.append(name+".tmb") + else:#ntft icon + name = label.encode("ascii", "ignore") + if not name: + name = "nameless ntft %i" % ntftcount + ntftcount += 1 + + if name+".ntft" in names: + j = 2 + while "%s_%i.ntft" % (name, j) not in names: + j += 1 + name = "%s_%i" % (name, j) + + file = (name+".ntft", ExtraData[pos:pos+2048]) + names.append(name+".ntft") + pos += 2048 + + self.Items.append(("button", trait, label, link, other, file)) + + + # if subtype == 3:#flipnote + # tmb = PPM.TMB().Read(ExtraData[pos:pos+0x6A0]); pos += 0x6A0 + # unknown1 = i[3]#empty + # stars = int(i[4])#not sure + # unknown2 = map(int, i[5:8])#unknown = [765, 573, 0] + + # self.Items.append(("flipnote", link, tmb, stars, unknown1, unknown2)) + # continue + # elif subtype == 100: pass + # elif subtype == 101: pass + # elif subtype == 102: pass + # elif subtype == 104:#list item? like mails and announcements + # label = b64decode(i[3]).decode("UTF-16LE") + # unknown = i[4] + # num = int(i[5])#only seen as 0 + + # # self.Items.append(("list item?", link, label, unknown, num)) + # # continue + # pass + # elif subtype == 115:#Labeled button link(size of a flipnote thumbnail, commonly "next page") + # label = b64decode(i[3]).decode("UTF-16LE") + # unknown = i[4:6] + # self.Items.append(("thumbnail link", link, label, unknown)) + # continue + # elif subtype == 117: pass + continue + + #if not recognized: + self.Items.append(("unknown", i)) + print "Unknown UGO item discovered:", i + self.Loaded = True + return self + def WriteFile(self, path): + if self.Loaded: + out = self.Pack() + if out: + f = open(path, "wb") + f.write(out) + f.close() + return True + else: + return False + def Pack(self): + if not self.Loaded: return False + + Header = ["UGAR", None] + TableOfContents = [] + ExtraData = [] + + #Encode data: + for i in self.Items: + if i[0] == "unknown": + TableOfContents.append("\t".join(i[1])) + elif i[0] == "layout":#0 + TableOfContents.append("\t".join(["0"] + map(str, list(i[1])))) + elif i[0] == "topscreen text":#1 + labels, num = i[1:] + + num = str(num) + for i in xrange(5): + labels[i] = b64encode(labels[i].encode("UTF-16LE")) + + TableOfContents.append("\t".join(("1", num, labels[0], labels[1], labels[2], labels[3], labels[4]))) + elif i[0] == "category":#2 + link, label, selected = i[1:] + + label = b64encode(label.encode("UTF-16LE")) + selected = str(1*selected) + + TableOfContents.append("\t".join(("2", link, label, selected))) + elif i[0] == "post":#not yet implented + pass + elif i[0] == "button": + trait, label, link, other, file = i[1:] + + trait = str(trait) + label = b64encode(label.encode("UTF-16LE")) + + TableOfContents.append("\t".join(["4", link, trait, label] + list(other))) + + if file: + ExtraData.append(file[1]) + else: + print "Unrecognized entry in self.Items:", i + TableOfContents = "\n".join(TableOfContents) + ExtraData = "".join(ExtraData) + + #Format data: + Sections = 0 + if TableOfContents: + Sections += 1 + Header.append(DecAsc(len(TableOfContents), 4, True)) + + #padding/zipaligning + if len(TableOfContents) % 4: + TableOfContents += "\0" * (4 - len(TableOfContents) % 4) + if ExtraData: + Sections += 1 + Header.append(DecAsc(len(ExtraData), 4, True)) + + #padding/zipaligning + if len(ExtraData) % 4: + ExtraData += "\0" * (4 - len(ExtraData) % 4) + Header[1] = DecAsc(Sections, 4, True) + + #Zip up and send the file: + return "".join(Header) + TableOfContents + ExtraData + #XML + def WriteXML(self, xmlname="content.ugoxml", folder="content.ugoxml embedded"):#WIP + if not self.Loaded: return False + + path, xmlname = os.path.split(xmlname) + ugo_xml = ET.Element("ugo_xml") + files = [] + + for i in self.Items: + if i[0] == "unknown": + elem = ET.SubElement(ugo_xml, "unknown", type=i[1][0]) + for value in i[1][1:]: + ET.SubElement(elem, "value").text = value + continue + elif i[0] == "layout":#0 + elem = ET.SubElement(ugo_xml, "layout") + for value in i[1]: + ET.SubElement(elem, "value").text = str(value) + continue + elif i[0] == "topscreen text":#1 + elem = ET.SubElement(ugo_xml, "title") + labels, num = i[1:] + + for label in labels: + ET.SubElement(elem, "label").text = label + + ET.SubElement(elem, "num").text = str(num) + continue + elif i[0] == "category":#2 + elem = ET.SubElement(ugo_xml, "category") + link, label, selected = i[1:] + + ET.SubElement(elem, "label").text = label + ET.SubElement(elem, "address").text = link + ET.SubElement(elem, "selected").text = str(selected).lower() + elif i[0] == "post":#3 + pass#not yet implented/parsed + elif i[0] == "button":#4 + elem = ET.SubElement(ugo_xml, "button") + trait, label, link, other, file = i[1:] + + ET.SubElement(elem, "label").text = label + ET.SubElement(elem, "address").text = link + ET.SubElement(elem, "trait").text = str(trait)#todo: add names + + for n, value in enumerate(other): + entry = ET.SubElement(elem, "value") + entry.text = value + if n == 0 and trait == 3: + entry.attrib["tip"] = "stars" + + if file: + ET.SubElement(elem, "embedded_file").text = os.path.join(folder, file[0]) + files.append((os.path.join(folder, file[0]), file[1])) + + #intend + indentXML(ugo_xml) + + #pack xml + files.append((xmlname, ET.tostring(ugo_xml, encoding="UTF-8"))) + + #write files + if not os.path.isdir(os.path.join(path, folder)): + os.mkdir(os.path.join(path, folder)) + for name, data in files: + f = open(os.path.join(path, name), "wb") + f.write(data) + f.close() + def ReadXML(self, xmlfile, silent=True): + ugo_xml = ET.parse(xmlfile).getroot() + xmlpath = os.path.split(xmlfile)[0] + + Items = [] + for elem in ugo_xml: + if elem.tag == "unknown": + if "type" not in elem.attrib: + if not silent: print "Invalid formatting. without \"type\" attribute" + return False + values = [elem.attrib["type"]] + for value in elem: + if value.tag <> "value": + if not silent: print "Invalid formatting. <%s> found within " % value.tag + return False + values.append(value.text if value.text else "") + + Items.append(("unknown", values)) + elif elem.tag == "layout":#0 + values = [] + for value in elem: + if value.tag <> "value": + if not silent: print "Invalid formatting. <%s> found within " % value.tag + return False + if not value.text.isdigit(): + if not silent: print "Invalid entry. in is not a number" % value.tag + return False + values.append(int(value.text)) + Items.append(("layout", values)) + elif elem.tag == "title":#1 + labels = ["", "", "", "", ""] + num = 0 + pos = 0 + numset = False + + for value in elem: + if value.tag not in ("label", "num"): + if not silent: print "Invalid formatting. <%s> found within " % value.tag + return False + if value.tag == "label": + if pos >= 5: + if not silent: print "Invalid formatting. More than 5 <labels> in <title>" + return False + if value.text: labels[pos] = value.text + pos += 1 + elif value.tag == "num": + if numset: + if not silent: print "Invalid formatting. Multible <num> in <title>" + return False + if not value.text.isdigit(): + if not silent: print "Invalid entry. <num> in <title> is not a number!" + return False + num = int(value.text) + numset = True + + Items.append(("topscreen text", labels, num)) + elif elem.tag == "category":#2 + link = None + label = None + selected = None + + for value in elem: + if value.tag not in ("label", "address", "selected"): + if not silent: print "Invalid formatting. <%s> found within <category>" % value.tag + return False + + if value.tag == "address": + if isinstance(link, str): + if not silent: print "Invalid formatting. multible <address> within <category>" + return False + link = value.text if value.text else "" + elif value.tag == "label": + if isinstance(label, str): + if not silent: print "Invalid formatting. multible <label> within <category>" + return False + label = value.text if value.text else "" + elif value.tag == "selected": + if selected in (True, False): + if not silent: print "Invalid formatting. multible <selected> within <category>" + return False + selected = value.text[0].lower() in "t1" + + Items.append(("category", link, label, selected)) + elif elem.tag == "post":#3 not yet implented + pass + elif elem.tag == "button":#4 + trait = None#todo: add names + label = None + link = None + other = [] + file = None + + for value in elem: + if value.tag not in ("label", "address", "trait", "value", "embedded_file"): + if not silent: print "Invalid formatting. <%s> found within <button>" % value.tag + return False + + if value.tag == "label": + if isinstance(label, str): + if not silent: print "Invalid formatting. Multible <label> within <button>" + return False + label = value.text if value.text else "" + elif value.tag == "address": + if isinstance(link, str): + if not silent: print "Invalid formatting. Multible <address> within <button>" + return False + link = value.text if value.text else "" + elif value.tag == "trait":#todo: add names + if isinstance(trait, str): + if not silent: print "Invalid formatting. Multible <trait> within <button>" + return False + if not value.text.isdigit(): + if not silent: print "Invalid entry. <trait> in <button> is not a number" + return False + trait = int(value.text) + elif value.tag == "value": + other.append(value.text if value.text else "") + elif value.tag == "embedded_file": + if file <> None: + if not silent: print "Invalid formatting. Multible <embedded_file> within <button>" + return False + + path = os.path.join(xmlpath, value.text) + if not os.path.isfile(path): + if not silent: print "Invalid entry. Embedded file \"%s\" not found!" % value.text + print path + return False + + + f = open(path, "rb") + file = (os.path.split(value.text)[1], f.read()) + f.close() + + if None in (trait, label, link): + if not silent: print "Invalid formatting. <button> lacks either a <trait>, a <address> or a <label>" + return False + + Items.append(("button", trait, label, link, other, file)) + else: + if not silent: + print "Invalid formatting: <%s> found within <ugo_xml>" % elem.tag + + self.Items = Items + self.Loaded = True + return self + +if __name__ == "__main__": + print " == UGO.py ==" + print " == by pbsds ==" + print " == v0.92 ==" + print + + if len(sys.argv) < 3: + print "Usage:" + print " UGO.py <mode> <input> [<output> [<foldername>]]" + print "" + print " <Mode>:" + print " -d: Converts the UGO file in <input> to a UGOXML file with the same" + print " name, unless <output> is specified. Any embedded files will be" + print " written to a folder called UGOXML-filename + \" embedded\" unless" + print " <foldername> is given." + print " <foldername> is relative to the XML." + print " -e: Converts the UGOXML file in <input> to a UGO file with the same" + print " name, unless <output> is specified." + sys.exit() + + mode = sys.argv[1] + if mode not in ("-d", "-e"): + print "Invalid <mode> given" + sys.exit() + + if mode == "-d": + input = sys.argv[2] + output = sys.argv[3] if len(sys.argv) >= 4 else sys.argv[2]+"xml" + foldername = sys.argv[4] if len(sys.argv) >= 5 else os.path.split(output)[1] + " embedded" + + print "Reading %s..." % os.path.split(input)[1] + ugo = UGO().ReadFile(input) + if not ugo: + print "Error!\n The given file is not a UGO file!" + sys.exit() + print "Done!" + + print "Writing XML..." + ugo.WriteXML(output, foldername) + + print "Done!\n\nHave a nice day!" + if mode == "-e": + input = sys.argv[2] + output = sys.argv[3] if len(sys.argv) >= 4 else ".".join(sys.argv[2].split(".")[:-1]) + ".ugo" + + print "Reading %s..." % os.path.split(input)[1] + try: + ugo = UGO().ReadXML(input, False) + except EL.ParseError: + print "Error!\nThe given file is not in the XML format" + ugo = False + if not ugo: + #it prints sufficient errormessages + #print "Error!\n The given file is not a UGO file!" + sys.exit() + print "Done!" + + print "Writing UGO..." + ugo.WriteFile(output) + print "Done" + + + + + + + + + + +