commit 92855bb4e7dec253093ec043e5d070ccba91c1ec Author: JeremyStarTM Date: Fri Mar 22 21:52:49 2024 +0100 v1-b3 diff --git a/.corebasepath b/.corebasepath new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2beb9e1 --- /dev/null +++ b/LICENSE @@ -0,0 +1,662 @@ + 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 +. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..0eb3b52 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# CORE Framework distribution repository +This repository is used for distributing CORE as a git submodule. + +## [CORE Repository](https://git.staropensource.de/StarOpenSource/CORE) +## [Documentation](https://core.staropensource.de) +## [Install using Asset Library](https://core.staropensource.de/getting-started/setting-up/#using-the-godot-asset-library) +## [Install using Git](https://core.staropensource.de/getting-started/setting-up/#using-git) diff --git a/dist/FiraCode/Bold.ttf b/dist/FiraCode/Bold.ttf new file mode 100644 index 0000000..5030383 Binary files /dev/null and b/dist/FiraCode/Bold.ttf differ diff --git a/dist/FiraCode/Bold.ttf.import b/dist/FiraCode/Bold.ttf.import new file mode 100644 index 0000000..a1ce452 --- /dev/null +++ b/dist/FiraCode/Bold.ttf.import @@ -0,0 +1,33 @@ +[remap] + +importer="font_data_dynamic" +type="FontFile" +uid="uid://bvg3rkn8w7apl" +path="res://.godot/imported/Bold.ttf-6bb1550eec6255af8f843b07ff368846.fontdata" + +[deps] + +source_file="res://dist/FiraCode/Bold.ttf" +dest_files=["res://.godot/imported/Bold.ttf-6bb1550eec6255af8f843b07ff368846.fontdata"] + +[params] + +Rendering=null +antialiasing=1 +generate_mipmaps=false +multichannel_signed_distance_field=false +msdf_pixel_range=8 +msdf_size=48 +allow_system_fallback=true +force_autohinter=false +hinting=1 +subpixel_positioning=1 +oversampling=0.0 +Fallbacks=null +fallbacks=[] +Compress=null +compress=true +preload=[] +language_support={} +script_support={} +opentype_features={} diff --git a/dist/FiraCode/Light.ttf b/dist/FiraCode/Light.ttf new file mode 100644 index 0000000..95913af Binary files /dev/null and b/dist/FiraCode/Light.ttf differ diff --git a/dist/FiraCode/Light.ttf.import b/dist/FiraCode/Light.ttf.import new file mode 100644 index 0000000..6c7255e --- /dev/null +++ b/dist/FiraCode/Light.ttf.import @@ -0,0 +1,33 @@ +[remap] + +importer="font_data_dynamic" +type="FontFile" +uid="uid://bvluo6uibvwwo" +path="res://.godot/imported/Light.ttf-ad4f5cc78f585b9feb8a0964e43f9ad0.fontdata" + +[deps] + +source_file="res://dist/FiraCode/Light.ttf" +dest_files=["res://.godot/imported/Light.ttf-ad4f5cc78f585b9feb8a0964e43f9ad0.fontdata"] + +[params] + +Rendering=null +antialiasing=1 +generate_mipmaps=false +multichannel_signed_distance_field=false +msdf_pixel_range=8 +msdf_size=48 +allow_system_fallback=true +force_autohinter=false +hinting=1 +subpixel_positioning=1 +oversampling=0.0 +Fallbacks=null +fallbacks=[] +Compress=null +compress=true +preload=[] +language_support={} +script_support={} +opentype_features={} diff --git a/dist/FiraCode/Medium.ttf b/dist/FiraCode/Medium.ttf new file mode 100644 index 0000000..eca9e18 Binary files /dev/null and b/dist/FiraCode/Medium.ttf differ diff --git a/dist/FiraCode/Medium.ttf.import b/dist/FiraCode/Medium.ttf.import new file mode 100644 index 0000000..c18f3c0 --- /dev/null +++ b/dist/FiraCode/Medium.ttf.import @@ -0,0 +1,33 @@ +[remap] + +importer="font_data_dynamic" +type="FontFile" +uid="uid://b1pxod4r5puw8" +path="res://.godot/imported/Medium.ttf-436fd36bcf9a8c06f77a7861f6e4be0b.fontdata" + +[deps] + +source_file="res://dist/FiraCode/Medium.ttf" +dest_files=["res://.godot/imported/Medium.ttf-436fd36bcf9a8c06f77a7861f6e4be0b.fontdata"] + +[params] + +Rendering=null +antialiasing=1 +generate_mipmaps=false +multichannel_signed_distance_field=false +msdf_pixel_range=8 +msdf_size=48 +allow_system_fallback=true +force_autohinter=false +hinting=1 +subpixel_positioning=1 +oversampling=0.0 +Fallbacks=null +fallbacks=[] +Compress=null +compress=true +preload=[] +language_support={} +script_support={} +opentype_features={} diff --git a/dist/FiraCode/Regular.ttf b/dist/FiraCode/Regular.ttf new file mode 100644 index 0000000..97c1159 Binary files /dev/null and b/dist/FiraCode/Regular.ttf differ diff --git a/dist/FiraCode/Regular.ttf.import b/dist/FiraCode/Regular.ttf.import new file mode 100644 index 0000000..841ddd4 --- /dev/null +++ b/dist/FiraCode/Regular.ttf.import @@ -0,0 +1,33 @@ +[remap] + +importer="font_data_dynamic" +type="FontFile" +uid="uid://dmyes0lwt4sgw" +path="res://.godot/imported/Regular.ttf-ca914d4917efa068dc5cfcc7083586ad.fontdata" + +[deps] + +source_file="res://dist/FiraCode/Regular.ttf" +dest_files=["res://.godot/imported/Regular.ttf-ca914d4917efa068dc5cfcc7083586ad.fontdata"] + +[params] + +Rendering=null +antialiasing=1 +generate_mipmaps=false +multichannel_signed_distance_field=false +msdf_pixel_range=8 +msdf_size=48 +allow_system_fallback=true +force_autohinter=false +hinting=1 +subpixel_positioning=1 +oversampling=0.0 +Fallbacks=null +fallbacks=[] +Compress=null +compress=true +preload=[] +language_support={} +script_support={} +opentype_features={} diff --git a/dist/FiraCode/Retina.ttf b/dist/FiraCode/Retina.ttf new file mode 100644 index 0000000..fe1f6e0 Binary files /dev/null and b/dist/FiraCode/Retina.ttf differ diff --git a/dist/FiraCode/Retina.ttf.import b/dist/FiraCode/Retina.ttf.import new file mode 100644 index 0000000..e6ee019 --- /dev/null +++ b/dist/FiraCode/Retina.ttf.import @@ -0,0 +1,33 @@ +[remap] + +importer="font_data_dynamic" +type="FontFile" +uid="uid://c2qswgll1vpc6" +path="res://.godot/imported/Retina.ttf-82d9e54633305cac0957f1b54d37c125.fontdata" + +[deps] + +source_file="res://dist/FiraCode/Retina.ttf" +dest_files=["res://.godot/imported/Retina.ttf-82d9e54633305cac0957f1b54d37c125.fontdata"] + +[params] + +Rendering=null +antialiasing=1 +generate_mipmaps=false +multichannel_signed_distance_field=false +msdf_pixel_range=8 +msdf_size=48 +allow_system_fallback=true +force_autohinter=false +hinting=1 +subpixel_positioning=1 +oversampling=0.0 +Fallbacks=null +fallbacks=[] +Compress=null +compress=true +preload=[] +language_support={} +script_support={} +opentype_features={} diff --git a/dist/core.png b/dist/core.png new file mode 100644 index 0000000..9a5fa12 Binary files /dev/null and b/dist/core.png differ diff --git a/dist/core.png.import b/dist/core.png.import new file mode 100644 index 0000000..058ab78 --- /dev/null +++ b/dist/core.png.import @@ -0,0 +1,34 @@ +[remap] + +importer="texture" +type="CompressedTexture2D" +uid="uid://o1vm4b2o5j6" +path="res://.godot/imported/core.png-e89ff2d52965299afbd8a6c20096578d.ctex" +metadata={ +"vram_texture": false +} + +[deps] + +source_file="res://dist/core.png" +dest_files=["res://.godot/imported/core.png-e89ff2d52965299afbd8a6c20096578d.ctex"] + +[params] + +compress/mode=0 +compress/high_quality=false +compress/lossy_quality=0.7 +compress/hdr_compression=1 +compress/normal_map=0 +compress/channel_pack=0 +mipmaps/generate=false +mipmaps/limit=-1 +roughness/mode=0 +roughness/src_normal="" +process/fix_alpha_border=true +process/premult_alpha=false +process/normal_map_invert_y=false +process/hdr_as_srgb=false +process/hdr_clamp_exposure=false +process/size_limit=0 +detect_3d/compress_to=1 diff --git a/dist/core.xcf b/dist/core.xcf new file mode 100644 index 0000000..a20e25b Binary files /dev/null and b/dist/core.xcf differ diff --git a/src/Core.gd b/src/Core.gd new file mode 100644 index 0000000..6da7776 --- /dev/null +++ b/src/Core.gd @@ -0,0 +1,333 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Initializes and manages the framework. +## +## The [b]CORE Object[/b] is responsible for initializing, managing and +## serving the CORE Framework to the developer. +extends Node +class_name Core + +# Constants +## The release number +const version_release: int = 1 +## The release type +const version_type: CoreTypes.VersionType = CoreTypes.VersionType.BETA +## The release type number. Resets on every new release and release type. +const version_typerelease: int = 3 + +# Modules +## Use this to access CORE's logging implementation. +var logger: CoreBaseModule +## Use this to access various useful functions. +var misc: CoreBaseModule +## Use this to access the scene management system. +var sms: CoreBaseModule +## Use this to access the graphical log. Serves no importance to you (probably). +var logui: CoreBaseModule +## Use this to access CORE's builtin HTTP request maker. +var edl: CoreBaseModule +## Use this to access configuration and settings files easily. +var storage: CoreBaseModule + +# Variables +## Contains CORE's load path +var basepath: String +## Holds the configuration[br] +## [br] +## [b]NEVER access this yourself. To change the configuration file, use [method Core.reload_configuration] instead.[/b] +var config: CoreConfiguration +## Contains all loaded custom modules. +var custom_modules: Dictionary = {} +## Contains the custom modules node. +var custom_modules_node: Node + +# Preinitialization +func _init(new_config: CoreConfiguration = CoreConfiguration.new()) -> void: + name = "CORE" + if !check_godot_version(): return + if !determine_basepath(): queue_free() + custom_modules_node = Node.new() + reload_configuration(new_config) + initialize_modules() + apply_configuration() + +# Initialization +func _ready() -> void: + inject_modules() + custom_modules_node.name = "Custom Modules" + add_child(custom_modules_node) + +# Initialize modules +## Initializes all modules during the first initialization phase.[br] +## [br] +## [b]NEVER call this yourself! You will break everything and risk a crash![/b] +func initialize_modules() -> void: + # Create Nodes + logger = CoreBaseModule.new() + misc = CoreBaseModule.new() + sms = CoreBaseModule.new() + logui = CoreBaseModule.new() + edl = CoreBaseModule.new() + storage = CoreBaseModule.new() + # Set names + logger.name = "Logger" + misc.name = "Misc" + sms.name = "SceneManagementSystem" + logui.name = "LogUI" + edl.name = "EasyDownLoader" + storage.name = "Storage" + # Set scripts + logger.set_script(ResourceLoader.load(basepath + "src/Logger.gd")) + misc.set_script(ResourceLoader.load(basepath + "src/Misc.gd")) + sms.set_script(ResourceLoader.load(basepath + "src/Sms.gd")) + logui.set_script(ResourceLoader.load(basepath + "src/Logui.gd")) + edl.set_script(ResourceLoader.load(basepath + "src/Edl.gd")) + storage.set_script(ResourceLoader.load(basepath + "src/Storage.gd")) + # Set reference to self + logger.core = self + misc.core = self + sms.core = self + logui.core = self + edl.core = self + storage.core = self + # Call _initialize() (workaround as modules cannot access "core" during _init()) + logger._initialize() + misc._initialize() + sms._initialize() + logui._initialize() + edl._initialize() + storage._initialize() + +# Inject modules into the SceneTree +## Injects CORE's builtin modules into the SceneTree.[br] +## [br] +## [b]NEVER call this yourself! You will break everything and risk a crash![/b] +func inject_modules() -> void: + add_child(logger) + add_child(misc) + add_child(sms) + add_child(logui) + add_child(edl) + add_child(storage) + +# Wait for all modules to be fully initialized +## Wait for all builtin modules to be fully initialized.[br] +## [br] +## This ensures that all of CORE's builtin modules are fully initialized and ready. +## [b]Not calling this function during startup may lead to runtime issues.[/b] +func complete_init(no_success: bool = false) -> void: + var modsinit_builtin: Array[String] = ["workaround"] + var modsinit_custom: Array[String] = ["workaround"] + + while modsinit_builtin.size() != 0 and modsinit_custom.size() != 0: + # Clear arrays + modsinit_builtin = [] + modsinit_custom = [] + + # Check builtin modules + if !logger.initialized: modsinit_builtin.append("logger") + if !misc.initialized: modsinit_builtin.append("misc") + if !sms.initialized: modsinit_builtin.append("sms") + if !logui.initialized: modsinit_builtin.append("logui") + if !edl.initialized: modsinit_builtin.append("edl") + if !storage.initialized: modsinit_builtin.append("storage") + + # Check custom modules + for module_name in custom_modules: + if !custom_modules[module_name].initialized: modsinit_custom.append(module_name) + + # Print and sleep + if modsinit_builtin.size() != 0 or modsinit_custom.size() != 0: + print("Waiting for modules to finish initialization:") + if modsinit_builtin.size() != 0: + print(" Builtin: " + str(modsinit_builtin)) + if modsinit_custom.size() != 0: + print(" Custom: " + str(modsinit_custom)) + await get_tree().create_timer(1).timeout + + # Initialization complete + await get_tree().process_frame + if !no_success: logger.infof("Core", "Initialized CORE successfully") + +# Registers a custom module +## Registers a new custom module. +func register_custom_module(module_name: String, module_class: CoreBaseModule) -> bool: + logger.verbf("Core", "Registering new custom module \"" + module_name + "\"") + if !config.custom_modules: + logger.errorf("Core", "Registering module failed: Custom module support is disabled.") + return false + if custom_modules.has(module_name): + logger.errorf("Core", "Registering module failed: A custom module with the name \"" + module_name + "\" already exists.") + return false + module_class.name = module_name + logger.diagf("Core", "Updating variables") + module_class.core = self + logger.diagf("Core", "Adding module to SceneTree") + custom_modules_node.add_child(module_class) + logger.diagf("Core", "Merging module with custom_modules") + custom_modules.merge({ module_name: module_class }) + logger.diagf("Core", "Initializing custom module") + module_class._initialize() + logger.diagf("Core", "Updating custom module configuration") + module_class._pull_config() + return true + +# Unregisters a custom module +## Unregisters a custom module, making it no longer function. +func unregister_custom_module(module_name: String) -> void: + logger.verbf("Core", "Unregistering custom module \"" + module_name + "\"") + if !custom_modules.has(module_name): + logger.errorf("Core", "Unregistering module failed: A custom module with the name \"" + module_name + "\" does not exist.") + return + custom_modules_node.remove_child(get_custom_module(module_name)) + custom_modules.erase(module_name) + +# Returns a custom module +## Returns a loaded custom module for access. +func get_custom_module(module_name: String) -> CoreBaseModule: + logger.diagf("Core", "Getting custom module \"" + module_name + "\"") + if !custom_modules.has(module_name): + logger.errorf("Core", "Getting module failed: A custom module with the name \"" + module_name + "\" does not exist.") + return null + return custom_modules[module_name] + +# (Re-)Load configuration +## Loads a (new) configuration file and applies it to all modules. +func reload_configuration(new_config: CoreConfiguration = CoreConfiguration.new()) -> void: + var initialized = config != null + if initialized: logger.verbf("Core", "Reloading CORE's configuration") + config = new_config + if is_devmode(): # Override configuration in development mode + config.logger_level = CoreTypes.LoggerLevel.VERB + if initialized: logger.verbf("Core", "Overrode configuration (development mode)") + if initialized: apply_configuration() + +# Call _pull_config() functions +## Applies the newly applied configuration.[br] +## [br] +## [b]NEVER call this yourself unless you know what you are doing![/b] +func apply_configuration() -> void: + logger.verbf("Core", "Applying configuration") + if is_devmode(): logger.warnf("Core", "The CORE Framework is in development mode. Here be dragons!") + if config.headless: logger.warnf("Core", "CORE is in headless mode. Certain modules will not work as expected.") + edl._pull_config() + if !config.custom_modules: + logger.verbf("Core", "Removing all custom modules (custom modules support is disabled)") + for module in custom_modules: unregister_custom_module(module) + logger._pull_config() + misc._pull_config() + sms._pull_config() + logui._pull_config() + if config.custom_modules: + for module in custom_modules: + logger.diagf("Core", "Updating configuration for custom module \"" + module.name + "\"") + module._pull_config() + +# Return development mode status +## Returns if the CORE Framework is in development mode. +func is_devmode() -> bool: + return config.debugging and basepath == "res://" and OS.is_debug_build() + +# Replaces variables with human-friendly strings +## Replaces placeholders with human-friendly strings You can use the following placeholders:[br] +## - [code]%release%[/code]: Returns the release number.[br] +## - [code]%release_type%[/code]: Returns the typerelease number[br] +## - [code]%release_semantic%[/code]: Returns the result of [method Core.get_version_semantic], example [i]5.2.3[/i][br] +## - [code]%type%[/code]: Returns the release type as a word, for example [i]Release Candidate[/i][br] +## - [code]%type_technical%[/code]: Returns the release type as one or two lowercase letters, for example [i]rc[/i][br] +## - [code]%devmode%[/code]: Returns the development mode status[br] +## - [code]%headless%[/code]: Returns the headless mode status +func get_formatted_string(string: String) -> String: + # Version strings + string = string.replace("%release%", str(version_release)) + string = string.replace("%release_type%", str(version_typerelease)) + var semantic_version: Array[int] = get_version_semantic() + string = string.replace("%release_semantic%", str(semantic_version[0]) + "." + str(semantic_version[1]) + "." + str(semantic_version[2])) + match(version_type): + CoreTypes.VersionType.RELEASE: + string = string.replace("%type%", "Release") + string = string.replace("%type_technical%", "r") + CoreTypes.VersionType.RELEASECANDIDATE: + string = string.replace("%type%", "Release Candidate") + string = string.replace("%type_technical%", "rc") + CoreTypes.VersionType.BETA: + string = string.replace("%type%", "Beta") + string = string.replace("%type_technical%", "b") + CoreTypes.VersionType.ALPHA: + string = string.replace("%type%", "Alpha") + string = string.replace("%type_technical%", "a") + _: await logger.crashf("Core", "Invalid version type " + str(version_type), true) + # Development mode + if is_devmode(): string = string.replace("%devmode%", "Enabled") + else: string = string.replace("%devmode%", "Disabled") + # Headless mode + if config.headless: string = string.replace("%headless%", "Enabled") + else: string = string.replace("%headless%", "Disabled") + # Custom module support + if config.custom_modules: string = string.replace("%custommodules%", "Enabled") + else: string = string.replace("%custommodules%", "Disabled") + return string + +# Return CORE's version in the semantic versioning scheme +## Returns CORE's versioning scheme into the semantic versioning scheme.[br] +## The first integer contains the release number, the second integer contains the release type ([code]0[/code] for alpha, [code]1[/code] for beta, [code]2[/code] for rc and [code]3[/code] for release and the last integer contains the typerelease number. +func get_version_semantic() -> Array[int]: + var version_type_int: int + match(version_type): + CoreTypes.VersionType.RELEASE: version_type_int = 3 + CoreTypes.VersionType.RELEASECANDIDATE: version_type_int = 2 + CoreTypes.VersionType.BETA: version_type_int = 1 + CoreTypes.VersionType.ALPHA: version_type_int = 0 + return [version_release, version_type_int, version_typerelease] + +# Determines CORE's installation/base path +## Determines CORE's installation/base path[br] +## [br] +## [b]Calling this function is likely to be safe, but shouldn't be done nonetheless![/b] +func determine_basepath() -> bool: + if FileAccess.file_exists("res://.corebasepath"): + basepath = "res://" + elif FileAccess.file_exists("res://CORE/.corebasepath"): + basepath = "res://CORE/" + elif FileAccess.file_exists("res://addons/CORE/.corebasepath"): + basepath = "res://addons/CORE/" + else: + assert(false, "CORE is not located at 'res://CORE/', aborting initialization") + return false + return true + +# Checks Godot's version +## Checks compatibility with the running version. +func check_godot_version() -> bool: + var version: Dictionary = Engine.get_version_info() + match(version["major"]): + 4: pass + _: + printerr("The CORE Framework does not support Godot versions older or newer than 4.x.x") + return false + match(version["minor"]): + 0: printerr("The CORE Framework does not support Godot versions older than 4.2.x. Please update to Godot 4.2.x to ensure full compatibility.") + 1: printerr("The CORE Framework does not support Godot versions older than 4.2.x. Please update to Godot 4.2.x to ensure full compatibility.") + 2: pass + _: + printerr("The CORE Framework does not support Godot versions newer than 4.2.x. Please downgrade to Godot 4.2.x.") + return false + if version["status"] != "stable": + printerr("The CORE Framework does not support unstable Godot versions. Please switch to Godot stable 4.2.x.") + return false + return true diff --git a/src/Edl.gd b/src/Edl.gd new file mode 100644 index 0000000..4162c97 --- /dev/null +++ b/src/Edl.gd @@ -0,0 +1,86 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## A easy download/request maker. +## +## Allows for awaited and/or batched requests. +extends CoreBaseModule + +var list_queue: Dictionary = {} +var list_active: Dictionary = {} +var list_complete: Dictionary = {} + +func generate_id() -> int: + var id = randi() + if list_queue.has(id) or list_active.has(id): return generate_id() + logger.diagf("Edl", "Generated new download id " + str(id)) + return id + +func awaited_request(url: String, method: HTTPClient.Method = HTTPClient.Method.METHOD_GET, headers: PackedStringArray = PackedStringArray([]), data: String = "") -> Dictionary: + logger.verbf("Edl", "Creating awaited request") + var id: int = create_download(url, method, headers, data) + start_download(id) + logger.diagf("Edl", "Waiting for request " + str(id) + " to finish") + while !is_download_complete(id): await get_tree().create_timer(0.1, true).timeout + var dldata: Dictionary = list_complete[id] + list_complete.erase(id) + return dldata + +func batch_awaited_request(urls: PackedStringArray, method: HTTPClient.Method = HTTPClient.Method.METHOD_GET, headers: PackedStringArray = PackedStringArray([]), data: String = "") -> Array[Dictionary]: + logger.verbf("Edl", "Creating " + str(urls.size()) + " awaited request(s)") + var dldata: Array[Dictionary]= [] + for url in urls: + var id: int = create_download(url, method, headers, data) + start_download(id) + logger.diagf("Edl", "Waiting for request " + str(id) + " to finish") + while !is_download_complete(id): await get_tree().create_timer(0.1, true).timeout + dldata.append(list_complete[id]) + list_complete.erase(id) + return dldata + +func create_download(url: String, method: HTTPClient.Method = HTTPClient.Method.METHOD_GET, headers: PackedStringArray = PackedStringArray([]), body: String = "") -> int: + logger.verbf("Edl", "Creating new request\n-> URL: " + url + "\n-> Method: " + str(method) + "\nHeaders:\n" + str(headers) + "\nBody:\n" + body) + var id = generate_id() + list_queue.merge({ id: { "url": url, "method": method, "headers": headers, "body": body } }) + return id + +func start_download(id) -> void: + logger.verbf("Edl", "Starting request " + str(id)) + list_active.merge({ id: list_queue[id] }) + list_queue.erase(id) + logger.diagf("Edl", "Creating new HTTPRequest \"Request #" + str(id) + "\"") + var download: HTTPRequest = HTTPRequest.new() + download.name = "Request #" + str(id) + download.accept_gzip = true + download.use_threads = true + var lambda: Callable = func(result: int, http_code: int, headers: PackedStringArray, body: PackedByteArray) -> void: + logger.verbf("Edl", "Request " + str(id) + " completed\nResult: " + str(result) + "\nHTTP response code: " + str(http_code) + "\nHeaders:\n" + str(headers) + "\nBody size: " + str(body.size()) + " Bytes // " + str(core.misc.byte2mib(body.size(), true)) + " MiB") + list_complete.merge({ id: { "result": result, "http_code": http_code, "headers": headers, "body": body, "body_utf8": body.get_string_from_utf8() } }) + list_active.erase(id) + download.connect("request_completed", lambda) + add_child(download) + download.request(list_active[id]["url"], list_active[id]["headers"], list_active[id]["method"], list_active[id]["body"]) + +func is_download_complete(id: int) -> bool: return list_complete.has(id) + +func clean_queue() -> void: + logger.verbf("Edl", "Cleaning request queue") + list_queue.clear() + +func clean_completed() -> void: + logger.verbf("Edl", "Cleaning completed requests") + list_complete.clear() diff --git a/src/Logger.gd b/src/Logger.gd new file mode 100644 index 0000000..bd737e3 --- /dev/null +++ b/src/Logger.gd @@ -0,0 +1,198 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Your usual basic logger implementation, with some extra features. +## +## Allows for colored output, better newlines, multiple logger levels and a +## large variety of placeholders usable in [param config_format]. +extends CoreBaseModule + +# Signals +signal log_event + +# Configuration +var config_level: CoreTypes.LoggerLevel +var config_colored: bool +var config_format: String +var config_newlines_override: bool +var config_newlines_sizelimit: int + +# Update configuration +func _pull_config() -> void: + config_level = core.config.logger_level + config_colored = core.config.logger_colored + config_format = core.config.logger_format + config_newlines_override = core.config.logger_newlines_override + config_newlines_sizelimit = core.config.logger_newlines_sizelimit + +# Creates log messages +func _log(level: CoreTypes.LoggerLevel, origin: String, message: String) -> void: + if !is_level_allowed(level): + emit_signal("log_event", false, level, origin, message, "") + return + var format: String = config_format + format = format.replace("%time_ms%", str(Time.get_ticks_msec())) + format = format.replace("%time%", Time.get_time_string_from_system(true)) + format = format.replace("%origin%", origin) + var format_newline: String = format.replace("%color%", "").replace("%message%", "") + if !config_colored: format = format.replace("%color%", "") + match(level): + CoreTypes.LoggerLevel.DIAG: + format = format.replace("%level%", "DIAG") + format_newline = format_newline.replace("%level%", "DIAG") + format = format.replace("%color%", "[color=dark_gray]") + CoreTypes.LoggerLevel.VERB: + format = format.replace("%level%", "VERB") + format_newline = format_newline.replace("%level%", "VERB") + format = format.replace("%color%", "[color=gray]") + CoreTypes.LoggerLevel.INFO: + format = format.replace("%level%", "INFO") + format_newline = format_newline.replace("%level%", "INFO") + format = format.replace("%color%", "[color=white]") + CoreTypes.LoggerLevel.WARN: + format = format.replace("%level%", "WARN") + format_newline = format_newline.replace("%level%", "WARN") + format = format.replace("%color%", "[color=yellow]") + CoreTypes.LoggerLevel.ERROR: + format = format.replace("%level%", "ERR!") + format_newline = format_newline.replace("%level%", "ERR!") + format = format.replace("%color%", "[color=red]") + CoreTypes.LoggerLevel.NONE: + format = format.replace("%level%", "CRSH") + format_newline = format_newline.replace("%level%", "CRSH") + format = format.replace("%color%", "[b][color=red]") + # Replace %message% + if config_newlines_override and config_newlines_sizelimit <= -1 or format_newline.length() <= config_newlines_sizelimit: message = message.replace("\n", "\n" + " ".repeat(format_newline.length())) + format = format.replace("%message%", message) + emit_signal("log_event", true, level, origin, message, format) + if config_colored: print_rich(format) + else: print(format) + +# Check if level is allowed +func is_level_allowed(level: CoreTypes.LoggerLevel) -> bool: + if level <= config_level: return true + else: return false + +# Self explanitory +func diag(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.DIAG, origin, message) +func verb(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.VERB, origin, message) +func info(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.INFO, origin, message) +func warn(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.WARN, origin, message) +func error(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.ERROR, origin, message) + +# Built-in crash handler for CORE and applications using it +func crash(origin: String, message: String, framework_crash: bool = false) -> void: + # Collect information + var stack: Array[Dictionary] = get_stack() + var mem_info: Dictionary = OS.get_memory_info() + var crash_message: String = """Generating crash report... +###################################### +### CORE CRASH HANDLER ### +###################################### +%causer% inflicted a crash! +%origin% says: +%message% + + +++ CORE INFORMATION +++ +VERSION + -> Release %version_release% + -> Type %version_type% + -> Typerelease %version_typerelease% + -> Full %version_full% + -> SemVer %version_semantic% +MODES + -> Development %devmode% + -> Headless %headless% + + +++ SYSTEM INFORMATION +++ +OPERATING SYSTEM + -> Operating System %os% + -> Version %os_version% + -> Distribution %os_distribution% +LOCALE + -> Locale %locale% + -> Language %locale_lang% +MEMORY + -> Free %mem_free% + -> Available %mem_avail% + -> Used (by engine) %mem_used% + -> Total (physical) %mem_total% + -> Peak %mem_peak% +PROCESSOR + -> Name %processor_name% + -> Count %processor_count% +VIDEO + -> Adapter Information %video_adapter% + + +++ GODOT ENGINE INFORMATION +++ +BUILD + -> Debug build %godot_debug% + -> Sandboxed %godot_sandboxed% +USERDATA + -> Persistent %godot_persistance% +STACKTRACE +%godot_stacktrace% +###################################### +### CORE CRASH HANDLER ### +######################################""" + # Replace placeholders + if framework_crash: crash_message = crash_message.replace("%causer%", "The CORE Framework") + else: crash_message = crash_message.replace("%causer%", "The running application") + crash_message = crash_message.replace("%origin%", origin) + crash_message = crash_message.replace("%message%", message) + crash_message = crash_message.replace("%version_release%", str(core.version_release)) + crash_message = crash_message.replace("%version_type%", await core.get_formatted_string("%type%")) + crash_message = crash_message.replace("%version_typerelease%", str(core.version_typerelease)) + crash_message = crash_message.replace("%version_full%", str(core.version_release) + await core.get_formatted_string("-%type_technical%") + str(core.version_typerelease)) + crash_message = crash_message.replace("%version_semantic%", await core.get_formatted_string("%release_semantic%")) + crash_message = crash_message.replace("%devmode%", str(core.is_devmode())) + crash_message = crash_message.replace("%headless%", str(core.config.headless)) + crash_message = crash_message.replace("%os%", OS.get_name()) + crash_message = crash_message.replace("%os_version%", OS.get_version()) + crash_message = crash_message.replace("%os_distribution%", OS.get_distribution_name()) + crash_message = crash_message.replace("%locale%", OS.get_locale()) + crash_message = crash_message.replace("%locale_lang%", OS.get_locale_language()) + crash_message = crash_message.replace("%mem_free%", str(core.misc.mib2gib(core.misc.byte2mib(mem_info["free"], false))) + " GiB") + crash_message = crash_message.replace("%mem_avail%", str(core.misc.mib2gib(core.misc.byte2mib(mem_info["available"], false))) + " GiB") + crash_message = crash_message.replace("%mem_used%", str(core.misc.byte2mib(OS.get_static_memory_usage())) + " MiB") + crash_message = crash_message.replace("%mem_total%", str(core.misc.mib2gib(core.misc.byte2mib(mem_info["physical"], false))) + " GiB") + crash_message = crash_message.replace("%mem_peak%", str(core.misc.byte2mib(OS.get_static_memory_peak_usage())) + " MiB") + crash_message = crash_message.replace("%processor_name%", OS.get_processor_name()) + crash_message = crash_message.replace("%processor_count%", str(OS.get_processor_count())) + crash_message = crash_message.replace("%video_adapter%", str(OS.get_video_adapter_driver_info())) + crash_message = crash_message.replace("%godot_debug%", str(OS.is_debug_build())) + crash_message = crash_message.replace("%godot_sandboxed%", str(OS.is_sandboxed())) + crash_message = crash_message.replace("%godot_persistance%", str(OS.is_userfs_persistent())) + crash_message = crash_message.replace("%godot_stacktrace%", str(stack)) + # Enable newline overrides + config_newlines_override = true + config_newlines_sizelimit = -1 + # Print crash message + _log(CoreTypes.LoggerLevel.NONE, origin, crash_message) + # Shutdown + await core.misc.quit_safely(69) + +# Makes CORE development easier +func diagf(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.DIAG, core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) +func verbf(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.VERB, core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) +func infof(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.INFO, core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) +func warnf(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.WARN, core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) +func errorf(origin: String, message: String) -> void: _log(CoreTypes.LoggerLevel.ERROR, core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) +func crashf(origin: String, message: String) -> void: crash(core.basepath.replace("res://", "") + "src/" + origin + ".gd", message) + +# Returns a logger instance +func get_instance(origin: String) -> CoreLoggerInstance: return CoreLoggerInstance.new(self, origin) diff --git a/src/Logui.gd b/src/Logui.gd new file mode 100644 index 0000000..685de40 --- /dev/null +++ b/src/Logui.gd @@ -0,0 +1,89 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Displays the log graphically. +## +## Displays the log output graphically in the background of the application. +extends CoreBaseModule + +# Objects +var background: ColorRect +var logrtl: RichTextLabel + +# Resources +var font_normal: Font +var font_bold: Font + +func _initialize() -> void: + # Load fonts into memory + font_normal = ResourceLoader.load(core.basepath + "dist/FiraCode/Regular.ttf") + font_bold = ResourceLoader.load(core.basepath + "dist/FiraCode/Bold.ttf") + # Create LogUI + background = ColorRect.new() + background.name = "LOGUI" + # Create LogRTL + logrtl = RichTextLabel.new() + logrtl.name = "LogRTL" + logrtl.bbcode_enabled = true + ## Interaction + logrtl.selection_enabled = false + logrtl.deselect_on_focus_loss_enabled = true + logrtl.drag_and_drop_selection_enabled = false + logrtl.mouse_filter = Control.MOUSE_FILTER_IGNORE + ## Scrolling + logrtl.scroll_active = true + logrtl.scroll_following = true + ## Disable localization + logrtl.auto_translate = false + logrtl.localize_numeral_system = false + ## Override fonts + logrtl.add_theme_font_override("normal_font", font_normal) + logrtl.add_theme_font_override("bold_font", font_bold) + logrtl.add_theme_font_size_override("normal_font_size", 14) + logrtl.add_theme_font_size_override("bold_font_size", 14) + + # Mark as initialized + initialized = true + +func _pull_config() -> void: + background.visible = !core.config.headless and core.config.logui_enabled + background.color = core.config.logui_background_color + logrtl.add_theme_font_size_override("normal_font_size", core.config.logui_font_size) + logrtl.add_theme_font_size_override("bold_font_size", core.config.logui_font_size) + +func _ready() -> void: + # Add to SceneTree + core.sms.add_child(background) + core.sms.move_child(background, 0) + background.add_child(logrtl) + # Hide VScrollBar + var vsbar: VScrollBar = logrtl.get_child(0, true) + vsbar.set_deferred("size", Vector2i(1, 1)) + vsbar.mouse_filter = Control.MOUSE_FILTER_IGNORE + vsbar.add_theme_stylebox_override("scroll", StyleBoxEmpty.new()) + vsbar.add_theme_stylebox_override("scroll_focus", StyleBoxEmpty.new()) + vsbar.add_theme_stylebox_override("grabber", StyleBoxEmpty.new()) + vsbar.add_theme_stylebox_override("grabber_highlight", StyleBoxEmpty.new()) + vsbar.add_theme_stylebox_override("grabber_pressed", StyleBoxEmpty.new()) + # Connect log_event + logger.connect("log_event", func(allowed: bool, _level: CoreTypes.LoggerLevel, _origin: String, _message: String, format: String) -> void: if allowed: logrtl.text = logrtl.text + format + "\n") + +func _process(_delta: float) -> void: + if !core.config.headless: + var window_size: Vector2i = DisplayServer.window_get_size() + background.size = window_size + logrtl.size = window_size diff --git a/src/Misc.gd b/src/Misc.gd new file mode 100644 index 0000000..c0de803 --- /dev/null +++ b/src/Misc.gd @@ -0,0 +1,45 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Contains various useful functions that do not fit into other modules. +## +## Contains various useful functions that you can use to save yourself some time +## programming or searching. +extends CoreBaseModule + +func quit_safely(exitcode: int = 0) -> void: + logger.infof("Misc", "Shutting down (code " + str(exitcode) + ")") + logger.diagf("Misc", "Waiting for log messages to be flushed") + await get_tree().create_timer(0.25).timeout + get_tree().quit(exitcode) + +@warning_ignore("integer_division") +func byte2mib(bytes: int, flatten: bool = true) -> float: + if flatten: return bytes/1048576 + return bytes/float(1048576) + +func mib2byte(mib: float, flatten: bool = true) -> float: + if flatten: return int(mib*1048576) + return mib*1048576 + +func mib2gib(mib: float, flatten: bool = true) -> float: + if flatten: return int(mib/1024) + return mib/1024 + +func gib2mib(gib: float, flatten: bool = true) -> float: + if flatten: return int(gib*1024) + return gib*1024 diff --git a/src/Sms.gd b/src/Sms.gd new file mode 100644 index 0000000..7e0222d --- /dev/null +++ b/src/Sms.gd @@ -0,0 +1,139 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Manages scenes more efficiently. +## +## Allows for organized scene management, making development much faster. +extends CoreBaseModule + +# Objects +var scenes_debug: Node = Node.new() +var scenes_cutscene: Node = Node.new() +var scenes_menu: Node = Node.new() +var scenes_main: Node = Node.new() +var scenes_background: Node = Node.new() + +# Variables +var scenes: Dictionary = {} + +func _initialize() -> void: + scenes_debug.name = "DEBUG" + scenes_cutscene.name = "CUTSCENE" + scenes_menu.name = "MENU" + scenes_main.name = "MAIN" + scenes_background.name = "BACKGROUND" + add_child(scenes_background) + add_child(scenes_main) + add_child(scenes_menu) + add_child(scenes_cutscene) + add_child(scenes_debug) + + # Mark as initialized + initialized = true + +func _pull_config() -> void: + if core.config.headless: + # Remove all scenes + logger.verbf("Sms", "Removing all scenes (triggered by headless mode)") + for scene in scenes: remove_scene(scene, true) + +# Add a scene to some scene collection +func add_scene(sname: String, type: CoreTypes.SceneType, sclass: Node) -> bool: + if core.config.headless: return false + logger.verbf("Sms", "Adding scene \"" + sname + "\" of type " + str(type)) + if exists(sname) != CoreTypes.SceneType.NONE: + logger.errorf("Sms", "Scene with name \"" + sname + "\" already exists") + return true + sclass.name = sname + match(type): + CoreTypes.SceneType.DEBUG: scenes_debug.add_child(sclass) + CoreTypes.SceneType.CUTSCENE: scenes_cutscene.add_child(sclass) + CoreTypes.SceneType.MENU: scenes_menu.add_child(sclass) + CoreTypes.SceneType.MAIN: scenes_main.add_child(sclass) + CoreTypes.SceneType.BACKGROUND: scenes_background.add_child(sclass) + CoreTypes.SceneType.NONE: + logger.errorf("Sms", "CoreTypes.SceneType.NONE is not a valid scene type") + return false + _: await logger.crashf("Sms", "Invalid SceneType " + str(type), true) + scenes.merge({ sname: { "type": type, "class": sclass } }) + return true + +# Remove a scene from some scene collection +func remove_scene(sname: String, force_remove: bool = false) -> bool: + if core.config.headless and !force_remove: return false + if force_remove: await logger.crashf("Sms", "force_remove = true is not allowed", true) + logger.verbf("Sms", "Removing scene \"" + sname + "\"") + match(exists(sname)): + CoreTypes.SceneType.DEBUG: scenes_debug.remove_child(scenes[sname]["class"]) + CoreTypes.SceneType.CUTSCENE: scenes_cutscene.remove_child(scenes[sname]["class"]) + CoreTypes.SceneType.MENU: scenes_menu.remove_child(scenes[sname]["class"]) + CoreTypes.SceneType.MAIN: scenes_main.remove_child(scenes[sname]["class"]) + CoreTypes.SceneType.BACKGROUND: scenes_background.remove_child(scenes[sname]["class"]) + CoreTypes.SceneType.NONE: + logger.errorf("Sms", "Scene \"" + sname + "\" does not exist") + return false + _: await logger.crashf("Sms", "Invalid SceneType " + str(exists(sname)), true) + scenes.erase(sname) + return true + +# Return a loaded scene +func get_scene(sname: String) -> Node: + if core.config.headless: return null + match(exists(sname)): + CoreTypes.SceneType.DEBUG: return scenes[sname]["class"] + CoreTypes.SceneType.CUTSCENE: return scenes[sname]["class"] + CoreTypes.SceneType.MENU: return scenes[sname]["class"] + CoreTypes.SceneType.MAIN: return scenes[sname]["class"] + CoreTypes.SceneType.BACKGROUND: return scenes[sname]["class"] + CoreTypes.SceneType.NONE: logger.errorf("Sms", "Scene \"" + sname + "\" does not exist") + _: await logger.crashf("Sms", "Invalid SceneType " + str(exists(sname)), true) + return null + +# Return a scene collection for scene manipulation +func get_scene_collection(type: CoreTypes.SceneType) -> Node: + if core.config.headless: return null + match(type): + CoreTypes.SceneType.DEBUG: return scenes_debug + CoreTypes.SceneType.CUTSCENE: return scenes_cutscene + CoreTypes.SceneType.MENU: return scenes_menu + CoreTypes.SceneType.MAIN: return scenes_main + CoreTypes.SceneType.BACKGROUND: return scenes_background + CoreTypes.SceneType.NONE: logger.errorf("Sms", "No scene collection was found for CoreTypes.SceneType.NONE") + _: await logger.crashf("Sms", "Invalid SceneType " + str(type), true) + return null + +# Return scenes in some scene collection +func get_scene_collection_list(type: CoreTypes.SceneType) -> Array[Node]: + var list: Array[Node] = [] + for scene in scenes: + if scenes[scene]["type"] == type: + list.append(scene) + return list + +# Return scene count in some scene collection +func get_scene_collection_count(type: CoreTypes.SceneType) -> int: + var amount: int = 0 + for scene in scenes: + if scene[scene]["type"] == type: + amount = amount+1 + return amount + +# Return scene existance & scene collection +func exists(sname: String) -> CoreTypes.SceneType: + for scene in scenes: + if scene == sname: return scenes[scene]["type"] + return CoreTypes.SceneType.NONE diff --git a/src/Storage.gd b/src/Storage.gd new file mode 100644 index 0000000..7035da5 --- /dev/null +++ b/src/Storage.gd @@ -0,0 +1,159 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . +extends CoreBaseModule + +var is_open: bool = false +var storage: Dictionary = {} +var storage_location: String = "" + +func open_storage(location: String, create_new: bool = true, sanity_check: bool = true, fail_on_sanity_check: bool = false) -> bool: + if is_open: + logger.errorf("Storage", "Failed to open storage: A storage file is already open") + return false + logger.verbf("Storage", "Opening storage file at \"" + location + "\"") + var file: FileAccess + if !FileAccess.file_exists(location): + if create_new: + file = FileAccess.open(location, FileAccess.WRITE) + if file == null: + await logger.crashf("Storage", "Could not open storage file at \"" + location + "\": Failed with code " + str(FileAccess.get_open_error())) + return false + file.store_string("{}") + file.close() + else: + logger.errorf("Storage", "Failed to open storage: create_new is set to false") + return false + file = FileAccess.open(location, FileAccess.READ) + var storage_temp: Variant = file.get_as_text() + file.close() + storage_temp = JSON.parse_string(storage_temp) + if typeof(storage_temp) != TYPE_DICTIONARY: + logger.errorf("Storage", "Failed to open storage: Parsed storage file is of type " + str(typeof(storage_temp))) + return false + if sanity_check: + var check_result: Array[String] = perform_sanity_check(storage_temp) + if check_result.size() != 0: + if fail_on_sanity_check: + logger.errorf("Storage", "Sanity check failed (stopping):") + for error in check_result: + logger.errorf("Storage", "-> " + error) + return false + else: + logger.warnf("Storage", "Sanity check failed (continuing anyway):") + for error in check_result: + logger.warnf("Storage", "-> " + error) + storage = storage_temp + storage_location = location + is_open = true + return true + +func close_storage() -> bool: + if !is_open: + logger.errorf("Storage", "Failed to close storage: No storage file is open") + return false + logger.verbf("Storage", "Closing storage file") + storage = {} + is_open = false + return true + +func save_storage() -> bool: + if !is_open: + logger.errorf("Storage", "Failed to save storage: No storage file is open") + return false + var file: FileAccess = FileAccess.open(storage_location, FileAccess.WRITE) + if file == null: + await logger.crashf("Storage", "Could not open storage file at \"" + storage_location + "\": Failed with code " + str(FileAccess.get_open_error())) + return false + logger.diagf("Storage", "Writing storage file to disk") + file.store_string(JSON.stringify(storage)) + file.close() + return true + +func nuke_storage(autosave: bool = true) -> bool: + if !is_open: + logger.errorf("Storage", "Failed to nuke storage: No storage file is open") + return false + logger.warnf("Storage", "Nuking storage") + storage = {} + if autosave: save_storage() + return true + +func get_key(key: String, default: Variant) -> Variant: + if !is_open: + logger.errorf("Storage", "Failed to get key: No storage file is open") + return NAN + logger.diagf("Storage", "Returning storage key \"" + key + "\" (default='" + default + "')") + return storage.get(key, default) + +func set_key(key: String, value: Variant, overwrite: bool = true, autosave: bool = true) -> bool: + if !is_open: + logger.errorf("Storage", "Failed to set key: No storage file is open") + return false + logger.diagf("Storage", "Updating storage key \"" + key + "\" with value '" + str(value) + "' (overwrite='" + str(overwrite) + "' autosave='" + str(autosave) + "'") + storage.merge({key: value}, overwrite) + if autosave: save_storage() + return true + +func del_key(key: String, autosave: bool = true) -> bool: + if !is_open: + logger.errof("Storage", "Failed to delete key: No storage file is open") + return false + logger.diagf("Storage", "Deleting storage key \"" + key + "\" (autosave='" + str(autosave) + "')") + storage.erase(key) + if autosave: save_storage() + return true + +func get_dict() -> Dictionary: + if !is_open: + logger.errorf("Storage", "Failed to get dictionary: No storage file is open") + return {} + logger.verbf("Storage", "Returning storage dictionary") + return storage + +func save_dict(dict: Dictionary, sanity_check: bool = true, fail_on_sanity_check: bool = false, autosave: bool = true) -> bool: + if !is_open: + logger.errorf("Storage", "Failed to save dictionary: No storage file is open") + return false + logger.verbf("Storage", "Saving custom dictionary as storage") + if sanity_check: + var check_result: Array[String] = perform_sanity_check(dict) + if check_result.size() != 0: + if fail_on_sanity_check: + logger.errorf("Storage", "Sanity check failed (stopping):") + for error in check_result: + logger.errorf("Storage", "-> " + error) + return false + else: + logger.warnf("Storage", "Sanity check failed (continuing anyway):") + for error in check_result: + logger.warnf("Storage", "-> " + error) + storage = dict + if autosave: save_storage() + return true + +func perform_sanity_check(storage_check: Dictionary) -> Array[String]: + logger.verbf("Storage", "Performing a sanity check on some storage dictionary") + var errors: Array[String] = [] + for key in storage_check: + if typeof(key) != TYPE_STRING: + errors.append("Key \"" + str(key) + "\" is not of type String (type '" + type_string(typeof(key)) + "')") + continue + if typeof(storage_check[key]) != TYPE_NIL and typeof(storage_check[key]) != TYPE_STRING and typeof(storage_check[key]) != TYPE_INT and typeof(storage_check[key]) != TYPE_FLOAT and typeof(storage_check[key]) != TYPE_BOOL and typeof(storage_check[key]) != TYPE_ARRAY and typeof(storage_check[key]) != TYPE_DICTIONARY: + errors.append("The value of \"" + key + "\" is not null, a string, an integer, a float, boolean, array or dictionary (type '" + type_string(typeof(key)) + "')") + + logger.verbf("Storage", "Completed sanity check with " + str(errors.size()) + " errors") + return errors diff --git a/src/classes/Basemodule.gd b/src/classes/Basemodule.gd new file mode 100644 index 0000000..0117e8d --- /dev/null +++ b/src/classes/Basemodule.gd @@ -0,0 +1,41 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Template for CORE modules. +## +## Provides a basic template and a common foundation for building CORE modules. +## It provides common functions and variables used in all CORE modules. +extends Node +class_name CoreBaseModule + +## Contains a reference to the CORE Object[br] +## [br] +## Set before loading the module into the SceneTree. +var core: Core +## Reference to CORE's logger implementation.[br] +## [br] +## Will be set before [method Node._ready] +@onready var logger: CoreBaseModule = core.logger +## Marks a module as fully initialized and ready. +var initialized: bool = false + +## CORE's replacement for [method Object._init] and [method Node._ready] +## It's [b]strongly[/b] recommended to initialize your module here. +func _initialize() -> void: initialized = true +## Called by [method Core.apply_configuration]. +## This should be used to update your module configuration. +func _pull_config() -> void: pass diff --git a/src/classes/Config.gd b/src/classes/Config.gd new file mode 100644 index 0000000..b69f180 --- /dev/null +++ b/src/classes/Config.gd @@ -0,0 +1,65 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed in the Public Domain + +## The default configuration file for the CORE Framework. +## +## The [code]CoreConfiguration[/code] class holds the Framework's settings. +## The default configuration is designed to be usable without any modification. +extends Node +class_name CoreConfiguration + +@export_category("Global") +## Controls CORE's functionality. +## Renders GUI-related modules useless when set to [code]false[/code], which is the recommended behaviour on servers. For CORE's full functionality, set this to [code]true[/code]. +@export var headless: bool +## Allows debugging functionality if set to [code]true[/code], or not if set to [code]false[/code].[br] +## [br] +## Note: This will not enable the development mode automatically, only if you're developing on CORE itself. +@export var debugging: bool +## Allows or disallows custom modules. +@export var custom_modules: bool +@export_category("Logger") +## I don't have to explain this, do I? +@export var logger_level: CoreTypes.LoggerLevel +## Toggles colored output. Set to [code]false[/code] if you don't want that. +@export var logger_colored: bool +## The format string the logger will operate on. Available placeholders are: [code]%time%[/code], [code]%time_ms%[/code], [code]%level%[/code], [code]%color%[/code], [code]%message%[/code], [code]%source%[/code], [code]%source_raw%[/code], [code]%function%[/code] and [code]%line%[/code] +@export var logger_format: String +## This example should make it clear, what this does: +## [codeblock] +## logger_newlines_override = true: +## [09:47:00] [INFO Test.gd:69] This is a test message... +## with a newline! +## logger_newlines_override = false: +## [09:47:00] [INFO Test.gd:69] This is a test message... +## with a newline! +## [/codeblock] +@export var logger_newlines_override: bool +## The maximum amount of characters than can appear before [code]%message%[/code] before newlines won't be overriden. Setting this variable to [code]-1[/code] disables this behaviour. +@export var logger_newlines_sizelimit: int +@export_category("LogUI") +## Determines if [code]LogUI[/code] should be visible or not. +@export var logui_enabled: bool +## The color the [code]LogUI[/code] background will have. Set to [code]Color.TRANSPARENT[/code] for a transparent background. +@export var logui_background_color: Color +## What size the graphical log should have. +@export var logui_font_size: int + +# Populates configuration with default values +func _init() -> void: + # Global + headless = false + debugging = false + custom_modules = false + + # Logger + logger_level = CoreTypes.LoggerLevel.INFO + logger_colored = true + logger_format = "%color%[%time%] [%level% %origin%] %message%" + logger_newlines_override = true + logger_newlines_sizelimit = 40 + # LogUI + logui_enabled = true + logui_background_color = Color.BLACK # To disable the background, use Color.TRANSPARENT + logui_font_size = 14 diff --git a/src/classes/Loggerinstance.gd b/src/classes/Loggerinstance.gd new file mode 100644 index 0000000..fc64653 --- /dev/null +++ b/src/classes/Loggerinstance.gd @@ -0,0 +1,45 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . +## Passes [code]origin[/code] for you. +## +## Pretty much a wrapper around CORE's logging implementation. +## CoreLoggerInstance's only job is to save you some effort aka. +## you not needing to pass the [code]origin[/code] argument to each +## and every log call, which is extremely annoying. Thank us later ;) +extends Node +class_name CoreLoggerInstance + +## Class name +var logger: CoreBaseModule +var origin: String + +func _init(logger_new: CoreBaseModule, origin_new: String) -> void: + logger = logger_new + origin = origin_new + +## Prints a diagnostic message +func diag(message: String) -> void: logger.diag(origin, message) +## Prints a verbose message +func verb(message: String) -> void: logger.verb(origin, message) +## Prints a informational message +func info(message: String) -> void: logger.info(origin, message) +## Prints a warning message +func warn(message: String) -> void: logger.warn(origin, message) +## Prints a error message +func error(message: String) -> void: logger.error(origin, message) +## Handles crashes. Will terminate your game/application immediately. +func crash(message: String) -> void: await logger.crash(origin, message) diff --git a/src/classes/Types.gd b/src/classes/Types.gd new file mode 100644 index 0000000..5595f83 --- /dev/null +++ b/src/classes/Types.gd @@ -0,0 +1,29 @@ +# CORE FRAMEWORK SOURCE FILE +# Copyright (c) 2024 The StarOpenSource Project & Contributors +# Licensed under the GNU Affero General Public License v3 +# +# 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 . + +## Types and enums for the CORE Framework. +## +## Contains enums and types shared across the CORE Framework. +extends Node +class_name CoreTypes + +## Available version types, following the StarOpenSource Versioning Specification (SOSVS) v1 +enum VersionType { RELEASE, RELEASECANDIDATE, BETA, ALPHA } +## Available log levels, followingthe StarOpenSource Logging Specification (SOSLS) v1 +enum LoggerLevel { NONE, ERROR, WARN, INFO, VERB, DIAG } +## Available scene types +enum SceneType { NONE, DEBUG, CUTSCENE, MENU, MAIN, BACKGROUND }