diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..68bc17f --- /dev/null +++ b/.gitignore @@ -0,0 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..b0db36c --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +ROP translating tool. + diff --git a/gui.py b/gui.py new file mode 100644 index 0000000..52fddef --- /dev/null +++ b/gui.py @@ -0,0 +1,802 @@ +import sys + +if __name__ == '__main__': + print('Please run main.py to start the program!') + sys.exit() + +import os +import platform +import traceback +import tkinter as tk +import tkinter.ttk as ttk +import tkinter.font +import tkinter.messagebox + +# for PyInstaller binaries +try: + temp_path = sys._MEIPASS +except AttributeError: + temp_path = os.getcwd() + +# TODO: add more main modules here +import json +import urllib.request +import threading +import webbrowser +import configparser +import pkg_resources + +pg_name = 'PyU8ROP' # program name here + +username = 'fxesdev' # GitHub username here +repo_name = 'pyu8rop' # GitHub repository name here + +version = '0.0.1' # displayed version (e.g. 1.0.0 Prerelease - must match GH release title) +internal_version = 'v0.0.1' # internal version (must match GitHub release tag) +prerelease = False # prerelease flag (must match GitHub release's prerelease flag) + + +def report_error(self=None, exc=None, val=None, tb=None, term=True): + """ + Logs in the console and displays a dialog box showing the error. + Replaces the report_callback_exception() function in + the tkinter.Tk class. + NOTE: DO NOT REMOVE THE UNUSED ARGUMENTS! Due to the function replacement + these arguments must be added. + """ + + e = traceback.format_exc() + err_text = f'''\ +Whoops! An error has occurred. +{e} +If this error persists, please report it here: +https://github.com/{username}/{repo_name}/issues\ +''' + + print(err_text) + tk.messagebox.showerror('Whoops!', err_text) + if term: + sys.exit() + + +tk.Tk.report_callback_exception = report_error + + +class GUI: + def __init__(self, window): + self.version = version + + self.window = window + + self.temp_path = temp_path + + # change width and height of window here + self.display_w = 800 + self.display_h = 600 + + # TODO: add more "open" bools for other Toplevel classes + self.updater_win_open = False + + tk_font = tk.font.nametofont('TkDefaultFont').actual() + self.font_name = tk_font['family'] + self.font_size = tk_font['size'] + + # TODO: add more font styles (italic, condensed, etc.) + self.bold_font = (self.font_name, self.font_size, 'bold') + + self.init_window() + self.init_protocols() + + # updater settings + self.auto_check_updates = tk.BooleanVar() + self.auto_check_updates.set(True) + self.check_prerelease_version = tk.BooleanVar() + self.check_prerelease_version.set(False) + + self.debug = False + + # gets appdata folder + if os.name == 'nt': + self.appdata_folder = f'{os.getenv("LOCALAPPDATA")}\\{pg_name}' + else: + if platform.system() == 'Darwin': + self.appdata_folder = os.path.expanduser(f'~/Library/Application Support/{pg_name}') + else: + self.appdata_folder = os.path.expanduser(f'~/.config/{pg_name}') + + self.save_to_cwd = False + self.ini = configparser.ConfigParser() + self.parse_settings() + + self.refreshing = True + + # TODO: add more toplevel classes + self.UpdaterGUI = UpdaterGUI(self) + + self.unsupported_tcl = False + if sys.version_info < (3, 7, 6): + if tk.messagebox.askyesno('Warning', f''' +It looks like you are running Python {platform.python_version()}, which has a version of Tcl/Tk that doesn\'t support \ +some Unicode characters. + +Do you want to continue?\ +''', icon='warning'): + self.unsupported_tcl = True + else: + self.quit() + + self.menubar() + + def write_ro(self, obj, text): + obj['state'] = 'normal' + obj.delete('1.0', 'end') + obj.insert('end', text) + obj['state'] = 'disabled' + + def start_main(self): + """ + Runs necessary commands before calling the main function. + """ + + # TODO: add more commands here + + self.updates_checked = False + + if self.auto_check_updates.get(): + threading.Thread(target=self.auto_update).start() + else: + self.updates_checked = True + + ttk.Label(text = 'Hex form').pack(anchor = 'nw') + hexframe = tk.Frame() + self.hex = tk.Text(hexframe, height = 17) + self.hex.bind('', self.update_hex) + self.hex.bind('', self.translate_hex) + hexsb = ttk.Scrollbar(hexframe, command = self.hex.yview); self.hex['yscrollcommand'] = hexsb.set + hexsb.pack(side = 'right', fill = 'y') + self.hex.pack(side = 'left', fill = 'both', expand = True) + hexframe.pack(fill = 'x') + + decodeframe = tk.Frame() + self.decode = tk.Text(decodeframe, height = 17, state = 'disabled') + decodesb = ttk.Scrollbar(decodeframe, command = self.decode.yview); self.decode['yscrollcommand'] = decodesb.set + decodesb.pack(side = 'right', fill = 'y') + self.decode.pack(side = 'left', fill = 'both', expand = True) + decodeframe.pack(side = 'bottom', fill = 'x') + ttk.Label(text = 'Translated').pack(side = 'bottom', anchor = 'sw') + + self.main() + + def update_hex(self, event): + content = event.widget.get(1.0, 'end-1c') + if event.char.lower() not in '\x080123456789abcdef': return 'break' + elif event.char == '\x08' and len(content) > 1: event.widget.delete(f'end-{1 + (content[-2] == " ")}c', 'end') + else: + if len(content) > 1 and ' ' not in content[-2:]: event.widget.insert('end', ' ') + if event.char.lower() in 'abcdef': + event.widget.insert('end', event.char.upper()) + return 'break' + + def translate_hex(self, event): + string = '' + content = event.widget.get(1.0, 'end-1c').replace(' ', '').replace('\n', '') + if len(content) > 0: + if len(content) % 2 != 0: content = content[:-1] + '0' + content[-1] + bytecode = bytes.fromhex(content) + for i in range(0, len(bytecode), 4): + data = bytecode[i:i+4].ljust(4, b'\0') + string += f'{data[2] & 0xf:X}:{data[1] & 0xff:02X}{data[0] & 0xfe:02X}H\n' + + self.write_ro(self.decode, string) + + + def auto_update(self): + self.update_thread = ThreadWithResult(target=self.UpdaterGUI.updater.check_updates, args=(True,)) + self.update_thread.start() + i = 0 + j = 0 + mult = 5000 + while self.update_thread.is_alive(): + if i == mult * 4: + i += 1 + j = 1 + else: + i = i - 1 if j else i + 1 + if i == 0: + j = 0 + print(' ' * (int(i / mult)) + '.' + ' ' * (5 - int(i / mult)), end='\r') + print('\r ', end='\r') + update_info = self.update_thread.result + if update_info['newupdate']: + self.UpdaterGUI.init_window(True, (update_info['title'], update_info['tag'], update_info['prerelease'], + update_info['body'])) + self.updates_checked = True + + def parse_settings(self): + """ + Loads the program settings. + """ + + # load override settings + if os.path.exists(os.path.join(os.getcwd(), 'settings.ini')): + self.ini.read('settings.ini') + self.save_to_cwd = True + else: + # load normal settings + self.ini.read(f'{self.appdata_folder}\\settings.ini') + + sects = self.ini.sections() + if sects: + if 'settings' in sects: + # TODO: add commands for loading settings + pass + + if 'updater' in sects: + try: + self.auto_check_updates.set(self.ini.getboolean('updater', 'auto_check_updates')) + except (configparser.NoSectionError, configparser.NoOptionError): + pass + try: + self.check_prerelease_version.set(self.ini.getboolean('updater', 'check_prerelease_version')) + except (configparser.NoSectionError, configparser.NoOptionError): + pass + + if 'dont_touch_this_area_unless_you_know_what_youre_doing' in sects: + try: + self.debug = self.ini.getboolean('dont_touch_this_area_unless_you_know_what_youre_doing', 'debug') + except (configparser.NoSectionError, configparser.NoOptionError): + pass + + self.save_settings() + + def save_settings(self): + """ + Saves the program settings. + """ + + # settings are set individually and initialized when needed to retain compatibility between versions + if 'settings' not in self.ini.keys(): + self.ini['settings'] = {} + + # TODO: add commands for saving settings + + if 'updater' not in self.ini.keys(): + self.ini['updater'] = {} + self.ini['updater']['auto_check_updates'] = str(self.auto_check_updates.get()) + self.ini['updater']['check_prerelease_version'] = str(self.check_prerelease_version.get()) + + if 'dont_touch_this_area_unless_you_know_what_youre_doing' not in self.ini.keys(): + self.ini['dont_touch_this_area_unless_you_know_what_youre_doing'] = {} + self.ini['dont_touch_this_area_unless_you_know_what_youre_doing']['debug'] = str(self.debug) + + if self.save_to_cwd: + with open(os.path.join(os.getcwd(), 'settings.ini'), 'w') as f: + self.ini.write(f) + + if not os.path.exists(self.appdata_folder): + os.makedirs(self.appdata_folder) + with open(f'{self.appdata_folder}\\settings.ini', 'w') as f: + self.ini.write(f) + + @staticmethod + def n_a(): + """ + Used to prevent access to unimplemented or unfinished features. + """ + + tk.messagebox.showinfo('Not implemented', + f'This feature is not implemented into this version of {pg_name}. Sorry!') + + def set_title(self, custom_str=None): + """ + Sets the Tkinter window title. + """ + + self.window.title(f'{pg_name} {version}{" - " + custom_str if custom_str is not None else ""}') + + def init_window(self): + """ + Initializes the Tkinter window. + """ + + self.window.geometry(f'{self.display_w}x{self.display_h}') + self.window.bind('', self.version_details) + self.window.option_add('*tearOff', False) + self.set_title() + # TODO: uncomment this when you actually have an icon.ico/xbm file + + # try: + # self.window.iconbitmap(f'{self.temp_path}\\icon.{"ico" if os.name == "nt" else "xbm"}') + # except tk.TclError: + # err_text = f'''\ + # Whoops! The icon file "icon.ico" is required. + # Can you make sure the file is in "{self.temp_path}"? + # {traceback.format_exc()} + # If this problem persists, please report it here: + # https://github.com/{username}/{repo_name}/issues\ + # ''' + # print(err_text) + # tk.messagebox.showerror('Hmmm?', err_text) + # sys.exit() + + def init_protocols(self): + """ + Initializes protocols. + """ + + self.window.protocol('WM_DELETE_WINDOW', self.quit) + + def quit(self): + """ + Quits the program. + """ + + if not any([ + self.updater_win_open, + # TODO: add other "open" bools here + ]): + sys.exit() + + @staticmethod + def about_menu(): + """ + Shows basic information about the version, system and architecture, as well as the license of the project. + NOTE: LICENSE CANNOT BE CHANGED, AS PER THE CONDITIONS OF THE GNU GPL-V3 LICENSE. + """ + + nl = '\n' + syst = platform.system() + syst += ' x64' if platform.machine().endswith('64') else ' x86' + tk.messagebox.showinfo(f'About {pg_name}', f'''\ +{pg_name} - {version} ({'64' if sys.maxsize > 2 ** 31 - 1 else '32'}-bit) - Running on {syst} +Project page: https://github.com/{username}/{repo_name} +{nl + 'WARNING: This is a pre-release version, therefore it may have bugs and/or glitches.' + nl if prerelease else ''} +Licensed under the GNU GPL-v3 license +(LICENSE file available on the GitHub repository or included with source code)\ +''') + + def version_details(self, event=None): + """ + Shows technical information about the Python installation and operating system. + By default, it can be triggered via the F12 key. + Note: DO NOT REMOVE THE event ARGUMENT! + """ + + if self.debug: + dnl = '\n\n' + tk.messagebox.showinfo(f'{pg_name} version details', f'''\ +{pg_name} {version}{" (prerelease)" if prerelease else ""} +Internal version: {internal_version} + +Python version information: +Python {platform.python_version()} ({'64' if sys.maxsize > 2 ** 31 - 1 else '32'}-bit) +Tkinter (Tcl/Tk) version {self.window.tk.call('info', 'patchlevel')}\ +{" (most Unicode chars not supported)" if self.unsupported_tcl else ""} + +Operating system information: +{platform.system()} {platform.release()} +{'NT version: ' if os.name == 'nt' else ''}{platform.version()} +Architecture: {platform.machine()}{dnl + "Settings file is saved to working directory" if self.save_to_cwd else ""}\ +''') + + def disable_debug(self): + if tk.messagebox.askyesno('Warning', + 'To re-enable debug mode you must set the debug flag to True in settings.ini.\nContinue?', + icon='warning'): + self.debug = False + self.save_settings() + self.menubar() # update the menubar + + def menubar(self): + """ + Sets up the menubar. + """ + + menubar = tk.Menu() + + file_menu = tk.Menu(menubar) + file_menu.add_command(label = 'New', accelerator = 'Ctrl+N') + file_menu.add_command(label = 'Open...', accelerator = 'Ctrl+O') + file_menu.add_command(label = 'Save', accelerator = 'Ctrl+S') + file_menu.add_command(label = 'Save as...', accelerator = 'Ctrl+Shift+S') + file_menu.add_separator() + file_menu.add_command(label = 'Exit', command = self.quit) + menubar.add_cascade(label='File', menu=file_menu) + + settings_menu = tk.Menu(menubar) + # TODO: add more setting options + updater_settings_menu = tk.Menu(settings_menu) + updater_settings_menu.add_checkbutton(label='Check for updates on startup', variable=self.auto_check_updates, + command=self.save_settings) + updater_settings_menu.add_checkbutton(label='Check for pre-release versions', + variable=self.check_prerelease_version, + command=self.save_settings) + settings_menu.add_cascade(label='Updates', menu=updater_settings_menu) + + if self.debug: + settings_menu.add_separator() + debug_menu = tk.Menu(settings_menu) + debug_menu.add_command(label='Version details', command=self.version_details, accelerator='F12') + debug_menu.add_separator() + debug_menu.add_command(label='Updater test', command=lambda: self.UpdaterGUI.init_window(debug=True)) + debug_menu.add_separator() + debug_menu.add_command(label='Disable debug mode', command=self.disable_debug) + settings_menu.add_cascade(label='Debug', menu=debug_menu) + + menubar.add_cascade(label='Settings', menu=settings_menu) + + help_menu = tk.Menu(menubar) + help_menu.add_command(label='Check for updates', command=self.UpdaterGUI.init_window) + help_menu.add_command(label=f'About {pg_name}', command=self.about_menu) + menubar.add_cascade(label='Help', menu=help_menu) + + self.window.config(menu=menubar) + + def main(self): + """ + Where the mainloop is called. + """ + + self.write_ro(self.decode, '===== EXPERIMENTAL VERSION =====') + + self.set_title() + self.window.mainloop() + + +# TODO: add some other classes here + + +class UpdaterGUI: + def __init__(self, gui): + self.gui = gui + + self.after_ms = 100 + + self.updater = Updater() + + def init_window(self, auto=False, auto_download_options=None, debug=False): + if not self.gui.updater_win_open: + self.gui.updater_win_open = True + + self.auto = auto + self.debug = debug + + self.win = tk.Toplevel(self.gui.window) + self.win.geometry('400x400') + self.win.resizable(False, False) + self.win.protocol('WM_DELETE_WINDOW', self.quit) + self.win.title('Updater') + # TODO: uncomment this when you actually have an icon.ico/xbm file +# try: +# self.updater_win.iconbitmap(f'{self.gui.temp_path}\\icon.{"ico" if os.name == "nt" else "xbm"}') +# except tk.TclError: +# err_text = f'''\ +# Whoops! The icon file "icon.ico" is required. +# Can you make sure the file is in "{self.gui.temp_path}"? +# {traceback.format_exc()} +# If this problem persists, please report it here: +# https://github.com/{username}/{repo_name}/issues\ +# ''' +# print(err_text) +# tk.messagebox.showerror('Hmmm?', err_text) +# sys.exit() + + self.win.focus() + self.win.grab_set() + if self.debug: + self.debug_menu() + elif self.auto: + self.win.after(0, lambda: self.draw_download_msg(*auto_download_options)) + else: self.main() + + def quit(self): + self.win.grab_release() + self.win.destroy() + self.gui.updater_win_open = False + if self.auto: + self.auto = False + self.gui.main() + + def main(self): + self.update_thread = ThreadWithResult(target=self.updater.check_updates, + args=(self.gui.check_prerelease_version.get(),)) + + self.draw_check() + self.win.after(1, self.start_thread) + self.win.mainloop() + + def debug_menu(self): + ttk.Button(self.win, text='Check updates', command=self.main).pack() + ttk.Button(self.win, text='Message test', + command=lambda: self.draw_msg('Updater message test.\nLine 2\nLine 3\nLine 4')).pack() + ttk.Button(self.win, text='New update screen test', + command=lambda: self.draw_download_msg(version, internal_version, False, '''\ +Hello! **This is a *test* of the updater\'s Markdown viewer**, made possible with the [Markdown](https://pypi.org/project/Markdown/), [`mdformat`](https://pypi.org/project/mdformat/), and [TkinterWeb](https://pypi.org/project/tkinterweb/) modules. + +By the way, here\'s [TkTemplate](https://github.com/gamingwithevets/tktemplate), which is what this program was based on. + +Also, you should check out the [Steveyboi/GWE Discord server](https://gamingwithevets.github.io/redirector/discord).\ +''')).pack() + ttk.Button(self.win, text='Quit', command=self.quit).pack(side='bottom') + + def start_thread(self): + self.update_thread.start() + while self.update_thread.is_alive(): + self.win.update_idletasks() + self.progressbar['value'] = self.updater.progress + self.progressbar['value'] = 100 + self.update_thread.join() + update_info = self.update_thread.result + + if update_info['error']: + if update_info['exceeded']: + self.draw_msg('GitHub API rate limit exceeded! Please try again later.') + elif update_info['nowifi']: + self.draw_msg( + 'Unable to connect to the internet. Please try again\nwhen you have a stable internet connection.') + else: + self.draw_msg('Unable to check for updates! Please try again later.') + elif update_info['newupdate']: + self.draw_download_msg(update_info['title'], update_info['tag'], update_info['prerelease']) + else: + self.draw_msg('You are already using the latest version.') + + def draw_check(self): + for w in self.win.winfo_children(): + w.destroy() + + ttk.Label(self.win, text='Checking for updates...').pack() + self.progressbar = ttk.Progressbar(self.win, orient='horizontal', length=100, mode='determinate') + self.progressbar.pack() + ttk.Label(self.win, text='DO NOT close the program\nwhile checking for updates', + justify='center', font=self.gui.bold_font).pack(side='bottom') + + def draw_msg(self, msg): + if self.auto: + self.gui.set_title() + self.quit() + else: + for w in self.win.winfo_children(): + w.destroy() + ttk.Label(self.win, text=msg, justify='center').pack() + ttk.Button(self.win, text='Back', command=self.quit).pack(side='bottom') + + @staticmethod + def package_installed(package): + try: + pkg_resources.get_distribution(package) + except pkg_resources.DistributionNotFound: + return False + + return True + + def draw_download_msg(self, title, tag, prever, body): + if self.auto: + self.win.deiconify() + self.gui.set_title() + for w in self.win.winfo_children(): + w.destroy() + ttk.Label(self.win, justify='center', text=f'''\ +An update is available! +Current version: {self.gui.version}{" (pre-release)" if prerelease else ""} +New version: {title}{" (pre-release)" if prever else ""}\ +''').pack() + ttk.Button(self.win, text='Cancel', command=self.quit).pack(side='bottom') + ttk.Button(self.win, text='Visit download page', + command=lambda: self.open_download(tag)).pack(side='bottom') + + ttk.Label(self.win).pack() + + packages_missing = [] + for package in ('markdown', 'mdformat-gfm', 'tkinterweb'): + if not self.package_installed(package): + packages_missing.append(package) + + if packages_missing: + ttk.Label(self.win, + text=f'Missing package(s): {", ".join(packages_missing[:2])}{" and " + str(len(packages_missing) - 2) + " others" if len(packages_missing) > 2 else ""}', + font=self.gui.bold_font).pack() + else: + import markdown + import mdformat + import tkinterweb + + html = tkinterweb.HtmlFrame(self.win, messages_enabled=False) + html.load_html( + markdown.markdown(mdformat.text(body)).replace('../..', f'https://github.com/{username}/{repo_name}')) + html.on_link_click(webbrowser.open_new_tab) + html.pack() + + if self.auto: + self.win.deiconify() + + def open_download(self, tag): + webbrowser.open_new_tab(f'https://github.com/{username}/{repo_name}/releases/tag/{tag}') + self.quit() + + +class Updater: + def __init__(self): + self.username, self.reponame = username, repo_name + self.request_limit = 5 + + self.progress = 0 + self.progress_inc = 25 + + def check_internet(self): + try: + self.request('https://google.com', True) + return True + except Exception: + return False + + def request(self, url, testing=False): + success = False + for i in range(self.request_limit): + try: + r = urllib.request.urlopen(url) + success = True + break + except Exception: + if not testing: + if not self.check_internet(): + return + if success: + if not testing: + d = r.read().decode() + return json.loads(d) + + def check_updates(self, pr): + self.progress = 0 + + if not self.check_internet(): + return { + 'newupdate': False, + 'error': True, + 'exceeded': False, + 'nowifi': True + } + try: + versions = [] + if not self.check_internet(): + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + + response = self.request(f'https://api.github.com/repos/{self.username}/{self.reponame}/releases') + if response is None: + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + + for info in response: + versions.append(info['tag_name']) + + # UPDATE POINT 1 + self.progress += self.progress_inc + + if internal_version not in versions: + try: + testvar = response['message'] + if 'API rate limit exceeded for' in testvar: + return { + 'newupdate': False, + 'error': True, + 'exceeded': True + } + else: + return {'newupdate': False, 'error': False} + except Exception: + return {'newupdate': False, 'error': False} + if not self.check_internet(): + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + + # UPDATE POINT 2 + self.progress += self.progress_inc + + response = self.request( + f'https://api.github.com/repos/{self.username}/{self.reponame}/releases/tags/{internal_version}') + if response is None: + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + try: + testvar = response['message'] + if 'API rate limit exceeded for' in testvar: + return { + 'newupdate': False, + 'error': True, + 'exceeded': True + } + else: + return {'newupdate': False, 'error': False} + except Exception: + pass + + currvertime = response['published_at'] + + # UPDATE POINT 3 + self.progress += self.progress_inc + + if not pr: + if not self.check_internet(): + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + + response = self.request(f'https://api.github.com/repos/{self.username}/{self.reponame}/releases/latest') + if response is None: + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + try: + testvar = response['message'] + if 'API rate limit exceeded for' in testvar: + return { + 'newupdate': False, + 'error': True, + 'exceeded': True + } + else: + return {'newupdate': False, 'error': False} + except Exception: + pass + if response['tag_name'] != internal_version and response['published_at'] > currvertime: + return { + 'newupdate': True, + 'prerelease': False, + 'error': False, + 'title': response['name'], + 'tag': response['tag_name'], + 'body': response['body'] + } + else: + return { + 'newupdate': False, + 'unofficial': False, + 'error': False + } + else: + for ver in versions: + if not self.check_internet(): + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + + response = self.request( + f'https://api.github.com/repos/{self.username}/{self.reponame}/releases/tags/{ver}') + if response is None: + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': True} + try: + testvar = response['message'] + if 'API rate limit exceeded for' in testvar: + return { + 'newupdate': False, + 'error': True, + 'exceeded': True + } + else: + return {'newupdate': False, 'error': True, 'exceeded': False, 'nowifi': False} + except Exception: + pass + if currvertime < response['published_at']: + return { + 'newupdate': True, + 'prerelease': response['prerelease'], + 'error': False, + 'title': response['name'], + 'tag': response['tag_name'], + 'body': response['body'] + } + else: + return { + 'newupdate': False, + 'unofficial': False, + 'error': False + } + except Exception: + return { + 'newupdate': False, + 'error': True, + 'exceeded': False, + 'nowifi': False + } + + +# https://stackoverflow.com/a/65447493 +class ThreadWithResult(threading.Thread): + def __init__(self, group=None, target=None, name=None, args=(), kwargs=None, *, daemon=None): + if kwargs is None: + kwargs = {} + + def function(): self.result = target(*args, **kwargs) + + super().__init__(group=group, target=function, name=name, daemon=daemon) diff --git a/main.py b/main.py new file mode 100644 index 0000000..f26c88c --- /dev/null +++ b/main.py @@ -0,0 +1,45 @@ +import os +import sys +import platform +import traceback +import tkinter.messagebox + +python_requirement = (3, 6, 0) +if sys.version_info < python_requirement: + print('Oops! Your Python version is too old.\n') + print(f'Requirement: Python {".".join(map(str, python_requirement))}\nYou have : Python {platform.python_version()}') + print('\nGet a newer version!') + sys.exit() + +try: + import tkinter as tk +except ImportError: + print('''Oooh no you don't have Tkinter. +Don't worry! It's super easy. Just search "install tkinter" on Google and you\'ll find it! + +Now scram!''') + sys.exit() + +username = 'fxesdev' # GitHub username here +reponame = 'pyu8rop' # GitHub repository name here + +try: + import gui +except ImportError: + err_text = f'''\ +Whoops! The script "gui.py" is required.\nCan you make sure the script is in "{gui.temp_path}"? + +{traceback.format_exc()} +If this problem persists, please report it here:\nhttps://github.com/{username}/{reponame}/issues\ +''' + print(err_text) + tk.messagebox.showerror('Hmmm?', err_text) + sys.exit() + +try: + g = gui.GUI(tk.Tk()) + g.start_main() +except SystemExit: + os._exit(0) +except Exception: + gui.report_error()