diff --git a/LICENSE b/LICENSE
new file mode 100644
index 00000000..80b218f6
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ Crafty 4
+ Copyright (C) 2022 Crafty Controller
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see .
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ Copyright (C) 2022 Crafty Controller
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+.
diff --git a/app/classes/controllers/roles_controller.py b/app/classes/controllers/roles_controller.py
index 49f25d88..dbd58578 100644
--- a/app/classes/controllers/roles_controller.py
+++ b/app/classes/controllers/roles_controller.py
@@ -172,7 +172,7 @@ class RolesController:
if role:
server_ids = PermissionsServers.get_server_ids_from_role(role_id)
- role["servers"] = list(server_ids)
+ role["servers"] = server_ids
# logger.debug("role: ({}) {}".format(role_id, role))
return role
else:
diff --git a/app/classes/controllers/servers_controller.py b/app/classes/controllers/servers_controller.py
index 63f75e2d..f9aa2143 100644
--- a/app/classes/controllers/servers_controller.py
+++ b/app/classes/controllers/servers_controller.py
@@ -149,7 +149,7 @@ class ServersController:
def get_authorized_servers_stats_api_key(api_key: ApiKeys):
server_data = []
authorized_servers = ServersController.get_authorized_servers(
- api_key.user.user_id # TODO: API key authorized servers?
+ api_key.user_id # TODO: API key authorized servers?
)
for server in authorized_servers:
diff --git a/app/classes/minecraft/stats.py b/app/classes/minecraft/stats.py
index 5886eb5d..95b781ef 100644
--- a/app/classes/minecraft/stats.py
+++ b/app/classes/minecraft/stats.py
@@ -1,7 +1,9 @@
+from __future__ import annotations
import json
import logging
import datetime
import base64
+import typing as t
import psutil
from app.classes.minecraft.mc_ping import ping
@@ -9,37 +11,77 @@ from app.classes.models.management import HostStats
from app.classes.models.servers import HelperServers
from app.classes.shared.helpers import Helpers
+if t.TYPE_CHECKING:
+ from app.classes.shared.main_controller import Controller
+
logger = logging.getLogger(__name__)
+class DiskDataDict(t.TypedDict):
+ device: str
+ total_raw: int
+ total: str
+ used_raw: int
+ used: str
+ free_raw: int
+ free: str
+ percent_used: float
+ fs: str
+ mount: str
+
+
+class NodeStatsDict(t.TypedDict):
+ boot_time: str
+ cpu_usage: float
+ cpu_count: int
+ cpu_cur_freq: float
+ cpu_max_freq: float
+ mem_percent: float
+ mem_usage_raw: int
+ mem_usage: str
+ mem_total_raw: int
+ mem_total: str
+ disk_data: t.List[DiskDataDict]
+
+
+class NodeStatsReturnDict(t.TypedDict):
+ node_stats: NodeStatsDict
+
+
class Stats:
+ helper: Helpers
+ controller: Controller
+
def __init__(self, helper, controller):
self.helper = helper
self.controller = controller
- def get_node_stats(self):
+ def get_node_stats(self) -> NodeStatsReturnDict:
boot_time = datetime.datetime.fromtimestamp(psutil.boot_time())
- data = {}
try:
cpu_freq = psutil.cpu_freq()
except NotImplementedError:
cpu_freq = psutil._common.scpufreq(current=0, min=0, max=0)
- node_stats = {
+ memory = psutil.virtual_memory()
+ node_stats: NodeStatsDict = {
"boot_time": str(boot_time),
"cpu_usage": psutil.cpu_percent(interval=0.5) / psutil.cpu_count(),
"cpu_count": psutil.cpu_count(),
"cpu_cur_freq": round(cpu_freq[0], 2),
"cpu_max_freq": cpu_freq[2],
- "mem_percent": psutil.virtual_memory()[2],
- "mem_usage": Helpers.human_readable_file_size(psutil.virtual_memory()[3]),
- "mem_total": Helpers.human_readable_file_size(psutil.virtual_memory()[0]),
+ "mem_percent": memory.percent,
+ "mem_usage_raw": memory.used,
+ "mem_usage": Helpers.human_readable_file_size(memory.used),
+ "mem_total_raw": memory.total,
+ "mem_total": Helpers.human_readable_file_size(memory.total),
"disk_data": self._all_disk_usage(),
}
# server_stats = self.get_servers_stats()
# data['servers'] = server_stats
- data["node_stats"] = node_stats
- return data
+ return {
+ "node_stats": node_stats,
+ }
@staticmethod
def _get_process_stats(process):
@@ -82,7 +124,7 @@ class Stats:
# Source: https://github.com/giampaolo/psutil/blob/master/scripts/disk_usage.py
@staticmethod
- def _all_disk_usage():
+ def _all_disk_usage() -> t.List[DiskDataDict]:
disk_data = []
# print(templ % ("Device", "Total", "Used", "Free", "Use ", "Type","Mount"))
@@ -97,10 +139,13 @@ class Stats:
disk_data.append(
{
"device": part.device,
+ "total_raw": usage.total,
"total": Helpers.human_readable_file_size(usage.total),
+ "used_raw": usage.used,
"used": Helpers.human_readable_file_size(usage.used),
+ "free_raw": usage.free,
"free": Helpers.human_readable_file_size(usage.free),
- "percent_used": int(usage.percent),
+ "percent_used": usage.percent,
"fs": part.fstype,
"mount": part.mountpoint,
}
@@ -194,7 +239,7 @@ class Stats:
def record_stats(self):
stats_to_send = self.get_node_stats()
- node_stats = stats_to_send.get("node_stats")
+ node_stats = stats_to_send["node_stats"]
HostStats.insert(
{
diff --git a/app/classes/models/crafty_permissions.py b/app/classes/models/crafty_permissions.py
index 936d88bd..73b59fd8 100644
--- a/app/classes/models/crafty_permissions.py
+++ b/app/classes/models/crafty_permissions.py
@@ -1,5 +1,4 @@
import logging
-import typing
from enum import Enum
from peewee import (
ForeignKeyField,
@@ -46,37 +45,26 @@ class PermissionsCrafty:
# **********************************************************************************
@staticmethod
def get_permissions_list():
- permissions_list: typing.List[EnumPermissionsCrafty] = []
- for member in EnumPermissionsCrafty.__members__.items():
- permissions_list.append(member[1])
- return permissions_list
+ return list(EnumPermissionsCrafty.__members__.values())
@staticmethod
def get_permissions(permissions_mask):
- permissions_list: typing.List[EnumPermissionsCrafty] = []
- for member in EnumPermissionsCrafty.__members__.items():
- if PermissionsCrafty.has_permission(permissions_mask, member[1]):
- permissions_list.append(member[1])
- return permissions_list
+ return [
+ permission
+ for permission in EnumPermissionsCrafty.__members__.values()
+ if PermissionsCrafty.has_permission(permissions_mask, permission)
+ ]
@staticmethod
- def has_permission(
- permission_mask: typing.Mapping[int, str],
- permission_tested: EnumPermissionsCrafty,
- ):
- result = False
- if permission_mask[permission_tested.value] == "1":
- result = True
- return result
+ def has_permission(permission_mask, permission_tested: EnumPermissionsCrafty):
+ return permission_mask[permission_tested.value] == "1"
@staticmethod
def set_permission(
permission_mask, permission_tested: EnumPermissionsCrafty, value
):
- lst = list(permission_mask)
- lst[permission_tested.value] = str(value)
- permission_mask = "".join(lst)
- return permission_mask
+ index = permission_tested.value
+ return permission_mask[:index] + str(value) + permission_mask[index + 1 :]
@staticmethod
def get_permission(permission_mask, permission_tested: EnumPermissionsCrafty):
@@ -84,19 +72,14 @@ class PermissionsCrafty:
@staticmethod
def get_crafty_permissions_mask(user_id):
- permissions_mask = ""
+ # TODO: only get the permissions of the UserCrafty
user_crafty = PermissionsCrafty.get_user_crafty(user_id)
permissions_mask = user_crafty.permissions
return permissions_mask
@staticmethod
def get_all_permission_quantity_list():
- quantity_list = {
- EnumPermissionsCrafty.SERVER_CREATION.name: -1,
- EnumPermissionsCrafty.USER_CONFIG.name: -1,
- EnumPermissionsCrafty.ROLES_CONFIG.name: -1,
- }
- return quantity_list
+ return {name: -1 for name in EnumPermissionsCrafty.__members__.keys()}
@staticmethod
def get_permission_quantity_list(user_id):
@@ -114,7 +97,7 @@ class PermissionsCrafty:
@staticmethod
def get_user_crafty(user_id):
try:
- user_crafty = UserCrafty.select().where(UserCrafty.user_id == user_id).get()
+ user_crafty = UserCrafty.get(UserCrafty.user_id == user_id)
except DoesNotExist:
user_crafty = UserCrafty.insert(
{
@@ -146,23 +129,17 @@ class PermissionsCrafty:
limit_user_creation,
limit_role_creation,
):
- try:
- user_crafty = UserCrafty.select().where(UserCrafty.user_id == user_id).get()
- user_crafty.permissions = permissions_mask
- user_crafty.limit_server_creation = limit_server_creation
- user_crafty.limit_user_creation = limit_user_creation
- user_crafty.limit_role_creation = limit_role_creation
- UserCrafty.save(user_crafty)
- except:
- UserCrafty.insert(
- {
- UserCrafty.user_id: user_id,
- UserCrafty.permissions: permissions_mask,
- UserCrafty.limit_server_creation: limit_server_creation,
- UserCrafty.limit_user_creation: limit_user_creation,
- UserCrafty.limit_role_creation: limit_role_creation,
- }
- ).execute()
+ # http://docs.peewee-orm.com/en/latest/peewee/querying.html#upsert
+
+ UserCrafty.replace(
+ {
+ UserCrafty.user_id: user_id,
+ UserCrafty.permissions: permissions_mask,
+ UserCrafty.limit_server_creation: limit_server_creation,
+ UserCrafty.limit_user_creation: limit_user_creation,
+ UserCrafty.limit_role_creation: limit_role_creation,
+ }
+ ).execute()
@staticmethod
def get_created_quantity_list(user_id):
@@ -191,19 +168,15 @@ class PermissionsCrafty:
)
@staticmethod
- def add_server_creation(user_id):
+ def add_server_creation(user_id: int):
"""Increase the "Server Creation" counter for this user
Args:
user_id (int): The modifiable user's ID
-
- Returns:
- int: The new count of servers created by this user
"""
- user_crafty = PermissionsCrafty.get_user_crafty(user_id)
- user_crafty.created_server += 1
- UserCrafty.save(user_crafty)
- return user_crafty.created_server
+ UserCrafty.update(created_server=UserCrafty.created_server + 1).where(
+ UserCrafty.user_id == user_id
+ ).execute()
@staticmethod
def add_user_creation(user_id):
@@ -226,8 +199,10 @@ class PermissionsCrafty:
return PermissionsCrafty.get_permissions_list()
else:
if user["superuser"]:
+ # User is superuser but API key isn't
user_permissions_mask = "111"
else:
+ # Not superuser
user_permissions_mask = PermissionsCrafty.get_crafty_permissions_mask(
user["user_id"]
)
diff --git a/app/classes/models/management.py b/app/classes/models/management.py
index 1503844e..d100ee31 100644
--- a/app/classes/models/management.py
+++ b/app/classes/models/management.py
@@ -269,8 +269,7 @@ class HelpersManagement:
@staticmethod
def delete_scheduled_task(schedule_id):
- sch = Schedules.get(Schedules.schedule_id == schedule_id)
- return Schedules.delete_instance(sch)
+ return Schedules.delete().where(Schedules.schedule_id == schedule_id).execute()
@staticmethod
def update_scheduled_task(schedule_id, updates):
@@ -329,7 +328,7 @@ class HelpersManagement:
"backup_path": row.server_id.backup_path,
"excluded_dirs": row.excluded_dirs,
"max_backups": row.max_backups,
- "server_id": row.server_id.server_id,
+ "server_id": row.server_id_id,
"compress": row.compress,
}
except IndexError:
diff --git a/app/classes/models/roles.py b/app/classes/models/roles.py
index 0166244a..60338475 100644
--- a/app/classes/models/roles.py
+++ b/app/classes/models/roles.py
@@ -89,6 +89,4 @@ class HelperRoles:
@staticmethod
def role_id_exists(role_id) -> bool:
- if not HelperRoles.get_role(role_id):
- return False
- return True
+ return Roles.select().where(Roles.role_id == role_id).count() != 0
diff --git a/app/classes/models/server_permissions.py b/app/classes/models/server_permissions.py
index 02b3cd91..afdf428c 100644
--- a/app/classes/models/server_permissions.py
+++ b/app/classes/models/server_permissions.py
@@ -52,18 +52,15 @@ class PermissionsServers:
@staticmethod
def get_permissions_list():
- permissions_list: t.List[EnumPermissionsServer] = []
- for member in EnumPermissionsServer.__members__.items():
- permissions_list.append(member[1])
- return permissions_list
+ return list(EnumPermissionsServer.__members__.values())
@staticmethod
def get_permissions(permissions_mask):
- permissions_list: t.List[EnumPermissionsServer] = []
- for member in EnumPermissionsServer.__members__.items():
- if PermissionsServers.has_permission(permissions_mask, member[1]):
- permissions_list.append(member[1])
- return permissions_list
+ return [
+ permission
+ for permission in EnumPermissionsServer.__members__.values()
+ if PermissionsServers.has_permission(permissions_mask, permission)
+ ]
@staticmethod
def has_permission(permission_mask, permission_tested: EnumPermissionsServer):
@@ -84,13 +81,13 @@ class PermissionsServers:
@staticmethod
def get_token_permissions(permissions_mask, api_permissions_mask):
- permissions_list = []
- for member in EnumPermissionsServer.__members__.items():
+ return [
+ permission
+ for permission in EnumPermissionsServer.__members__.values()
if PermissionHelper.both_have_perm(
- permissions_mask, api_permissions_mask, member[1]
- ):
- permissions_list.append(member[1])
- return permissions_list
+ permissions_mask, api_permissions_mask, permission
+ )
+ ]
# **********************************************************************************
# Role_Servers Methods
@@ -160,10 +157,10 @@ class PermissionsServers:
@staticmethod
def get_role_permissions_list(role_id):
- permissions_mask = "00000000"
role_server = RoleServers.get_or_none(RoleServers.role_id == role_id)
- if role_server is not None:
- permissions_mask = role_server.permissions
+ permissions_mask = (
+ "00000000" if role_server is None else role_server.permissions
+ )
permissions_list = PermissionsServers.get_permissions(permissions_mask)
return permissions_list
@@ -181,14 +178,9 @@ class PermissionsServers:
@staticmethod
def update_role_permission(role_id, server_id, permissions_mask):
- role_server = (
- RoleServers.select()
- .where(RoleServers.role_id == role_id)
- .where(RoleServers.server_id == server_id)
- .get()
- )
- role_server.permissions = permissions_mask
- RoleServers.save(role_server)
+ RoleServers.update(permissions=permissions_mask).where(
+ RoleServers.role_id == role_id, RoleServers.server_id == server_id
+ ).execute()
@staticmethod
def delete_roles_permissions(
@@ -232,14 +224,16 @@ class PermissionsServers:
def get_server_user_list(server_id):
final_users = []
server_roles = RoleServers.select().where(RoleServers.server_id == server_id)
- super_users = Users.select().where(
+ super_users = Users.select(Users.user_id).where(
Users.superuser == True # pylint: disable=singleton-comparison
)
for role in server_roles:
- users = UserRoles.select().where(UserRoles.role_id == role.role_id)
+ users = UserRoles.select(UserRoles.user_id).where(
+ UserRoles.role_id == role.role_id
+ )
for user in users:
- if user.user_id.user_id not in final_users:
- final_users.append(user.user_id.user_id)
+ if user.user_id_id not in final_users:
+ final_users.append(user.user_id_id)
for suser in super_users:
if suser.user_id not in final_users:
final_users.append(suser.user_id)
diff --git a/app/classes/models/server_stats.py b/app/classes/models/server_stats.py
index b0b89a2e..7e16f444 100644
--- a/app/classes/models/server_stats.py
+++ b/app/classes/models/server_stats.py
@@ -76,7 +76,7 @@ class HelperServerStats:
db_folder = os.path.join(f"{server['path']}", "db_stats")
db_file = os.path.join(
db_folder,
- f"{server['server_name']}" + ".sqlite",
+ "crafty_server_stats.sqlite",
)
database = SqliteDatabase(
db_file, pragmas={"journal_mode": "wal", "cache_size": -1024 * 10}
@@ -109,7 +109,7 @@ class HelperServerStats:
db_file = os.path.join(
f"{server['path']}",
"db_stats",
- f"{server['server_name']}" + ".sqlite",
+ "crafty_server_stats.sqlite",
)
database = SqliteDatabase(
db_file, pragmas={"journal_mode": "wal", "cache_size": -1024 * 10}
@@ -211,26 +211,23 @@ class HelperServerStats:
@staticmethod
def sever_crashed(server_id):
HelperServerStats.select_database(server_id)
- with database_stats_proxy.atomic():
- ServerStats.update(crashed=True).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(crashed=True).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def set_download(server_id):
HelperServerStats.select_database(server_id)
- with database_stats_proxy.atomic():
- ServerStats.update(downloading=True).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(downloading=True).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def finish_download(server_id):
HelperServerStats.select_database(server_id)
- with database_stats_proxy.atomic():
- ServerStats.update(downloading=False).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(downloading=False).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def get_download_status(server_id):
@@ -246,10 +243,9 @@ class HelperServerStats:
return
HelperServerStats.select_database(server_id)
- with database_stats_proxy.atomic():
- ServerStats.update(crashed=False).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(crashed=False).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def is_crashed(server_id):
@@ -272,10 +268,9 @@ class HelperServerStats:
ServerStats.select().where(ServerStats.server_id == server_id)
except Exception as ex:
logger.error(f"Database entry not found! {ex}")
- with database_stats_proxy.atomic():
- ServerStats.update(updating=value).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(updating=value).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def get_update_status(server_id):
@@ -295,10 +290,9 @@ class HelperServerStats:
except Exception as ex:
logger.error(f"Database entry not found! {ex}")
return
- with database_stats_proxy.atomic():
- ServerStats.update(first_run=False).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(first_run=False).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def get_first_run(server_id):
@@ -341,10 +335,9 @@ class HelperServerStats:
ServerStats.select().where(ServerStats.server_id == server_id)
except Exception as ex:
logger.error(f"Database entry not found! {ex}")
- with database_stats_proxy.atomic():
- ServerStats.update(waiting_start=value).where(
- ServerStats.server_id == server_id
- ).execute()
+ ServerStats.update(waiting_start=value).where(
+ ServerStats.server_id == server_id
+ ).execute()
@staticmethod
def get_waiting_start(server_id):
diff --git a/app/classes/models/servers.py b/app/classes/models/servers.py
index 6e1af166..42b119a4 100644
--- a/app/classes/models/servers.py
+++ b/app/classes/models/servers.py
@@ -120,8 +120,7 @@ class HelperServers:
return server_obj.save()
def remove_server(self, server_id):
- with self.database.atomic():
- Servers.delete().where(Servers.server_id == server_id).execute()
+ Servers.delete().where(Servers.server_id == server_id).execute()
@staticmethod
def get_server_data_by_id(server_id):
diff --git a/app/classes/models/users.py b/app/classes/models/users.py
index f2dc4460..620a6688 100644
--- a/app/classes/models/users.py
+++ b/app/classes/models/users.py
@@ -275,9 +275,7 @@ class HelperUsers:
@staticmethod
def user_id_exists(user_id):
- if not HelperUsers.get_user(user_id):
- return False
- return True
+ return Users.select().where(Users.user_id == user_id).count() != 0
# **********************************************************************************
# User_Roles Methods
@@ -323,10 +321,7 @@ class HelperUsers:
.join(Roles, JOIN.INNER)
.where(UserRoles.user_id == user_id)
)
- # TODO: this query needs to be narrower
- roles = set()
- for r in roles_query:
- roles.add(r.role_id.role_id)
+ roles = {r.role_id_id for r in roles_query}
if isinstance(user, dict):
user["roles"] = roles
diff --git a/app/classes/shared/command.py b/app/classes/shared/command.py
index 2071c645..2fb222cb 100644
--- a/app/classes/shared/command.py
+++ b/app/classes/shared/command.py
@@ -22,9 +22,7 @@ class MainPrompt(cmd.Cmd):
# overrides the default Prompt
self.prompt = f"Crafty Controller v{self.helper.get_version_string()} > "
- # see MR !233 for pylint exemptino reason
- @staticmethod
- def emptyline(): # pylint: disable=arguments-differ
+ def emptyline(self):
pass
def do_exit(self, _line):
@@ -88,11 +86,15 @@ class MainPrompt(cmd.Cmd):
for thread in threading.enumerate():
if sys.version_info >= (3, 8):
print(
- f"Name: {thread.name} Identifier: "
- f"{thread.ident} TID/PID: {thread.native_id}"
+ f"Name: {thread.name}\tIdentifier: "
+ f"{thread.ident}\tTID/PID: {thread.native_id}"
)
else:
- print(f"Name: {thread.name} Identifier: {thread.ident}")
+ print(f"Name: {thread.name}\tIdentifier: {thread.ident}")
+
+ def print_prompt(self):
+ self.stdout.write(self.prompt)
+ self.stdout.flush()
def do_import3(self, _line):
Import3.start_import()
diff --git a/app/classes/shared/console.py b/app/classes/shared/console.py
index 4c330cf3..84362032 100644
--- a/app/classes/shared/console.py
+++ b/app/classes/shared/console.py
@@ -1,8 +1,10 @@
import datetime
import logging
import sys
+import locale
logger = logging.getLogger(__name__)
+locale.setlocale(locale.LC_ALL, "") # Get the locale from the environment
try:
from colorama import init
@@ -21,6 +23,11 @@ class Console:
if "colorama" in sys.modules:
init()
+ @staticmethod
+ def get_fmt_date_time():
+ # This will use the local date (%x) and time (%X) formatting
+ return datetime.datetime.now().strftime("%x %X")
+
@staticmethod
def do_print(message, color):
if "termcolor" in sys.modules or "colorama" in sys.modules:
@@ -54,30 +61,30 @@ class Console:
@staticmethod
def debug(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.magenta(f"[+] Crafty: {date_time} - DEBUG:\t{message}")
@staticmethod
def info(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.white(f"[+] Crafty: {date_time} - INFO:\t{message}")
@staticmethod
def warning(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.cyan(f"[+] Crafty: {date_time} - WARNING:\t{message}")
@staticmethod
def error(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.yellow(f"[+] Crafty: {date_time} - ERROR:\t{message}")
@staticmethod
def critical(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.red(f"[+] Crafty: {date_time} - CRITICAL:\t{message}")
@staticmethod
def help(message):
- date_time = datetime.datetime.now().strftime("%Y-%m-%d %I:%M:%S %p")
+ date_time = Console.get_fmt_date_time()
Console.green(f"[+] Crafty: {date_time} - HELP:\t{message}")
diff --git a/app/classes/shared/main_controller.py b/app/classes/shared/main_controller.py
index 9e08c04c..d3a7bf7b 100644
--- a/app/classes/shared/main_controller.py
+++ b/app/classes/shared/main_controller.py
@@ -273,13 +273,23 @@ class Controller:
except:
return {"percent": 0, "total_files": 0}
- def get_server_obj(self, server_id: t.Union[str, int]) -> t.Union[bool, Server]:
+ def get_server_obj(self, server_id: t.Union[str, int]) -> Server:
for server in self.servers_list:
if str(server["server_id"]) == str(server_id):
return server["server_obj"]
logger.warning(f"Unable to find server object for server id {server_id}")
- return False # TODO: Change to None
+ raise Exception(f"Unable to find server object for server id {server_id}")
+
+ def get_server_obj_optional(
+ self, server_id: t.Union[str, int]
+ ) -> t.Optional[Server]:
+ for server in self.servers_list:
+ if str(server["server_id"]) == str(server_id):
+ return server["server_obj"]
+
+ logger.warning(f"Unable to find server object for server id {server_id}")
+ return None
def get_server_data(self, server_id: str):
for server in self.servers_list:
diff --git a/app/classes/shared/server.py b/app/classes/shared/server.py
index 7be5fad4..7d85ad59 100644
--- a/app/classes/shared/server.py
+++ b/app/classes/shared/server.py
@@ -263,27 +263,18 @@ class Server:
# Checks for eula. Creates one if none detected.
# If EULA is detected and not set to true we offer to set it true.
+ e_flag = False
if Helpers.check_file_exists(os.path.join(self.settings["path"], "eula.txt")):
- f = open(
+ with open(
os.path.join(self.settings["path"], "eula.txt"), "r", encoding="utf-8"
- )
- line = f.readline().lower()
- if line == "eula=true":
- e_flag = True
-
- elif line == "eula = true":
- e_flag = True
-
- elif line == "eula= true":
- e_flag = True
-
- elif line == "eula =true":
- e_flag = True
-
- else:
- e_flag = False
- else:
- e_flag = False
+ ) as f:
+ line = f.readline().lower()
+ e_flag = line in [
+ "eula=true",
+ "eula = true",
+ "eula= true",
+ "eula =true",
+ ]
if not e_flag:
if user_id:
@@ -295,9 +286,7 @@ class Server:
"Autostart failed due to EULA being false. "
"Agree not sent due to auto start."
)
- return False
return False
- f.close()
if Helpers.is_os_windows():
logger.info("Windows Detected")
else:
@@ -309,15 +298,16 @@ class Server:
# checks to make sure file is openable (downloaded) and exists.
try:
- f = open(
+ with open(
os.path.join(
self.server_path,
HelperServers.get_server_data_by_id(self.server_id)["executable"],
),
"r",
encoding="utf-8",
- )
- f.close()
+ ):
+ # Can open the file
+ pass
except:
if user_id:
diff --git a/app/classes/shared/tasks.py b/app/classes/shared/tasks.py
index 3892d662..58e1cc2d 100644
--- a/app/classes/shared/tasks.py
+++ b/app/classes/shared/tasks.py
@@ -87,10 +87,11 @@ class TasksManager:
svr = self.controller.get_server_obj(cmd.server_id)
except:
logger.error(
- "Server value requested does note exist! "
+ "Server value requested does not exist! "
"Purging item from waiting commands."
)
HelpersManagement.mark_command_complete(cmd.command_id)
+ continue
user_id = cmd.user_id
command = cmd.command
diff --git a/app/classes/web/panel_handler.py b/app/classes/web/panel_handler.py
index b627b7fb..deac2db1 100644
--- a/app/classes/web/panel_handler.py
+++ b/app/classes/web/panel_handler.py
@@ -180,7 +180,7 @@ class PanelHandler(BaseHandler):
logger.debug(
f'User {exec_user["user_id"]} does not have permission'
)
- self.redirect("/pandel/error?error=Invalid Server ID")
+ self.redirect("/panel/error?error=Invalid Server ID")
return None
return server_id
@@ -221,10 +221,9 @@ class PanelHandler(BaseHandler):
if api_key is not None:
superuser = superuser and api_key.superuser
- exec_user_role = set()
if superuser: # TODO: Figure out a better solution
defined_servers = self.controller.list_defined_servers()
- exec_user_role.add("Super User")
+ exec_user_role = {"Super User"}
exec_user_crafty_permissions = (
self.controller.crafty_perms.list_defined_crafty_permissions()
)
@@ -240,6 +239,7 @@ class PanelHandler(BaseHandler):
)
)
logger.debug(exec_user["roles"])
+ exec_user_role = set()
for r in exec_user["roles"]:
role = self.controller.roles.get_role(r)
exec_user_role.add(role["role_name"])
@@ -878,11 +878,16 @@ class PanelHandler(BaseHandler):
template = "panel/server_schedule_edit.html"
elif page == "edit_schedule":
- server_id = self.get_argument("id", None)
+ server_id = self.check_server_id()
+ if not server_id:
+ return
+
page_data["schedules"] = HelpersManagement.get_schedules_by_server(
server_id
)
sch_id = self.get_argument("sch_id", None)
+ if sch_id is None:
+ self.redirect("/panel/error?error=Invalid Schedule ID")
schedule = self.controller.management.get_scheduled_task_model(sch_id)
page_data["get_players"] = lambda: self.controller.stats.get_server_players(
server_id
@@ -946,9 +951,6 @@ class PanelHandler(BaseHandler):
difficulty = "advanced"
page_data["schedule"]["difficulty"] = difficulty
- if sch_id is None or server_id is None:
- self.redirect("/panel/error?error=Invalid server ID or Schedule ID")
-
if not EnumPermissionsServer.SCHEDULE in page_data["user_permissions"]:
if not superuser:
self.redirect("/panel/error?error=Unauthorized access To Schedules")
@@ -960,12 +962,11 @@ class PanelHandler(BaseHandler):
user_id = self.get_argument("id", None)
role_servers = self.controller.servers.get_authorized_servers(user_id)
page_role_servers = []
- servers = set()
for server in role_servers:
page_role_servers.append(server["server_id"])
page_data["new_user"] = False
page_data["user"] = self.controller.users.get_user_by_id(user_id)
- page_data["servers"] = servers
+ page_data["servers"] = set()
page_data["role-servers"] = page_role_servers
page_data["roles_all"] = self.controller.roles.get_all_roles()
page_data["servers_all"] = self.controller.list_defined_servers()
@@ -1254,10 +1255,9 @@ class PanelHandler(BaseHandler):
"Config": EnumPermissionsServer.CONFIG,
"Players": EnumPermissionsServer.PLAYERS,
}
- exec_user_role = set()
if superuser:
# defined_servers = self.controller.list_defined_servers()
- exec_user_role.add("Super User")
+ exec_user_role = {"Super User"}
exec_user_crafty_permissions = (
self.controller.crafty_perms.list_defined_crafty_permissions()
)
@@ -1269,6 +1269,7 @@ class PanelHandler(BaseHandler):
)
# defined_servers =
# self.controller.servers.get_authorized_servers(exec_user["user_id"])
+ exec_user_role = set()
for r in exec_user["roles"]:
role = self.controller.roles.get_role(r)
exec_user_role.add(role["role_name"])
@@ -1365,7 +1366,23 @@ class PanelHandler(BaseHandler):
if page == "server_backup":
logger.debug(self.request.arguments)
- server_id = self.get_argument("id", None)
+
+ server_id = self.check_server_id()
+ if not server_id:
+ return
+
+ if (
+ not permissions["Backup"]
+ in self.controller.server_perms.get_user_id_permissions_list(
+ exec_user["user_id"], server_id
+ )
+ and not superuser
+ ):
+ self.redirect(
+ "/panel/error?error=Unauthorized access: User not authorized"
+ )
+ return
+
server_obj = self.controller.servers.get_server_obj(server_id)
compress = self.get_argument("compress", False)
check_changed = self.get_argument("changed")
@@ -1382,25 +1399,6 @@ class PanelHandler(BaseHandler):
backup_path = server_obj.backup_path
max_backups = bleach.clean(self.get_argument("max_backups", None))
- if not permissions[
- "Backup"
- ] in self.controller.server_perms.get_user_id_permissions_list(
- exec_user["user_id"], server_id
- ):
- if not superuser:
- self.redirect(
- "/panel/error?error=Unauthorized access: User not authorized"
- )
- return
- elif server_id is None:
- self.redirect("/panel/error?error=Invalid Server ID")
- return
- else:
- # does this server id exist?
- if not self.controller.servers.server_id_exists(server_id):
- self.redirect("/panel/error?error=Invalid Server ID")
- return
-
server_obj = self.controller.servers.get_server_obj(server_id)
server_obj.backup_path = backup_path
self.controller.servers.update_server(server_obj)
@@ -1421,7 +1419,22 @@ class PanelHandler(BaseHandler):
self.redirect(f"/panel/server_detail?id={server_id}&subpage=backup")
if page == "new_schedule":
- server_id = bleach.clean(self.get_argument("id", None))
+ server_id = self.check_server_id()
+ if not server_id:
+ return
+
+ if (
+ not permissions["Schedule"]
+ in self.controller.server_perms.get_user_id_permissions_list(
+ exec_user["user_id"], server_id
+ )
+ and not superuser
+ ):
+ self.redirect(
+ "/panel/error?error=Unauthorized access: User not authorized"
+ )
+ return
+
difficulty = bleach.clean(self.get_argument("difficulty", None))
server_obj = self.controller.servers.get_server_obj(server_id)
enabled = bleach.clean(self.get_argument("enabled", "0"))
@@ -1487,85 +1500,67 @@ class PanelHandler(BaseHandler):
else:
one_time = False
- if not superuser and not permissions[
- "Schedule"
- ] in self.controller.server_perms.get_user_id_permissions_list(
- exec_user["user_id"], server_id
- ):
- self.redirect(
- "/panel/error?error=Unauthorized access: User not authorized"
- )
- return
- elif server_id is None:
- self.redirect("/panel/error?error=Invalid Server ID")
- return
+ if interval_type == "days":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": interval,
+ "command": command,
+ "start_time": sch_time,
+ "enabled": enabled,
+ "one_time": one_time,
+ "cron_string": "",
+ "parent": None,
+ "delay": 0,
+ }
+ elif difficulty == "reaction":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": "",
+ # We'll base every interval off of a midnight start time.
+ "start_time": "",
+ "command": command,
+ "cron_string": "",
+ "enabled": enabled,
+ "one_time": one_time,
+ "parent": parent,
+ "delay": delay,
+ }
+ elif difficulty == "advanced":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": "",
+ "interval": "",
+ # We'll base every interval off of a midnight start time.
+ "start_time": "",
+ "command": command,
+ "cron_string": cron_string,
+ "enabled": enabled,
+ "one_time": one_time,
+ "parent": None,
+ "delay": 0,
+ }
else:
- # does this server id exist?
- if not self.controller.servers.server_id_exists(server_id):
- self.redirect("/panel/error?error=Invalid Server ID")
- return
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": interval,
+ "command": command,
+ "enabled": enabled,
+ # We'll base every interval off of a midnight start time.
+ "start_time": "00:00",
+ "one_time": one_time,
+ "cron_string": "",
+ "parent": None,
+ "delay": 0,
+ }
- if interval_type == "days":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": interval,
- "command": command,
- "start_time": sch_time,
- "enabled": enabled,
- "one_time": one_time,
- "cron_string": "",
- "parent": None,
- "delay": 0,
- }
- elif difficulty == "reaction":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": "",
- # We'll base every interval off of a midnight start time.
- "start_time": "",
- "command": command,
- "cron_string": "",
- "enabled": enabled,
- "one_time": one_time,
- "parent": parent,
- "delay": delay,
- }
- elif difficulty == "advanced":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": "",
- "interval": "",
- # We'll base every interval off of a midnight start time.
- "start_time": "",
- "command": command,
- "cron_string": cron_string,
- "enabled": enabled,
- "one_time": one_time,
- "parent": None,
- "delay": 0,
- }
- else:
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": interval,
- "command": command,
- "enabled": enabled,
- # We'll base every interval off of a midnight start time.
- "start_time": "00:00",
- "one_time": one_time,
- "cron_string": "",
- "parent": None,
- "delay": 0,
- }
-
- self.tasks_manager.schedule_job(job_data)
+ self.tasks_manager.schedule_job(job_data)
self.controller.management.add_to_audit_log(
exec_user["user_id"],
@@ -1577,7 +1572,26 @@ class PanelHandler(BaseHandler):
self.redirect(f"/panel/server_detail?id={server_id}&subpage=schedules")
if page == "edit_schedule":
- server_id = bleach.clean(self.get_argument("id", None))
+ server_id = self.check_server_id()
+ if not server_id:
+ return
+
+ if (
+ not permissions["Schedule"]
+ in self.controller.server_perms.get_user_id_permissions_list(
+ exec_user["user_id"], server_id
+ )
+ and not superuser
+ ):
+ self.redirect(
+ "/panel/error?error=Unauthorized access: User not authorized"
+ )
+ return
+
+ sch_id = self.get_argument("sch_id", None)
+ if sch_id is None:
+ self.redirect("/panel/error?error=Invalid Schedule ID")
+
difficulty = bleach.clean(self.get_argument("difficulty", None))
server_obj = self.controller.servers.get_server_obj(server_id)
enabled = bleach.clean(self.get_argument("enabled", "0"))
@@ -1617,7 +1631,6 @@ class PanelHandler(BaseHandler):
else:
interval_type = ""
cron_string = bleach.clean(self.get_argument("cron", ""))
- sch_id = self.get_argument("sch_id", None)
if not croniter.is_valid(cron_string):
self.redirect(
"/panel/error?error=INVALID FORMAT: Invalid Cron Format."
@@ -1643,85 +1656,66 @@ class PanelHandler(BaseHandler):
else:
one_time = False
- if not superuser and not permissions[
- "Schedule"
- ] in self.controller.server_perms.get_user_id_permissions_list(
- exec_user["user_id"], server_id
- ):
- self.redirect(
- "/panel/error?error=Unauthorized access: User not authorized"
- )
- return
- elif server_id is None:
- self.redirect("/panel/error?error=Invalid Server ID")
- return
+ if interval_type == "days":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": interval,
+ "command": command,
+ "start_time": sch_time,
+ "enabled": enabled,
+ "one_time": one_time,
+ "cron_string": "",
+ "parent": None,
+ "delay": 0,
+ }
+ elif difficulty == "advanced":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": "",
+ "interval": "",
+ # We'll base every interval off of a midnight start time.
+ "start_time": "",
+ "command": command,
+ "cron_string": cron_string,
+ "delay": "",
+ "parent": "",
+ "enabled": enabled,
+ "one_time": one_time,
+ }
+ elif difficulty == "reaction":
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": "",
+ # We'll base every interval off of a midnight start time.
+ "start_time": "",
+ "command": command,
+ "cron_string": "",
+ "enabled": enabled,
+ "one_time": one_time,
+ "parent": parent,
+ "delay": delay,
+ }
else:
- # does this server id exist?
- if not self.controller.servers.server_id_exists(server_id):
- self.redirect("/panel/error?error=Invalid Server ID")
- return
-
- if interval_type == "days":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": interval,
- "command": command,
- "start_time": sch_time,
- "enabled": enabled,
- "one_time": one_time,
- "cron_string": "",
- "parent": None,
- "delay": 0,
- }
- elif difficulty == "advanced":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": "",
- "interval": "",
- # We'll base every interval off of a midnight start time.
- "start_time": "",
- "command": command,
- "cron_string": cron_string,
- "delay": "",
- "parent": "",
- "enabled": enabled,
- "one_time": one_time,
- }
- elif difficulty == "reaction":
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": "",
- # We'll base every interval off of a midnight start time.
- "start_time": "",
- "command": command,
- "cron_string": "",
- "enabled": enabled,
- "one_time": one_time,
- "parent": parent,
- "delay": delay,
- }
- else:
- job_data = {
- "server_id": server_id,
- "action": action,
- "interval_type": interval_type,
- "interval": interval,
- "command": command,
- "enabled": enabled,
- # We'll base every interval off of a midnight start time.
- "start_time": "00:00",
- "delay": "",
- "parent": "",
- "one_time": one_time,
- "cron_string": "",
- }
- sch_id = self.get_argument("sch_id", None)
- self.tasks_manager.update_job(sch_id, job_data)
+ job_data = {
+ "server_id": server_id,
+ "action": action,
+ "interval_type": interval_type,
+ "interval": interval,
+ "command": command,
+ "enabled": enabled,
+ # We'll base every interval off of a midnight start time.
+ "start_time": "00:00",
+ "delay": "",
+ "parent": "",
+ "one_time": one_time,
+ "cron_string": "",
+ }
+ self.tasks_manager.update_job(sch_id, job_data)
self.controller.management.add_to_audit_log(
exec_user["user_id"],
@@ -1905,7 +1899,7 @@ class PanelHandler(BaseHandler):
self.write(
self.controller.authentication.generate(
- key.user_id.user_id, {"token_id": key.token_id}
+ key.user_id_id, {"token_id": key.token_id}
)
)
self.finish()
diff --git a/app/classes/web/server_handler.py b/app/classes/web/server_handler.py
index 44da81df..4ab5260e 100644
--- a/app/classes/web/server_handler.py
+++ b/app/classes/web/server_handler.py
@@ -27,10 +27,9 @@ class ServerHandler(BaseHandler):
if api_key is not None:
superuser = superuser and api_key.superuser
- exec_user_role = set()
if superuser:
defined_servers = self.controller.list_defined_servers()
- exec_user_role.add("Super User")
+ exec_user_role = {"Super User"}
exec_user_crafty_permissions = (
self.controller.crafty_perms.list_defined_crafty_permissions()
)
@@ -47,6 +46,7 @@ class ServerHandler(BaseHandler):
exec_user["user_id"]
)
list_roles = []
+ exec_user_role = set()
for r in exec_user["roles"]:
role = self.controller.roles.get_role(r)
exec_user_role.add(role["role_name"])
diff --git a/app/classes/web/tornado_handler.py b/app/classes/web/tornado_handler.py
index f501c7d1..32385ab5 100644
--- a/app/classes/web/tornado_handler.py
+++ b/app/classes/web/tornado_handler.py
@@ -224,7 +224,7 @@ class Webserver:
f"is up and ready for connections."
)
- Console.info("Server Init Complete: Listening For Connections:")
+ Console.info("Server Init Complete: Listening For Connections!")
self.ioloop = tornado.ioloop.IOLoop.current()
self.ioloop.start()
diff --git a/docker/unraid.xml b/docker/unraid.xml
index a0ba70a6..f36f123c 100644
--- a/docker/unraid.xml
+++ b/docker/unraid.xml
@@ -9,27 +9,27 @@
false
https://discord.gg/9VJPhCE
https://craftycontrol.com/
- Crafty Controller is a lightweight Minecraft wrapper with great featuers and a awesome GUI, acessible from a modern web browser.
-The username and password appear on the first launch in the Docker logs!
+ Crafty 4 is the next iteration of our Minecraft Server Wrapper / Controller / Launcher. Boasting a clean new look, rebuilt from the ground up. Crafty 4 brings a whole host of new features such as Bedrock support. With SteamCMD support on the way!
+Default login Credentrails are username: "admin" password: "crafty" logs!
Crafty 4 is the successor of Crafty Controller, the Docker image is no longer maintained on DockerHub. (now on GitLab)
-For official support join the discord: https://discord.gg/9VJPhCE
-For migration from 3.x please refer to the documentation on GitLab: https://wiki.craftycontrol.com/
+For official support join the Discord: https://discord.gg/9VJPhCE
+For migration from 3.x please refer to the documentation: https://wiki.craftycontrol.com/en/4/
GameServers: Other:
https://[IP]:[PORT:8443]/
- https://gitlab.com/crafty-controller/crafty-4/-/blob/dev/docker/unraid.xml
- https://gitlab.com/crafty-controller/crafty-4/-/raw/master/app/frontend/static/assets/images/logo_square.jpg
+ https://gitlab.com/crafty-controller/crafty-4/-/raw/master/docker/unraid.xml
+ https://gitlab.com/crafty-controller/crafty-4/-/blob/master/app/frontend/static/assets/images/Crafty_4-0_Logo_square.ico
- Help to support Crafty on Patreon
- https://www.patreon.com/craftycontroller
- Crafty Controller is a lightweight Minecraft wrapper with great featuers and a awesome GUI, acessible from a modern web browser.
-The username and password appear on the first launch in the Docker logs!
+ Help to support Crafty on Kofi
+ https://ko-fi.com/arcadiatech
+ Crafty 4 is the next iteration of our Minecraft Server Wrapper / Controller / Launcher. Boasting a clean new look, rebuilt from the ground up. Crafty 4 brings a whole host of new features such as Bedrock support. With SteamCMD support on the way!
+Default login Credentrails are username: "admin" password: "crafty" logs!
Crafty 4 is the successor of Crafty Controller, the Docker image is no longer maintained on DockerHub. (now on GitLab)
-For official support join the discord: https://discord.gg/9VJPhCE
-For migration from 3.x please refer to the documentation on GitLab: https://gitlab.com/crafty-controller/crafty-4/-/wikis/home
+For official support join the Discord: https://discord.gg/9VJPhCE
+For migration from 3.x please refer to the documentation: https://wiki.craftycontrol.com/en/4/
bridge
diff --git a/main.py b/main.py
index 4de06eb4..10179729 100644
--- a/main.py
+++ b/main.py
@@ -1,6 +1,7 @@
import os
import sys
import json
+from threading import Thread
import time
import argparse
import logging.config
@@ -135,8 +136,17 @@ if __name__ == "__main__":
tasks_manager = TasksManager(helper, controller)
tasks_manager.start_webserver()
- # slowing down reporting just for a 1/2 second so messages look cleaner
- time.sleep(0.5)
+ def signal_handler(signum, _frame):
+ if not args.daemon:
+ print() # for newline after prompt
+ signame = signal.Signals(signum).name
+ logger.info(f"Recieved signal {signame} [{signum}], stopping Crafty...")
+ Console.info(f"Recieved signal {signame} [{signum}], stopping Crafty...")
+ tasks_manager._main_graceful_exit()
+ crafty_prompt.universal_exit()
+
+ signal.signal(signal.SIGTERM, signal_handler)
+ signal.signal(signal.SIGINT, signal_handler)
# init servers
logger.info("Initializing all servers defined")
@@ -144,69 +154,87 @@ if __name__ == "__main__":
controller.init_all_servers()
servers = controller.list_defined_servers()
- # start stats logging
- tasks_manager.start_stats_recording()
+ def tasks_starter():
+ # start stats logging
+ tasks_manager.start_stats_recording()
- # once the controller is up and stats are logging, we can kick off
- # the scheduler officially
- tasks_manager.start_scheduler()
+ # once the controller is up and stats are logging, we can kick off
+ # the scheduler officially
+ tasks_manager.start_scheduler()
- # refresh our cache and schedule for every 12 hoursour cache refresh
- # for serverjars.com
- tasks_manager.serverjar_cache_refresher()
+ # refresh our cache and schedule for every 12 hoursour cache refresh
+ # for serverjars.com
+ tasks_manager.serverjar_cache_refresher()
- logger.info("Checking Internet. This may take a minute.")
- Console.info("Checking Internet. This may take a minute.")
+ tasks_starter_thread = Thread(target=tasks_starter, name="tasks_starter")
- if not helper.check_internet():
- Console.warning(
- "We have detected the machine running Crafty has no "
- "connection to the internet. Client connections to "
- "the server may be limited."
- )
+ def internet_check():
+ logger.info("Checking Internet. This may take a minute.")
+ Console.info("Checking Internet. This may take a minute.")
- if not controller.check_system_user():
- controller.add_system_user()
+ if not helper.check_internet():
+ logger.warning(
+ "We have detected the machine running Crafty has no "
+ "connection to the internet. Client connections to "
+ "the server may be limited."
+ )
+ Console.warning(
+ "We have detected the machine running Crafty has no "
+ "connection to the internet. Client connections to "
+ "the server may be limited."
+ )
- Crafty = MainPrompt(helper, tasks_manager, migration_manager, controller)
+ internet_check_thread = Thread(target=internet_check, name="internet_check")
- project_root = os.path.dirname(__file__)
- controller.set_project_root(project_root)
- controller.clear_unexecuted_commands()
- controller.clear_support_status()
+ def controller_setup():
+ if not controller.check_system_user():
+ controller.add_system_user()
- def sigterm_handler(*sig):
- print() # for newline
- logger.info(
- f"Recieved {signal.Signals(sig[0]).name} [{sig[0]}], stopping Crafty..."
- )
- Console.info(
- f"Recieved {signal.Signals(sig[0]).name} [{sig[0]}], stopping Crafty..."
- )
- tasks_manager._main_graceful_exit()
- Crafty.universal_exit()
+ project_root = os.path.dirname(__file__)
+ controller.set_project_root(project_root)
+ controller.clear_unexecuted_commands()
+ controller.clear_support_status()
- signal.signal(signal.SIGTERM, sigterm_handler)
+ crafty_prompt = MainPrompt(helper, tasks_manager, migration_manager, controller)
+
+ controller_setup_thread = Thread(target=controller_setup, name="controller_setup")
+
+ def setup_starter():
+ if not args.daemon:
+ time.sleep(0.01) # Wait for the prompt to start
+ print() # Make a newline after the prompt so logs are on an empty line
+ else:
+ time.sleep(0.01) # Wait for the daemon info message
+
+ Console.info("Setting up Crafty's internal components...")
+
+ # Start the setup threads
+ tasks_starter_thread.start()
+ internet_check_thread.start()
+ controller_setup_thread.start()
+
+ # Wait for the setup threads to finish
+ tasks_starter_thread.join()
+ internet_check_thread.join()
+ controller_setup_thread.join()
+
+ Console.info("Crafty has fully started and is now ready for use!")
+
+ if not args.daemon:
+ # Put the prompt under the cursor
+ crafty_prompt.print_prompt()
+
+ Thread(target=setup_starter, name="setup_starter").start()
if not args.daemon:
- try:
- Crafty.cmdloop()
- except KeyboardInterrupt:
- print() # for newline
- logger.info("Recieved SIGINT, stopping Crafty...")
- Console.info("Recieved SIGINT, stopping Crafty...")
- tasks_manager._main_graceful_exit()
- Crafty.universal_exit()
+ # Start the Crafty prompt
+ crafty_prompt.cmdloop()
else:
- print("Crafty started in daemon mode, no shell will be printed")
+ Console.info("Crafty started in daemon mode, no shell will be printed")
+ print()
while True:
- try:
- if tasks_manager.get_main_thread_run_status():
- break
- time.sleep(1)
- except KeyboardInterrupt:
- logger.info("Recieved SIGINT, stopping Crafty...")
- Console.info("Recieved SIGINT, stopping Crafty...")
+ if tasks_manager.get_main_thread_run_status():
break
+ time.sleep(1)
tasks_manager._main_graceful_exit()
- Crafty.universal_exit()
+ crafty_prompt.universal_exit()